From 6ce741f5d4e01e15f9ea5ec96df1a43f522c330f Mon Sep 17 00:00:00 2001 From: James Ives Date: Fri, 26 Nov 2021 12:57:51 +0000 Subject: [PATCH] =?UTF-8?q?Deploy=20Production=20Code=20for=20Commit=2036b?= =?UTF-8?q?163b9382e05d6d6a125a573be87b6a956fa06=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 4 +- lib/constants.d.ts | 78 + lib/constants.js | 96 + lib/execute.d.ts | 10 + lib/execute.js | 47 + lib/git.d.ts | 3 + lib/git.js | 149 + lib/lib.d.ts | 6 + lib/lib.js | 63 + lib/main.d.ts | 1 + lib/main.js | 9 + lib/ssh.d.ts | 2 + lib/ssh.js | 54 + lib/util.d.ts | 10 + lib/util.js | 77 + lib/worktree.d.ts | 9 + lib/worktree.js | 67 + node_modules/.bin/semver | 1 + node_modules/.bin/which | 1 + node_modules/@actions/core/LICENSE.md | 9 + node_modules/@actions/core/README.md | 312 + node_modules/@actions/core/lib/command.d.ts | 15 + node_modules/@actions/core/lib/command.js | 92 + node_modules/@actions/core/lib/command.js.map | 1 + node_modules/@actions/core/lib/core.d.ts | 186 + node_modules/@actions/core/lib/core.js | 312 + node_modules/@actions/core/lib/core.js.map | 1 + .../@actions/core/lib/file-command.d.ts | 1 + .../@actions/core/lib/file-command.js | 42 + .../@actions/core/lib/file-command.js.map | 1 + .../@actions/core/lib/oidc-utils.d.ts | 7 + node_modules/@actions/core/lib/oidc-utils.js | 77 + .../@actions/core/lib/oidc-utils.js.map | 1 + node_modules/@actions/core/lib/utils.d.ts | 14 + node_modules/@actions/core/lib/utils.js | 40 + node_modules/@actions/core/lib/utils.js.map | 1 + node_modules/@actions/core/package.json | 44 + node_modules/@actions/exec/LICENSE.md | 9 + node_modules/@actions/exec/README.md | 57 + node_modules/@actions/exec/lib/exec.d.ts | 24 + node_modules/@actions/exec/lib/exec.js | 103 + node_modules/@actions/exec/lib/exec.js.map | 1 + .../@actions/exec/lib/interfaces.d.ts | 57 + node_modules/@actions/exec/lib/interfaces.js | 3 + .../@actions/exec/lib/interfaces.js.map | 1 + .../@actions/exec/lib/toolrunner.d.ts | 37 + node_modules/@actions/exec/lib/toolrunner.js | 618 + .../@actions/exec/lib/toolrunner.js.map | 1 + node_modules/@actions/exec/package.json | 41 + node_modules/@actions/github/LICENSE.md | 9 + node_modules/@actions/github/README.md | 97 + node_modules/@actions/github/lib/context.d.ts | 32 + node_modules/@actions/github/lib/context.js | 54 + .../@actions/github/lib/context.js.map | 1 + node_modules/@actions/github/lib/github.d.ts | 11 + node_modules/@actions/github/lib/github.js | 36 + .../@actions/github/lib/github.js.map | 1 + .../@actions/github/lib/interfaces.d.ts | 40 + .../@actions/github/lib/interfaces.js | 4 + .../@actions/github/lib/interfaces.js.map | 1 + .../@actions/github/lib/internal/utils.d.ts | 6 + .../@actions/github/lib/internal/utils.js | 43 + .../@actions/github/lib/internal/utils.js.map | 1 + node_modules/@actions/github/lib/utils.d.ts | 14 + node_modules/@actions/github/lib/utils.js | 54 + node_modules/@actions/github/lib/utils.js.map | 1 + node_modules/@actions/github/package.json | 50 + node_modules/@actions/http-client/LICENSE | 21 + node_modules/@actions/http-client/README.md | 79 + node_modules/@actions/http-client/RELEASES.md | 26 + node_modules/@actions/http-client/actions.png | Bin 0 -> 33889 bytes node_modules/@actions/http-client/auth.d.ts | 23 + node_modules/@actions/http-client/auth.js | 58 + node_modules/@actions/http-client/index.d.ts | 124 + node_modules/@actions/http-client/index.js | 537 + .../@actions/http-client/interfaces.d.ts | 49 + .../@actions/http-client/interfaces.js | 2 + .../@actions/http-client/package.json | 39 + node_modules/@actions/http-client/proxy.d.ts | 2 + node_modules/@actions/http-client/proxy.js | 57 + node_modules/@actions/io/LICENSE.md | 9 + node_modules/@actions/io/README.md | 53 + node_modules/@actions/io/lib/io-util.d.ts | 19 + node_modules/@actions/io/lib/io-util.js | 177 + node_modules/@actions/io/lib/io-util.js.map | 1 + node_modules/@actions/io/lib/io.d.ts | 64 + node_modules/@actions/io/lib/io.js | 341 + node_modules/@actions/io/lib/io.js.map | 1 + node_modules/@actions/io/package.json | 37 + node_modules/@octokit/auth-token/LICENSE | 21 + node_modules/@octokit/auth-token/README.md | 271 + .../@octokit/auth-token/dist-node/index.js | 49 + .../auth-token/dist-node/index.js.map | 1 + .../@octokit/auth-token/dist-src/auth.js | 12 + .../@octokit/auth-token/dist-src/hook.js | 6 + .../@octokit/auth-token/dist-src/index.js | 14 + .../@octokit/auth-token/dist-src/types.js | 1 + .../dist-src/with-authorization-prefix.js | 11 + .../@octokit/auth-token/dist-types/auth.d.ts | 2 + .../@octokit/auth-token/dist-types/hook.d.ts | 2 + .../@octokit/auth-token/dist-types/index.d.ts | 7 + .../@octokit/auth-token/dist-types/types.d.ts | 28 + .../dist-types/with-authorization-prefix.d.ts | 6 + .../@octokit/auth-token/dist-web/index.js | 46 + .../@octokit/auth-token/dist-web/index.js.map | 1 + node_modules/@octokit/auth-token/package.json | 48 + node_modules/@octokit/core/LICENSE | 21 + node_modules/@octokit/core/README.md | 440 + node_modules/@octokit/core/dist-node/index.js | 175 + .../@octokit/core/dist-node/index.js.map | 1 + node_modules/@octokit/core/dist-src/index.js | 125 + node_modules/@octokit/core/dist-src/types.js | 1 + .../@octokit/core/dist-src/version.js | 1 + .../@octokit/core/dist-types/index.d.ts | 30 + .../@octokit/core/dist-types/types.d.ts | 44 + .../@octokit/core/dist-types/version.d.ts | 1 + node_modules/@octokit/core/dist-web/index.js | 130 + .../@octokit/core/dist-web/index.js.map | 1 + node_modules/@octokit/core/package.json | 58 + node_modules/@octokit/endpoint/LICENSE | 21 + node_modules/@octokit/endpoint/README.md | 421 + .../@octokit/endpoint/dist-node/index.js | 379 + .../@octokit/endpoint/dist-node/index.js.map | 1 + .../@octokit/endpoint/dist-src/defaults.js | 17 + .../dist-src/endpoint-with-defaults.js | 5 + .../@octokit/endpoint/dist-src/index.js | 3 + .../@octokit/endpoint/dist-src/merge.js | 22 + .../@octokit/endpoint/dist-src/parse.js | 81 + .../dist-src/util/add-query-parameters.js | 17 + .../util/extract-url-variable-names.js | 11 + .../endpoint/dist-src/util/lowercase-keys.js | 9 + .../endpoint/dist-src/util/merge-deep.js | 16 + .../@octokit/endpoint/dist-src/util/omit.js | 8 + .../endpoint/dist-src/util/url-template.js | 164 + .../@octokit/endpoint/dist-src/version.js | 1 + .../endpoint/dist-src/with-defaults.js | 13 + .../endpoint/dist-types/defaults.d.ts | 2 + .../dist-types/endpoint-with-defaults.d.ts | 3 + .../@octokit/endpoint/dist-types/index.d.ts | 1 + .../@octokit/endpoint/dist-types/merge.d.ts | 2 + .../@octokit/endpoint/dist-types/parse.d.ts | 2 + .../dist-types/util/add-query-parameters.d.ts | 4 + .../util/extract-url-variable-names.d.ts | 1 + .../dist-types/util/lowercase-keys.d.ts | 5 + .../endpoint/dist-types/util/merge-deep.d.ts | 1 + .../endpoint/dist-types/util/omit.d.ts | 5 + .../dist-types/util/url-template.d.ts | 3 + .../@octokit/endpoint/dist-types/version.d.ts | 1 + .../endpoint/dist-types/with-defaults.d.ts | 2 + .../@octokit/endpoint/dist-web/index.js | 369 + .../@octokit/endpoint/dist-web/index.js.map | 1 + .../node_modules/@octokit/types/LICENSE | 7 + .../node_modules/@octokit/types/README.md | 64 + .../@octokit/types/dist-node/index.js | 8 + .../@octokit/types/dist-node/index.js.map | 1 + .../@octokit/types/dist-src/AuthInterface.js | 0 .../types/dist-src/EndpointDefaults.js | 0 .../types/dist-src/EndpointInterface.js | 0 .../types/dist-src/EndpointOptions.js | 0 .../@octokit/types/dist-src/Fetch.js | 0 .../GetResponseTypeFromEndpointMethod.js | 0 .../types/dist-src/OctokitResponse.js | 0 .../@octokit/types/dist-src/RequestHeaders.js | 0 .../types/dist-src/RequestInterface.js | 0 .../@octokit/types/dist-src/RequestMethod.js | 0 .../@octokit/types/dist-src/RequestOptions.js | 0 .../types/dist-src/RequestParameters.js | 0 .../types/dist-src/RequestRequestOptions.js | 0 .../types/dist-src/ResponseHeaders.js | 0 .../@octokit/types/dist-src/Route.js | 0 .../@octokit/types/dist-src/Signal.js | 0 .../types/dist-src/StrategyInterface.js | 0 .../@octokit/types/dist-src/Url.js | 0 .../@octokit/types/dist-src/VERSION.js | 1 + .../types/dist-src/generated/Endpoints.js | 0 .../@octokit/types/dist-src/index.js | 20 + .../types/dist-types/AuthInterface.d.ts | 31 + .../types/dist-types/EndpointDefaults.d.ts | 21 + .../types/dist-types/EndpointInterface.d.ts | 65 + .../types/dist-types/EndpointOptions.d.ts | 7 + .../@octokit/types/dist-types/Fetch.d.ts | 4 + .../GetResponseTypeFromEndpointMethod.d.ts | 5 + .../types/dist-types/OctokitResponse.d.ts | 17 + .../types/dist-types/RequestHeaders.d.ts | 15 + .../types/dist-types/RequestInterface.d.ts | 34 + .../types/dist-types/RequestMethod.d.ts | 4 + .../types/dist-types/RequestOptions.d.ts | 14 + .../types/dist-types/RequestParameters.d.ts | 45 + .../dist-types/RequestRequestOptions.d.ts | 26 + .../types/dist-types/ResponseHeaders.d.ts | 20 + .../@octokit/types/dist-types/Route.d.ts | 4 + .../@octokit/types/dist-types/Signal.d.ts | 6 + .../types/dist-types/StrategyInterface.d.ts | 4 + .../@octokit/types/dist-types/Url.d.ts | 4 + .../@octokit/types/dist-types/VERSION.d.ts | 1 + .../types/dist-types/generated/Endpoints.d.ts | 36972 ++++++++++++++++ .../@octokit/types/dist-types/index.d.ts | 20 + .../@octokit/types/dist-web/index.js | 4 + .../@octokit/types/dist-web/index.js.map | 1 + .../node_modules/@octokit/types/package.json | 49 + .../universal-user-agent/LICENSE.md | 7 + .../universal-user-agent/README.md | 25 + .../universal-user-agent/dist-node/index.js | 22 + .../dist-node/index.js.map | 1 + .../universal-user-agent/dist-src/browser.js | 8 + .../universal-user-agent/dist-src/index.js | 1 + .../universal-user-agent/dist-src/node.js | 12 + .../dist-types/browser.d.ts | 1 + .../dist-types/index.d.ts | 1 + .../universal-user-agent/dist-types/node.d.ts | 1 + .../universal-user-agent/dist-web/index.js | 11 + .../dist-web/index.js.map | 1 + .../universal-user-agent/package.json | 33 + node_modules/@octokit/endpoint/package.json | 51 + node_modules/@octokit/graphql/LICENSE | 21 + node_modules/@octokit/graphql/README.md | 398 + .../@octokit/graphql/dist-node/index.js | 116 + .../@octokit/graphql/dist-node/index.js.map | 1 + .../@octokit/graphql/dist-src/error.js | 15 + .../@octokit/graphql/dist-src/graphql.js | 55 + .../@octokit/graphql/dist-src/index.js | 17 + .../@octokit/graphql/dist-src/types.js | 1 + .../@octokit/graphql/dist-src/version.js | 1 + .../graphql/dist-src/with-defaults.js | 12 + .../@octokit/graphql/dist-types/error.d.ts | 9 + .../@octokit/graphql/dist-types/graphql.d.ts | 3 + .../@octokit/graphql/dist-types/index.d.ts | 4 + .../@octokit/graphql/dist-types/types.d.ts | 54 + .../@octokit/graphql/dist-types/version.d.ts | 1 + .../graphql/dist-types/with-defaults.d.ts | 3 + .../@octokit/graphql/dist-web/index.js | 103 + .../@octokit/graphql/dist-web/index.js.map | 1 + .../node_modules/@octokit/endpoint/LICENSE | 21 + .../node_modules/@octokit/endpoint/README.md | 421 + .../@octokit/endpoint/dist-node/index.js | 379 + .../@octokit/endpoint/dist-node/index.js.map | 1 + .../@octokit/endpoint/dist-src/defaults.js | 17 + .../dist-src/endpoint-with-defaults.js | 5 + .../@octokit/endpoint/dist-src/index.js | 3 + .../@octokit/endpoint/dist-src/merge.js | 22 + .../@octokit/endpoint/dist-src/parse.js | 81 + .../dist-src/util/add-query-parameters.js | 21 + .../util/extract-url-variable-names.js | 11 + .../endpoint/dist-src/util/lowercase-keys.js | 9 + .../endpoint/dist-src/util/merge-deep.js | 16 + .../@octokit/endpoint/dist-src/util/omit.js | 8 + .../endpoint/dist-src/util/url-template.js | 170 + .../@octokit/endpoint/dist-src/version.js | 1 + .../endpoint/dist-src/with-defaults.js | 13 + .../endpoint/dist-types/defaults.d.ts | 2 + .../dist-types/endpoint-with-defaults.d.ts | 3 + .../@octokit/endpoint/dist-types/index.d.ts | 1 + .../@octokit/endpoint/dist-types/merge.d.ts | 2 + .../@octokit/endpoint/dist-types/parse.d.ts | 2 + .../dist-types/util/add-query-parameters.d.ts | 4 + .../util/extract-url-variable-names.d.ts | 1 + .../dist-types/util/lowercase-keys.d.ts | 5 + .../endpoint/dist-types/util/merge-deep.d.ts | 1 + .../endpoint/dist-types/util/omit.d.ts | 5 + .../dist-types/util/url-template.d.ts | 3 + .../@octokit/endpoint/dist-types/version.d.ts | 1 + .../endpoint/dist-types/with-defaults.d.ts | 2 + .../@octokit/endpoint/dist-web/index.js | 379 + .../@octokit/endpoint/dist-web/index.js.map | 1 + .../types/.github/ISSUE_TEMPLATE/01_help.md | 5 + .../types/.github/ISSUE_TEMPLATE/02_bug.md | 19 + .../ISSUE_TEMPLATE/03_feature_request.md | 19 + .../types/.github/ISSUE_TEMPLATE/04_thanks.md | 19 + .../types/.github/workflows/release.yml | 25 + .../types/.github/workflows/routes-update.yml | 37 + .../@octokit/types/.github/workflows/test.yml | 19 + .../@octokit/types/CODE_OF_CONDUCT.md | 75 + .../@octokit/types/CONTRIBUTING.md | 59 + .../node_modules/@octokit/types/LICENSE | 7 + .../node_modules/@octokit/types/README.md | 19 + .../node_modules/@octokit/types/package.json | 62 + .../scripts/update-endpoints/fetch-json.js | 41 + .../update-endpoints/generated/README.md | 3 + .../update-endpoints/generated/endpoints.json | 25258 +++++++++++ .../templates/endpoints.ts.template | 33 + .../scripts/update-endpoints/typescript.js | 179 + .../@octokit/types/src/AuthInterface.ts | 43 + .../@octokit/types/src/EndpointDefaults.ts | 22 + .../@octokit/types/src/EndpointInterface.ts | 74 + .../@octokit/types/src/EndpointOptions.ts | 8 + .../node_modules/@octokit/types/src/Fetch.ts | 4 + .../@octokit/types/src/OctokitResponse.ts | 18 + .../@octokit/types/src/RequestHeaders.ts | 15 + .../@octokit/types/src/RequestInterface.ts | 51 + .../@octokit/types/src/RequestMethod.ts | 10 + .../@octokit/types/src/RequestOptions.ts | 15 + .../@octokit/types/src/RequestParameters.ts | 46 + .../types/src/RequestRequestOptions.ts | 27 + .../@octokit/types/src/ResponseHeaders.ts | 21 + .../node_modules/@octokit/types/src/Route.ts | 4 + .../node_modules/@octokit/types/src/Signal.ts | 6 + .../@octokit/types/src/StrategyInterface.ts | 9 + .../node_modules/@octokit/types/src/Url.ts | 4 + .../@octokit/types/src/VERSION.ts | 1 + .../@octokit/types/src/generated/Endpoints.ts | 14190 ++++++ .../@octokit/types/src/generated/README.md | 3 + .../node_modules/@octokit/types/src/index.ts | 18 + .../universal-user-agent/LICENSE.md | 7 + .../universal-user-agent/README.md | 25 + .../universal-user-agent/dist-node/index.js | 22 + .../dist-node/index.js.map | 1 + .../universal-user-agent/dist-src/browser.js | 3 + .../universal-user-agent/dist-src/index.js | 1 + .../universal-user-agent/dist-src/node.js | 12 + .../dist-types/browser.d.ts | 1 + .../dist-types/index.d.ts | 1 + .../universal-user-agent/dist-types/node.d.ts | 1 + .../universal-user-agent/dist-web/index.js | 6 + .../dist-web/index.js.map | 1 + .../universal-user-agent/package.json | 33 + .../@octokit/endpoint/package.json | 51 + .../@octokit/request-error/LICENSE | 21 + .../@octokit/request-error/README.md | 68 + .../@octokit/request-error/dist-node/index.js | 55 + .../request-error/dist-node/index.js.map | 1 + .../@octokit/request-error/dist-src/index.js | 40 + .../@octokit/request-error/dist-src/types.js | 0 .../request-error/dist-types/index.d.ts | 27 + .../request-error/dist-types/types.d.ts | 5 + .../@octokit/request-error/dist-web/index.js | 44 + .../request-error/dist-web/index.js.map | 1 + .../types/.github/ISSUE_TEMPLATE/01_help.md | 5 + .../types/.github/ISSUE_TEMPLATE/02_bug.md | 19 + .../ISSUE_TEMPLATE/03_feature_request.md | 19 + .../types/.github/ISSUE_TEMPLATE/04_thanks.md | 19 + .../types/.github/workflows/release.yml | 25 + .../types/.github/workflows/routes-update.yml | 37 + .../@octokit/types/.github/workflows/test.yml | 19 + .../@octokit/types/CODE_OF_CONDUCT.md | 75 + .../@octokit/types/CONTRIBUTING.md | 59 + .../node_modules/@octokit/types/LICENSE | 7 + .../node_modules/@octokit/types/README.md | 19 + .../node_modules/@octokit/types/package.json | 62 + .../scripts/update-endpoints/fetch-json.js | 41 + .../update-endpoints/generated/README.md | 3 + .../update-endpoints/generated/endpoints.json | 25258 +++++++++++ .../templates/endpoints.ts.template | 33 + .../scripts/update-endpoints/typescript.js | 179 + .../@octokit/types/src/AuthInterface.ts | 43 + .../@octokit/types/src/EndpointDefaults.ts | 22 + .../@octokit/types/src/EndpointInterface.ts | 74 + .../@octokit/types/src/EndpointOptions.ts | 8 + .../node_modules/@octokit/types/src/Fetch.ts | 4 + .../@octokit/types/src/OctokitResponse.ts | 18 + .../@octokit/types/src/RequestHeaders.ts | 15 + .../@octokit/types/src/RequestInterface.ts | 51 + .../@octokit/types/src/RequestMethod.ts | 10 + .../@octokit/types/src/RequestOptions.ts | 15 + .../@octokit/types/src/RequestParameters.ts | 46 + .../types/src/RequestRequestOptions.ts | 27 + .../@octokit/types/src/ResponseHeaders.ts | 21 + .../node_modules/@octokit/types/src/Route.ts | 4 + .../node_modules/@octokit/types/src/Signal.ts | 6 + .../@octokit/types/src/StrategyInterface.ts | 9 + .../node_modules/@octokit/types/src/Url.ts | 4 + .../@octokit/types/src/VERSION.ts | 1 + .../@octokit/types/src/generated/Endpoints.ts | 14190 ++++++ .../@octokit/types/src/generated/README.md | 3 + .../node_modules/@octokit/types/src/index.ts | 18 + .../@octokit/request-error/package.json | 54 + .../node_modules/@octokit/request/LICENSE | 21 + .../node_modules/@octokit/request/README.md | 539 + .../@octokit/request/dist-node/index.js | 148 + .../@octokit/request/dist-node/index.js.map | 1 + .../request/dist-src/fetch-wrapper.js | 93 + .../request/dist-src/get-buffer-response.js | 3 + .../@octokit/request/dist-src/index.js | 9 + .../@octokit/request/dist-src/version.js | 1 + .../request/dist-src/with-defaults.js | 22 + .../request/dist-types/fetch-wrapper.d.ts | 11 + .../dist-types/get-buffer-response.d.ts | 2 + .../@octokit/request/dist-types/index.d.ts | 1 + .../@octokit/request/dist-types/version.d.ts | 1 + .../request/dist-types/with-defaults.d.ts | 2 + .../@octokit/request/dist-web/index.js | 132 + .../@octokit/request/dist-web/index.js.map | 1 + .../types/.github/ISSUE_TEMPLATE/01_help.md | 5 + .../types/.github/ISSUE_TEMPLATE/02_bug.md | 19 + .../ISSUE_TEMPLATE/03_feature_request.md | 19 + .../types/.github/ISSUE_TEMPLATE/04_thanks.md | 19 + .../types/.github/workflows/release.yml | 25 + .../types/.github/workflows/routes-update.yml | 37 + .../@octokit/types/.github/workflows/test.yml | 19 + .../@octokit/types/CODE_OF_CONDUCT.md | 75 + .../@octokit/types/CONTRIBUTING.md | 59 + .../node_modules/@octokit/types/LICENSE | 7 + .../node_modules/@octokit/types/README.md | 19 + .../node_modules/@octokit/types/package.json | 62 + .../scripts/update-endpoints/fetch-json.js | 41 + .../update-endpoints/generated/README.md | 3 + .../update-endpoints/generated/endpoints.json | 25258 +++++++++++ .../templates/endpoints.ts.template | 33 + .../scripts/update-endpoints/typescript.js | 179 + .../@octokit/types/src/AuthInterface.ts | 43 + .../@octokit/types/src/EndpointDefaults.ts | 22 + .../@octokit/types/src/EndpointInterface.ts | 74 + .../@octokit/types/src/EndpointOptions.ts | 8 + .../node_modules/@octokit/types/src/Fetch.ts | 4 + .../@octokit/types/src/OctokitResponse.ts | 18 + .../@octokit/types/src/RequestHeaders.ts | 15 + .../@octokit/types/src/RequestInterface.ts | 51 + .../@octokit/types/src/RequestMethod.ts | 10 + .../@octokit/types/src/RequestOptions.ts | 15 + .../@octokit/types/src/RequestParameters.ts | 46 + .../types/src/RequestRequestOptions.ts | 27 + .../@octokit/types/src/ResponseHeaders.ts | 21 + .../node_modules/@octokit/types/src/Route.ts | 4 + .../node_modules/@octokit/types/src/Signal.ts | 6 + .../@octokit/types/src/StrategyInterface.ts | 9 + .../node_modules/@octokit/types/src/Url.ts | 4 + .../@octokit/types/src/VERSION.ts | 1 + .../@octokit/types/src/generated/Endpoints.ts | 14190 ++++++ .../@octokit/types/src/generated/README.md | 3 + .../node_modules/@octokit/types/src/index.ts | 18 + .../universal-user-agent/LICENSE.md | 7 + .../universal-user-agent/README.md | 25 + .../universal-user-agent/dist-node/index.js | 22 + .../dist-node/index.js.map | 1 + .../universal-user-agent/dist-src/browser.js | 3 + .../universal-user-agent/dist-src/index.js | 1 + .../universal-user-agent/dist-src/node.js | 12 + .../dist-types/browser.d.ts | 1 + .../dist-types/index.d.ts | 1 + .../universal-user-agent/dist-types/node.d.ts | 1 + .../universal-user-agent/dist-web/index.js | 6 + .../dist-web/index.js.map | 1 + .../universal-user-agent/package.json | 33 + .../@octokit/request/package.json | 64 + node_modules/@octokit/graphql/package.json | 47 + node_modules/@octokit/openapi-types/LICENSE | 7 + node_modules/@octokit/openapi-types/README.md | 9 + .../@octokit/openapi-types/dist-node/index.js | 8 + .../openapi-types/dist-node/index.js.map | 1 + .../openapi-types/dist-src/generated/types.js | 5 + .../@octokit/openapi-types/dist-src/index.js | 2 + .../openapi-types/dist-src/version.js | 1 + .../dist-types/generated/types.d.ts | 33562 ++++++++++++++ .../openapi-types/dist-types/index.d.ts | 2 + .../openapi-types/dist-types/version.d.ts | 1 + .../@octokit/openapi-types/dist-web/index.js | 4 + .../openapi-types/dist-web/index.js.map | 1 + .../@octokit/openapi-types/package.json | 36 + .../@octokit/plugin-paginate-rest/LICENSE | 7 + .../@octokit/plugin-paginate-rest/README.md | 270 + .../plugin-paginate-rest/dist-node/index.js | 144 + .../dist-node/index.js.map | 1 + .../dist-src/compose-paginate.js | 5 + .../generated/paginating-endpoints.js | 191 + .../plugin-paginate-rest/dist-src/index.js | 17 + .../plugin-paginate-rest/dist-src/iterator.js | 25 + .../normalize-paginated-list-response.js | 40 + .../plugin-paginate-rest/dist-src/paginate.js | 24 + .../dist-src/paginating-endpoints.js | 10 + .../plugin-paginate-rest/dist-src/types.js | 1 + .../plugin-paginate-rest/dist-src/version.js | 1 + .../dist-types/compose-paginate.d.ts | 2 + .../generated/paginating-endpoints.d.ts | 1411 + .../dist-types/index.d.ts | 16 + .../dist-types/iterator.d.ts | 13 + .../normalize-paginated-list-response.d.ts | 18 + .../dist-types/paginate.d.ts | 3 + .../dist-types/paginating-endpoints.d.ts | 3 + .../dist-types/types.d.ts | 242 + .../dist-types/version.d.ts | 1 + .../plugin-paginate-rest/dist-web/index.js | 312 + .../dist-web/index.js.map | 1 + .../plugin-paginate-rest/package.json | 51 + .../plugin-rest-endpoint-methods/LICENSE | 7 + .../plugin-rest-endpoint-methods/README.md | 76 + .../dist-node/index.js | 1257 + .../dist-node/index.js.map | 1 + .../dist-src/endpoints-to-methods.js | 60 + .../dist-src/generated/endpoints.js | 1425 + .../dist-src/generated/method-types.js | 1 + .../parameters-and-response-types.js | 1 + .../dist-src/index.js | 18 + .../dist-src/types.js | 1 + .../dist-src/version.js | 1 + .../dist-types/endpoints-to-methods.d.ts | 4 + .../dist-types/generated/endpoints.d.ts | 3 + .../dist-types/generated/method-types.d.ts | 7933 ++++ .../parameters-and-response-types.d.ts | 2653 ++ .../dist-types/index.d.ts | 11 + .../dist-types/types.d.ts | 18 + .../dist-types/version.d.ts | 1 + .../dist-web/index.js | 1506 + .../dist-web/index.js.map | 1 + .../plugin-rest-endpoint-methods/package.json | 60 + node_modules/@octokit/request-error/LICENSE | 21 + node_modules/@octokit/request-error/README.md | 67 + .../@octokit/request-error/dist-node/index.js | 55 + .../request-error/dist-node/index.js.map | 1 + .../@octokit/request-error/dist-src/index.js | 40 + .../@octokit/request-error/dist-src/types.js | 1 + .../request-error/dist-types/index.d.ts | 27 + .../request-error/dist-types/types.d.ts | 5 + .../@octokit/request-error/dist-web/index.js | 44 + .../request-error/dist-web/index.js.map | 1 + .../@octokit/request-error/package.json | 54 + node_modules/@octokit/request/LICENSE | 21 + node_modules/@octokit/request/README.md | 541 + .../@octokit/request/dist-node/index.js | 150 + .../@octokit/request/dist-node/index.js.map | 1 + .../request/dist-src/fetch-wrapper.js | 96 + .../request/dist-src/get-buffer-response.js | 3 + .../@octokit/request/dist-src/index.js | 9 + .../@octokit/request/dist-src/version.js | 1 + .../request/dist-src/with-defaults.js | 22 + .../request/dist-types/fetch-wrapper.d.ts | 11 + .../dist-types/get-buffer-response.d.ts | 2 + .../@octokit/request/dist-types/index.d.ts | 1 + .../@octokit/request/dist-types/version.d.ts | 1 + .../request/dist-types/with-defaults.d.ts | 2 + .../@octokit/request/dist-web/index.js | 135 + .../@octokit/request/dist-web/index.js.map | 1 + .../@octokit/request-error/LICENSE | 21 + .../@octokit/request-error/README.md | 67 + .../@octokit/request-error/dist-node/index.js | 55 + .../request-error/dist-node/index.js.map | 1 + .../@octokit/request-error/dist-src/index.js | 40 + .../@octokit/request-error/dist-src/types.js | 0 .../request-error/dist-types/index.d.ts | 27 + .../request-error/dist-types/types.d.ts | 5 + .../@octokit/request-error/dist-web/index.js | 44 + .../request-error/dist-web/index.js.map | 1 + .../node_modules/@octokit/types/LICENSE | 7 + .../node_modules/@octokit/types/README.md | 64 + .../@octokit/types/dist-node/index.js | 8 + .../@octokit/types/dist-node/index.js.map | 1 + .../@octokit/types/dist-src/AuthInterface.js | 0 .../types/dist-src/EndpointDefaults.js | 0 .../types/dist-src/EndpointInterface.js | 0 .../types/dist-src/EndpointOptions.js | 0 .../@octokit/types/dist-src/Fetch.js | 0 .../GetResponseTypeFromEndpointMethod.js | 0 .../types/dist-src/OctokitResponse.js | 0 .../@octokit/types/dist-src/RequestHeaders.js | 0 .../types/dist-src/RequestInterface.js | 0 .../@octokit/types/dist-src/RequestMethod.js | 0 .../@octokit/types/dist-src/RequestOptions.js | 0 .../types/dist-src/RequestParameters.js | 0 .../types/dist-src/RequestRequestOptions.js | 0 .../types/dist-src/ResponseHeaders.js | 0 .../@octokit/types/dist-src/Route.js | 0 .../@octokit/types/dist-src/Signal.js | 0 .../types/dist-src/StrategyInterface.js | 0 .../@octokit/types/dist-src/Url.js | 0 .../@octokit/types/dist-src/VERSION.js | 1 + .../types/dist-src/generated/Endpoints.js | 0 .../@octokit/types/dist-src/index.js | 20 + .../types/dist-types/AuthInterface.d.ts | 31 + .../types/dist-types/EndpointDefaults.d.ts | 21 + .../types/dist-types/EndpointInterface.d.ts | 65 + .../types/dist-types/EndpointOptions.d.ts | 7 + .../@octokit/types/dist-types/Fetch.d.ts | 4 + .../GetResponseTypeFromEndpointMethod.d.ts | 5 + .../types/dist-types/OctokitResponse.d.ts | 17 + .../types/dist-types/RequestHeaders.d.ts | 15 + .../types/dist-types/RequestInterface.d.ts | 34 + .../types/dist-types/RequestMethod.d.ts | 4 + .../types/dist-types/RequestOptions.d.ts | 14 + .../types/dist-types/RequestParameters.d.ts | 45 + .../dist-types/RequestRequestOptions.d.ts | 26 + .../types/dist-types/ResponseHeaders.d.ts | 20 + .../@octokit/types/dist-types/Route.d.ts | 4 + .../@octokit/types/dist-types/Signal.d.ts | 6 + .../types/dist-types/StrategyInterface.d.ts | 4 + .../@octokit/types/dist-types/Url.d.ts | 4 + .../@octokit/types/dist-types/VERSION.d.ts | 1 + .../types/dist-types/generated/Endpoints.d.ts | 36972 ++++++++++++++++ .../@octokit/types/dist-types/index.d.ts | 20 + .../@octokit/types/dist-web/index.js | 4 + .../@octokit/types/dist-web/index.js.map | 1 + .../node_modules/@octokit/types/package.json | 49 + .../@octokit/request-error/package.json | 54 + .../node_modules/is-plain-object/LICENSE | 21 + .../node_modules/is-plain-object/README.md | 125 + .../is-plain-object/dist/is-plain-object.js | 38 + .../is-plain-object/dist/is-plain-object.mjs | 34 + .../is-plain-object/is-plain-object.d.ts | 1 + .../node_modules/is-plain-object/package.json | 85 + node_modules/@octokit/request/package.json | 55 + node_modules/@octokit/types/LICENSE | 7 + node_modules/@octokit/types/README.md | 65 + .../@octokit/types/dist-node/index.js | 8 + .../@octokit/types/dist-node/index.js.map | 1 + .../@octokit/types/dist-src/AuthInterface.js | 1 + .../types/dist-src/EndpointDefaults.js | 1 + .../types/dist-src/EndpointInterface.js | 1 + .../types/dist-src/EndpointOptions.js | 1 + node_modules/@octokit/types/dist-src/Fetch.js | 1 + .../GetResponseTypeFromEndpointMethod.js | 1 + .../types/dist-src/OctokitResponse.js | 1 + .../@octokit/types/dist-src/RequestError.js | 1 + .../@octokit/types/dist-src/RequestHeaders.js | 1 + .../types/dist-src/RequestInterface.js | 1 + .../@octokit/types/dist-src/RequestMethod.js | 1 + .../@octokit/types/dist-src/RequestOptions.js | 1 + .../types/dist-src/RequestParameters.js | 1 + .../types/dist-src/RequestRequestOptions.js | 1 + .../types/dist-src/ResponseHeaders.js | 1 + node_modules/@octokit/types/dist-src/Route.js | 1 + .../@octokit/types/dist-src/Signal.js | 1 + .../types/dist-src/StrategyInterface.js | 1 + node_modules/@octokit/types/dist-src/Url.js | 1 + .../@octokit/types/dist-src/VERSION.js | 1 + .../types/dist-src/generated/Endpoints.js | 1 + node_modules/@octokit/types/dist-src/index.js | 21 + .../types/dist-types/AuthInterface.d.ts | 31 + .../types/dist-types/EndpointDefaults.d.ts | 21 + .../types/dist-types/EndpointInterface.d.ts | 65 + .../types/dist-types/EndpointOptions.d.ts | 7 + .../@octokit/types/dist-types/Fetch.d.ts | 4 + .../GetResponseTypeFromEndpointMethod.d.ts | 5 + .../types/dist-types/OctokitResponse.d.ts | 17 + .../types/dist-types/RequestError.d.ts | 11 + .../types/dist-types/RequestHeaders.d.ts | 15 + .../types/dist-types/RequestInterface.d.ts | 34 + .../types/dist-types/RequestMethod.d.ts | 4 + .../types/dist-types/RequestOptions.d.ts | 14 + .../types/dist-types/RequestParameters.d.ts | 45 + .../dist-types/RequestRequestOptions.d.ts | 26 + .../types/dist-types/ResponseHeaders.d.ts | 20 + .../@octokit/types/dist-types/Route.d.ts | 4 + .../@octokit/types/dist-types/Signal.d.ts | 6 + .../types/dist-types/StrategyInterface.d.ts | 4 + .../@octokit/types/dist-types/Url.d.ts | 4 + .../@octokit/types/dist-types/VERSION.d.ts | 1 + .../types/dist-types/generated/Endpoints.d.ts | 3174 ++ .../@octokit/types/dist-types/index.d.ts | 21 + node_modules/@octokit/types/dist-web/index.js | 4 + .../@octokit/types/dist-web/index.js.map | 1 + node_modules/@octokit/types/package.json | 54 + node_modules/@types/node/LICENSE | 21 + node_modules/@types/node/README.md | 16 + node_modules/@types/node/assert.d.ts | 912 + node_modules/@types/node/assert/strict.d.ts | 8 + node_modules/@types/node/async_hooks.d.ts | 497 + node_modules/@types/node/buffer.d.ts | 2142 + node_modules/@types/node/child_process.d.ts | 1366 + node_modules/@types/node/cluster.d.ts | 414 + node_modules/@types/node/console.d.ts | 412 + node_modules/@types/node/constants.d.ts | 18 + node_modules/@types/node/crypto.d.ts | 3307 ++ node_modules/@types/node/dgram.d.ts | 545 + .../@types/node/diagnostics_channel.d.ts | 134 + node_modules/@types/node/dns.d.ts | 654 + node_modules/@types/node/dns/promises.d.ts | 368 + node_modules/@types/node/domain.d.ts | 169 + node_modules/@types/node/events.d.ts | 623 + node_modules/@types/node/fs.d.ts | 3784 ++ node_modules/@types/node/fs/promises.d.ts | 1091 + node_modules/@types/node/globals.d.ts | 284 + node_modules/@types/node/globals.global.d.ts | 1 + node_modules/@types/node/http.d.ts | 1369 + node_modules/@types/node/http2.d.ts | 2100 + node_modules/@types/node/https.d.ts | 391 + node_modules/@types/node/index.d.ts | 131 + node_modules/@types/node/inspector.d.ts | 2745 ++ node_modules/@types/node/module.d.ts | 114 + node_modules/@types/node/net.d.ts | 783 + node_modules/@types/node/os.d.ts | 455 + node_modules/@types/node/package.json | 230 + node_modules/@types/node/path.d.ts | 172 + node_modules/@types/node/perf_hooks.d.ts | 555 + node_modules/@types/node/process.d.ts | 1481 + node_modules/@types/node/punycode.d.ts | 117 + node_modules/@types/node/querystring.d.ts | 131 + node_modules/@types/node/readline.d.ts | 543 + node_modules/@types/node/repl.d.ts | 424 + node_modules/@types/node/stream.d.ts | 1249 + .../@types/node/stream/consumers.d.ts | 24 + node_modules/@types/node/stream/promises.d.ts | 42 + node_modules/@types/node/stream/web.d.ts | 6 + node_modules/@types/node/string_decoder.d.ts | 67 + node_modules/@types/node/timers.d.ts | 94 + node_modules/@types/node/timers/promises.d.ts | 68 + node_modules/@types/node/tls.d.ts | 1019 + node_modules/@types/node/trace_events.d.ts | 161 + node_modules/@types/node/tty.d.ts | 204 + node_modules/@types/node/url.d.ts | 821 + node_modules/@types/node/util.d.ts | 1594 + node_modules/@types/node/v8.d.ts | 378 + node_modules/@types/node/vm.d.ts | 507 + node_modules/@types/node/wasi.d.ts | 158 + node_modules/@types/node/worker_threads.d.ts | 649 + node_modules/@types/node/zlib.d.ts | 517 + node_modules/before-after-hook/LICENSE | 201 + node_modules/before-after-hook/README.md | 655 + node_modules/before-after-hook/index.d.ts | 186 + node_modules/before-after-hook/index.js | 57 + node_modules/before-after-hook/lib/add.js | 46 + .../before-after-hook/lib/register.js | 27 + node_modules/before-after-hook/lib/remove.js | 19 + node_modules/before-after-hook/package.json | 66 + node_modules/deprecation/LICENSE | 15 + node_modules/deprecation/README.md | 77 + node_modules/deprecation/dist-node/index.js | 20 + node_modules/deprecation/dist-src/index.js | 14 + .../deprecation/dist-types/index.d.ts | 3 + node_modules/deprecation/dist-web/index.js | 16 + node_modules/deprecation/package.json | 34 + node_modules/end-of-stream/LICENSE | 21 + node_modules/end-of-stream/README.md | 54 + node_modules/end-of-stream/index.js | 94 + node_modules/end-of-stream/package.json | 37 + node_modules/execa/index.js | 361 + node_modules/execa/lib/errname.js | 39 + node_modules/execa/lib/stdio.js | 41 + node_modules/execa/license | 9 + .../node_modules/cross-spawn/CHANGELOG.md | 100 + .../execa/node_modules/cross-spawn/LICENSE | 21 + .../execa/node_modules/cross-spawn/README.md | 94 + .../execa/node_modules/cross-spawn/index.js | 39 + .../node_modules/cross-spawn/lib/enoent.js | 59 + .../node_modules/cross-spawn/lib/parse.js | 125 + .../cross-spawn/lib/util/escape.js | 45 + .../cross-spawn/lib/util/readShebang.js | 32 + .../cross-spawn/lib/util/resolveCommand.js | 47 + .../cross-spawn/node_modules/.bin/semver | 1 + .../cross-spawn/node_modules/.bin/which | 1 + .../node_modules/cross-spawn/package.json | 76 + .../execa/node_modules/is-stream/index.js | 21 + .../execa/node_modules/is-stream/license | 21 + .../execa/node_modules/is-stream/package.json | 38 + .../execa/node_modules/is-stream/readme.md | 42 + .../execa/node_modules/npm-run-path/index.js | 39 + .../execa/node_modules/npm-run-path/license | 21 + .../node_modules/npm-run-path/package.json | 45 + .../execa/node_modules/npm-run-path/readme.md | 81 + .../execa/node_modules/path-key/index.js | 13 + .../execa/node_modules/path-key/license | 21 + .../execa/node_modules/path-key/package.json | 39 + .../execa/node_modules/path-key/readme.md | 51 + .../execa/node_modules/semver/CHANGELOG.md | 39 + .../execa/node_modules/semver/LICENSE | 15 + .../execa/node_modules/semver/README.md | 412 + .../execa/node_modules/semver/bin/semver | 160 + .../execa/node_modules/semver/package.json | 28 + .../execa/node_modules/semver/range.bnf | 16 + .../execa/node_modules/semver/semver.js | 1483 + .../node_modules/shebang-command/index.js | 19 + .../node_modules/shebang-command/license | 21 + .../node_modules/shebang-command/package.json | 39 + .../node_modules/shebang-command/readme.md | 39 + .../execa/node_modules/shebang-regex/index.js | 2 + .../execa/node_modules/shebang-regex/license | 21 + .../node_modules/shebang-regex/package.json | 32 + .../node_modules/shebang-regex/readme.md | 29 + .../execa/node_modules/which/CHANGELOG.md | 152 + node_modules/execa/node_modules/which/LICENSE | 15 + .../execa/node_modules/which/README.md | 51 + .../execa/node_modules/which/bin/which | 52 + .../execa/node_modules/which/package.json | 30 + .../execa/node_modules/which/which.js | 135 + node_modules/execa/package.json | 69 + node_modules/execa/readme.md | 327 + node_modules/get-stream/buffer-stream.js | 51 + node_modules/get-stream/index.js | 50 + node_modules/get-stream/license | 9 + node_modules/get-stream/package.json | 46 + node_modules/get-stream/readme.md | 123 + node_modules/is-plain-object/LICENSE | 21 + node_modules/is-plain-object/README.md | 119 + node_modules/is-plain-object/index.cjs.js | 48 + node_modules/is-plain-object/index.d.ts | 3 + node_modules/is-plain-object/index.js | 35 + .../node_modules/isobject/LICENSE | 21 + .../node_modules/isobject/README.md | 127 + .../node_modules/isobject/index.cjs.js | 14 + .../node_modules/isobject/index.d.ts | 3 + .../node_modules/isobject/index.js | 10 + .../node_modules/isobject/package.json | 80 + node_modules/is-plain-object/package.json | 82 + node_modules/isexe/.npmignore | 2 + node_modules/isexe/LICENSE | 15 + node_modules/isexe/README.md | 51 + node_modules/isexe/index.js | 57 + node_modules/isexe/mode.js | 41 + node_modules/isexe/package.json | 31 + node_modules/isexe/test/basic.js | 221 + node_modules/isexe/windows.js | 42 + node_modules/macos-release/index.d.ts | 36 + node_modules/macos-release/index.js | 32 + node_modules/macos-release/license | 9 + node_modules/macos-release/package.json | 39 + node_modules/macos-release/readme.md | 57 + node_modules/nice-try/CHANGELOG.md | 21 + node_modules/nice-try/LICENSE | 21 + node_modules/nice-try/README.md | 32 + node_modules/nice-try/package.json | 33 + node_modules/nice-try/src/index.js | 12 + node_modules/node-fetch/CHANGELOG.md | 272 + node_modules/node-fetch/LICENSE.md | 22 + node_modules/node-fetch/README.md | 590 + node_modules/node-fetch/browser.js | 25 + node_modules/node-fetch/lib/index.es.js | 1640 + node_modules/node-fetch/lib/index.js | 1649 + node_modules/node-fetch/lib/index.mjs | 1638 + node_modules/node-fetch/package.json | 66 + node_modules/once/LICENSE | 15 + node_modules/once/README.md | 79 + node_modules/once/once.js | 42 + node_modules/once/package.json | 33 + node_modules/os-name/index.d.ts | 37 + node_modules/os-name/index.js | 46 + node_modules/os-name/license | 9 + node_modules/os-name/package.json | 45 + node_modules/os-name/readme.md | 64 + node_modules/p-finally/index.js | 15 + node_modules/p-finally/license | 21 + node_modules/p-finally/package.json | 42 + node_modules/p-finally/readme.md | 47 + node_modules/pump/.travis.yml | 5 + node_modules/pump/LICENSE | 21 + node_modules/pump/README.md | 65 + node_modules/pump/index.js | 82 + node_modules/pump/package.json | 24 + node_modules/pump/test-browser.js | 66 + node_modules/pump/test-node.js | 53 + node_modules/signal-exit/CHANGELOG.md | 27 + node_modules/signal-exit/LICENSE.txt | 16 + node_modules/signal-exit/README.md | 40 + node_modules/signal-exit/index.js | 157 + node_modules/signal-exit/package.json | 38 + node_modules/signal-exit/signals.js | 53 + node_modules/strip-eof/index.js | 15 + node_modules/strip-eof/license | 21 + node_modules/strip-eof/package.json | 39 + node_modules/strip-eof/readme.md | 28 + node_modules/tunnel/.idea/encodings.xml | 6 + node_modules/tunnel/.idea/modules.xml | 8 + node_modules/tunnel/.idea/node-tunnel.iml | 12 + node_modules/tunnel/.idea/vcs.xml | 6 + node_modules/tunnel/.idea/workspace.xml | 797 + node_modules/tunnel/.travis.yml | 6 + node_modules/tunnel/CHANGELOG.md | 22 + node_modules/tunnel/LICENSE | 21 + node_modules/tunnel/README.md | 185 + node_modules/tunnel/index.js | 1 + node_modules/tunnel/lib/tunnel.js | 264 + node_modules/tunnel/package.json | 34 + node_modules/universal-user-agent/LICENSE.md | 7 + node_modules/universal-user-agent/README.md | 25 + .../universal-user-agent/dist-node/index.js | 18 + .../dist-node/index.js.map | 1 + .../universal-user-agent/dist-src/index.js | 9 + .../dist-types/index.d.ts | 1 + .../universal-user-agent/dist-web/index.js | 12 + .../dist-web/index.js.map | 1 + .../universal-user-agent/package.json | 31 + node_modules/windows-release/index.d.ts | 30 + node_modules/windows-release/index.js | 44 + node_modules/windows-release/license | 9 + node_modules/windows-release/package.json | 43 + node_modules/windows-release/readme.md | 56 + node_modules/wrappy/LICENSE | 15 + node_modules/wrappy/README.md | 36 + node_modules/wrappy/package.json | 29 + node_modules/wrappy/wrappy.js | 33 + 865 files changed, 318864 insertions(+), 2 deletions(-) create mode 100644 lib/constants.d.ts create mode 100644 lib/constants.js create mode 100644 lib/execute.d.ts create mode 100644 lib/execute.js create mode 100644 lib/git.d.ts create mode 100644 lib/git.js create mode 100644 lib/lib.d.ts create mode 100644 lib/lib.js create mode 100644 lib/main.d.ts create mode 100644 lib/main.js create mode 100644 lib/ssh.d.ts create mode 100644 lib/ssh.js create mode 100644 lib/util.d.ts create mode 100644 lib/util.js create mode 100644 lib/worktree.d.ts create mode 100644 lib/worktree.js create mode 120000 node_modules/.bin/semver create mode 120000 node_modules/.bin/which create mode 100644 node_modules/@actions/core/LICENSE.md create mode 100644 node_modules/@actions/core/README.md create mode 100644 node_modules/@actions/core/lib/command.d.ts create mode 100644 node_modules/@actions/core/lib/command.js create mode 100644 node_modules/@actions/core/lib/command.js.map create mode 100644 node_modules/@actions/core/lib/core.d.ts create mode 100644 node_modules/@actions/core/lib/core.js create mode 100644 node_modules/@actions/core/lib/core.js.map create mode 100644 node_modules/@actions/core/lib/file-command.d.ts create mode 100644 node_modules/@actions/core/lib/file-command.js create mode 100644 node_modules/@actions/core/lib/file-command.js.map create mode 100644 node_modules/@actions/core/lib/oidc-utils.d.ts create mode 100644 node_modules/@actions/core/lib/oidc-utils.js create mode 100644 node_modules/@actions/core/lib/oidc-utils.js.map create mode 100644 node_modules/@actions/core/lib/utils.d.ts create mode 100644 node_modules/@actions/core/lib/utils.js create mode 100644 node_modules/@actions/core/lib/utils.js.map create mode 100644 node_modules/@actions/core/package.json create mode 100644 node_modules/@actions/exec/LICENSE.md create mode 100644 node_modules/@actions/exec/README.md create mode 100644 node_modules/@actions/exec/lib/exec.d.ts create mode 100644 node_modules/@actions/exec/lib/exec.js create mode 100644 node_modules/@actions/exec/lib/exec.js.map create mode 100644 node_modules/@actions/exec/lib/interfaces.d.ts create mode 100644 node_modules/@actions/exec/lib/interfaces.js create mode 100644 node_modules/@actions/exec/lib/interfaces.js.map create mode 100644 node_modules/@actions/exec/lib/toolrunner.d.ts create mode 100644 node_modules/@actions/exec/lib/toolrunner.js create mode 100644 node_modules/@actions/exec/lib/toolrunner.js.map create mode 100644 node_modules/@actions/exec/package.json create mode 100644 node_modules/@actions/github/LICENSE.md create mode 100644 node_modules/@actions/github/README.md create mode 100644 node_modules/@actions/github/lib/context.d.ts create mode 100644 node_modules/@actions/github/lib/context.js create mode 100644 node_modules/@actions/github/lib/context.js.map create mode 100644 node_modules/@actions/github/lib/github.d.ts create mode 100644 node_modules/@actions/github/lib/github.js create mode 100644 node_modules/@actions/github/lib/github.js.map create mode 100644 node_modules/@actions/github/lib/interfaces.d.ts create mode 100644 node_modules/@actions/github/lib/interfaces.js create mode 100644 node_modules/@actions/github/lib/interfaces.js.map create mode 100644 node_modules/@actions/github/lib/internal/utils.d.ts create mode 100644 node_modules/@actions/github/lib/internal/utils.js create mode 100644 node_modules/@actions/github/lib/internal/utils.js.map create mode 100644 node_modules/@actions/github/lib/utils.d.ts create mode 100644 node_modules/@actions/github/lib/utils.js create mode 100644 node_modules/@actions/github/lib/utils.js.map create mode 100644 node_modules/@actions/github/package.json create mode 100644 node_modules/@actions/http-client/LICENSE create mode 100644 node_modules/@actions/http-client/README.md create mode 100644 node_modules/@actions/http-client/RELEASES.md create mode 100644 node_modules/@actions/http-client/actions.png create mode 100644 node_modules/@actions/http-client/auth.d.ts create mode 100644 node_modules/@actions/http-client/auth.js create mode 100644 node_modules/@actions/http-client/index.d.ts create mode 100644 node_modules/@actions/http-client/index.js create mode 100644 node_modules/@actions/http-client/interfaces.d.ts create mode 100644 node_modules/@actions/http-client/interfaces.js create mode 100644 node_modules/@actions/http-client/package.json create mode 100644 node_modules/@actions/http-client/proxy.d.ts create mode 100644 node_modules/@actions/http-client/proxy.js create mode 100644 node_modules/@actions/io/LICENSE.md create mode 100644 node_modules/@actions/io/README.md create mode 100644 node_modules/@actions/io/lib/io-util.d.ts create mode 100644 node_modules/@actions/io/lib/io-util.js create mode 100644 node_modules/@actions/io/lib/io-util.js.map create mode 100644 node_modules/@actions/io/lib/io.d.ts create mode 100644 node_modules/@actions/io/lib/io.js create mode 100644 node_modules/@actions/io/lib/io.js.map create mode 100644 node_modules/@actions/io/package.json create mode 100644 node_modules/@octokit/auth-token/LICENSE create mode 100644 node_modules/@octokit/auth-token/README.md create mode 100644 node_modules/@octokit/auth-token/dist-node/index.js create mode 100644 node_modules/@octokit/auth-token/dist-node/index.js.map create mode 100644 node_modules/@octokit/auth-token/dist-src/auth.js create mode 100644 node_modules/@octokit/auth-token/dist-src/hook.js create mode 100644 node_modules/@octokit/auth-token/dist-src/index.js create mode 100644 node_modules/@octokit/auth-token/dist-src/types.js create mode 100644 node_modules/@octokit/auth-token/dist-src/with-authorization-prefix.js create mode 100644 node_modules/@octokit/auth-token/dist-types/auth.d.ts create mode 100644 node_modules/@octokit/auth-token/dist-types/hook.d.ts create mode 100644 node_modules/@octokit/auth-token/dist-types/index.d.ts create mode 100644 node_modules/@octokit/auth-token/dist-types/types.d.ts create mode 100644 node_modules/@octokit/auth-token/dist-types/with-authorization-prefix.d.ts create mode 100644 node_modules/@octokit/auth-token/dist-web/index.js create mode 100644 node_modules/@octokit/auth-token/dist-web/index.js.map create mode 100644 node_modules/@octokit/auth-token/package.json create mode 100644 node_modules/@octokit/core/LICENSE create mode 100644 node_modules/@octokit/core/README.md create mode 100644 node_modules/@octokit/core/dist-node/index.js create mode 100644 node_modules/@octokit/core/dist-node/index.js.map create mode 100644 node_modules/@octokit/core/dist-src/index.js create mode 100644 node_modules/@octokit/core/dist-src/types.js create mode 100644 node_modules/@octokit/core/dist-src/version.js create mode 100644 node_modules/@octokit/core/dist-types/index.d.ts create mode 100644 node_modules/@octokit/core/dist-types/types.d.ts create mode 100644 node_modules/@octokit/core/dist-types/version.d.ts create mode 100644 node_modules/@octokit/core/dist-web/index.js create mode 100644 node_modules/@octokit/core/dist-web/index.js.map create mode 100644 node_modules/@octokit/core/package.json create mode 100644 node_modules/@octokit/endpoint/LICENSE create mode 100644 node_modules/@octokit/endpoint/README.md create mode 100644 node_modules/@octokit/endpoint/dist-node/index.js create mode 100644 node_modules/@octokit/endpoint/dist-node/index.js.map create mode 100644 node_modules/@octokit/endpoint/dist-src/defaults.js create mode 100644 node_modules/@octokit/endpoint/dist-src/endpoint-with-defaults.js create mode 100644 node_modules/@octokit/endpoint/dist-src/index.js create mode 100644 node_modules/@octokit/endpoint/dist-src/merge.js create mode 100644 node_modules/@octokit/endpoint/dist-src/parse.js create mode 100644 node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js create mode 100644 node_modules/@octokit/endpoint/dist-src/util/extract-url-variable-names.js create mode 100644 node_modules/@octokit/endpoint/dist-src/util/lowercase-keys.js create mode 100644 node_modules/@octokit/endpoint/dist-src/util/merge-deep.js create mode 100644 node_modules/@octokit/endpoint/dist-src/util/omit.js create mode 100644 node_modules/@octokit/endpoint/dist-src/util/url-template.js create mode 100644 node_modules/@octokit/endpoint/dist-src/version.js create mode 100644 node_modules/@octokit/endpoint/dist-src/with-defaults.js create mode 100644 node_modules/@octokit/endpoint/dist-types/defaults.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-types/endpoint-with-defaults.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-types/index.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-types/merge.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-types/parse.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-types/util/add-query-parameters.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-types/util/extract-url-variable-names.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-types/util/lowercase-keys.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-types/util/merge-deep.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-types/util/omit.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-types/util/url-template.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-types/version.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-types/with-defaults.d.ts create mode 100644 node_modules/@octokit/endpoint/dist-web/index.js create mode 100644 node_modules/@octokit/endpoint/dist-web/index.js.map create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/LICENSE create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/README.md create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-node/index.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-node/index.js.map create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/AuthInterface.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/EndpointDefaults.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/EndpointInterface.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/EndpointOptions.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/Fetch.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/OctokitResponse.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestHeaders.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestInterface.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestMethod.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestOptions.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestParameters.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestRequestOptions.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/ResponseHeaders.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/Route.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/Signal.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/StrategyInterface.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/Url.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/VERSION.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/generated/Endpoints.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/index.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/AuthInterface.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Fetch.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestInterface.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestMethod.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestOptions.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestParameters.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Route.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Signal.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Url.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/VERSION.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/index.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-web/index.js create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-web/index.js.map create mode 100644 node_modules/@octokit/endpoint/node_modules/@octokit/types/package.json create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/LICENSE.md create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/README.md create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/index.js create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/browser.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/index.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/node.d.ts create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map create mode 100644 node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json create mode 100644 node_modules/@octokit/endpoint/package.json create mode 100644 node_modules/@octokit/graphql/LICENSE create mode 100644 node_modules/@octokit/graphql/README.md create mode 100644 node_modules/@octokit/graphql/dist-node/index.js create mode 100644 node_modules/@octokit/graphql/dist-node/index.js.map create mode 100644 node_modules/@octokit/graphql/dist-src/error.js create mode 100644 node_modules/@octokit/graphql/dist-src/graphql.js create mode 100644 node_modules/@octokit/graphql/dist-src/index.js create mode 100644 node_modules/@octokit/graphql/dist-src/types.js create mode 100644 node_modules/@octokit/graphql/dist-src/version.js create mode 100644 node_modules/@octokit/graphql/dist-src/with-defaults.js create mode 100644 node_modules/@octokit/graphql/dist-types/error.d.ts create mode 100644 node_modules/@octokit/graphql/dist-types/graphql.d.ts create mode 100644 node_modules/@octokit/graphql/dist-types/index.d.ts create mode 100644 node_modules/@octokit/graphql/dist-types/types.d.ts create mode 100644 node_modules/@octokit/graphql/dist-types/version.d.ts create mode 100644 node_modules/@octokit/graphql/dist-types/with-defaults.d.ts create mode 100644 node_modules/@octokit/graphql/dist-web/index.js create mode 100644 node_modules/@octokit/graphql/dist-web/index.js.map create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/LICENSE create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-node/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-node/index.js.map create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/defaults.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/endpoint-with-defaults.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/merge.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/parse.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/extract-url-variable-names.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/lowercase-keys.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/omit.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/url-template.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/version.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/with-defaults.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/defaults.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/endpoint-with-defaults.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/index.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/merge.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/parse.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/add-query-parameters.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/extract-url-variable-names.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/lowercase-keys.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/merge-deep.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/omit.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/url-template.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/version.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/with-defaults.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-web/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-web/index.js.map create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/workflows/release.yml create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/workflows/routes-update.yml create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/workflows/test.yml create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/CODE_OF_CONDUCT.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/CONTRIBUTING.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/LICENSE create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/package.json create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/typescript.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/AuthInterface.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/EndpointDefaults.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/EndpointInterface.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/EndpointOptions.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Fetch.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/OctokitResponse.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestHeaders.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestInterface.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestMethod.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestOptions.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestParameters.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestRequestOptions.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/ResponseHeaders.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Route.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Signal.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/StrategyInterface.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Url.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/VERSION.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/generated/Endpoints.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/generated/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/index.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/LICENSE.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/browser.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/index.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/node.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/endpoint/package.json create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/LICENSE create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-node/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-node/index.js.map create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-src/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-src/types.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-types/index.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-types/types.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-web/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-web/index.js.map create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/workflows/release.yml create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/workflows/routes-update.yml create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/workflows/test.yml create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/CODE_OF_CONDUCT.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/CONTRIBUTING.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/LICENSE create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/package.json create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/typescript.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/AuthInterface.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/EndpointDefaults.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/EndpointInterface.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/EndpointOptions.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Fetch.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/OctokitResponse.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestHeaders.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestInterface.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestMethod.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestOptions.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestParameters.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestRequestOptions.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/ResponseHeaders.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Route.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Signal.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/StrategyInterface.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Url.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/VERSION.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/generated/Endpoints.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/generated/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/index.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request-error/package.json create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/LICENSE create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-node/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-node/index.js.map create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/fetch-wrapper.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/get-buffer-response.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/version.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/with-defaults.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/fetch-wrapper.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/get-buffer-response.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/index.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/version.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/with-defaults.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-web/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/dist-web/index.js.map create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/workflows/release.yml create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/workflows/routes-update.yml create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/workflows/test.yml create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/CODE_OF_CONDUCT.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/CONTRIBUTING.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/LICENSE create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/package.json create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/typescript.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/AuthInterface.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/EndpointDefaults.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/EndpointInterface.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/EndpointOptions.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Fetch.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/OctokitResponse.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestHeaders.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestInterface.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestMethod.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestOptions.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestParameters.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestRequestOptions.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/ResponseHeaders.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Route.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Signal.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/StrategyInterface.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Url.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/VERSION.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/generated/Endpoints.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/generated/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/index.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/LICENSE.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/README.md create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js.map create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/browser.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/node.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/browser.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/index.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/node.d.ts create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js.map create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/package.json create mode 100644 node_modules/@octokit/graphql/node_modules/@octokit/request/package.json create mode 100644 node_modules/@octokit/graphql/package.json create mode 100644 node_modules/@octokit/openapi-types/LICENSE create mode 100644 node_modules/@octokit/openapi-types/README.md create mode 100644 node_modules/@octokit/openapi-types/dist-node/index.js create mode 100644 node_modules/@octokit/openapi-types/dist-node/index.js.map create mode 100644 node_modules/@octokit/openapi-types/dist-src/generated/types.js create mode 100644 node_modules/@octokit/openapi-types/dist-src/index.js create mode 100644 node_modules/@octokit/openapi-types/dist-src/version.js create mode 100644 node_modules/@octokit/openapi-types/dist-types/generated/types.d.ts create mode 100644 node_modules/@octokit/openapi-types/dist-types/index.d.ts create mode 100644 node_modules/@octokit/openapi-types/dist-types/version.d.ts create mode 100644 node_modules/@octokit/openapi-types/dist-web/index.js create mode 100644 node_modules/@octokit/openapi-types/dist-web/index.js.map create mode 100644 node_modules/@octokit/openapi-types/package.json create mode 100644 node_modules/@octokit/plugin-paginate-rest/LICENSE create mode 100644 node_modules/@octokit/plugin-paginate-rest/README.md create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-node/index.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/index.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/paginating-endpoints.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/types.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-src/version.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/paginating-endpoints.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-types/version.d.ts create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-web/index.js create mode 100644 node_modules/@octokit/plugin-paginate-rest/dist-web/index.js.map create mode 100644 node_modules/@octokit/plugin-paginate-rest/package.json create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/LICENSE create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/README.md create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js.map create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/endpoints-to-methods.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/endpoints.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/method-types.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/parameters-and-response-types.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/index.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/types.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/version.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/endpoints-to-methods.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/endpoints.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/index.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/types.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/version.d.ts create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js.map create mode 100644 node_modules/@octokit/plugin-rest-endpoint-methods/package.json create mode 100644 node_modules/@octokit/request-error/LICENSE create mode 100644 node_modules/@octokit/request-error/README.md create mode 100644 node_modules/@octokit/request-error/dist-node/index.js create mode 100644 node_modules/@octokit/request-error/dist-node/index.js.map create mode 100644 node_modules/@octokit/request-error/dist-src/index.js create mode 100644 node_modules/@octokit/request-error/dist-src/types.js create mode 100644 node_modules/@octokit/request-error/dist-types/index.d.ts create mode 100644 node_modules/@octokit/request-error/dist-types/types.d.ts create mode 100644 node_modules/@octokit/request-error/dist-web/index.js create mode 100644 node_modules/@octokit/request-error/dist-web/index.js.map create mode 100644 node_modules/@octokit/request-error/package.json create mode 100644 node_modules/@octokit/request/LICENSE create mode 100644 node_modules/@octokit/request/README.md create mode 100644 node_modules/@octokit/request/dist-node/index.js create mode 100644 node_modules/@octokit/request/dist-node/index.js.map create mode 100644 node_modules/@octokit/request/dist-src/fetch-wrapper.js create mode 100644 node_modules/@octokit/request/dist-src/get-buffer-response.js create mode 100644 node_modules/@octokit/request/dist-src/index.js create mode 100644 node_modules/@octokit/request/dist-src/version.js create mode 100644 node_modules/@octokit/request/dist-src/with-defaults.js create mode 100644 node_modules/@octokit/request/dist-types/fetch-wrapper.d.ts create mode 100644 node_modules/@octokit/request/dist-types/get-buffer-response.d.ts create mode 100644 node_modules/@octokit/request/dist-types/index.d.ts create mode 100644 node_modules/@octokit/request/dist-types/version.d.ts create mode 100644 node_modules/@octokit/request/dist-types/with-defaults.d.ts create mode 100644 node_modules/@octokit/request/dist-web/index.js create mode 100644 node_modules/@octokit/request/dist-web/index.js.map create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/LICENSE create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/README.md create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/dist-node/index.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/dist-node/index.js.map create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/dist-src/index.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/dist-src/types.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/dist-types/index.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/dist-types/types.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/dist-web/index.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/dist-web/index.js.map create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/LICENSE create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/README.md create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-node/index.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-node/index.js.map create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/AuthInterface.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/EndpointDefaults.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/EndpointInterface.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/EndpointOptions.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/Fetch.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/OctokitResponse.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestHeaders.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestInterface.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestMethod.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestOptions.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestParameters.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestRequestOptions.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/ResponseHeaders.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/Route.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/Signal.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/StrategyInterface.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/Url.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/VERSION.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/generated/Endpoints.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/index.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/AuthInterface.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Fetch.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestInterface.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestMethod.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestOptions.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestParameters.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Route.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Signal.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Url.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/VERSION.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/index.d.ts create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-web/index.js create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-web/index.js.map create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/package.json create mode 100644 node_modules/@octokit/request/node_modules/@octokit/request-error/package.json create mode 100644 node_modules/@octokit/request/node_modules/is-plain-object/LICENSE create mode 100644 node_modules/@octokit/request/node_modules/is-plain-object/README.md create mode 100644 node_modules/@octokit/request/node_modules/is-plain-object/dist/is-plain-object.js create mode 100644 node_modules/@octokit/request/node_modules/is-plain-object/dist/is-plain-object.mjs create mode 100644 node_modules/@octokit/request/node_modules/is-plain-object/is-plain-object.d.ts create mode 100644 node_modules/@octokit/request/node_modules/is-plain-object/package.json create mode 100644 node_modules/@octokit/request/package.json create mode 100644 node_modules/@octokit/types/LICENSE create mode 100644 node_modules/@octokit/types/README.md create mode 100644 node_modules/@octokit/types/dist-node/index.js create mode 100644 node_modules/@octokit/types/dist-node/index.js.map create mode 100644 node_modules/@octokit/types/dist-src/AuthInterface.js create mode 100644 node_modules/@octokit/types/dist-src/EndpointDefaults.js create mode 100644 node_modules/@octokit/types/dist-src/EndpointInterface.js create mode 100644 node_modules/@octokit/types/dist-src/EndpointOptions.js create mode 100644 node_modules/@octokit/types/dist-src/Fetch.js create mode 100644 node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js create mode 100644 node_modules/@octokit/types/dist-src/OctokitResponse.js create mode 100644 node_modules/@octokit/types/dist-src/RequestError.js create mode 100644 node_modules/@octokit/types/dist-src/RequestHeaders.js create mode 100644 node_modules/@octokit/types/dist-src/RequestInterface.js create mode 100644 node_modules/@octokit/types/dist-src/RequestMethod.js create mode 100644 node_modules/@octokit/types/dist-src/RequestOptions.js create mode 100644 node_modules/@octokit/types/dist-src/RequestParameters.js create mode 100644 node_modules/@octokit/types/dist-src/RequestRequestOptions.js create mode 100644 node_modules/@octokit/types/dist-src/ResponseHeaders.js create mode 100644 node_modules/@octokit/types/dist-src/Route.js create mode 100644 node_modules/@octokit/types/dist-src/Signal.js create mode 100644 node_modules/@octokit/types/dist-src/StrategyInterface.js create mode 100644 node_modules/@octokit/types/dist-src/Url.js create mode 100644 node_modules/@octokit/types/dist-src/VERSION.js create mode 100644 node_modules/@octokit/types/dist-src/generated/Endpoints.js create mode 100644 node_modules/@octokit/types/dist-src/index.js create mode 100644 node_modules/@octokit/types/dist-types/AuthInterface.d.ts create mode 100644 node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts create mode 100644 node_modules/@octokit/types/dist-types/EndpointInterface.d.ts create mode 100644 node_modules/@octokit/types/dist-types/EndpointOptions.d.ts create mode 100644 node_modules/@octokit/types/dist-types/Fetch.d.ts create mode 100644 node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts create mode 100644 node_modules/@octokit/types/dist-types/OctokitResponse.d.ts create mode 100644 node_modules/@octokit/types/dist-types/RequestError.d.ts create mode 100644 node_modules/@octokit/types/dist-types/RequestHeaders.d.ts create mode 100644 node_modules/@octokit/types/dist-types/RequestInterface.d.ts create mode 100644 node_modules/@octokit/types/dist-types/RequestMethod.d.ts create mode 100644 node_modules/@octokit/types/dist-types/RequestOptions.d.ts create mode 100644 node_modules/@octokit/types/dist-types/RequestParameters.d.ts create mode 100644 node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts create mode 100644 node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts create mode 100644 node_modules/@octokit/types/dist-types/Route.d.ts create mode 100644 node_modules/@octokit/types/dist-types/Signal.d.ts create mode 100644 node_modules/@octokit/types/dist-types/StrategyInterface.d.ts create mode 100644 node_modules/@octokit/types/dist-types/Url.d.ts create mode 100644 node_modules/@octokit/types/dist-types/VERSION.d.ts create mode 100644 node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts create mode 100644 node_modules/@octokit/types/dist-types/index.d.ts create mode 100644 node_modules/@octokit/types/dist-web/index.js create mode 100644 node_modules/@octokit/types/dist-web/index.js.map create mode 100644 node_modules/@octokit/types/package.json create mode 100755 node_modules/@types/node/LICENSE create mode 100755 node_modules/@types/node/README.md create mode 100755 node_modules/@types/node/assert.d.ts create mode 100755 node_modules/@types/node/assert/strict.d.ts create mode 100755 node_modules/@types/node/async_hooks.d.ts create mode 100755 node_modules/@types/node/buffer.d.ts create mode 100755 node_modules/@types/node/child_process.d.ts create mode 100755 node_modules/@types/node/cluster.d.ts create mode 100755 node_modules/@types/node/console.d.ts create mode 100755 node_modules/@types/node/constants.d.ts create mode 100755 node_modules/@types/node/crypto.d.ts create mode 100755 node_modules/@types/node/dgram.d.ts create mode 100755 node_modules/@types/node/diagnostics_channel.d.ts create mode 100755 node_modules/@types/node/dns.d.ts create mode 100755 node_modules/@types/node/dns/promises.d.ts create mode 100755 node_modules/@types/node/domain.d.ts create mode 100755 node_modules/@types/node/events.d.ts create mode 100755 node_modules/@types/node/fs.d.ts create mode 100755 node_modules/@types/node/fs/promises.d.ts create mode 100755 node_modules/@types/node/globals.d.ts create mode 100755 node_modules/@types/node/globals.global.d.ts create mode 100755 node_modules/@types/node/http.d.ts create mode 100755 node_modules/@types/node/http2.d.ts create mode 100755 node_modules/@types/node/https.d.ts create mode 100755 node_modules/@types/node/index.d.ts create mode 100755 node_modules/@types/node/inspector.d.ts create mode 100755 node_modules/@types/node/module.d.ts create mode 100755 node_modules/@types/node/net.d.ts create mode 100755 node_modules/@types/node/os.d.ts create mode 100755 node_modules/@types/node/package.json create mode 100755 node_modules/@types/node/path.d.ts create mode 100755 node_modules/@types/node/perf_hooks.d.ts create mode 100755 node_modules/@types/node/process.d.ts create mode 100755 node_modules/@types/node/punycode.d.ts create mode 100755 node_modules/@types/node/querystring.d.ts create mode 100755 node_modules/@types/node/readline.d.ts create mode 100755 node_modules/@types/node/repl.d.ts create mode 100755 node_modules/@types/node/stream.d.ts create mode 100755 node_modules/@types/node/stream/consumers.d.ts create mode 100755 node_modules/@types/node/stream/promises.d.ts create mode 100755 node_modules/@types/node/stream/web.d.ts create mode 100755 node_modules/@types/node/string_decoder.d.ts create mode 100755 node_modules/@types/node/timers.d.ts create mode 100755 node_modules/@types/node/timers/promises.d.ts create mode 100755 node_modules/@types/node/tls.d.ts create mode 100755 node_modules/@types/node/trace_events.d.ts create mode 100755 node_modules/@types/node/tty.d.ts create mode 100755 node_modules/@types/node/url.d.ts create mode 100755 node_modules/@types/node/util.d.ts create mode 100755 node_modules/@types/node/v8.d.ts create mode 100755 node_modules/@types/node/vm.d.ts create mode 100755 node_modules/@types/node/wasi.d.ts create mode 100755 node_modules/@types/node/worker_threads.d.ts create mode 100755 node_modules/@types/node/zlib.d.ts create mode 100644 node_modules/before-after-hook/LICENSE create mode 100644 node_modules/before-after-hook/README.md create mode 100644 node_modules/before-after-hook/index.d.ts create mode 100644 node_modules/before-after-hook/index.js create mode 100644 node_modules/before-after-hook/lib/add.js create mode 100644 node_modules/before-after-hook/lib/register.js create mode 100644 node_modules/before-after-hook/lib/remove.js create mode 100644 node_modules/before-after-hook/package.json create mode 100644 node_modules/deprecation/LICENSE create mode 100644 node_modules/deprecation/README.md create mode 100644 node_modules/deprecation/dist-node/index.js create mode 100644 node_modules/deprecation/dist-src/index.js create mode 100644 node_modules/deprecation/dist-types/index.d.ts create mode 100644 node_modules/deprecation/dist-web/index.js create mode 100644 node_modules/deprecation/package.json create mode 100644 node_modules/end-of-stream/LICENSE create mode 100644 node_modules/end-of-stream/README.md create mode 100644 node_modules/end-of-stream/index.js create mode 100644 node_modules/end-of-stream/package.json create mode 100644 node_modules/execa/index.js create mode 100644 node_modules/execa/lib/errname.js create mode 100644 node_modules/execa/lib/stdio.js create mode 100644 node_modules/execa/license create mode 100644 node_modules/execa/node_modules/cross-spawn/CHANGELOG.md create mode 100644 node_modules/execa/node_modules/cross-spawn/LICENSE create mode 100644 node_modules/execa/node_modules/cross-spawn/README.md create mode 100644 node_modules/execa/node_modules/cross-spawn/index.js create mode 100644 node_modules/execa/node_modules/cross-spawn/lib/enoent.js create mode 100644 node_modules/execa/node_modules/cross-spawn/lib/parse.js create mode 100644 node_modules/execa/node_modules/cross-spawn/lib/util/escape.js create mode 100644 node_modules/execa/node_modules/cross-spawn/lib/util/readShebang.js create mode 100644 node_modules/execa/node_modules/cross-spawn/lib/util/resolveCommand.js create mode 120000 node_modules/execa/node_modules/cross-spawn/node_modules/.bin/semver create mode 120000 node_modules/execa/node_modules/cross-spawn/node_modules/.bin/which create mode 100644 node_modules/execa/node_modules/cross-spawn/package.json create mode 100644 node_modules/execa/node_modules/is-stream/index.js create mode 100644 node_modules/execa/node_modules/is-stream/license create mode 100644 node_modules/execa/node_modules/is-stream/package.json create mode 100644 node_modules/execa/node_modules/is-stream/readme.md create mode 100644 node_modules/execa/node_modules/npm-run-path/index.js create mode 100644 node_modules/execa/node_modules/npm-run-path/license create mode 100644 node_modules/execa/node_modules/npm-run-path/package.json create mode 100644 node_modules/execa/node_modules/npm-run-path/readme.md create mode 100644 node_modules/execa/node_modules/path-key/index.js create mode 100644 node_modules/execa/node_modules/path-key/license create mode 100644 node_modules/execa/node_modules/path-key/package.json create mode 100644 node_modules/execa/node_modules/path-key/readme.md create mode 100644 node_modules/execa/node_modules/semver/CHANGELOG.md create mode 100644 node_modules/execa/node_modules/semver/LICENSE create mode 100644 node_modules/execa/node_modules/semver/README.md create mode 100755 node_modules/execa/node_modules/semver/bin/semver create mode 100644 node_modules/execa/node_modules/semver/package.json create mode 100644 node_modules/execa/node_modules/semver/range.bnf create mode 100644 node_modules/execa/node_modules/semver/semver.js create mode 100644 node_modules/execa/node_modules/shebang-command/index.js create mode 100644 node_modules/execa/node_modules/shebang-command/license create mode 100644 node_modules/execa/node_modules/shebang-command/package.json create mode 100644 node_modules/execa/node_modules/shebang-command/readme.md create mode 100644 node_modules/execa/node_modules/shebang-regex/index.js create mode 100644 node_modules/execa/node_modules/shebang-regex/license create mode 100644 node_modules/execa/node_modules/shebang-regex/package.json create mode 100644 node_modules/execa/node_modules/shebang-regex/readme.md create mode 100644 node_modules/execa/node_modules/which/CHANGELOG.md create mode 100644 node_modules/execa/node_modules/which/LICENSE create mode 100644 node_modules/execa/node_modules/which/README.md create mode 100755 node_modules/execa/node_modules/which/bin/which create mode 100644 node_modules/execa/node_modules/which/package.json create mode 100644 node_modules/execa/node_modules/which/which.js create mode 100644 node_modules/execa/package.json create mode 100644 node_modules/execa/readme.md create mode 100644 node_modules/get-stream/buffer-stream.js create mode 100644 node_modules/get-stream/index.js create mode 100644 node_modules/get-stream/license create mode 100644 node_modules/get-stream/package.json create mode 100644 node_modules/get-stream/readme.md create mode 100644 node_modules/is-plain-object/LICENSE create mode 100644 node_modules/is-plain-object/README.md create mode 100644 node_modules/is-plain-object/index.cjs.js create mode 100644 node_modules/is-plain-object/index.d.ts create mode 100644 node_modules/is-plain-object/index.js create mode 100644 node_modules/is-plain-object/node_modules/isobject/LICENSE create mode 100644 node_modules/is-plain-object/node_modules/isobject/README.md create mode 100644 node_modules/is-plain-object/node_modules/isobject/index.cjs.js create mode 100644 node_modules/is-plain-object/node_modules/isobject/index.d.ts create mode 100644 node_modules/is-plain-object/node_modules/isobject/index.js create mode 100644 node_modules/is-plain-object/node_modules/isobject/package.json create mode 100644 node_modules/is-plain-object/package.json create mode 100644 node_modules/isexe/.npmignore create mode 100644 node_modules/isexe/LICENSE create mode 100644 node_modules/isexe/README.md create mode 100644 node_modules/isexe/index.js create mode 100644 node_modules/isexe/mode.js create mode 100644 node_modules/isexe/package.json create mode 100644 node_modules/isexe/test/basic.js create mode 100644 node_modules/isexe/windows.js create mode 100644 node_modules/macos-release/index.d.ts create mode 100644 node_modules/macos-release/index.js create mode 100644 node_modules/macos-release/license create mode 100644 node_modules/macos-release/package.json create mode 100644 node_modules/macos-release/readme.md create mode 100644 node_modules/nice-try/CHANGELOG.md create mode 100644 node_modules/nice-try/LICENSE create mode 100644 node_modules/nice-try/README.md create mode 100644 node_modules/nice-try/package.json create mode 100644 node_modules/nice-try/src/index.js create mode 100644 node_modules/node-fetch/CHANGELOG.md create mode 100644 node_modules/node-fetch/LICENSE.md create mode 100644 node_modules/node-fetch/README.md create mode 100644 node_modules/node-fetch/browser.js create mode 100644 node_modules/node-fetch/lib/index.es.js create mode 100644 node_modules/node-fetch/lib/index.js create mode 100644 node_modules/node-fetch/lib/index.mjs create mode 100644 node_modules/node-fetch/package.json create mode 100644 node_modules/once/LICENSE create mode 100644 node_modules/once/README.md create mode 100644 node_modules/once/once.js create mode 100644 node_modules/once/package.json create mode 100644 node_modules/os-name/index.d.ts create mode 100644 node_modules/os-name/index.js create mode 100644 node_modules/os-name/license create mode 100644 node_modules/os-name/package.json create mode 100644 node_modules/os-name/readme.md create mode 100644 node_modules/p-finally/index.js create mode 100644 node_modules/p-finally/license create mode 100644 node_modules/p-finally/package.json create mode 100644 node_modules/p-finally/readme.md create mode 100644 node_modules/pump/.travis.yml create mode 100644 node_modules/pump/LICENSE create mode 100644 node_modules/pump/README.md create mode 100644 node_modules/pump/index.js create mode 100644 node_modules/pump/package.json create mode 100644 node_modules/pump/test-browser.js create mode 100644 node_modules/pump/test-node.js create mode 100644 node_modules/signal-exit/CHANGELOG.md create mode 100644 node_modules/signal-exit/LICENSE.txt create mode 100644 node_modules/signal-exit/README.md create mode 100644 node_modules/signal-exit/index.js create mode 100644 node_modules/signal-exit/package.json create mode 100644 node_modules/signal-exit/signals.js create mode 100644 node_modules/strip-eof/index.js create mode 100644 node_modules/strip-eof/license create mode 100644 node_modules/strip-eof/package.json create mode 100644 node_modules/strip-eof/readme.md create mode 100644 node_modules/tunnel/.idea/encodings.xml create mode 100644 node_modules/tunnel/.idea/modules.xml create mode 100644 node_modules/tunnel/.idea/node-tunnel.iml create mode 100644 node_modules/tunnel/.idea/vcs.xml create mode 100644 node_modules/tunnel/.idea/workspace.xml create mode 100644 node_modules/tunnel/.travis.yml create mode 100644 node_modules/tunnel/CHANGELOG.md create mode 100644 node_modules/tunnel/LICENSE create mode 100644 node_modules/tunnel/README.md create mode 100644 node_modules/tunnel/index.js create mode 100644 node_modules/tunnel/lib/tunnel.js create mode 100644 node_modules/tunnel/package.json create mode 100644 node_modules/universal-user-agent/LICENSE.md create mode 100644 node_modules/universal-user-agent/README.md create mode 100644 node_modules/universal-user-agent/dist-node/index.js create mode 100644 node_modules/universal-user-agent/dist-node/index.js.map create mode 100644 node_modules/universal-user-agent/dist-src/index.js create mode 100644 node_modules/universal-user-agent/dist-types/index.d.ts create mode 100644 node_modules/universal-user-agent/dist-web/index.js create mode 100644 node_modules/universal-user-agent/dist-web/index.js.map create mode 100644 node_modules/universal-user-agent/package.json create mode 100644 node_modules/windows-release/index.d.ts create mode 100644 node_modules/windows-release/index.js create mode 100644 node_modules/windows-release/license create mode 100644 node_modules/windows-release/package.json create mode 100644 node_modules/windows-release/readme.md create mode 100644 node_modules/wrappy/LICENSE create mode 100644 node_modules/wrappy/README.md create mode 100644 node_modules/wrappy/package.json create mode 100644 node_modules/wrappy/wrappy.js diff --git a/.gitignore b/.gitignore index b38e794d..083a6034 100644 --- a/.gitignore +++ b/.gitignore @@ -5,14 +5,14 @@ npm-debug.log* yarn-debug.log* yarn-error.log* -node_modules +# node_moduless # Test Temp Files assets/.nojekyll assets/CNAME # Build -lib +# lib ## Registry package-lock.json diff --git a/lib/constants.d.ts b/lib/constants.d.ts new file mode 100644 index 00000000..4329df5d --- /dev/null +++ b/lib/constants.d.ts @@ -0,0 +1,78 @@ +export declare enum TestFlag { + NONE = 0, + HAS_CHANGED_FILES = 2, + HAS_REMOTE_BRANCH = 4, + UNABLE_TO_REMOVE_ORIGIN = 8, + UNABLE_TO_UNSET_GIT_CONFIG = 16 +} +export interface ActionInterface { + /** The branch that the action should deploy to. */ + branch: string; + /** git push with --dry-run */ + dryRun?: boolean | null; + /** If your project generates hashed files on build you can use this option to automatically delete them from the deployment branch with each deploy. This option can be toggled on by setting it to true. */ + clean?: boolean | null; + /** If you need to use CLEAN but you'd like to preserve certain files or folders you can use this option. */ + cleanExclude?: string[]; + /** If you need to customize the commit message for an integration you can do so. */ + commitMessage?: string; + /** The hostname of which the GitHub Workflow is being run on, ie: github.com */ + hostname?: string; + /** The git config email. */ + email?: string; + /** The folder to deploy. */ + folder: string; + /** The auto generated folder path. */ + folderPath?: string; + /** Determines test scenarios the action is running in. */ + isTest: TestFlag; + /** The git config name. */ + name?: string; + /** The repository path, for example JamesIves/github-pages-deploy-action. */ + repositoryName?: string; + /** The fully qualified repositpory path, this gets auto generated if repositoryName is provided. */ + repositoryPath?: string; + /** Wipes the commit history from the deployment branch in favor of a single commit. */ + singleCommit?: boolean | null; + /** Determines if the action should run in silent mode or not. */ + silent: boolean; + /** Defines an SSH private key that can be used during deployment. This can also be set to true to use SSH deployment endpoints if you've already configured the SSH client outside of this package. */ + sshKey?: string | boolean | null; + /** If you'd like to push the contents of the deployment folder into a specific directory on the deployment branch you can specify it here. */ + targetFolder?: string; + /** Deployment token. */ + token?: string | null; + /** The token type, ie ssh/token, this gets automatically generated. */ + tokenType?: string; + /** The folder where your deployment project lives. */ + workspace: string; +} +/** The minimum required values to run the action as a node module. */ +export interface NodeActionInterface { + /** The branch that the action should deploy to. */ + branch: string; + /** The folder to deploy. */ + folder: string; + /** The repository path, for example JamesIves/github-pages-deploy-action. */ + repositoryName: string; + /** GitHub deployment token. */ + token?: string | null; + /** Determines if the action should run in silent mode or not. */ + silent: boolean; + /** Defines an SSH private key that can be used during deployment. This can also be set to true to use SSH deployment endpoints if you've already configured the SSH client outside of this package. */ + sshKey?: string | boolean | null; + /** The folder where your deployment project lives. */ + workspace: string; + /** Determines test scenarios the action is running in. */ + isTest: TestFlag; +} +export declare const action: ActionInterface; +/** Types for the required action parameters. */ +export declare type RequiredActionParameters = Pick; +/** Status codes for the action. */ +export declare enum Status { + SUCCESS = "success", + FAILED = "failed", + SKIPPED = "skipped", + RUNNING = "running" +} diff --git a/lib/constants.js b/lib/constants.js new file mode 100644 index 00000000..5b3ed9f7 --- /dev/null +++ b/lib/constants.js @@ -0,0 +1,96 @@ +"use strict"; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.Status = exports.action = exports.TestFlag = void 0; +const core_1 = require("@actions/core"); +const github = __importStar(require("@actions/github")); +const util_1 = require("./util"); +const { pusher, repository } = github.context.payload; +/* Flags to signal different scenarios to test cases */ +var TestFlag; +(function (TestFlag) { + TestFlag[TestFlag["NONE"] = 0] = "NONE"; + TestFlag[TestFlag["HAS_CHANGED_FILES"] = 2] = "HAS_CHANGED_FILES"; + TestFlag[TestFlag["HAS_REMOTE_BRANCH"] = 4] = "HAS_REMOTE_BRANCH"; + TestFlag[TestFlag["UNABLE_TO_REMOVE_ORIGIN"] = 8] = "UNABLE_TO_REMOVE_ORIGIN"; + TestFlag[TestFlag["UNABLE_TO_UNSET_GIT_CONFIG"] = 16] = "UNABLE_TO_UNSET_GIT_CONFIG"; // Assume we can't remove previously set git configs. +})(TestFlag = exports.TestFlag || (exports.TestFlag = {})); +/* Required action data that gets initialized when running within the GitHub Actions environment. */ +exports.action = { + folder: (0, core_1.getInput)('folder'), + branch: (0, core_1.getInput)('branch'), + commitMessage: (0, core_1.getInput)('commit-message'), + dryRun: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('dry-run')) + ? (0, core_1.getInput)('dry-run').toLowerCase() === 'true' + : false, + clean: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('clean')) + ? (0, core_1.getInput)('clean').toLowerCase() === 'true' + : false, + cleanExclude: ((0, core_1.getInput)('clean-exclude') || '') + .split('\n') + .filter(l => l !== ''), + hostname: process.env.GITHUB_SERVER_URL + ? (0, util_1.stripProtocolFromUrl)(process.env.GITHUB_SERVER_URL) + : 'github.com', + isTest: TestFlag.NONE, + email: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('git-config-email')) + ? (0, core_1.getInput)('git-config-email') + : pusher && pusher.email + ? pusher.email + : `${process.env.GITHUB_ACTOR || 'github-pages-deploy-action'}@users.noreply.${process.env.GITHUB_SERVER_URL + ? (0, util_1.stripProtocolFromUrl)(process.env.GITHUB_SERVER_URL) + : 'github.com'}`, + name: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('git-config-name')) + ? (0, core_1.getInput)('git-config-name') + : pusher && pusher.name + ? pusher.name + : process.env.GITHUB_ACTOR + ? process.env.GITHUB_ACTOR + : 'GitHub Pages Deploy Action', + repositoryName: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('repository-name')) + ? (0, core_1.getInput)('repository-name') + : repository && repository.full_name + ? repository.full_name + : process.env.GITHUB_REPOSITORY, + token: (0, core_1.getInput)('token'), + singleCommit: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('single-commit')) + ? (0, core_1.getInput)('single-commit').toLowerCase() === 'true' + : false, + silent: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('silent')) + ? (0, core_1.getInput)('silent').toLowerCase() === 'true' + : false, + sshKey: (0, util_1.isNullOrUndefined)((0, core_1.getInput)('ssh-key')) + ? false + : !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('ssh-key')) && + (0, core_1.getInput)('ssh-key').toLowerCase() === 'true' + ? true + : (0, core_1.getInput)('ssh-key'), + targetFolder: (0, core_1.getInput)('target-folder'), + workspace: process.env.GITHUB_WORKSPACE || '' +}; +/** Status codes for the action. */ +var Status; +(function (Status) { + Status["SUCCESS"] = "success"; + Status["FAILED"] = "failed"; + Status["SKIPPED"] = "skipped"; + Status["RUNNING"] = "running"; +})(Status = exports.Status || (exports.Status = {})); diff --git a/lib/execute.d.ts b/lib/execute.d.ts new file mode 100644 index 00000000..2ecd6217 --- /dev/null +++ b/lib/execute.d.ts @@ -0,0 +1,10 @@ +/// +/** Wrapper around the GitHub toolkit exec command which returns the output. + * Also allows you to easily toggle the current working directory. + * + * @param {string} cmd - The command to execute. + * @param {string} cwd - The current working directory. + * @param {boolean} silent - Determines if the in/out should be silenced or not. + */ +export declare function execute(cmd: string, cwd: string, silent: boolean): Promise; +export declare function stdout(data: Buffer | string): void; diff --git a/lib/execute.js b/lib/execute.js new file mode 100644 index 00000000..fc5cfd86 --- /dev/null +++ b/lib/execute.js @@ -0,0 +1,47 @@ +"use strict"; +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +var __importDefault = (this && this.__importDefault) || function (mod) { + return (mod && mod.__esModule) ? mod : { "default": mod }; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.stdout = exports.execute = void 0; +const exec_1 = require("@actions/exec"); +const buffer_1 = __importDefault(require("buffer")); +let output = ''; +/** Wrapper around the GitHub toolkit exec command which returns the output. + * Also allows you to easily toggle the current working directory. + * + * @param {string} cmd - The command to execute. + * @param {string} cwd - The current working directory. + * @param {boolean} silent - Determines if the in/out should be silenced or not. + */ +function execute(cmd, cwd, silent) { + return __awaiter(this, void 0, void 0, function* () { + output = ''; + yield (0, exec_1.exec)(cmd, [], { + // Silences the input unless the INPUT_DEBUG flag is set. + silent, + cwd, + listeners: { + stdout + } + }); + return Promise.resolve(output); + }); +} +exports.execute = execute; +function stdout(data) { + const dataString = data.toString().trim(); + if (output.length + dataString.length < buffer_1.default.constants.MAX_STRING_LENGTH) { + output += dataString; + } +} +exports.stdout = stdout; diff --git a/lib/git.d.ts b/lib/git.d.ts new file mode 100644 index 00000000..56047692 --- /dev/null +++ b/lib/git.d.ts @@ -0,0 +1,3 @@ +import { ActionInterface, Status } from './constants'; +export declare function init(action: ActionInterface): Promise; +export declare function deploy(action: ActionInterface): Promise; diff --git a/lib/git.js b/lib/git.js new file mode 100644 index 00000000..514d1976 --- /dev/null +++ b/lib/git.js @@ -0,0 +1,149 @@ +"use strict"; +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +var __importDefault = (this && this.__importDefault) || function (mod) { + return (mod && mod.__esModule) ? mod : { "default": mod }; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.deploy = exports.init = void 0; +const core_1 = require("@actions/core"); +const io_1 = require("@actions/io"); +const fs_1 = __importDefault(require("fs")); +const constants_1 = require("./constants"); +const execute_1 = require("./execute"); +const worktree_1 = require("./worktree"); +const util_1 = require("./util"); +/* Initializes git in the workspace. */ +function init(action) { + return __awaiter(this, void 0, void 0, function* () { + try { + (0, core_1.info)(`Deploying using ${action.tokenType}… 🔑`); + (0, core_1.info)('Configuring git…'); + yield (0, execute_1.execute)(`git config user.name "${action.name}"`, action.workspace, action.silent); + yield (0, execute_1.execute)(`git config user.email "${action.email}"`, action.workspace, action.silent); + try { + if ((process.env.CI && !action.sshKey) || action.isTest) { + /* Ensures that previously set Git configs do not interfere with the deployment. + Only runs in the GitHub Actions CI environment if a user is not using an SSH key. + */ + yield (0, execute_1.execute)(`git config --local --unset-all http.https://${action.hostname}/.extraheader`, action.workspace, action.silent); + } + if (action.isTest === constants_1.TestFlag.UNABLE_TO_UNSET_GIT_CONFIG) { + throw new Error(); + } + } + catch (_a) { + (0, core_1.info)('Unable to unset previous git config authentication as it may not exist, continuing…'); + } + try { + yield (0, execute_1.execute)(`git remote rm origin`, action.workspace, action.silent); + if (action.isTest === constants_1.TestFlag.UNABLE_TO_REMOVE_ORIGIN) { + throw new Error(); + } + } + catch (_b) { + (0, core_1.info)('Attempted to remove origin but failed, continuing…'); + } + yield (0, execute_1.execute)(`git remote add origin ${action.repositoryPath}`, action.workspace, action.silent); + (0, core_1.info)('Git configured… 🔧'); + } + catch (error) { + throw new Error(`There was an error initializing the repository: ${(0, util_1.suppressSensitiveInformation)((0, util_1.extractErrorMessage)(error), action)} ❌`); + } + }); +} +exports.init = init; +/* Runs the necessary steps to make the deployment. */ +function deploy(action) { + return __awaiter(this, void 0, void 0, function* () { + const temporaryDeploymentDirectory = 'github-pages-deploy-action-temp-deployment-folder'; + const temporaryDeploymentBranch = `github-pages-deploy-action/${Math.random() + .toString(36) + .substr(2, 9)}`; + (0, core_1.info)('Starting to commit changes…'); + try { + const commitMessage = !(0, util_1.isNullOrUndefined)(action.commitMessage) + ? action.commitMessage + : `Deploying to ${action.branch}${process.env.GITHUB_SHA + ? ` from @ ${process.env.GITHUB_REPOSITORY}@${process.env.GITHUB_SHA}` + : ''} 🚀`; + // Checks to see if the remote exists prior to deploying. + const branchExists = action.isTest & constants_1.TestFlag.HAS_REMOTE_BRANCH || + (yield (0, execute_1.execute)(`git ls-remote --heads ${action.repositoryPath} refs/heads/${action.branch}`, action.workspace, action.silent)); + yield (0, worktree_1.generateWorktree)(action, temporaryDeploymentDirectory, branchExists); + // Ensures that items that need to be excluded from the clean job get parsed. + let excludes = ''; + if (action.clean && action.cleanExclude) { + for (const item of action.cleanExclude) { + excludes += `--exclude ${item} `; + } + } + if (action.targetFolder) { + (0, core_1.info)(`Creating target folder if it doesn't already exist… 📌`); + yield (0, io_1.mkdirP)(`${temporaryDeploymentDirectory}/${action.targetFolder}`); + } + /* + Pushes all of the build files into the deployment directory. + Allows the user to specify the root if '.' is provided. + rsync is used to prevent file duplication. */ + yield (0, execute_1.execute)(`rsync -q -av --checksum --progress ${action.folderPath}/. ${action.targetFolder + ? `${temporaryDeploymentDirectory}/${action.targetFolder}` + : temporaryDeploymentDirectory} ${action.clean + ? `--delete ${excludes} ${!fs_1.default.existsSync(`${action.folderPath}/CNAME`) + ? '--exclude CNAME' + : ''} ${!fs_1.default.existsSync(`${action.folderPath}/.nojekyll`) + ? '--exclude .nojekyll' + : ''}` + : ''} --exclude .ssh --exclude .git --exclude .github ${action.folderPath === action.workspace + ? `--exclude ${temporaryDeploymentDirectory}` + : ''}`, action.workspace, action.silent); + if (action.singleCommit) { + yield (0, execute_1.execute)(`git add --all .`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent); + } + // Use git status to check if we have something to commit. + // Special case is singleCommit with existing history, when + // we're really interested if the diff against the upstream branch + // changed. + const checkGitStatus = branchExists && action.singleCommit + ? `git diff origin/${action.branch}` + : `git status --porcelain`; + (0, core_1.info)(`Checking if there are files to commit…`); + const hasFilesToCommit = action.isTest & constants_1.TestFlag.HAS_CHANGED_FILES || + (yield (0, execute_1.execute)(checkGitStatus, `${action.workspace}/${temporaryDeploymentDirectory}`, true // This output is always silenced due to the large output it creates. + )); + if ((!action.singleCommit && !hasFilesToCommit) || + // Ignores the case where single commit is true with a target folder to prevent incorrect early exiting. + (action.singleCommit && !action.targetFolder && !hasFilesToCommit)) { + return constants_1.Status.SKIPPED; + } + // Commits to GitHub. + yield (0, execute_1.execute)(`git add --all .`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent); + yield (0, execute_1.execute)(`git checkout -b ${temporaryDeploymentBranch}`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent); + yield (0, execute_1.execute)(`git commit -m "${commitMessage}" --quiet --no-verify`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent); + if (!action.dryRun) { + yield (0, execute_1.execute)(`git push --force ${action.repositoryPath} ${temporaryDeploymentBranch}:${action.branch}`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent); + } + (0, core_1.info)(`Changes committed to the ${action.branch} branch… 📦`); + return constants_1.Status.SUCCESS; + } + catch (error) { + throw new Error(`The deploy step encountered an error: ${(0, util_1.suppressSensitiveInformation)((0, util_1.extractErrorMessage)(error), action)} ❌`); + } + finally { + // Cleans up temporary files/folders and restores the git state. + (0, core_1.info)('Running post deployment cleanup jobs… 🗑️'); + yield (0, execute_1.execute)(`git checkout -B ${temporaryDeploymentBranch}`, `${action.workspace}/${temporaryDeploymentDirectory}`, action.silent); + yield (0, execute_1.execute)(`chmod -R 777 ${temporaryDeploymentDirectory}`, action.workspace, action.silent); + yield (0, execute_1.execute)(`git worktree remove ${temporaryDeploymentDirectory} --force`, action.workspace, action.silent); + yield (0, io_1.rmRF)(temporaryDeploymentDirectory); + } + }); +} +exports.deploy = deploy; diff --git a/lib/lib.d.ts b/lib/lib.d.ts new file mode 100644 index 00000000..90d04d23 --- /dev/null +++ b/lib/lib.d.ts @@ -0,0 +1,6 @@ +import { ActionInterface, NodeActionInterface } from './constants'; +/** Initializes and runs the action. + * + * @param {object} configuration - The action configuration. + */ +export default function run(configuration: ActionInterface | NodeActionInterface): Promise; diff --git a/lib/lib.js b/lib/lib.js new file mode 100644 index 00000000..247fb778 --- /dev/null +++ b/lib/lib.js @@ -0,0 +1,63 @@ +"use strict"; +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +Object.defineProperty(exports, "__esModule", { value: true }); +const core_1 = require("@actions/core"); +const constants_1 = require("./constants"); +const git_1 = require("./git"); +const ssh_1 = require("./ssh"); +const util_1 = require("./util"); +/** Initializes and runs the action. + * + * @param {object} configuration - The action configuration. + */ +function run(configuration) { + return __awaiter(this, void 0, void 0, function* () { + let status = constants_1.Status.RUNNING; + try { + (0, core_1.info)(` + GitHub Pages Deploy Action 🚀 + + 🚀 Getting Started Guide: https://github.com/marketplace/actions/deploy-to-github-pages + ❓ Discussions / Q&A: https://github.com/JamesIves/github-pages-deploy-action/discussions + 🔧 Report a Bug: https://github.com/JamesIves/github-pages-deploy-action/issues + + 📣 Maintained by James Ives: https://jamesiv.es + 💖 Support: https://github.com/sponsors/JamesIves`); + (0, core_1.info)('Checking configuration and starting deployment… 🚦'); + const settings = Object.assign({}, configuration); + // Defines the repository/folder paths and token types. + // Also verifies that the action has all of the required parameters. + settings.folderPath = (0, util_1.generateFolderPath)(settings); + (0, util_1.checkParameters)(settings); + settings.repositoryPath = (0, util_1.generateRepositoryPath)(settings); + settings.tokenType = (0, util_1.generateTokenType)(settings); + if (settings.sshKey) { + yield (0, ssh_1.configureSSH)(settings); + } + yield (0, git_1.init)(settings); + status = yield (0, git_1.deploy)(settings); + } + catch (error) { + status = constants_1.Status.FAILED; + (0, core_1.setFailed)((0, util_1.extractErrorMessage)(error)); + } + finally { + (0, core_1.info)(`${status === constants_1.Status.FAILED + ? 'Deployment failed! ❌' + : status === constants_1.Status.SUCCESS + ? 'Completed deployment successfully! ✅' + : 'There is nothing to commit. Exiting early… 📭'}`); + (0, core_1.exportVariable)('deployment_status', status); + (0, core_1.setOutput)('deployment-status', status); + } + }); +} +exports.default = run; diff --git a/lib/main.d.ts b/lib/main.d.ts new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/lib/main.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/lib/main.js b/lib/main.js new file mode 100644 index 00000000..6c577dea --- /dev/null +++ b/lib/main.js @@ -0,0 +1,9 @@ +"use strict"; +var __importDefault = (this && this.__importDefault) || function (mod) { + return (mod && mod.__esModule) ? mod : { "default": mod }; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +const constants_1 = require("./constants"); +const lib_1 = __importDefault(require("./lib")); +// Runs the action within the GitHub actions environment. +(0, lib_1.default)(constants_1.action); diff --git a/lib/ssh.d.ts b/lib/ssh.d.ts new file mode 100644 index 00000000..5ee8eeed --- /dev/null +++ b/lib/ssh.d.ts @@ -0,0 +1,2 @@ +import { ActionInterface } from './constants'; +export declare function configureSSH(action: ActionInterface): Promise; diff --git a/lib/ssh.js b/lib/ssh.js new file mode 100644 index 00000000..9ed8469b --- /dev/null +++ b/lib/ssh.js @@ -0,0 +1,54 @@ +"use strict"; +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.configureSSH = void 0; +const core_1 = require("@actions/core"); +const io_1 = require("@actions/io"); +const child_process_1 = require("child_process"); +const fs_1 = require("fs"); +const util_1 = require("./util"); +function configureSSH(action) { + return __awaiter(this, void 0, void 0, function* () { + try { + if (typeof action.sshKey === 'string') { + const sshDirectory = `${process.env['HOME']}/.ssh`; + const sshKnownHostsDirectory = `${sshDirectory}/known_hosts`; + // SSH fingerprints provided by GitHub: https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/githubs-ssh-key-fingerprints + const sshGitHubKnownHostRsa = `\n${action.hostname} ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ==\n`; + const sshGitHubKnownHostDss = `\n${action.hostname} ssh-dss AAAAB3NzaC1kc3MAAACBANGFW2P9xlGU3zWrymJgI/lKo//ZW2WfVtmbsUZJ5uyKArtlQOT2+WRhcg4979aFxgKdcsqAYW3/LS1T2km3jYW/vr4Uzn+dXWODVk5VlUiZ1HFOHf6s6ITcZvjvdbp6ZbpM+DuJT7Bw+h5Fx8Qt8I16oCZYmAPJRtu46o9C2zk1AAAAFQC4gdFGcSbp5Gr0Wd5Ay/jtcldMewAAAIATTgn4sY4Nem/FQE+XJlyUQptPWMem5fwOcWtSXiTKaaN0lkk2p2snz+EJvAGXGq9dTSWHyLJSM2W6ZdQDqWJ1k+cL8CARAqL+UMwF84CR0m3hj+wtVGD/J4G5kW2DBAf4/bqzP4469lT+dF2FRQ2L9JKXrCWcnhMtJUvua8dvnwAAAIB6C4nQfAA7x8oLta6tT+oCk2WQcydNsyugE8vLrHlogoWEicla6cWPk7oXSspbzUcfkjN3Qa6e74PhRkc7JdSdAlFzU3m7LMkXo1MHgkqNX8glxWNVqBSc0YRdbFdTkL0C6gtpklilhvuHQCdbgB3LBAikcRkDp+FCVkUgPC/7Rw==\n`; + (0, core_1.info)(`Configuring SSH client… 🔑`); + yield (0, io_1.mkdirP)(sshDirectory); + (0, fs_1.appendFileSync)(sshKnownHostsDirectory, sshGitHubKnownHostRsa); + (0, fs_1.appendFileSync)(sshKnownHostsDirectory, sshGitHubKnownHostDss); + // Initializes SSH agent. + const agentOutput = (0, child_process_1.execFileSync)('ssh-agent').toString().split('\n'); + agentOutput.map(line => { + const exportableVariables = /^(SSH_AUTH_SOCK|SSH_AGENT_PID)=(.*); export \1/.exec(line); + if (exportableVariables && exportableVariables.length) { + (0, core_1.exportVariable)(exportableVariables[1], exportableVariables[2]); + } + }); + // Adds the SSH key to the agent. + action.sshKey.split(/(?=-----BEGIN)/).map((line) => __awaiter(this, void 0, void 0, function* () { + (0, child_process_1.execSync)('ssh-add -', { input: `${line.trim()}\n` }); + })); + (0, child_process_1.execSync)('ssh-add -l'); + } + else { + (0, core_1.info)(`Skipping SSH client configuration… ⌚`); + } + } + catch (error) { + throw new Error(`The ssh client configuration encountered an error: ${(0, util_1.suppressSensitiveInformation)((0, util_1.extractErrorMessage)(error), action)} ❌`); + } + }); +} +exports.configureSSH = configureSSH; diff --git a/lib/util.d.ts b/lib/util.d.ts new file mode 100644 index 00000000..68578fab --- /dev/null +++ b/lib/util.d.ts @@ -0,0 +1,10 @@ +import { ActionInterface } from './constants'; +export declare const isNullOrUndefined: (value: unknown) => boolean; +export declare const generateTokenType: (action: ActionInterface) => string; +export declare const generateRepositoryPath: (action: ActionInterface) => string; +export declare const generateFolderPath: (action: ActionInterface) => string; +export declare const checkParameters: (action: ActionInterface) => void; +export declare const suppressSensitiveInformation: (str: string, action: ActionInterface) => string; +export declare const extractErrorMessage: (error: unknown) => string; +/** Strips the protocol from a provided URL. */ +export declare const stripProtocolFromUrl: (url: string) => string; diff --git a/lib/util.js b/lib/util.js new file mode 100644 index 00000000..5c08dafe --- /dev/null +++ b/lib/util.js @@ -0,0 +1,77 @@ +"use strict"; +var __importDefault = (this && this.__importDefault) || function (mod) { + return (mod && mod.__esModule) ? mod : { "default": mod }; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.stripProtocolFromUrl = exports.extractErrorMessage = exports.suppressSensitiveInformation = exports.checkParameters = exports.generateFolderPath = exports.generateRepositoryPath = exports.generateTokenType = exports.isNullOrUndefined = void 0; +const core_1 = require("@actions/core"); +const fs_1 = require("fs"); +const path_1 = __importDefault(require("path")); +/* Replaces all instances of a match in a string. */ +const replaceAll = (input, find, replace) => input.split(find).join(replace); +/* Utility function that checks to see if a value is undefined or not. + If allowEmptyString is passed the parameter is allowed to contain an empty string as a valid parameter. */ +const isNullOrUndefined = (value) => typeof value === 'undefined' || value === null || value === ''; +exports.isNullOrUndefined = isNullOrUndefined; +/* Generates a token type used for the action. */ +const generateTokenType = (action) => action.sshKey ? 'SSH Deploy Key' : action.token ? 'Deploy Token' : '…'; +exports.generateTokenType = generateTokenType; +/* Generates a the repository path used to make the commits. */ +const generateRepositoryPath = (action) => action.sshKey + ? `git@${action.hostname}:${action.repositoryName}` + : `https://${`x-access-token:${action.token}`}@${action.hostname}/${action.repositoryName}.git`; +exports.generateRepositoryPath = generateRepositoryPath; +/* Genetate absolute folder path by the provided folder name */ +const generateFolderPath = (action) => { + const folderName = action['folder']; + return path_1.default.isAbsolute(folderName) + ? folderName + : folderName.startsWith('~') + ? folderName.replace('~', process.env.HOME) + : path_1.default.join(action.workspace, folderName); +}; +exports.generateFolderPath = generateFolderPath; +/* Checks for the required tokens and formatting. Throws an error if any case is matched. */ +const hasRequiredParameters = (action, params) => { + const nonNullParams = params.filter(param => !(0, exports.isNullOrUndefined)(action[param])); + return Boolean(nonNullParams.length); +}; +/* Verifies the action has the required parameters to run, otherwise throw an error. */ +const checkParameters = (action) => { + if (!hasRequiredParameters(action, ['token', 'sshKey'])) { + throw new Error('No deployment token/method was provided. You must provide the action with either a Personal Access Token or the GitHub Token secret in order to deploy. If you wish to use an ssh deploy token then you must set SSH to true.'); + } + if (!hasRequiredParameters(action, ['branch'])) { + throw new Error('Branch is required.'); + } + if (!hasRequiredParameters(action, ['folder'])) { + throw new Error('You must provide the action with a folder to deploy.'); + } + if (!(0, fs_1.existsSync)(action.folderPath)) { + throw new Error(`The directory you're trying to deploy named ${action.folderPath} doesn't exist. Please double check the path and any prerequisite build scripts and try again. ❗`); + } +}; +exports.checkParameters = checkParameters; +/* Suppresses sensitive information from being exposed in error messages. */ +const suppressSensitiveInformation = (str, action) => { + let value = str; + if ((0, core_1.isDebug)()) { + // Data is unmasked in debug mode. + return value; + } + const orderedByLength = [action.token, action.repositoryPath].filter(Boolean).sort((a, b) => b.length - a.length); + for (const find of orderedByLength) { + value = replaceAll(value, find, '***'); + } + return value; +}; +exports.suppressSensitiveInformation = suppressSensitiveInformation; +const extractErrorMessage = (error) => error instanceof Error + ? error.message + : typeof error == 'string' + ? error + : JSON.stringify(error); +exports.extractErrorMessage = extractErrorMessage; +/** Strips the protocol from a provided URL. */ +const stripProtocolFromUrl = (url) => url.replace(/^(?:https?:\/\/)?(?:www\.)?/i, '').split('/')[0]; +exports.stripProtocolFromUrl = stripProtocolFromUrl; diff --git a/lib/worktree.d.ts b/lib/worktree.d.ts new file mode 100644 index 00000000..c418854d --- /dev/null +++ b/lib/worktree.d.ts @@ -0,0 +1,9 @@ +import { ActionInterface } from './constants'; +export declare class GitCheckout { + orphan: boolean; + commitish?: string | null; + branch: string; + constructor(branch: string); + toString(): string; +} +export declare function generateWorktree(action: ActionInterface, worktreedir: string, branchExists: unknown): Promise; diff --git a/lib/worktree.js b/lib/worktree.js new file mode 100644 index 00000000..e757aedb --- /dev/null +++ b/lib/worktree.js @@ -0,0 +1,67 @@ +"use strict"; +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.generateWorktree = exports.GitCheckout = void 0; +const core_1 = require("@actions/core"); +const execute_1 = require("./execute"); +const util_1 = require("./util"); +class GitCheckout { + constructor(branch) { + this.orphan = false; + this.commitish = null; + this.branch = branch; + } + toString() { + return [ + 'git', + 'checkout', + this.orphan ? '--orphan' : '-B', + this.branch, + this.commitish || '' + ].join(' '); + } +} +exports.GitCheckout = GitCheckout; +/* Generate the worktree and set initial content if it exists */ +function generateWorktree(action, worktreedir, branchExists) { + return __awaiter(this, void 0, void 0, function* () { + try { + (0, core_1.info)('Creating worktree…'); + if (branchExists) { + yield (0, execute_1.execute)(`git fetch --no-recurse-submodules --depth=1 origin ${action.branch}`, action.workspace, action.silent); + } + yield (0, execute_1.execute)(`git worktree add --no-checkout --detach ${worktreedir}`, action.workspace, action.silent); + const checkout = new GitCheckout(action.branch); + if (branchExists) { + // There's existing data on the branch to check out + checkout.commitish = `origin/${action.branch}`; + } + if (!branchExists || action.singleCommit) { + // Create a new history if we don't have the branch, or if we want to reset it + checkout.orphan = true; + } + yield (0, execute_1.execute)(checkout.toString(), `${action.workspace}/${worktreedir}`, action.silent); + if (!branchExists) { + (0, core_1.info)(`Created the ${action.branch} branch… 🔧`); + // Our index is in HEAD state, reset + yield (0, execute_1.execute)('git reset --hard', `${action.workspace}/${worktreedir}`, action.silent); + if (!action.singleCommit) { + // New history isn't singleCommit, create empty initial commit + yield (0, execute_1.execute)(`git commit --no-verify --allow-empty -m "Initial ${action.branch} commit"`, `${action.workspace}/${worktreedir}`, action.silent); + } + } + } + catch (error) { + throw new Error(`There was an error creating the worktree: ${(0, util_1.suppressSensitiveInformation)((0, util_1.extractErrorMessage)(error), action)} ❌`); + } + }); +} +exports.generateWorktree = generateWorktree; diff --git a/node_modules/.bin/semver b/node_modules/.bin/semver new file mode 120000 index 00000000..e92f34a1 --- /dev/null +++ b/node_modules/.bin/semver @@ -0,0 +1 @@ +../execa/node_modules/semver/bin/semver \ No newline at end of file diff --git a/node_modules/.bin/which b/node_modules/.bin/which new file mode 120000 index 00000000..287f0993 --- /dev/null +++ b/node_modules/.bin/which @@ -0,0 +1 @@ +../execa/node_modules/which/bin/which \ No newline at end of file diff --git a/node_modules/@actions/core/LICENSE.md b/node_modules/@actions/core/LICENSE.md new file mode 100644 index 00000000..dbae2edb --- /dev/null +++ b/node_modules/@actions/core/LICENSE.md @@ -0,0 +1,9 @@ +The MIT License (MIT) + +Copyright 2019 GitHub + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/node_modules/@actions/core/README.md b/node_modules/@actions/core/README.md new file mode 100644 index 00000000..8f227a83 --- /dev/null +++ b/node_modules/@actions/core/README.md @@ -0,0 +1,312 @@ +# `@actions/core` + +> Core functions for setting results, logging, registering secrets and exporting variables across actions + +## Usage + +### Import the package + +```js +// javascript +const core = require('@actions/core'); + +// typescript +import * as core from '@actions/core'; +``` + +#### Inputs/Outputs + +Action inputs can be read with `getInput` which returns a `string` or `getBooleanInput` which parses a boolean based on the [yaml 1.2 specification](https://yaml.org/spec/1.2/spec.html#id2804923). If `required` set to be false, the input should have a default value in `action.yml`. + +Outputs can be set with `setOutput` which makes them available to be mapped into inputs of other actions to ensure they are decoupled. + +```js +const myInput = core.getInput('inputName', { required: true }); +const myBooleanInput = core.getBooleanInput('booleanInputName', { required: true }); +const myMultilineInput = core.getMultilineInput('multilineInputName', { required: true }); +core.setOutput('outputKey', 'outputVal'); +``` + +#### Exporting variables + +Since each step runs in a separate process, you can use `exportVariable` to add it to this step and future steps environment blocks. + +```js +core.exportVariable('envVar', 'Val'); +``` + +#### Setting a secret + +Setting a secret registers the secret with the runner to ensure it is masked in logs. + +```js +core.setSecret('myPassword'); +``` + +#### PATH Manipulation + +To make a tool's path available in the path for the remainder of the job (without altering the machine or containers state), use `addPath`. The runner will prepend the path given to the jobs PATH. + +```js +core.addPath('/path/to/mytool'); +``` + +#### Exit codes + +You should use this library to set the failing exit code for your action. If status is not set and the script runs to completion, that will lead to a success. + +```js +const core = require('@actions/core'); + +try { + // Do stuff +} +catch (err) { + // setFailed logs the message and sets a failing exit code + core.setFailed(`Action failed with error ${err}`); +} +``` + +Note that `setNeutral` is not yet implemented in actions V2 but equivalent functionality is being planned. + +#### Logging + +Finally, this library provides some utilities for logging. Note that debug logging is hidden from the logs by default. This behavior can be toggled by enabling the [Step Debug Logs](../../docs/action-debugging.md#step-debug-logs). + +```js +const core = require('@actions/core'); + +const myInput = core.getInput('input'); +try { + core.debug('Inside try block'); + + if (!myInput) { + core.warning('myInput was not set'); + } + + if (core.isDebug()) { + // curl -v https://github.com + } else { + // curl https://github.com + } + + // Do stuff + core.info('Output to the actions build log') + + core.notice('This is a message that will also emit an annotation') +} +catch (err) { + core.error(`Error ${err}, action may still succeed though`); +} +``` + +This library can also wrap chunks of output in foldable groups. + +```js +const core = require('@actions/core') + +// Manually wrap output +core.startGroup('Do some function') +doSomeFunction() +core.endGroup() + +// Wrap an asynchronous function call +const result = await core.group('Do something async', async () => { + const response = await doSomeHTTPRequest() + return response +}) +``` + +#### Annotations + +This library has 3 methods that will produce [annotations](https://docs.github.com/en/rest/reference/checks#create-a-check-run). +```js +core.error('This is a bad error. This will also fail the build.') + +core.warning('Something went wrong, but it\'s not bad enough to fail the build.') + +core.notice('Something happened that you might want to know about.') +``` + +These will surface to the UI in the Actions page and on Pull Requests. They look something like this: + +![Annotations Image](../../docs/assets/annotations.png) + +These annotations can also be attached to particular lines and columns of your source files to show exactly where a problem is occuring. + +These options are: +```typescript +export interface AnnotationProperties { + /** + * A title for the annotation. + */ + title?: string + + /** + * The name of the file for which the annotation should be created. + */ + file?: string + + /** + * The start line for the annotation. + */ + startLine?: number + + /** + * The end line for the annotation. Defaults to `startLine` when `startLine` is provided. + */ + endLine?: number + + /** + * The start column for the annotation. Cannot be sent when `startLine` and `endLine` are different values. + */ + startColumn?: number + + /** + * The start column for the annotation. Cannot be sent when `startLine` and `endLine` are different values. + * Defaults to `startColumn` when `startColumn` is provided. + */ + endColumn?: number +} +``` + +#### Styling output + +Colored output is supported in the Action logs via standard [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code). 3/4 bit, 8 bit and 24 bit colors are all supported. + +Foreground colors: + +```js +// 3/4 bit +core.info('\u001b[35mThis foreground will be magenta') + +// 8 bit +core.info('\u001b[38;5;6mThis foreground will be cyan') + +// 24 bit +core.info('\u001b[38;2;255;0;0mThis foreground will be bright red') +``` + +Background colors: + +```js +// 3/4 bit +core.info('\u001b[43mThis background will be yellow'); + +// 8 bit +core.info('\u001b[48;5;6mThis background will be cyan') + +// 24 bit +core.info('\u001b[48;2;255;0;0mThis background will be bright red') +``` + +Special styles: + +```js +core.info('\u001b[1mBold text') +core.info('\u001b[3mItalic text') +core.info('\u001b[4mUnderlined text') +``` + +ANSI escape codes can be combined with one another: + +```js +core.info('\u001b[31;46mRed foreground with a cyan background and \u001b[1mbold text at the end'); +``` + +> Note: Escape codes reset at the start of each line + +```js +core.info('\u001b[35mThis foreground will be magenta') +core.info('This foreground will reset to the default') +``` + +Manually typing escape codes can be a little difficult, but you can use third party modules such as [ansi-styles](https://github.com/chalk/ansi-styles). + +```js +const style = require('ansi-styles'); +core.info(style.color.ansi16m.hex('#abcdef') + 'Hello world!') +``` + +#### Action state + +You can use this library to save state and get state for sharing information between a given wrapper action: + +**action.yml**: + +```yaml +name: 'Wrapper action sample' +inputs: + name: + default: 'GitHub' +runs: + using: 'node12' + main: 'main.js' + post: 'cleanup.js' +``` + +In action's `main.js`: + +```js +const core = require('@actions/core'); + +core.saveState("pidToKill", 12345); +``` + +In action's `cleanup.js`: + +```js +const core = require('@actions/core'); + +var pid = core.getState("pidToKill"); + +process.kill(pid); +``` + +#### OIDC Token + +You can use these methods to interact with the GitHub OIDC provider and get a JWT ID token which would help to get access token from third party cloud providers. + +**Method Name**: getIDToken() + +**Inputs** + +audience : optional + +**Outputs** + +A [JWT](https://jwt.io/) ID Token + +In action's `main.ts`: +```js +const core = require('@actions/core'); +async function getIDTokenAction(): Promise { + + const audience = core.getInput('audience', {required: false}) + + const id_token1 = await core.getIDToken() // ID Token with default audience + const id_token2 = await core.getIDToken(audience) // ID token with custom audience + + // this id_token can be used to get access token from third party cloud providers +} +getIDTokenAction() +``` + +In action's `actions.yml`: + +```yaml +name: 'GetIDToken' +description: 'Get ID token from Github OIDC provider' +inputs: + audience: + description: 'Audience for which the ID token is intended for' + required: false +outputs: + id_token1: + description: 'ID token obtained from OIDC provider' + id_token2: + description: 'ID token obtained from OIDC provider' +runs: + using: 'node12' + main: 'dist/index.js' +``` \ No newline at end of file diff --git a/node_modules/@actions/core/lib/command.d.ts b/node_modules/@actions/core/lib/command.d.ts new file mode 100644 index 00000000..53f8f4b8 --- /dev/null +++ b/node_modules/@actions/core/lib/command.d.ts @@ -0,0 +1,15 @@ +export interface CommandProperties { + [key: string]: any; +} +/** + * Commands + * + * Command Format: + * ::name key=value,key=value::message + * + * Examples: + * ::warning::This is the message + * ::set-env name=MY_VAR::some value + */ +export declare function issueCommand(command: string, properties: CommandProperties, message: any): void; +export declare function issue(name: string, message?: string): void; diff --git a/node_modules/@actions/core/lib/command.js b/node_modules/@actions/core/lib/command.js new file mode 100644 index 00000000..0b28c66b --- /dev/null +++ b/node_modules/@actions/core/lib/command.js @@ -0,0 +1,92 @@ +"use strict"; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.issue = exports.issueCommand = void 0; +const os = __importStar(require("os")); +const utils_1 = require("./utils"); +/** + * Commands + * + * Command Format: + * ::name key=value,key=value::message + * + * Examples: + * ::warning::This is the message + * ::set-env name=MY_VAR::some value + */ +function issueCommand(command, properties, message) { + const cmd = new Command(command, properties, message); + process.stdout.write(cmd.toString() + os.EOL); +} +exports.issueCommand = issueCommand; +function issue(name, message = '') { + issueCommand(name, {}, message); +} +exports.issue = issue; +const CMD_STRING = '::'; +class Command { + constructor(command, properties, message) { + if (!command) { + command = 'missing.command'; + } + this.command = command; + this.properties = properties; + this.message = message; + } + toString() { + let cmdStr = CMD_STRING + this.command; + if (this.properties && Object.keys(this.properties).length > 0) { + cmdStr += ' '; + let first = true; + for (const key in this.properties) { + if (this.properties.hasOwnProperty(key)) { + const val = this.properties[key]; + if (val) { + if (first) { + first = false; + } + else { + cmdStr += ','; + } + cmdStr += `${key}=${escapeProperty(val)}`; + } + } + } + } + cmdStr += `${CMD_STRING}${escapeData(this.message)}`; + return cmdStr; + } +} +function escapeData(s) { + return utils_1.toCommandValue(s) + .replace(/%/g, '%25') + .replace(/\r/g, '%0D') + .replace(/\n/g, '%0A'); +} +function escapeProperty(s) { + return utils_1.toCommandValue(s) + .replace(/%/g, '%25') + .replace(/\r/g, '%0D') + .replace(/\n/g, '%0A') + .replace(/:/g, '%3A') + .replace(/,/g, '%2C'); +} +//# sourceMappingURL=command.js.map \ No newline at end of file diff --git a/node_modules/@actions/core/lib/command.js.map b/node_modules/@actions/core/lib/command.js.map new file mode 100644 index 00000000..51c7c637 --- /dev/null +++ b/node_modules/@actions/core/lib/command.js.map @@ -0,0 +1 @@ +{"version":3,"file":"command.js","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAwB;AACxB,mCAAsC;AAWtC;;;;;;;;;GASG;AACH,SAAgB,YAAY,CAC1B,OAAe,EACf,UAA6B,EAC7B,OAAY;IAEZ,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAA;IACrD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAA;AAC/C,CAAC;AAPD,oCAOC;AAED,SAAgB,KAAK,CAAC,IAAY,EAAE,OAAO,GAAG,EAAE;IAC9C,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;AACjC,CAAC;AAFD,sBAEC;AAED,MAAM,UAAU,GAAG,IAAI,CAAA;AAEvB,MAAM,OAAO;IAKX,YAAY,OAAe,EAAE,UAA6B,EAAE,OAAe;QACzE,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,iBAAiB,CAAA;SAC5B;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED,QAAQ;QACN,IAAI,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC,OAAO,CAAA;QAEtC,IAAI,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YAC9D,MAAM,IAAI,GAAG,CAAA;YACb,IAAI,KAAK,GAAG,IAAI,CAAA;YAChB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE;gBACjC,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;oBACvC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;oBAChC,IAAI,GAAG,EAAE;wBACP,IAAI,KAAK,EAAE;4BACT,KAAK,GAAG,KAAK,CAAA;yBACd;6BAAM;4BACL,MAAM,IAAI,GAAG,CAAA;yBACd;wBAED,MAAM,IAAI,GAAG,GAAG,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE,CAAA;qBAC1C;iBACF;aACF;SACF;QAED,MAAM,IAAI,GAAG,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAA;QACpD,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAED,SAAS,UAAU,CAAC,CAAM;IACxB,OAAO,sBAAc,CAAC,CAAC,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AAC1B,CAAC;AAED,SAAS,cAAc,CAAC,CAAM;IAC5B,OAAO,sBAAc,CAAC,CAAC,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;AACzB,CAAC"} \ No newline at end of file diff --git a/node_modules/@actions/core/lib/core.d.ts b/node_modules/@actions/core/lib/core.d.ts new file mode 100644 index 00000000..356872ec --- /dev/null +++ b/node_modules/@actions/core/lib/core.d.ts @@ -0,0 +1,186 @@ +/** + * Interface for getInput options + */ +export interface InputOptions { + /** Optional. Whether the input is required. If required and not present, will throw. Defaults to false */ + required?: boolean; + /** Optional. Whether leading/trailing whitespace will be trimmed for the input. Defaults to true */ + trimWhitespace?: boolean; +} +/** + * The code to exit an action + */ +export declare enum ExitCode { + /** + * A code indicating that the action was successful + */ + Success = 0, + /** + * A code indicating that the action was a failure + */ + Failure = 1 +} +/** + * Optional properties that can be sent with annotatation commands (notice, error, and warning) + * See: https://docs.github.com/en/rest/reference/checks#create-a-check-run for more information about annotations. + */ +export interface AnnotationProperties { + /** + * A title for the annotation. + */ + title?: string; + /** + * The path of the file for which the annotation should be created. + */ + file?: string; + /** + * The start line for the annotation. + */ + startLine?: number; + /** + * The end line for the annotation. Defaults to `startLine` when `startLine` is provided. + */ + endLine?: number; + /** + * The start column for the annotation. Cannot be sent when `startLine` and `endLine` are different values. + */ + startColumn?: number; + /** + * The start column for the annotation. Cannot be sent when `startLine` and `endLine` are different values. + * Defaults to `startColumn` when `startColumn` is provided. + */ + endColumn?: number; +} +/** + * Sets env variable for this action and future actions in the job + * @param name the name of the variable to set + * @param val the value of the variable. Non-string values will be converted to a string via JSON.stringify + */ +export declare function exportVariable(name: string, val: any): void; +/** + * Registers a secret which will get masked from logs + * @param secret value of the secret + */ +export declare function setSecret(secret: string): void; +/** + * Prepends inputPath to the PATH (for this action and future actions) + * @param inputPath + */ +export declare function addPath(inputPath: string): void; +/** + * Gets the value of an input. + * Unless trimWhitespace is set to false in InputOptions, the value is also trimmed. + * Returns an empty string if the value is not defined. + * + * @param name name of the input to get + * @param options optional. See InputOptions. + * @returns string + */ +export declare function getInput(name: string, options?: InputOptions): string; +/** + * Gets the values of an multiline input. Each value is also trimmed. + * + * @param name name of the input to get + * @param options optional. See InputOptions. + * @returns string[] + * + */ +export declare function getMultilineInput(name: string, options?: InputOptions): string[]; +/** + * Gets the input value of the boolean type in the YAML 1.2 "core schema" specification. + * Support boolean input list: `true | True | TRUE | false | False | FALSE` . + * The return value is also in boolean type. + * ref: https://yaml.org/spec/1.2/spec.html#id2804923 + * + * @param name name of the input to get + * @param options optional. See InputOptions. + * @returns boolean + */ +export declare function getBooleanInput(name: string, options?: InputOptions): boolean; +/** + * Sets the value of an output. + * + * @param name name of the output to set + * @param value value to store. Non-string values will be converted to a string via JSON.stringify + */ +export declare function setOutput(name: string, value: any): void; +/** + * Enables or disables the echoing of commands into stdout for the rest of the step. + * Echoing is disabled by default if ACTIONS_STEP_DEBUG is not set. + * + */ +export declare function setCommandEcho(enabled: boolean): void; +/** + * Sets the action status to failed. + * When the action exits it will be with an exit code of 1 + * @param message add error issue message + */ +export declare function setFailed(message: string | Error): void; +/** + * Gets whether Actions Step Debug is on or not + */ +export declare function isDebug(): boolean; +/** + * Writes debug message to user log + * @param message debug message + */ +export declare function debug(message: string): void; +/** + * Adds an error issue + * @param message error issue message. Errors will be converted to string via toString() + * @param properties optional properties to add to the annotation. + */ +export declare function error(message: string | Error, properties?: AnnotationProperties): void; +/** + * Adds a warning issue + * @param message warning issue message. Errors will be converted to string via toString() + * @param properties optional properties to add to the annotation. + */ +export declare function warning(message: string | Error, properties?: AnnotationProperties): void; +/** + * Adds a notice issue + * @param message notice issue message. Errors will be converted to string via toString() + * @param properties optional properties to add to the annotation. + */ +export declare function notice(message: string | Error, properties?: AnnotationProperties): void; +/** + * Writes info to log with console.log. + * @param message info message + */ +export declare function info(message: string): void; +/** + * Begin an output group. + * + * Output until the next `groupEnd` will be foldable in this group + * + * @param name The name of the output group + */ +export declare function startGroup(name: string): void; +/** + * End an output group. + */ +export declare function endGroup(): void; +/** + * Wrap an asynchronous function call in a group. + * + * Returns the same type as the function itself. + * + * @param name The name of the group + * @param fn The function to wrap in the group + */ +export declare function group(name: string, fn: () => Promise): Promise; +/** + * Saves state for current action, the state can only be retrieved by this action's post job execution. + * + * @param name name of the state to store + * @param value value to store. Non-string values will be converted to a string via JSON.stringify + */ +export declare function saveState(name: string, value: any): void; +/** + * Gets the value of an state set by this action's main execution. + * + * @param name name of the state to get + * @returns string + */ +export declare function getState(name: string): string; +export declare function getIDToken(aud?: string): Promise; diff --git a/node_modules/@actions/core/lib/core.js b/node_modules/@actions/core/lib/core.js new file mode 100644 index 00000000..e0ceced1 --- /dev/null +++ b/node_modules/@actions/core/lib/core.js @@ -0,0 +1,312 @@ +"use strict"; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.getIDToken = exports.getState = exports.saveState = exports.group = exports.endGroup = exports.startGroup = exports.info = exports.notice = exports.warning = exports.error = exports.debug = exports.isDebug = exports.setFailed = exports.setCommandEcho = exports.setOutput = exports.getBooleanInput = exports.getMultilineInput = exports.getInput = exports.addPath = exports.setSecret = exports.exportVariable = exports.ExitCode = void 0; +const command_1 = require("./command"); +const file_command_1 = require("./file-command"); +const utils_1 = require("./utils"); +const os = __importStar(require("os")); +const path = __importStar(require("path")); +const oidc_utils_1 = require("./oidc-utils"); +/** + * The code to exit an action + */ +var ExitCode; +(function (ExitCode) { + /** + * A code indicating that the action was successful + */ + ExitCode[ExitCode["Success"] = 0] = "Success"; + /** + * A code indicating that the action was a failure + */ + ExitCode[ExitCode["Failure"] = 1] = "Failure"; +})(ExitCode = exports.ExitCode || (exports.ExitCode = {})); +//----------------------------------------------------------------------- +// Variables +//----------------------------------------------------------------------- +/** + * Sets env variable for this action and future actions in the job + * @param name the name of the variable to set + * @param val the value of the variable. Non-string values will be converted to a string via JSON.stringify + */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any +function exportVariable(name, val) { + const convertedVal = utils_1.toCommandValue(val); + process.env[name] = convertedVal; + const filePath = process.env['GITHUB_ENV'] || ''; + if (filePath) { + const delimiter = '_GitHubActionsFileCommandDelimeter_'; + const commandValue = `${name}<<${delimiter}${os.EOL}${convertedVal}${os.EOL}${delimiter}`; + file_command_1.issueCommand('ENV', commandValue); + } + else { + command_1.issueCommand('set-env', { name }, convertedVal); + } +} +exports.exportVariable = exportVariable; +/** + * Registers a secret which will get masked from logs + * @param secret value of the secret + */ +function setSecret(secret) { + command_1.issueCommand('add-mask', {}, secret); +} +exports.setSecret = setSecret; +/** + * Prepends inputPath to the PATH (for this action and future actions) + * @param inputPath + */ +function addPath(inputPath) { + const filePath = process.env['GITHUB_PATH'] || ''; + if (filePath) { + file_command_1.issueCommand('PATH', inputPath); + } + else { + command_1.issueCommand('add-path', {}, inputPath); + } + process.env['PATH'] = `${inputPath}${path.delimiter}${process.env['PATH']}`; +} +exports.addPath = addPath; +/** + * Gets the value of an input. + * Unless trimWhitespace is set to false in InputOptions, the value is also trimmed. + * Returns an empty string if the value is not defined. + * + * @param name name of the input to get + * @param options optional. See InputOptions. + * @returns string + */ +function getInput(name, options) { + const val = process.env[`INPUT_${name.replace(/ /g, '_').toUpperCase()}`] || ''; + if (options && options.required && !val) { + throw new Error(`Input required and not supplied: ${name}`); + } + if (options && options.trimWhitespace === false) { + return val; + } + return val.trim(); +} +exports.getInput = getInput; +/** + * Gets the values of an multiline input. Each value is also trimmed. + * + * @param name name of the input to get + * @param options optional. See InputOptions. + * @returns string[] + * + */ +function getMultilineInput(name, options) { + const inputs = getInput(name, options) + .split('\n') + .filter(x => x !== ''); + return inputs; +} +exports.getMultilineInput = getMultilineInput; +/** + * Gets the input value of the boolean type in the YAML 1.2 "core schema" specification. + * Support boolean input list: `true | True | TRUE | false | False | FALSE` . + * The return value is also in boolean type. + * ref: https://yaml.org/spec/1.2/spec.html#id2804923 + * + * @param name name of the input to get + * @param options optional. See InputOptions. + * @returns boolean + */ +function getBooleanInput(name, options) { + const trueValue = ['true', 'True', 'TRUE']; + const falseValue = ['false', 'False', 'FALSE']; + const val = getInput(name, options); + if (trueValue.includes(val)) + return true; + if (falseValue.includes(val)) + return false; + throw new TypeError(`Input does not meet YAML 1.2 "Core Schema" specification: ${name}\n` + + `Support boolean input list: \`true | True | TRUE | false | False | FALSE\``); +} +exports.getBooleanInput = getBooleanInput; +/** + * Sets the value of an output. + * + * @param name name of the output to set + * @param value value to store. Non-string values will be converted to a string via JSON.stringify + */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any +function setOutput(name, value) { + process.stdout.write(os.EOL); + command_1.issueCommand('set-output', { name }, value); +} +exports.setOutput = setOutput; +/** + * Enables or disables the echoing of commands into stdout for the rest of the step. + * Echoing is disabled by default if ACTIONS_STEP_DEBUG is not set. + * + */ +function setCommandEcho(enabled) { + command_1.issue('echo', enabled ? 'on' : 'off'); +} +exports.setCommandEcho = setCommandEcho; +//----------------------------------------------------------------------- +// Results +//----------------------------------------------------------------------- +/** + * Sets the action status to failed. + * When the action exits it will be with an exit code of 1 + * @param message add error issue message + */ +function setFailed(message) { + process.exitCode = ExitCode.Failure; + error(message); +} +exports.setFailed = setFailed; +//----------------------------------------------------------------------- +// Logging Commands +//----------------------------------------------------------------------- +/** + * Gets whether Actions Step Debug is on or not + */ +function isDebug() { + return process.env['RUNNER_DEBUG'] === '1'; +} +exports.isDebug = isDebug; +/** + * Writes debug message to user log + * @param message debug message + */ +function debug(message) { + command_1.issueCommand('debug', {}, message); +} +exports.debug = debug; +/** + * Adds an error issue + * @param message error issue message. Errors will be converted to string via toString() + * @param properties optional properties to add to the annotation. + */ +function error(message, properties = {}) { + command_1.issueCommand('error', utils_1.toCommandProperties(properties), message instanceof Error ? message.toString() : message); +} +exports.error = error; +/** + * Adds a warning issue + * @param message warning issue message. Errors will be converted to string via toString() + * @param properties optional properties to add to the annotation. + */ +function warning(message, properties = {}) { + command_1.issueCommand('warning', utils_1.toCommandProperties(properties), message instanceof Error ? message.toString() : message); +} +exports.warning = warning; +/** + * Adds a notice issue + * @param message notice issue message. Errors will be converted to string via toString() + * @param properties optional properties to add to the annotation. + */ +function notice(message, properties = {}) { + command_1.issueCommand('notice', utils_1.toCommandProperties(properties), message instanceof Error ? message.toString() : message); +} +exports.notice = notice; +/** + * Writes info to log with console.log. + * @param message info message + */ +function info(message) { + process.stdout.write(message + os.EOL); +} +exports.info = info; +/** + * Begin an output group. + * + * Output until the next `groupEnd` will be foldable in this group + * + * @param name The name of the output group + */ +function startGroup(name) { + command_1.issue('group', name); +} +exports.startGroup = startGroup; +/** + * End an output group. + */ +function endGroup() { + command_1.issue('endgroup'); +} +exports.endGroup = endGroup; +/** + * Wrap an asynchronous function call in a group. + * + * Returns the same type as the function itself. + * + * @param name The name of the group + * @param fn The function to wrap in the group + */ +function group(name, fn) { + return __awaiter(this, void 0, void 0, function* () { + startGroup(name); + let result; + try { + result = yield fn(); + } + finally { + endGroup(); + } + return result; + }); +} +exports.group = group; +//----------------------------------------------------------------------- +// Wrapper action state +//----------------------------------------------------------------------- +/** + * Saves state for current action, the state can only be retrieved by this action's post job execution. + * + * @param name name of the state to store + * @param value value to store. Non-string values will be converted to a string via JSON.stringify + */ +// eslint-disable-next-line @typescript-eslint/no-explicit-any +function saveState(name, value) { + command_1.issueCommand('save-state', { name }, value); +} +exports.saveState = saveState; +/** + * Gets the value of an state set by this action's main execution. + * + * @param name name of the state to get + * @returns string + */ +function getState(name) { + return process.env[`STATE_${name}`] || ''; +} +exports.getState = getState; +function getIDToken(aud) { + return __awaiter(this, void 0, void 0, function* () { + return yield oidc_utils_1.OidcClient.getIDToken(aud); + }); +} +exports.getIDToken = getIDToken; +//# sourceMappingURL=core.js.map \ No newline at end of file diff --git a/node_modules/@actions/core/lib/core.js.map b/node_modules/@actions/core/lib/core.js.map new file mode 100644 index 00000000..087a91d8 --- /dev/null +++ b/node_modules/@actions/core/lib/core.js.map @@ -0,0 +1 @@ +{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAA6C;AAC7C,iDAA+D;AAC/D,mCAA2D;AAE3D,uCAAwB;AACxB,2CAA4B;AAE5B,6CAAuC;AAavC;;GAEG;AACH,IAAY,QAUX;AAVD,WAAY,QAAQ;IAClB;;OAEG;IACH,6CAAW,CAAA;IAEX;;OAEG;IACH,6CAAW,CAAA;AACb,CAAC,EAVW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAUnB;AAuCD,yEAAyE;AACzE,YAAY;AACZ,yEAAyE;AAEzE;;;;GAIG;AACH,8DAA8D;AAC9D,SAAgB,cAAc,CAAC,IAAY,EAAE,GAAQ;IACnD,MAAM,YAAY,GAAG,sBAAc,CAAC,GAAG,CAAC,CAAA;IACxC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,YAAY,CAAA;IAEhC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAA;IAChD,IAAI,QAAQ,EAAE;QACZ,MAAM,SAAS,GAAG,qCAAqC,CAAA;QACvD,MAAM,YAAY,GAAG,GAAG,IAAI,KAAK,SAAS,GAAG,EAAE,CAAC,GAAG,GAAG,YAAY,GAAG,EAAE,CAAC,GAAG,GAAG,SAAS,EAAE,CAAA;QACzF,2BAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;KACtC;SAAM;QACL,sBAAY,CAAC,SAAS,EAAE,EAAC,IAAI,EAAC,EAAE,YAAY,CAAC,CAAA;KAC9C;AACH,CAAC;AAZD,wCAYC;AAED;;;GAGG;AACH,SAAgB,SAAS,CAAC,MAAc;IACtC,sBAAY,CAAC,UAAU,EAAE,EAAE,EAAE,MAAM,CAAC,CAAA;AACtC,CAAC;AAFD,8BAEC;AAED;;;GAGG;AACH,SAAgB,OAAO,CAAC,SAAiB;IACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,CAAA;IACjD,IAAI,QAAQ,EAAE;QACZ,2BAAgB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;KACpC;SAAM;QACL,sBAAY,CAAC,UAAU,EAAE,EAAE,EAAE,SAAS,CAAC,CAAA;KACxC;IACD,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAA;AAC7E,CAAC;AARD,0BAQC;AAED;;;;;;;;GAQG;AACH,SAAgB,QAAQ,CAAC,IAAY,EAAE,OAAsB;IAC3D,MAAM,GAAG,GACP,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,EAAE,CAAA;IACrE,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,GAAG,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAI,EAAE,CAAC,CAAA;KAC5D;IAED,IAAI,OAAO,IAAI,OAAO,CAAC,cAAc,KAAK,KAAK,EAAE;QAC/C,OAAO,GAAG,CAAA;KACX;IAED,OAAO,GAAG,CAAC,IAAI,EAAE,CAAA;AACnB,CAAC;AAZD,4BAYC;AAED;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAC/B,IAAY,EACZ,OAAsB;IAEtB,MAAM,MAAM,GAAa,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;SAC7C,KAAK,CAAC,IAAI,CAAC;SACX,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAA;IAExB,OAAO,MAAM,CAAA;AACf,CAAC;AATD,8CASC;AAED;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAAC,IAAY,EAAE,OAAsB;IAClE,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IAC1C,MAAM,UAAU,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IAC9C,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IACnC,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAA;IACxC,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IAC1C,MAAM,IAAI,SAAS,CACjB,6DAA6D,IAAI,IAAI;QACnE,4EAA4E,CAC/E,CAAA;AACH,CAAC;AAVD,0CAUC;AAED;;;;;GAKG;AACH,8DAA8D;AAC9D,SAAgB,SAAS,CAAC,IAAY,EAAE,KAAU;IAChD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAA;IAC5B,sBAAY,CAAC,YAAY,EAAE,EAAC,IAAI,EAAC,EAAE,KAAK,CAAC,CAAA;AAC3C,CAAC;AAHD,8BAGC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,OAAgB;IAC7C,eAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AACvC,CAAC;AAFD,wCAEC;AAED,yEAAyE;AACzE,UAAU;AACV,yEAAyE;AAEzE;;;;GAIG;AACH,SAAgB,SAAS,CAAC,OAAuB;IAC/C,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAA;IAEnC,KAAK,CAAC,OAAO,CAAC,CAAA;AAChB,CAAC;AAJD,8BAIC;AAED,yEAAyE;AACzE,mBAAmB;AACnB,yEAAyE;AAEzE;;GAEG;AACH,SAAgB,OAAO;IACrB,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,GAAG,CAAA;AAC5C,CAAC;AAFD,0BAEC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAC,OAAe;IACnC,sBAAY,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;AACpC,CAAC;AAFD,sBAEC;AAED;;;;GAIG;AACH,SAAgB,KAAK,CACnB,OAAuB,EACvB,aAAmC,EAAE;IAErC,sBAAY,CACV,OAAO,EACP,2BAAmB,CAAC,UAAU,CAAC,EAC/B,OAAO,YAAY,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CACxD,CAAA;AACH,CAAC;AATD,sBASC;AAED;;;;GAIG;AACH,SAAgB,OAAO,CACrB,OAAuB,EACvB,aAAmC,EAAE;IAErC,sBAAY,CACV,SAAS,EACT,2BAAmB,CAAC,UAAU,CAAC,EAC/B,OAAO,YAAY,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CACxD,CAAA;AACH,CAAC;AATD,0BASC;AAED;;;;GAIG;AACH,SAAgB,MAAM,CACpB,OAAuB,EACvB,aAAmC,EAAE;IAErC,sBAAY,CACV,QAAQ,EACR,2BAAmB,CAAC,UAAU,CAAC,EAC/B,OAAO,YAAY,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CACxD,CAAA;AACH,CAAC;AATD,wBASC;AAED;;;GAGG;AACH,SAAgB,IAAI,CAAC,OAAe;IAClC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,CAAA;AACxC,CAAC;AAFD,oBAEC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,IAAY;IACrC,eAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;AACtB,CAAC;AAFD,gCAEC;AAED;;GAEG;AACH,SAAgB,QAAQ;IACtB,eAAK,CAAC,UAAU,CAAC,CAAA;AACnB,CAAC;AAFD,4BAEC;AAED;;;;;;;GAOG;AACH,SAAsB,KAAK,CAAI,IAAY,EAAE,EAAoB;;QAC/D,UAAU,CAAC,IAAI,CAAC,CAAA;QAEhB,IAAI,MAAS,CAAA;QAEb,IAAI;YACF,MAAM,GAAG,MAAM,EAAE,EAAE,CAAA;SACpB;gBAAS;YACR,QAAQ,EAAE,CAAA;SACX;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CAAA;AAZD,sBAYC;AAED,yEAAyE;AACzE,uBAAuB;AACvB,yEAAyE;AAEzE;;;;;GAKG;AACH,8DAA8D;AAC9D,SAAgB,SAAS,CAAC,IAAY,EAAE,KAAU;IAChD,sBAAY,CAAC,YAAY,EAAE,EAAC,IAAI,EAAC,EAAE,KAAK,CAAC,CAAA;AAC3C,CAAC;AAFD,8BAEC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,IAAY;IACnC,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,IAAI,EAAE,CAAA;AAC3C,CAAC;AAFD,4BAEC;AAED,SAAsB,UAAU,CAAC,GAAY;;QAC3C,OAAO,MAAM,uBAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACzC,CAAC;CAAA;AAFD,gCAEC"} \ No newline at end of file diff --git a/node_modules/@actions/core/lib/file-command.d.ts b/node_modules/@actions/core/lib/file-command.d.ts new file mode 100644 index 00000000..ed408eb1 --- /dev/null +++ b/node_modules/@actions/core/lib/file-command.d.ts @@ -0,0 +1 @@ +export declare function issueCommand(command: string, message: any): void; diff --git a/node_modules/@actions/core/lib/file-command.js b/node_modules/@actions/core/lib/file-command.js new file mode 100644 index 00000000..55e3e9f8 --- /dev/null +++ b/node_modules/@actions/core/lib/file-command.js @@ -0,0 +1,42 @@ +"use strict"; +// For internal use, subject to change. +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.issueCommand = void 0; +// We use any as a valid input type +/* eslint-disable @typescript-eslint/no-explicit-any */ +const fs = __importStar(require("fs")); +const os = __importStar(require("os")); +const utils_1 = require("./utils"); +function issueCommand(command, message) { + const filePath = process.env[`GITHUB_${command}`]; + if (!filePath) { + throw new Error(`Unable to find environment variable for file command ${command}`); + } + if (!fs.existsSync(filePath)) { + throw new Error(`Missing file at path: ${filePath}`); + } + fs.appendFileSync(filePath, `${utils_1.toCommandValue(message)}${os.EOL}`, { + encoding: 'utf8' + }); +} +exports.issueCommand = issueCommand; +//# sourceMappingURL=file-command.js.map \ No newline at end of file diff --git a/node_modules/@actions/core/lib/file-command.js.map b/node_modules/@actions/core/lib/file-command.js.map new file mode 100644 index 00000000..ee35699f --- /dev/null +++ b/node_modules/@actions/core/lib/file-command.js.map @@ -0,0 +1 @@ +{"version":3,"file":"file-command.js","sourceRoot":"","sources":["../src/file-command.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;;;;;;;;;;;;;;;;;;;;AAEvC,mCAAmC;AACnC,uDAAuD;AAEvD,uCAAwB;AACxB,uCAAwB;AACxB,mCAAsC;AAEtC,SAAgB,YAAY,CAAC,OAAe,EAAE,OAAY;IACxD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,OAAO,EAAE,CAAC,CAAA;IACjD,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CACb,wDAAwD,OAAO,EAAE,CAClE,CAAA;KACF;IACD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QAC5B,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,EAAE,CAAC,CAAA;KACrD;IAED,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,GAAG,sBAAc,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;QACjE,QAAQ,EAAE,MAAM;KACjB,CAAC,CAAA;AACJ,CAAC;AAdD,oCAcC"} \ No newline at end of file diff --git a/node_modules/@actions/core/lib/oidc-utils.d.ts b/node_modules/@actions/core/lib/oidc-utils.d.ts new file mode 100644 index 00000000..657c7f4a --- /dev/null +++ b/node_modules/@actions/core/lib/oidc-utils.d.ts @@ -0,0 +1,7 @@ +export declare class OidcClient { + private static createHttpClient; + private static getRequestToken; + private static getIDTokenUrl; + private static getCall; + static getIDToken(audience?: string): Promise; +} diff --git a/node_modules/@actions/core/lib/oidc-utils.js b/node_modules/@actions/core/lib/oidc-utils.js new file mode 100644 index 00000000..9ee10faf --- /dev/null +++ b/node_modules/@actions/core/lib/oidc-utils.js @@ -0,0 +1,77 @@ +"use strict"; +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.OidcClient = void 0; +const http_client_1 = require("@actions/http-client"); +const auth_1 = require("@actions/http-client/auth"); +const core_1 = require("./core"); +class OidcClient { + static createHttpClient(allowRetry = true, maxRetry = 10) { + const requestOptions = { + allowRetries: allowRetry, + maxRetries: maxRetry + }; + return new http_client_1.HttpClient('actions/oidc-client', [new auth_1.BearerCredentialHandler(OidcClient.getRequestToken())], requestOptions); + } + static getRequestToken() { + const token = process.env['ACTIONS_ID_TOKEN_REQUEST_TOKEN']; + if (!token) { + throw new Error('Unable to get ACTIONS_ID_TOKEN_REQUEST_TOKEN env variable'); + } + return token; + } + static getIDTokenUrl() { + const runtimeUrl = process.env['ACTIONS_ID_TOKEN_REQUEST_URL']; + if (!runtimeUrl) { + throw new Error('Unable to get ACTIONS_ID_TOKEN_REQUEST_URL env variable'); + } + return runtimeUrl; + } + static getCall(id_token_url) { + var _a; + return __awaiter(this, void 0, void 0, function* () { + const httpclient = OidcClient.createHttpClient(); + const res = yield httpclient + .getJson(id_token_url) + .catch(error => { + throw new Error(`Failed to get ID Token. \n + Error Code : ${error.statusCode}\n + Error Message: ${error.result.message}`); + }); + const id_token = (_a = res.result) === null || _a === void 0 ? void 0 : _a.value; + if (!id_token) { + throw new Error('Response json body do not have ID Token field'); + } + return id_token; + }); + } + static getIDToken(audience) { + return __awaiter(this, void 0, void 0, function* () { + try { + // New ID Token is requested from action service + let id_token_url = OidcClient.getIDTokenUrl(); + if (audience) { + const encodedAudience = encodeURIComponent(audience); + id_token_url = `${id_token_url}&audience=${encodedAudience}`; + } + core_1.debug(`ID token url is ${id_token_url}`); + const id_token = yield OidcClient.getCall(id_token_url); + core_1.setSecret(id_token); + return id_token; + } + catch (error) { + throw new Error(`Error message: ${error.message}`); + } + }); + } +} +exports.OidcClient = OidcClient; +//# sourceMappingURL=oidc-utils.js.map \ No newline at end of file diff --git a/node_modules/@actions/core/lib/oidc-utils.js.map b/node_modules/@actions/core/lib/oidc-utils.js.map new file mode 100644 index 00000000..0ddbca92 --- /dev/null +++ b/node_modules/@actions/core/lib/oidc-utils.js.map @@ -0,0 +1 @@ +{"version":3,"file":"oidc-utils.js","sourceRoot":"","sources":["../src/oidc-utils.ts"],"names":[],"mappings":";;;;;;;;;;;;AAGA,sDAA+C;AAC/C,oDAAiE;AACjE,iCAAuC;AAKvC,MAAa,UAAU;IACb,MAAM,CAAC,gBAAgB,CAC7B,UAAU,GAAG,IAAI,EACjB,QAAQ,GAAG,EAAE;QAEb,MAAM,cAAc,GAAoB;YACtC,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,QAAQ;SACrB,CAAA;QAED,OAAO,IAAI,wBAAU,CACnB,qBAAqB,EACrB,CAAC,IAAI,8BAAuB,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC,EAC3D,cAAc,CACf,CAAA;IACH,CAAC;IAEO,MAAM,CAAC,eAAe;QAC5B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAA;QAC3D,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CACb,2DAA2D,CAC5D,CAAA;SACF;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,MAAM,CAAC,aAAa;QAC1B,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAA;QAC9D,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAA;SAC3E;QACD,OAAO,UAAU,CAAA;IACnB,CAAC;IAEO,MAAM,CAAO,OAAO,CAAC,YAAoB;;;YAC/C,MAAM,UAAU,GAAG,UAAU,CAAC,gBAAgB,EAAE,CAAA;YAEhD,MAAM,GAAG,GAAG,MAAM,UAAU;iBACzB,OAAO,CAAgB,YAAY,CAAC;iBACpC,KAAK,CAAC,KAAK,CAAC,EAAE;gBACb,MAAM,IAAI,KAAK,CACb;uBACa,KAAK,CAAC,UAAU;yBACd,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CACtC,CAAA;YACH,CAAC,CAAC,CAAA;YAEJ,MAAM,QAAQ,SAAG,GAAG,CAAC,MAAM,0CAAE,KAAK,CAAA;YAClC,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;aACjE;YACD,OAAO,QAAQ,CAAA;;KAChB;IAED,MAAM,CAAO,UAAU,CAAC,QAAiB;;YACvC,IAAI;gBACF,gDAAgD;gBAChD,IAAI,YAAY,GAAW,UAAU,CAAC,aAAa,EAAE,CAAA;gBACrD,IAAI,QAAQ,EAAE;oBACZ,MAAM,eAAe,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAA;oBACpD,YAAY,GAAG,GAAG,YAAY,aAAa,eAAe,EAAE,CAAA;iBAC7D;gBAED,YAAK,CAAC,mBAAmB,YAAY,EAAE,CAAC,CAAA;gBAExC,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;gBACvD,gBAAS,CAAC,QAAQ,CAAC,CAAA;gBACnB,OAAO,QAAQ,CAAA;aAChB;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;aACnD;QACH,CAAC;KAAA;CACF;AAzED,gCAyEC"} \ No newline at end of file diff --git a/node_modules/@actions/core/lib/utils.d.ts b/node_modules/@actions/core/lib/utils.d.ts new file mode 100644 index 00000000..3b9e28d5 --- /dev/null +++ b/node_modules/@actions/core/lib/utils.d.ts @@ -0,0 +1,14 @@ +import { AnnotationProperties } from './core'; +import { CommandProperties } from './command'; +/** + * Sanitizes an input into a string so it can be passed into issueCommand safely + * @param input input to sanitize into a string + */ +export declare function toCommandValue(input: any): string; +/** + * + * @param annotationProperties + * @returns The command properties to send with the actual annotation command + * See IssueCommandProperties: https://github.com/actions/runner/blob/main/src/Runner.Worker/ActionCommandManager.cs#L646 + */ +export declare function toCommandProperties(annotationProperties: AnnotationProperties): CommandProperties; diff --git a/node_modules/@actions/core/lib/utils.js b/node_modules/@actions/core/lib/utils.js new file mode 100644 index 00000000..9b5ca44b --- /dev/null +++ b/node_modules/@actions/core/lib/utils.js @@ -0,0 +1,40 @@ +"use strict"; +// We use any as a valid input type +/* eslint-disable @typescript-eslint/no-explicit-any */ +Object.defineProperty(exports, "__esModule", { value: true }); +exports.toCommandProperties = exports.toCommandValue = void 0; +/** + * Sanitizes an input into a string so it can be passed into issueCommand safely + * @param input input to sanitize into a string + */ +function toCommandValue(input) { + if (input === null || input === undefined) { + return ''; + } + else if (typeof input === 'string' || input instanceof String) { + return input; + } + return JSON.stringify(input); +} +exports.toCommandValue = toCommandValue; +/** + * + * @param annotationProperties + * @returns The command properties to send with the actual annotation command + * See IssueCommandProperties: https://github.com/actions/runner/blob/main/src/Runner.Worker/ActionCommandManager.cs#L646 + */ +function toCommandProperties(annotationProperties) { + if (!Object.keys(annotationProperties).length) { + return {}; + } + return { + title: annotationProperties.title, + file: annotationProperties.file, + line: annotationProperties.startLine, + endLine: annotationProperties.endLine, + col: annotationProperties.startColumn, + endColumn: annotationProperties.endColumn + }; +} +exports.toCommandProperties = toCommandProperties; +//# sourceMappingURL=utils.js.map \ No newline at end of file diff --git a/node_modules/@actions/core/lib/utils.js.map b/node_modules/@actions/core/lib/utils.js.map new file mode 100644 index 00000000..8211bb7e --- /dev/null +++ b/node_modules/@actions/core/lib/utils.js.map @@ -0,0 +1 @@ +{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAAA,mCAAmC;AACnC,uDAAuD;;;AAKvD;;;GAGG;AACH,SAAgB,cAAc,CAAC,KAAU;IACvC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;QACzC,OAAO,EAAE,CAAA;KACV;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,MAAM,EAAE;QAC/D,OAAO,KAAe,CAAA;KACvB;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;AAC9B,CAAC;AAPD,wCAOC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,oBAA0C;IAE1C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,MAAM,EAAE;QAC7C,OAAO,EAAE,CAAA;KACV;IAED,OAAO;QACL,KAAK,EAAE,oBAAoB,CAAC,KAAK;QACjC,IAAI,EAAE,oBAAoB,CAAC,IAAI;QAC/B,IAAI,EAAE,oBAAoB,CAAC,SAAS;QACpC,OAAO,EAAE,oBAAoB,CAAC,OAAO;QACrC,GAAG,EAAE,oBAAoB,CAAC,WAAW;QACrC,SAAS,EAAE,oBAAoB,CAAC,SAAS;KAC1C,CAAA;AACH,CAAC;AAfD,kDAeC"} \ No newline at end of file diff --git a/node_modules/@actions/core/package.json b/node_modules/@actions/core/package.json new file mode 100644 index 00000000..8d7a3997 --- /dev/null +++ b/node_modules/@actions/core/package.json @@ -0,0 +1,44 @@ +{ + "name": "@actions/core", + "version": "1.6.0", + "description": "Actions core lib", + "keywords": [ + "github", + "actions", + "core" + ], + "homepage": "https://github.com/actions/toolkit/tree/main/packages/core", + "license": "MIT", + "main": "lib/core.js", + "types": "lib/core.d.ts", + "directories": { + "lib": "lib", + "test": "__tests__" + }, + "files": [ + "lib", + "!.DS_Store" + ], + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/actions/toolkit.git", + "directory": "packages/core" + }, + "scripts": { + "audit-moderate": "npm install && npm audit --json --audit-level=moderate > audit.json", + "test": "echo \"Error: run tests from root\" && exit 1", + "tsc": "tsc" + }, + "bugs": { + "url": "https://github.com/actions/toolkit/issues" + }, + "dependencies": { + "@actions/http-client": "^1.0.11" + }, + "devDependencies": { + "@types/node": "^12.0.2" + } +} diff --git a/node_modules/@actions/exec/LICENSE.md b/node_modules/@actions/exec/LICENSE.md new file mode 100644 index 00000000..dbae2edb --- /dev/null +++ b/node_modules/@actions/exec/LICENSE.md @@ -0,0 +1,9 @@ +The MIT License (MIT) + +Copyright 2019 GitHub + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/node_modules/@actions/exec/README.md b/node_modules/@actions/exec/README.md new file mode 100644 index 00000000..53a6bf52 --- /dev/null +++ b/node_modules/@actions/exec/README.md @@ -0,0 +1,57 @@ +# `@actions/exec` + +## Usage + +#### Basic + +You can use this package to execute tools in a cross platform way: + +```js +const exec = require('@actions/exec'); + +await exec.exec('node index.js'); +``` + +#### Args + +You can also pass in arg arrays: + +```js +const exec = require('@actions/exec'); + +await exec.exec('node', ['index.js', 'foo=bar']); +``` + +#### Output/options + +Capture output or specify [other options](https://github.com/actions/toolkit/blob/d9347d4ab99fd507c0b9104b2cf79fb44fcc827d/packages/exec/src/interfaces.ts#L5): + +```js +const exec = require('@actions/exec'); + +let myOutput = ''; +let myError = ''; + +const options = {}; +options.listeners = { + stdout: (data: Buffer) => { + myOutput += data.toString(); + }, + stderr: (data: Buffer) => { + myError += data.toString(); + } +}; +options.cwd = './lib'; + +await exec.exec('node', ['index.js', 'foo=bar'], options); +``` + +#### Exec tools not in the PATH + +You can specify the full path for tools not in the PATH: + +```js +const exec = require('@actions/exec'); + +await exec.exec('"/path/to/my-tool"', ['arg1']); +``` diff --git a/node_modules/@actions/exec/lib/exec.d.ts b/node_modules/@actions/exec/lib/exec.d.ts new file mode 100644 index 00000000..baedcdb6 --- /dev/null +++ b/node_modules/@actions/exec/lib/exec.d.ts @@ -0,0 +1,24 @@ +import { ExecOptions, ExecOutput, ExecListeners } from './interfaces'; +export { ExecOptions, ExecOutput, ExecListeners }; +/** + * Exec a command. + * Output will be streamed to the live console. + * Returns promise with return code + * + * @param commandLine command to execute (can include additional args). Must be correctly escaped. + * @param args optional arguments for tool. Escaping is handled by the lib. + * @param options optional exec options. See ExecOptions + * @returns Promise exit code + */ +export declare function exec(commandLine: string, args?: string[], options?: ExecOptions): Promise; +/** + * Exec a command and get the output. + * Output will be streamed to the live console. + * Returns promise with the exit code and collected stdout and stderr + * + * @param commandLine command to execute (can include additional args). Must be correctly escaped. + * @param args optional arguments for tool. Escaping is handled by the lib. + * @param options optional exec options. See ExecOptions + * @returns Promise exit code, stdout, and stderr + */ +export declare function getExecOutput(commandLine: string, args?: string[], options?: ExecOptions): Promise; diff --git a/node_modules/@actions/exec/lib/exec.js b/node_modules/@actions/exec/lib/exec.js new file mode 100644 index 00000000..72c7a9cc --- /dev/null +++ b/node_modules/@actions/exec/lib/exec.js @@ -0,0 +1,103 @@ +"use strict"; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.getExecOutput = exports.exec = void 0; +const string_decoder_1 = require("string_decoder"); +const tr = __importStar(require("./toolrunner")); +/** + * Exec a command. + * Output will be streamed to the live console. + * Returns promise with return code + * + * @param commandLine command to execute (can include additional args). Must be correctly escaped. + * @param args optional arguments for tool. Escaping is handled by the lib. + * @param options optional exec options. See ExecOptions + * @returns Promise exit code + */ +function exec(commandLine, args, options) { + return __awaiter(this, void 0, void 0, function* () { + const commandArgs = tr.argStringToArray(commandLine); + if (commandArgs.length === 0) { + throw new Error(`Parameter 'commandLine' cannot be null or empty.`); + } + // Path to tool to execute should be first arg + const toolPath = commandArgs[0]; + args = commandArgs.slice(1).concat(args || []); + const runner = new tr.ToolRunner(toolPath, args, options); + return runner.exec(); + }); +} +exports.exec = exec; +/** + * Exec a command and get the output. + * Output will be streamed to the live console. + * Returns promise with the exit code and collected stdout and stderr + * + * @param commandLine command to execute (can include additional args). Must be correctly escaped. + * @param args optional arguments for tool. Escaping is handled by the lib. + * @param options optional exec options. See ExecOptions + * @returns Promise exit code, stdout, and stderr + */ +function getExecOutput(commandLine, args, options) { + var _a, _b; + return __awaiter(this, void 0, void 0, function* () { + let stdout = ''; + let stderr = ''; + //Using string decoder covers the case where a mult-byte character is split + const stdoutDecoder = new string_decoder_1.StringDecoder('utf8'); + const stderrDecoder = new string_decoder_1.StringDecoder('utf8'); + const originalStdoutListener = (_a = options === null || options === void 0 ? void 0 : options.listeners) === null || _a === void 0 ? void 0 : _a.stdout; + const originalStdErrListener = (_b = options === null || options === void 0 ? void 0 : options.listeners) === null || _b === void 0 ? void 0 : _b.stderr; + const stdErrListener = (data) => { + stderr += stderrDecoder.write(data); + if (originalStdErrListener) { + originalStdErrListener(data); + } + }; + const stdOutListener = (data) => { + stdout += stdoutDecoder.write(data); + if (originalStdoutListener) { + originalStdoutListener(data); + } + }; + const listeners = Object.assign(Object.assign({}, options === null || options === void 0 ? void 0 : options.listeners), { stdout: stdOutListener, stderr: stdErrListener }); + const exitCode = yield exec(commandLine, args, Object.assign(Object.assign({}, options), { listeners })); + //flush any remaining characters + stdout += stdoutDecoder.end(); + stderr += stderrDecoder.end(); + return { + exitCode, + stdout, + stderr + }; + }); +} +exports.getExecOutput = getExecOutput; +//# sourceMappingURL=exec.js.map \ No newline at end of file diff --git a/node_modules/@actions/exec/lib/exec.js.map b/node_modules/@actions/exec/lib/exec.js.map new file mode 100644 index 00000000..07626365 --- /dev/null +++ b/node_modules/@actions/exec/lib/exec.js.map @@ -0,0 +1 @@ +{"version":3,"file":"exec.js","sourceRoot":"","sources":["../src/exec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAA4C;AAE5C,iDAAkC;AAIlC;;;;;;;;;GASG;AACH,SAAsB,IAAI,CACxB,WAAmB,EACnB,IAAe,EACf,OAAqB;;QAErB,MAAM,WAAW,GAAG,EAAE,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;QACpD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;SACpE;QACD,8CAA8C;QAC9C,MAAM,QAAQ,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;QAC/B,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAA;QAC9C,MAAM,MAAM,GAAkB,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;QACxE,OAAO,MAAM,CAAC,IAAI,EAAE,CAAA;IACtB,CAAC;CAAA;AAdD,oBAcC;AAED;;;;;;;;;GASG;AAEH,SAAsB,aAAa,CACjC,WAAmB,EACnB,IAAe,EACf,OAAqB;;;QAErB,IAAI,MAAM,GAAG,EAAE,CAAA;QACf,IAAI,MAAM,GAAG,EAAE,CAAA;QAEf,2EAA2E;QAC3E,MAAM,aAAa,GAAG,IAAI,8BAAa,CAAC,MAAM,CAAC,CAAA;QAC/C,MAAM,aAAa,GAAG,IAAI,8BAAa,CAAC,MAAM,CAAC,CAAA;QAE/C,MAAM,sBAAsB,SAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,0CAAE,MAAM,CAAA;QACzD,MAAM,sBAAsB,SAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,0CAAE,MAAM,CAAA;QAEzD,MAAM,cAAc,GAAG,CAAC,IAAY,EAAQ,EAAE;YAC5C,MAAM,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACnC,IAAI,sBAAsB,EAAE;gBAC1B,sBAAsB,CAAC,IAAI,CAAC,CAAA;aAC7B;QACH,CAAC,CAAA;QAED,MAAM,cAAc,GAAG,CAAC,IAAY,EAAQ,EAAE;YAC5C,MAAM,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACnC,IAAI,sBAAsB,EAAE;gBAC1B,sBAAsB,CAAC,IAAI,CAAC,CAAA;aAC7B;QACH,CAAC,CAAA;QAED,MAAM,SAAS,mCACV,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,KACrB,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,cAAc,GACvB,CAAA;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,IAAI,kCAAM,OAAO,KAAE,SAAS,IAAE,CAAA;QAEvE,gCAAgC;QAChC,MAAM,IAAI,aAAa,CAAC,GAAG,EAAE,CAAA;QAC7B,MAAM,IAAI,aAAa,CAAC,GAAG,EAAE,CAAA;QAE7B,OAAO;YACL,QAAQ;YACR,MAAM;YACN,MAAM;SACP,CAAA;;CACF;AA9CD,sCA8CC"} \ No newline at end of file diff --git a/node_modules/@actions/exec/lib/interfaces.d.ts b/node_modules/@actions/exec/lib/interfaces.d.ts new file mode 100644 index 00000000..8ae20e48 --- /dev/null +++ b/node_modules/@actions/exec/lib/interfaces.d.ts @@ -0,0 +1,57 @@ +/// +import * as stream from 'stream'; +/** + * Interface for exec options + */ +export interface ExecOptions { + /** optional working directory. defaults to current */ + cwd?: string; + /** optional envvar dictionary. defaults to current process's env */ + env?: { + [key: string]: string; + }; + /** optional. defaults to false */ + silent?: boolean; + /** optional out stream to use. Defaults to process.stdout */ + outStream?: stream.Writable; + /** optional err stream to use. Defaults to process.stderr */ + errStream?: stream.Writable; + /** optional. whether to skip quoting/escaping arguments if needed. defaults to false. */ + windowsVerbatimArguments?: boolean; + /** optional. whether to fail if output to stderr. defaults to false */ + failOnStdErr?: boolean; + /** optional. defaults to failing on non zero. ignore will not fail leaving it up to the caller */ + ignoreReturnCode?: boolean; + /** optional. How long in ms to wait for STDIO streams to close after the exit event of the process before terminating. defaults to 10000 */ + delay?: number; + /** optional. input to write to the process on STDIN. */ + input?: Buffer; + /** optional. Listeners for output. Callback functions that will be called on these events */ + listeners?: ExecListeners; +} +/** + * Interface for the output of getExecOutput() + */ +export interface ExecOutput { + /**The exit code of the process */ + exitCode: number; + /**The entire stdout of the process as a string */ + stdout: string; + /**The entire stderr of the process as a string */ + stderr: string; +} +/** + * The user defined listeners for an exec call + */ +export interface ExecListeners { + /** A call back for each buffer of stdout */ + stdout?: (data: Buffer) => void; + /** A call back for each buffer of stderr */ + stderr?: (data: Buffer) => void; + /** A call back for each line of stdout */ + stdline?: (data: string) => void; + /** A call back for each line of stderr */ + errline?: (data: string) => void; + /** A call back for each debug log */ + debug?: (data: string) => void; +} diff --git a/node_modules/@actions/exec/lib/interfaces.js b/node_modules/@actions/exec/lib/interfaces.js new file mode 100644 index 00000000..db919115 --- /dev/null +++ b/node_modules/@actions/exec/lib/interfaces.js @@ -0,0 +1,3 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +//# sourceMappingURL=interfaces.js.map \ No newline at end of file diff --git a/node_modules/@actions/exec/lib/interfaces.js.map b/node_modules/@actions/exec/lib/interfaces.js.map new file mode 100644 index 00000000..8fb5f7d1 --- /dev/null +++ b/node_modules/@actions/exec/lib/interfaces.js.map @@ -0,0 +1 @@ +{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":""} \ No newline at end of file diff --git a/node_modules/@actions/exec/lib/toolrunner.d.ts b/node_modules/@actions/exec/lib/toolrunner.d.ts new file mode 100644 index 00000000..9bbbb1ea --- /dev/null +++ b/node_modules/@actions/exec/lib/toolrunner.d.ts @@ -0,0 +1,37 @@ +/// +import * as events from 'events'; +import * as im from './interfaces'; +export declare class ToolRunner extends events.EventEmitter { + constructor(toolPath: string, args?: string[], options?: im.ExecOptions); + private toolPath; + private args; + private options; + private _debug; + private _getCommandString; + private _processLineBuffer; + private _getSpawnFileName; + private _getSpawnArgs; + private _endsWith; + private _isCmdFile; + private _windowsQuoteCmdArg; + private _uvQuoteCmdArg; + private _cloneExecOptions; + private _getSpawnOptions; + /** + * Exec a tool. + * Output will be streamed to the live console. + * Returns promise with return code + * + * @param tool path to tool to exec + * @param options optional exec options. See ExecOptions + * @returns number + */ + exec(): Promise; +} +/** + * Convert an arg string to an array of args. Handles escaping + * + * @param argString string of arguments + * @returns string[] array of arguments + */ +export declare function argStringToArray(argString: string): string[]; diff --git a/node_modules/@actions/exec/lib/toolrunner.js b/node_modules/@actions/exec/lib/toolrunner.js new file mode 100644 index 00000000..e456a729 --- /dev/null +++ b/node_modules/@actions/exec/lib/toolrunner.js @@ -0,0 +1,618 @@ +"use strict"; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.argStringToArray = exports.ToolRunner = void 0; +const os = __importStar(require("os")); +const events = __importStar(require("events")); +const child = __importStar(require("child_process")); +const path = __importStar(require("path")); +const io = __importStar(require("@actions/io")); +const ioUtil = __importStar(require("@actions/io/lib/io-util")); +const timers_1 = require("timers"); +/* eslint-disable @typescript-eslint/unbound-method */ +const IS_WINDOWS = process.platform === 'win32'; +/* + * Class for running command line tools. Handles quoting and arg parsing in a platform agnostic way. + */ +class ToolRunner extends events.EventEmitter { + constructor(toolPath, args, options) { + super(); + if (!toolPath) { + throw new Error("Parameter 'toolPath' cannot be null or empty."); + } + this.toolPath = toolPath; + this.args = args || []; + this.options = options || {}; + } + _debug(message) { + if (this.options.listeners && this.options.listeners.debug) { + this.options.listeners.debug(message); + } + } + _getCommandString(options, noPrefix) { + const toolPath = this._getSpawnFileName(); + const args = this._getSpawnArgs(options); + let cmd = noPrefix ? '' : '[command]'; // omit prefix when piped to a second tool + if (IS_WINDOWS) { + // Windows + cmd file + if (this._isCmdFile()) { + cmd += toolPath; + for (const a of args) { + cmd += ` ${a}`; + } + } + // Windows + verbatim + else if (options.windowsVerbatimArguments) { + cmd += `"${toolPath}"`; + for (const a of args) { + cmd += ` ${a}`; + } + } + // Windows (regular) + else { + cmd += this._windowsQuoteCmdArg(toolPath); + for (const a of args) { + cmd += ` ${this._windowsQuoteCmdArg(a)}`; + } + } + } + else { + // OSX/Linux - this can likely be improved with some form of quoting. + // creating processes on Unix is fundamentally different than Windows. + // on Unix, execvp() takes an arg array. + cmd += toolPath; + for (const a of args) { + cmd += ` ${a}`; + } + } + return cmd; + } + _processLineBuffer(data, strBuffer, onLine) { + try { + let s = strBuffer + data.toString(); + let n = s.indexOf(os.EOL); + while (n > -1) { + const line = s.substring(0, n); + onLine(line); + // the rest of the string ... + s = s.substring(n + os.EOL.length); + n = s.indexOf(os.EOL); + } + return s; + } + catch (err) { + // streaming lines to console is best effort. Don't fail a build. + this._debug(`error processing line. Failed with error ${err}`); + return ''; + } + } + _getSpawnFileName() { + if (IS_WINDOWS) { + if (this._isCmdFile()) { + return process.env['COMSPEC'] || 'cmd.exe'; + } + } + return this.toolPath; + } + _getSpawnArgs(options) { + if (IS_WINDOWS) { + if (this._isCmdFile()) { + let argline = `/D /S /C "${this._windowsQuoteCmdArg(this.toolPath)}`; + for (const a of this.args) { + argline += ' '; + argline += options.windowsVerbatimArguments + ? a + : this._windowsQuoteCmdArg(a); + } + argline += '"'; + return [argline]; + } + } + return this.args; + } + _endsWith(str, end) { + return str.endsWith(end); + } + _isCmdFile() { + const upperToolPath = this.toolPath.toUpperCase(); + return (this._endsWith(upperToolPath, '.CMD') || + this._endsWith(upperToolPath, '.BAT')); + } + _windowsQuoteCmdArg(arg) { + // for .exe, apply the normal quoting rules that libuv applies + if (!this._isCmdFile()) { + return this._uvQuoteCmdArg(arg); + } + // otherwise apply quoting rules specific to the cmd.exe command line parser. + // the libuv rules are generic and are not designed specifically for cmd.exe + // command line parser. + // + // for a detailed description of the cmd.exe command line parser, refer to + // http://stackoverflow.com/questions/4094699/how-does-the-windows-command-interpreter-cmd-exe-parse-scripts/7970912#7970912 + // need quotes for empty arg + if (!arg) { + return '""'; + } + // determine whether the arg needs to be quoted + const cmdSpecialChars = [ + ' ', + '\t', + '&', + '(', + ')', + '[', + ']', + '{', + '}', + '^', + '=', + ';', + '!', + "'", + '+', + ',', + '`', + '~', + '|', + '<', + '>', + '"' + ]; + let needsQuotes = false; + for (const char of arg) { + if (cmdSpecialChars.some(x => x === char)) { + needsQuotes = true; + break; + } + } + // short-circuit if quotes not needed + if (!needsQuotes) { + return arg; + } + // the following quoting rules are very similar to the rules that by libuv applies. + // + // 1) wrap the string in quotes + // + // 2) double-up quotes - i.e. " => "" + // + // this is different from the libuv quoting rules. libuv replaces " with \", which unfortunately + // doesn't work well with a cmd.exe command line. + // + // note, replacing " with "" also works well if the arg is passed to a downstream .NET console app. + // for example, the command line: + // foo.exe "myarg:""my val""" + // is parsed by a .NET console app into an arg array: + // [ "myarg:\"my val\"" ] + // which is the same end result when applying libuv quoting rules. although the actual + // command line from libuv quoting rules would look like: + // foo.exe "myarg:\"my val\"" + // + // 3) double-up slashes that precede a quote, + // e.g. hello \world => "hello \world" + // hello\"world => "hello\\""world" + // hello\\"world => "hello\\\\""world" + // hello world\ => "hello world\\" + // + // technically this is not required for a cmd.exe command line, or the batch argument parser. + // the reasons for including this as a .cmd quoting rule are: + // + // a) this is optimized for the scenario where the argument is passed from the .cmd file to an + // external program. many programs (e.g. .NET console apps) rely on the slash-doubling rule. + // + // b) it's what we've been doing previously (by deferring to node default behavior) and we + // haven't heard any complaints about that aspect. + // + // note, a weakness of the quoting rules chosen here, is that % is not escaped. in fact, % cannot be + // escaped when used on the command line directly - even though within a .cmd file % can be escaped + // by using %%. + // + // the saving grace is, on the command line, %var% is left as-is if var is not defined. this contrasts + // the line parsing rules within a .cmd file, where if var is not defined it is replaced with nothing. + // + // one option that was explored was replacing % with ^% - i.e. %var% => ^%var^%. this hack would + // often work, since it is unlikely that var^ would exist, and the ^ character is removed when the + // variable is used. the problem, however, is that ^ is not removed when %* is used to pass the args + // to an external program. + // + // an unexplored potential solution for the % escaping problem, is to create a wrapper .cmd file. + // % can be escaped within a .cmd file. + let reverse = '"'; + let quoteHit = true; + for (let i = arg.length; i > 0; i--) { + // walk the string in reverse + reverse += arg[i - 1]; + if (quoteHit && arg[i - 1] === '\\') { + reverse += '\\'; // double the slash + } + else if (arg[i - 1] === '"') { + quoteHit = true; + reverse += '"'; // double the quote + } + else { + quoteHit = false; + } + } + reverse += '"'; + return reverse + .split('') + .reverse() + .join(''); + } + _uvQuoteCmdArg(arg) { + // Tool runner wraps child_process.spawn() and needs to apply the same quoting as + // Node in certain cases where the undocumented spawn option windowsVerbatimArguments + // is used. + // + // Since this function is a port of quote_cmd_arg from Node 4.x (technically, lib UV, + // see https://github.com/nodejs/node/blob/v4.x/deps/uv/src/win/process.c for details), + // pasting copyright notice from Node within this function: + // + // Copyright Joyent, Inc. and other Node contributors. All rights reserved. + // + // Permission is hereby granted, free of charge, to any person obtaining a copy + // of this software and associated documentation files (the "Software"), to + // deal in the Software without restriction, including without limitation the + // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + // sell copies of the Software, and to permit persons to whom the Software is + // furnished to do so, subject to the following conditions: + // + // The above copyright notice and this permission notice shall be included in + // all copies or substantial portions of the Software. + // + // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + // IN THE SOFTWARE. + if (!arg) { + // Need double quotation for empty argument + return '""'; + } + if (!arg.includes(' ') && !arg.includes('\t') && !arg.includes('"')) { + // No quotation needed + return arg; + } + if (!arg.includes('"') && !arg.includes('\\')) { + // No embedded double quotes or backslashes, so I can just wrap + // quote marks around the whole thing. + return `"${arg}"`; + } + // Expected input/output: + // input : hello"world + // output: "hello\"world" + // input : hello""world + // output: "hello\"\"world" + // input : hello\world + // output: hello\world + // input : hello\\world + // output: hello\\world + // input : hello\"world + // output: "hello\\\"world" + // input : hello\\"world + // output: "hello\\\\\"world" + // input : hello world\ + // output: "hello world\\" - note the comment in libuv actually reads "hello world\" + // but it appears the comment is wrong, it should be "hello world\\" + let reverse = '"'; + let quoteHit = true; + for (let i = arg.length; i > 0; i--) { + // walk the string in reverse + reverse += arg[i - 1]; + if (quoteHit && arg[i - 1] === '\\') { + reverse += '\\'; + } + else if (arg[i - 1] === '"') { + quoteHit = true; + reverse += '\\'; + } + else { + quoteHit = false; + } + } + reverse += '"'; + return reverse + .split('') + .reverse() + .join(''); + } + _cloneExecOptions(options) { + options = options || {}; + const result = { + cwd: options.cwd || process.cwd(), + env: options.env || process.env, + silent: options.silent || false, + windowsVerbatimArguments: options.windowsVerbatimArguments || false, + failOnStdErr: options.failOnStdErr || false, + ignoreReturnCode: options.ignoreReturnCode || false, + delay: options.delay || 10000 + }; + result.outStream = options.outStream || process.stdout; + result.errStream = options.errStream || process.stderr; + return result; + } + _getSpawnOptions(options, toolPath) { + options = options || {}; + const result = {}; + result.cwd = options.cwd; + result.env = options.env; + result['windowsVerbatimArguments'] = + options.windowsVerbatimArguments || this._isCmdFile(); + if (options.windowsVerbatimArguments) { + result.argv0 = `"${toolPath}"`; + } + return result; + } + /** + * Exec a tool. + * Output will be streamed to the live console. + * Returns promise with return code + * + * @param tool path to tool to exec + * @param options optional exec options. See ExecOptions + * @returns number + */ + exec() { + return __awaiter(this, void 0, void 0, function* () { + // root the tool path if it is unrooted and contains relative pathing + if (!ioUtil.isRooted(this.toolPath) && + (this.toolPath.includes('/') || + (IS_WINDOWS && this.toolPath.includes('\\')))) { + // prefer options.cwd if it is specified, however options.cwd may also need to be rooted + this.toolPath = path.resolve(process.cwd(), this.options.cwd || process.cwd(), this.toolPath); + } + // if the tool is only a file name, then resolve it from the PATH + // otherwise verify it exists (add extension on Windows if necessary) + this.toolPath = yield io.which(this.toolPath, true); + return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () { + this._debug(`exec tool: ${this.toolPath}`); + this._debug('arguments:'); + for (const arg of this.args) { + this._debug(` ${arg}`); + } + const optionsNonNull = this._cloneExecOptions(this.options); + if (!optionsNonNull.silent && optionsNonNull.outStream) { + optionsNonNull.outStream.write(this._getCommandString(optionsNonNull) + os.EOL); + } + const state = new ExecState(optionsNonNull, this.toolPath); + state.on('debug', (message) => { + this._debug(message); + }); + if (this.options.cwd && !(yield ioUtil.exists(this.options.cwd))) { + return reject(new Error(`The cwd: ${this.options.cwd} does not exist!`)); + } + const fileName = this._getSpawnFileName(); + const cp = child.spawn(fileName, this._getSpawnArgs(optionsNonNull), this._getSpawnOptions(this.options, fileName)); + let stdbuffer = ''; + if (cp.stdout) { + cp.stdout.on('data', (data) => { + if (this.options.listeners && this.options.listeners.stdout) { + this.options.listeners.stdout(data); + } + if (!optionsNonNull.silent && optionsNonNull.outStream) { + optionsNonNull.outStream.write(data); + } + stdbuffer = this._processLineBuffer(data, stdbuffer, (line) => { + if (this.options.listeners && this.options.listeners.stdline) { + this.options.listeners.stdline(line); + } + }); + }); + } + let errbuffer = ''; + if (cp.stderr) { + cp.stderr.on('data', (data) => { + state.processStderr = true; + if (this.options.listeners && this.options.listeners.stderr) { + this.options.listeners.stderr(data); + } + if (!optionsNonNull.silent && + optionsNonNull.errStream && + optionsNonNull.outStream) { + const s = optionsNonNull.failOnStdErr + ? optionsNonNull.errStream + : optionsNonNull.outStream; + s.write(data); + } + errbuffer = this._processLineBuffer(data, errbuffer, (line) => { + if (this.options.listeners && this.options.listeners.errline) { + this.options.listeners.errline(line); + } + }); + }); + } + cp.on('error', (err) => { + state.processError = err.message; + state.processExited = true; + state.processClosed = true; + state.CheckComplete(); + }); + cp.on('exit', (code) => { + state.processExitCode = code; + state.processExited = true; + this._debug(`Exit code ${code} received from tool '${this.toolPath}'`); + state.CheckComplete(); + }); + cp.on('close', (code) => { + state.processExitCode = code; + state.processExited = true; + state.processClosed = true; + this._debug(`STDIO streams have closed for tool '${this.toolPath}'`); + state.CheckComplete(); + }); + state.on('done', (error, exitCode) => { + if (stdbuffer.length > 0) { + this.emit('stdline', stdbuffer); + } + if (errbuffer.length > 0) { + this.emit('errline', errbuffer); + } + cp.removeAllListeners(); + if (error) { + reject(error); + } + else { + resolve(exitCode); + } + }); + if (this.options.input) { + if (!cp.stdin) { + throw new Error('child process missing stdin'); + } + cp.stdin.end(this.options.input); + } + })); + }); + } +} +exports.ToolRunner = ToolRunner; +/** + * Convert an arg string to an array of args. Handles escaping + * + * @param argString string of arguments + * @returns string[] array of arguments + */ +function argStringToArray(argString) { + const args = []; + let inQuotes = false; + let escaped = false; + let arg = ''; + function append(c) { + // we only escape double quotes. + if (escaped && c !== '"') { + arg += '\\'; + } + arg += c; + escaped = false; + } + for (let i = 0; i < argString.length; i++) { + const c = argString.charAt(i); + if (c === '"') { + if (!escaped) { + inQuotes = !inQuotes; + } + else { + append(c); + } + continue; + } + if (c === '\\' && escaped) { + append(c); + continue; + } + if (c === '\\' && inQuotes) { + escaped = true; + continue; + } + if (c === ' ' && !inQuotes) { + if (arg.length > 0) { + args.push(arg); + arg = ''; + } + continue; + } + append(c); + } + if (arg.length > 0) { + args.push(arg.trim()); + } + return args; +} +exports.argStringToArray = argStringToArray; +class ExecState extends events.EventEmitter { + constructor(options, toolPath) { + super(); + this.processClosed = false; // tracks whether the process has exited and stdio is closed + this.processError = ''; + this.processExitCode = 0; + this.processExited = false; // tracks whether the process has exited + this.processStderr = false; // tracks whether stderr was written to + this.delay = 10000; // 10 seconds + this.done = false; + this.timeout = null; + if (!toolPath) { + throw new Error('toolPath must not be empty'); + } + this.options = options; + this.toolPath = toolPath; + if (options.delay) { + this.delay = options.delay; + } + } + CheckComplete() { + if (this.done) { + return; + } + if (this.processClosed) { + this._setResult(); + } + else if (this.processExited) { + this.timeout = timers_1.setTimeout(ExecState.HandleTimeout, this.delay, this); + } + } + _debug(message) { + this.emit('debug', message); + } + _setResult() { + // determine whether there is an error + let error; + if (this.processExited) { + if (this.processError) { + error = new Error(`There was an error when attempting to execute the process '${this.toolPath}'. This may indicate the process failed to start. Error: ${this.processError}`); + } + else if (this.processExitCode !== 0 && !this.options.ignoreReturnCode) { + error = new Error(`The process '${this.toolPath}' failed with exit code ${this.processExitCode}`); + } + else if (this.processStderr && this.options.failOnStdErr) { + error = new Error(`The process '${this.toolPath}' failed because one or more lines were written to the STDERR stream`); + } + } + // clear the timeout + if (this.timeout) { + clearTimeout(this.timeout); + this.timeout = null; + } + this.done = true; + this.emit('done', error, this.processExitCode); + } + static HandleTimeout(state) { + if (state.done) { + return; + } + if (!state.processClosed && state.processExited) { + const message = `The STDIO streams did not close within ${state.delay / + 1000} seconds of the exit event from process '${state.toolPath}'. This may indicate a child process inherited the STDIO streams and has not yet exited.`; + state._debug(message); + } + state._setResult(); + } +} +//# sourceMappingURL=toolrunner.js.map \ No newline at end of file diff --git a/node_modules/@actions/exec/lib/toolrunner.js.map b/node_modules/@actions/exec/lib/toolrunner.js.map new file mode 100644 index 00000000..6eaf1830 --- /dev/null +++ b/node_modules/@actions/exec/lib/toolrunner.js.map @@ -0,0 +1 @@ +{"version":3,"file":"toolrunner.js","sourceRoot":"","sources":["../src/toolrunner.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAwB;AACxB,+CAAgC;AAChC,qDAAsC;AACtC,2CAA4B;AAG5B,gDAAiC;AACjC,gEAAiD;AACjD,mCAAiC;AAEjC,sDAAsD;AAEtD,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAA;AAE/C;;GAEG;AACH,MAAa,UAAW,SAAQ,MAAM,CAAC,YAAY;IACjD,YAAY,QAAgB,EAAE,IAAe,EAAE,OAAwB;QACrE,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;SACjE;QAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;IAC9B,CAAC;IAMO,MAAM,CAAC,OAAe;QAC5B,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE;YAC1D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;SACtC;IACH,CAAC;IAEO,iBAAiB,CACvB,OAAuB,EACvB,QAAkB;QAElB,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;QACzC,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;QACxC,IAAI,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAA,CAAC,0CAA0C;QAChF,IAAI,UAAU,EAAE;YACd,qBAAqB;YACrB,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;gBACrB,GAAG,IAAI,QAAQ,CAAA;gBACf,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;oBACpB,GAAG,IAAI,IAAI,CAAC,EAAE,CAAA;iBACf;aACF;YACD,qBAAqB;iBAChB,IAAI,OAAO,CAAC,wBAAwB,EAAE;gBACzC,GAAG,IAAI,IAAI,QAAQ,GAAG,CAAA;gBACtB,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;oBACpB,GAAG,IAAI,IAAI,CAAC,EAAE,CAAA;iBACf;aACF;YACD,oBAAoB;iBACf;gBACH,GAAG,IAAI,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAA;gBACzC,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;oBACpB,GAAG,IAAI,IAAI,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAA;iBACzC;aACF;SACF;aAAM;YACL,qEAAqE;YACrE,sEAAsE;YACtE,wCAAwC;YACxC,GAAG,IAAI,QAAQ,CAAA;YACf,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;gBACpB,GAAG,IAAI,IAAI,CAAC,EAAE,CAAA;aACf;SACF;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;IAEO,kBAAkB,CACxB,IAAY,EACZ,SAAiB,EACjB,MAA8B;QAE9B,IAAI;YACF,IAAI,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAA;YACnC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,CAAA;YAEzB,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE;gBACb,MAAM,IAAI,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;gBAC9B,MAAM,CAAC,IAAI,CAAC,CAAA;gBAEZ,6BAA6B;gBAC7B,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;gBAClC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,CAAA;aACtB;YAED,OAAO,CAAC,CAAA;SACT;QAAC,OAAO,GAAG,EAAE;YACZ,kEAAkE;YAClE,IAAI,CAAC,MAAM,CAAC,4CAA4C,GAAG,EAAE,CAAC,CAAA;YAE9D,OAAO,EAAE,CAAA;SACV;IACH,CAAC;IAEO,iBAAiB;QACvB,IAAI,UAAU,EAAE;YACd,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;gBACrB,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,SAAS,CAAA;aAC3C;SACF;QAED,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAEO,aAAa,CAAC,OAAuB;QAC3C,IAAI,UAAU,EAAE;YACd,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;gBACrB,IAAI,OAAO,GAAG,aAAa,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAA;gBACpE,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE;oBACzB,OAAO,IAAI,GAAG,CAAA;oBACd,OAAO,IAAI,OAAO,CAAC,wBAAwB;wBACzC,CAAC,CAAC,CAAC;wBACH,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAA;iBAChC;gBAED,OAAO,IAAI,GAAG,CAAA;gBACd,OAAO,CAAC,OAAO,CAAC,CAAA;aACjB;SACF;QAED,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAEO,SAAS,CAAC,GAAW,EAAE,GAAW;QACxC,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC;IAEO,UAAU;QAChB,MAAM,aAAa,GAAW,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAA;QACzD,OAAO,CACL,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC;YACrC,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,CACtC,CAAA;IACH,CAAC;IAEO,mBAAmB,CAAC,GAAW;QACrC,8DAA8D;QAC9D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACtB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;SAChC;QAED,6EAA6E;QAC7E,4EAA4E;QAC5E,uBAAuB;QACvB,EAAE;QACF,0EAA0E;QAC1E,4HAA4H;QAE5H,4BAA4B;QAC5B,IAAI,CAAC,GAAG,EAAE;YACR,OAAO,IAAI,CAAA;SACZ;QAED,+CAA+C;QAC/C,MAAM,eAAe,GAAG;YACtB,GAAG;YACH,IAAI;YACJ,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;YACH,GAAG;SACJ,CAAA;QACD,IAAI,WAAW,GAAG,KAAK,CAAA;QACvB,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE;YACtB,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,EAAE;gBACzC,WAAW,GAAG,IAAI,CAAA;gBAClB,MAAK;aACN;SACF;QAED,qCAAqC;QACrC,IAAI,CAAC,WAAW,EAAE;YAChB,OAAO,GAAG,CAAA;SACX;QAED,mFAAmF;QACnF,EAAE;QACF,+BAA+B;QAC/B,EAAE;QACF,qCAAqC;QACrC,EAAE;QACF,mGAAmG;QACnG,oDAAoD;QACpD,EAAE;QACF,sGAAsG;QACtG,oCAAoC;QACpC,sCAAsC;QACtC,wDAAwD;QACxD,kCAAkC;QAClC,yFAAyF;QACzF,4DAA4D;QAC5D,sCAAsC;QACtC,EAAE;QACF,6CAA6C;QAC7C,6CAA6C;QAC7C,+CAA+C;QAC/C,iDAAiD;QACjD,8CAA8C;QAC9C,EAAE;QACF,gGAAgG;QAChG,gEAAgE;QAChE,EAAE;QACF,iGAAiG;QACjG,kGAAkG;QAClG,EAAE;QACF,6FAA6F;QAC7F,wDAAwD;QACxD,EAAE;QACF,oGAAoG;QACpG,mGAAmG;QACnG,eAAe;QACf,EAAE;QACF,sGAAsG;QACtG,sGAAsG;QACtG,EAAE;QACF,gGAAgG;QAChG,kGAAkG;QAClG,oGAAoG;QACpG,0BAA0B;QAC1B,EAAE;QACF,iGAAiG;QACjG,uCAAuC;QACvC,IAAI,OAAO,GAAG,GAAG,CAAA;QACjB,IAAI,QAAQ,GAAG,IAAI,CAAA;QACnB,KAAK,IAAI,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YACnC,6BAA6B;YAC7B,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;YACrB,IAAI,QAAQ,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE;gBACnC,OAAO,IAAI,IAAI,CAAA,CAAC,mBAAmB;aACpC;iBAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;gBAC7B,QAAQ,GAAG,IAAI,CAAA;gBACf,OAAO,IAAI,GAAG,CAAA,CAAC,mBAAmB;aACnC;iBAAM;gBACL,QAAQ,GAAG,KAAK,CAAA;aACjB;SACF;QAED,OAAO,IAAI,GAAG,CAAA;QACd,OAAO,OAAO;aACX,KAAK,CAAC,EAAE,CAAC;aACT,OAAO,EAAE;aACT,IAAI,CAAC,EAAE,CAAC,CAAA;IACb,CAAC;IAEO,cAAc,CAAC,GAAW;QAChC,iFAAiF;QACjF,qFAAqF;QACrF,WAAW;QACX,EAAE;QACF,qFAAqF;QACrF,uFAAuF;QACvF,2DAA2D;QAC3D,EAAE;QACF,gFAAgF;QAChF,EAAE;QACF,oFAAoF;QACpF,gFAAgF;QAChF,kFAAkF;QAClF,mFAAmF;QACnF,kFAAkF;QAClF,gEAAgE;QAChE,EAAE;QACF,kFAAkF;QAClF,2DAA2D;QAC3D,EAAE;QACF,kFAAkF;QAClF,gFAAgF;QAChF,mFAAmF;QACnF,8EAA8E;QAC9E,+EAA+E;QAC/E,oFAAoF;QACpF,wBAAwB;QAExB,IAAI,CAAC,GAAG,EAAE;YACR,2CAA2C;YAC3C,OAAO,IAAI,CAAA;SACZ;QAED,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACnE,sBAAsB;YACtB,OAAO,GAAG,CAAA;SACX;QAED,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAC7C,+DAA+D;YAC/D,sCAAsC;YACtC,OAAO,IAAI,GAAG,GAAG,CAAA;SAClB;QAED,yBAAyB;QACzB,wBAAwB;QACxB,2BAA2B;QAC3B,yBAAyB;QACzB,6BAA6B;QAC7B,wBAAwB;QACxB,wBAAwB;QACxB,yBAAyB;QACzB,yBAAyB;QACzB,yBAAyB;QACzB,6BAA6B;QAC7B,0BAA0B;QAC1B,+BAA+B;QAC/B,yBAAyB;QACzB,sFAAsF;QACtF,gGAAgG;QAChG,IAAI,OAAO,GAAG,GAAG,CAAA;QACjB,IAAI,QAAQ,GAAG,IAAI,CAAA;QACnB,KAAK,IAAI,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YACnC,6BAA6B;YAC7B,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;YACrB,IAAI,QAAQ,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE;gBACnC,OAAO,IAAI,IAAI,CAAA;aAChB;iBAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;gBAC7B,QAAQ,GAAG,IAAI,CAAA;gBACf,OAAO,IAAI,IAAI,CAAA;aAChB;iBAAM;gBACL,QAAQ,GAAG,KAAK,CAAA;aACjB;SACF;QAED,OAAO,IAAI,GAAG,CAAA;QACd,OAAO,OAAO;aACX,KAAK,CAAC,EAAE,CAAC;aACT,OAAO,EAAE;aACT,IAAI,CAAC,EAAE,CAAC,CAAA;IACb,CAAC;IAEO,iBAAiB,CAAC,OAAwB;QAChD,OAAO,GAAG,OAAO,IAAoB,EAAE,CAAA;QACvC,MAAM,MAAM,GAAmC;YAC7C,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE;YACjC,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG;YAC/B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;YAC/B,wBAAwB,EAAE,OAAO,CAAC,wBAAwB,IAAI,KAAK;YACnE,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,KAAK;YAC3C,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,IAAI,KAAK;YACnD,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,KAAK;SAC9B,CAAA;QACD,MAAM,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAqB,OAAO,CAAC,MAAM,CAAA;QACvE,MAAM,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAqB,OAAO,CAAC,MAAM,CAAA;QACvE,OAAO,MAAM,CAAA;IACf,CAAC;IAEO,gBAAgB,CACtB,OAAuB,EACvB,QAAgB;QAEhB,OAAO,GAAG,OAAO,IAAoB,EAAE,CAAA;QACvC,MAAM,MAAM,GAAuB,EAAE,CAAA;QACrC,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACxB,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACxB,MAAM,CAAC,0BAA0B,CAAC;YAChC,OAAO,CAAC,wBAAwB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAA;QACvD,IAAI,OAAO,CAAC,wBAAwB,EAAE;YACpC,MAAM,CAAC,KAAK,GAAG,IAAI,QAAQ,GAAG,CAAA;SAC/B;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;;;OAQG;IACG,IAAI;;YACR,qEAAqE;YACrE,IACE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC/B,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC;oBAC1B,CAAC,UAAU,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAC/C;gBACA,wFAAwF;gBACxF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAC1B,OAAO,CAAC,GAAG,EAAE,EACb,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,EACjC,IAAI,CAAC,QAAQ,CACd,CAAA;aACF;YAED,iEAAiE;YACjE,qEAAqE;YACrE,IAAI,CAAC,QAAQ,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;YAEnD,OAAO,IAAI,OAAO,CAAS,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;gBACnD,IAAI,CAAC,MAAM,CAAC,cAAc,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;gBAC1C,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;gBACzB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE;oBAC3B,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;iBACzB;gBAED,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;gBAC3D,IAAI,CAAC,cAAc,CAAC,MAAM,IAAI,cAAc,CAAC,SAAS,EAAE;oBACtD,cAAc,CAAC,SAAS,CAAC,KAAK,CAC5B,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,CAChD,CAAA;iBACF;gBAED,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;gBAC1D,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,OAAe,EAAE,EAAE;oBACpC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;gBACtB,CAAC,CAAC,CAAA;gBAEF,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE;oBAChE,OAAO,MAAM,CAAC,IAAI,KAAK,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAA;iBACzE;gBAED,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;gBACzC,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CACpB,QAAQ,EACR,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,EAClC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAC9C,CAAA;gBAED,IAAI,SAAS,GAAG,EAAE,CAAA;gBAClB,IAAI,EAAE,CAAC,MAAM,EAAE;oBACb,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;wBACpC,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE;4BAC3D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;yBACpC;wBAED,IAAI,CAAC,cAAc,CAAC,MAAM,IAAI,cAAc,CAAC,SAAS,EAAE;4BACtD,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;yBACrC;wBAED,SAAS,GAAG,IAAI,CAAC,kBAAkB,CACjC,IAAI,EACJ,SAAS,EACT,CAAC,IAAY,EAAE,EAAE;4BACf,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE;gCAC5D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;6BACrC;wBACH,CAAC,CACF,CAAA;oBACH,CAAC,CAAC,CAAA;iBACH;gBAED,IAAI,SAAS,GAAG,EAAE,CAAA;gBAClB,IAAI,EAAE,CAAC,MAAM,EAAE;oBACb,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;wBACpC,KAAK,CAAC,aAAa,GAAG,IAAI,CAAA;wBAC1B,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE;4BAC3D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;yBACpC;wBAED,IACE,CAAC,cAAc,CAAC,MAAM;4BACtB,cAAc,CAAC,SAAS;4BACxB,cAAc,CAAC,SAAS,EACxB;4BACA,MAAM,CAAC,GAAG,cAAc,CAAC,YAAY;gCACnC,CAAC,CAAC,cAAc,CAAC,SAAS;gCAC1B,CAAC,CAAC,cAAc,CAAC,SAAS,CAAA;4BAC5B,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;yBACd;wBAED,SAAS,GAAG,IAAI,CAAC,kBAAkB,CACjC,IAAI,EACJ,SAAS,EACT,CAAC,IAAY,EAAE,EAAE;4BACf,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE;gCAC5D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;6BACrC;wBACH,CAAC,CACF,CAAA;oBACH,CAAC,CAAC,CAAA;iBACH;gBAED,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;oBAC5B,KAAK,CAAC,YAAY,GAAG,GAAG,CAAC,OAAO,CAAA;oBAChC,KAAK,CAAC,aAAa,GAAG,IAAI,CAAA;oBAC1B,KAAK,CAAC,aAAa,GAAG,IAAI,CAAA;oBAC1B,KAAK,CAAC,aAAa,EAAE,CAAA;gBACvB,CAAC,CAAC,CAAA;gBAEF,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;oBAC7B,KAAK,CAAC,eAAe,GAAG,IAAI,CAAA;oBAC5B,KAAK,CAAC,aAAa,GAAG,IAAI,CAAA;oBAC1B,IAAI,CAAC,MAAM,CAAC,aAAa,IAAI,wBAAwB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;oBACtE,KAAK,CAAC,aAAa,EAAE,CAAA;gBACvB,CAAC,CAAC,CAAA;gBAEF,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAY,EAAE,EAAE;oBAC9B,KAAK,CAAC,eAAe,GAAG,IAAI,CAAA;oBAC5B,KAAK,CAAC,aAAa,GAAG,IAAI,CAAA;oBAC1B,KAAK,CAAC,aAAa,GAAG,IAAI,CAAA;oBAC1B,IAAI,CAAC,MAAM,CAAC,uCAAuC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;oBACpE,KAAK,CAAC,aAAa,EAAE,CAAA;gBACvB,CAAC,CAAC,CAAA;gBAEF,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAY,EAAE,QAAgB,EAAE,EAAE;oBAClD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;wBACxB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;qBAChC;oBAED,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;wBACxB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;qBAChC;oBAED,EAAE,CAAC,kBAAkB,EAAE,CAAA;oBAEvB,IAAI,KAAK,EAAE;wBACT,MAAM,CAAC,KAAK,CAAC,CAAA;qBACd;yBAAM;wBACL,OAAO,CAAC,QAAQ,CAAC,CAAA;qBAClB;gBACH,CAAC,CAAC,CAAA;gBAEF,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;oBACtB,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE;wBACb,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;qBAC/C;oBAED,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;iBACjC;YACH,CAAC,CAAA,CAAC,CAAA;QACJ,CAAC;KAAA;CACF;AAthBD,gCAshBC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,SAAiB;IAChD,MAAM,IAAI,GAAa,EAAE,CAAA;IAEzB,IAAI,QAAQ,GAAG,KAAK,CAAA;IACpB,IAAI,OAAO,GAAG,KAAK,CAAA;IACnB,IAAI,GAAG,GAAG,EAAE,CAAA;IAEZ,SAAS,MAAM,CAAC,CAAS;QACvB,gCAAgC;QAChC,IAAI,OAAO,IAAI,CAAC,KAAK,GAAG,EAAE;YACxB,GAAG,IAAI,IAAI,CAAA;SACZ;QAED,GAAG,IAAI,CAAC,CAAA;QACR,OAAO,GAAG,KAAK,CAAA;IACjB,CAAC;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACzC,MAAM,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QAE7B,IAAI,CAAC,KAAK,GAAG,EAAE;YACb,IAAI,CAAC,OAAO,EAAE;gBACZ,QAAQ,GAAG,CAAC,QAAQ,CAAA;aACrB;iBAAM;gBACL,MAAM,CAAC,CAAC,CAAC,CAAA;aACV;YACD,SAAQ;SACT;QAED,IAAI,CAAC,KAAK,IAAI,IAAI,OAAO,EAAE;YACzB,MAAM,CAAC,CAAC,CAAC,CAAA;YACT,SAAQ;SACT;QAED,IAAI,CAAC,KAAK,IAAI,IAAI,QAAQ,EAAE;YAC1B,OAAO,GAAG,IAAI,CAAA;YACd,SAAQ;SACT;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE;YAC1B,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;gBAClB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBACd,GAAG,GAAG,EAAE,CAAA;aACT;YACD,SAAQ;SACT;QAED,MAAM,CAAC,CAAC,CAAC,CAAA;KACV;IAED,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;QAClB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;KACtB;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAvDD,4CAuDC;AAED,MAAM,SAAU,SAAQ,MAAM,CAAC,YAAY;IACzC,YAAY,OAAuB,EAAE,QAAgB;QACnD,KAAK,EAAE,CAAA;QAaT,kBAAa,GAAG,KAAK,CAAA,CAAC,4DAA4D;QAClF,iBAAY,GAAG,EAAE,CAAA;QACjB,oBAAe,GAAG,CAAC,CAAA;QACnB,kBAAa,GAAG,KAAK,CAAA,CAAC,wCAAwC;QAC9D,kBAAa,GAAG,KAAK,CAAA,CAAC,uCAAuC;QACrD,UAAK,GAAG,KAAK,CAAA,CAAC,aAAa;QAC3B,SAAI,GAAG,KAAK,CAAA;QAEZ,YAAO,GAAwB,IAAI,CAAA;QAnBzC,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;SAC9C;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,OAAO,CAAC,KAAK,EAAE;YACjB,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;SAC3B;IACH,CAAC;IAaD,aAAa;QACX,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,OAAM;SACP;QAED,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,IAAI,CAAC,UAAU,EAAE,CAAA;SAClB;aAAM,IAAI,IAAI,CAAC,aAAa,EAAE;YAC7B,IAAI,CAAC,OAAO,GAAG,mBAAU,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;SACrE;IACH,CAAC;IAEO,MAAM,CAAC,OAAe;QAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAC7B,CAAC;IAEO,UAAU;QAChB,sCAAsC;QACtC,IAAI,KAAwB,CAAA;QAC5B,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,IAAI,IAAI,CAAC,YAAY,EAAE;gBACrB,KAAK,GAAG,IAAI,KAAK,CACf,8DAA8D,IAAI,CAAC,QAAQ,4DAA4D,IAAI,CAAC,YAAY,EAAE,CAC3J,CAAA;aACF;iBAAM,IAAI,IAAI,CAAC,eAAe,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE;gBACvE,KAAK,GAAG,IAAI,KAAK,CACf,gBAAgB,IAAI,CAAC,QAAQ,2BAA2B,IAAI,CAAC,eAAe,EAAE,CAC/E,CAAA;aACF;iBAAM,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;gBAC1D,KAAK,GAAG,IAAI,KAAK,CACf,gBAAgB,IAAI,CAAC,QAAQ,sEAAsE,CACpG,CAAA;aACF;SACF;QAED,oBAAoB;QACpB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC1B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;SACpB;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,CAAA;IAChD,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,KAAgB;QAC3C,IAAI,KAAK,CAAC,IAAI,EAAE;YACd,OAAM;SACP;QAED,IAAI,CAAC,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,aAAa,EAAE;YAC/C,MAAM,OAAO,GAAG,0CAA0C,KAAK,CAAC,KAAK;gBACnE,IAAI,4CACJ,KAAK,CAAC,QACR,0FAA0F,CAAA;YAC1F,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;SACtB;QAED,KAAK,CAAC,UAAU,EAAE,CAAA;IACpB,CAAC;CACF"} \ No newline at end of file diff --git a/node_modules/@actions/exec/package.json b/node_modules/@actions/exec/package.json new file mode 100644 index 00000000..ff0cebfe --- /dev/null +++ b/node_modules/@actions/exec/package.json @@ -0,0 +1,41 @@ +{ + "name": "@actions/exec", + "version": "1.1.0", + "description": "Actions exec lib", + "keywords": [ + "github", + "actions", + "exec" + ], + "homepage": "https://github.com/actions/toolkit/tree/main/packages/exec", + "license": "MIT", + "main": "lib/exec.js", + "types": "lib/exec.d.ts", + "directories": { + "lib": "lib", + "test": "__tests__" + }, + "files": [ + "lib", + "!.DS_Store" + ], + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/actions/toolkit.git", + "directory": "packages/exec" + }, + "scripts": { + "audit-moderate": "npm install && npm audit --json --audit-level=moderate > audit.json", + "test": "echo \"Error: run tests from root\" && exit 1", + "tsc": "tsc" + }, + "bugs": { + "url": "https://github.com/actions/toolkit/issues" + }, + "dependencies": { + "@actions/io": "^1.0.1" + } +} diff --git a/node_modules/@actions/github/LICENSE.md b/node_modules/@actions/github/LICENSE.md new file mode 100644 index 00000000..dbae2edb --- /dev/null +++ b/node_modules/@actions/github/LICENSE.md @@ -0,0 +1,9 @@ +The MIT License (MIT) + +Copyright 2019 GitHub + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/node_modules/@actions/github/README.md b/node_modules/@actions/github/README.md new file mode 100644 index 00000000..21daad31 --- /dev/null +++ b/node_modules/@actions/github/README.md @@ -0,0 +1,97 @@ +# `@actions/github` + +> A hydrated Octokit client. + +## Usage + +Returns an authenticated Octokit client that follows the machine [proxy settings](https://help.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners) and correctly sets GHES base urls. See https://octokit.github.io/rest.js for the API. + +```js +const github = require('@actions/github'); +const core = require('@actions/core'); + +async function run() { + // This should be a token with access to your repository scoped in as a secret. + // The YML workflow will need to set myToken with the GitHub Secret Token + // myToken: ${{ secrets.GITHUB_TOKEN }} + // https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token#about-the-github_token-secret + const myToken = core.getInput('myToken'); + + const octokit = github.getOctokit(myToken) + + // You can also pass in additional options as a second parameter to getOctokit + // const octokit = github.getOctokit(myToken, {userAgent: "MyActionVersion1"}); + + const { data: pullRequest } = await octokit.rest.pulls.get({ + owner: 'octokit', + repo: 'rest.js', + pull_number: 123, + mediaType: { + format: 'diff' + } + }); + + console.log(pullRequest); +} + +run(); +``` + +You can also make GraphQL requests. See https://github.com/octokit/graphql.js for the API. + +```js +const result = await octokit.graphql(query, variables); +``` + +Finally, you can get the context of the current action: + +```js +const github = require('@actions/github'); + +const context = github.context; + +const newIssue = await octokit.rest.issues.create({ + ...context.repo, + title: 'New issue!', + body: 'Hello Universe!' +}); +``` + +## Webhook payload typescript definitions + +The npm module `@octokit/webhooks` provides type definitions for the response payloads. You can cast the payload to these types for better type information. + +First, install the npm module `npm install @octokit/webhooks` + +Then, assert the type based on the eventName +```ts +import * as core from '@actions/core' +import * as github from '@actions/github' +import * as Webhooks from '@octokit/webhooks' +if (github.context.eventName === 'push') { + const pushPayload = github.context.payload as Webhooks.WebhookPayloadPush + core.info(`The head commit is: ${pushPayload.head}`) +} +``` + +## Extending the Octokit instance +`@octokit/core` now supports the [plugin architecture](https://github.com/octokit/core.js#plugins). You can extend the GitHub instance using plugins. + +For example, using the `@octokit/plugin-enterprise-server` you can now access enterprise admin apis on GHES instances. + +```ts +import { GitHub, getOctokitOptions } from '@actions/github/lib/utils' +import { enterpriseServer220Admin } from '@octokit/plugin-enterprise-server' + +const octokit = GitHub.plugin(enterpriseServer220Admin) +// or override some of the default values as well +// const octokit = GitHub.plugin(enterpriseServer220Admin).defaults({userAgent: "MyNewUserAgent"}) + +const myToken = core.getInput('myToken'); +const myOctokit = new octokit(getOctokitOptions(token)) +// Create a new user +myOctokit.rest.enterpriseAdmin.createUser({ + login: "testuser", + email: "testuser@test.com", +}); +``` diff --git a/node_modules/@actions/github/lib/context.d.ts b/node_modules/@actions/github/lib/context.d.ts new file mode 100644 index 00000000..7d3a7de4 --- /dev/null +++ b/node_modules/@actions/github/lib/context.d.ts @@ -0,0 +1,32 @@ +import { WebhookPayload } from './interfaces'; +export declare class Context { + /** + * Webhook payload object that triggered the workflow + */ + payload: WebhookPayload; + eventName: string; + sha: string; + ref: string; + workflow: string; + action: string; + actor: string; + job: string; + runNumber: number; + runId: number; + apiUrl: string; + serverUrl: string; + graphqlUrl: string; + /** + * Hydrate the context from the environment + */ + constructor(); + get issue(): { + owner: string; + repo: string; + number: number; + }; + get repo(): { + owner: string; + repo: string; + }; +} diff --git a/node_modules/@actions/github/lib/context.js b/node_modules/@actions/github/lib/context.js new file mode 100644 index 00000000..767933ce --- /dev/null +++ b/node_modules/@actions/github/lib/context.js @@ -0,0 +1,54 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.Context = void 0; +const fs_1 = require("fs"); +const os_1 = require("os"); +class Context { + /** + * Hydrate the context from the environment + */ + constructor() { + var _a, _b, _c; + this.payload = {}; + if (process.env.GITHUB_EVENT_PATH) { + if (fs_1.existsSync(process.env.GITHUB_EVENT_PATH)) { + this.payload = JSON.parse(fs_1.readFileSync(process.env.GITHUB_EVENT_PATH, { encoding: 'utf8' })); + } + else { + const path = process.env.GITHUB_EVENT_PATH; + process.stdout.write(`GITHUB_EVENT_PATH ${path} does not exist${os_1.EOL}`); + } + } + this.eventName = process.env.GITHUB_EVENT_NAME; + this.sha = process.env.GITHUB_SHA; + this.ref = process.env.GITHUB_REF; + this.workflow = process.env.GITHUB_WORKFLOW; + this.action = process.env.GITHUB_ACTION; + this.actor = process.env.GITHUB_ACTOR; + this.job = process.env.GITHUB_JOB; + this.runNumber = parseInt(process.env.GITHUB_RUN_NUMBER, 10); + this.runId = parseInt(process.env.GITHUB_RUN_ID, 10); + this.apiUrl = (_a = process.env.GITHUB_API_URL) !== null && _a !== void 0 ? _a : `https://api.github.com`; + this.serverUrl = (_b = process.env.GITHUB_SERVER_URL) !== null && _b !== void 0 ? _b : `https://github.com`; + this.graphqlUrl = (_c = process.env.GITHUB_GRAPHQL_URL) !== null && _c !== void 0 ? _c : `https://api.github.com/graphql`; + } + get issue() { + const payload = this.payload; + return Object.assign(Object.assign({}, this.repo), { number: (payload.issue || payload.pull_request || payload).number }); + } + get repo() { + if (process.env.GITHUB_REPOSITORY) { + const [owner, repo] = process.env.GITHUB_REPOSITORY.split('/'); + return { owner, repo }; + } + if (this.payload.repository) { + return { + owner: this.payload.repository.owner.login, + repo: this.payload.repository.name + }; + } + throw new Error("context.repo requires a GITHUB_REPOSITORY environment variable like 'owner/repo'"); + } +} +exports.Context = Context; +//# sourceMappingURL=context.js.map \ No newline at end of file diff --git a/node_modules/@actions/github/lib/context.js.map b/node_modules/@actions/github/lib/context.js.map new file mode 100644 index 00000000..91fb9a9d --- /dev/null +++ b/node_modules/@actions/github/lib/context.js.map @@ -0,0 +1 @@ +{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":";;;AAEA,2BAA2C;AAC3C,2BAAsB;AAEtB,MAAa,OAAO;IAmBlB;;OAEG;IACH;;QACE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,IAAI,eAAU,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,EAAE;gBAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CACvB,iBAAY,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAChE,CAAA;aACF;iBAAM;gBACL,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;gBAC1C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,IAAI,kBAAkB,QAAG,EAAE,CAAC,CAAA;aACvE;SACF;QACD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,iBAA2B,CAAA;QACxD,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAoB,CAAA;QAC3C,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAoB,CAAA;QAC3C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,eAAyB,CAAA;QACrD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,aAAuB,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,YAAsB,CAAA;QAC/C,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,UAAoB,CAAA;QAC3C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAA2B,EAAE,EAAE,CAAC,CAAA;QACtE,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAuB,EAAE,EAAE,CAAC,CAAA;QAC9D,IAAI,CAAC,MAAM,SAAG,OAAO,CAAC,GAAG,CAAC,cAAc,mCAAI,wBAAwB,CAAA;QACpE,IAAI,CAAC,SAAS,SAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,mCAAI,oBAAoB,CAAA;QACtE,IAAI,CAAC,UAAU,SACb,OAAO,CAAC,GAAG,CAAC,kBAAkB,mCAAI,gCAAgC,CAAA;IACtE,CAAC;IAED,IAAI,KAAK;QACP,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAE5B,uCACK,IAAI,CAAC,IAAI,KACZ,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,CAAC,MAAM,IAClE;IACH,CAAC;IAED,IAAI,IAAI;QACN,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE;YACjC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC9D,OAAO,EAAC,KAAK,EAAE,IAAI,EAAC,CAAA;SACrB;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YAC3B,OAAO;gBACL,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK;gBAC1C,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI;aACnC,CAAA;SACF;QAED,MAAM,IAAI,KAAK,CACb,kFAAkF,CACnF,CAAA;IACH,CAAC;CACF;AA3ED,0BA2EC"} \ No newline at end of file diff --git a/node_modules/@actions/github/lib/github.d.ts b/node_modules/@actions/github/lib/github.d.ts new file mode 100644 index 00000000..90c3b985 --- /dev/null +++ b/node_modules/@actions/github/lib/github.d.ts @@ -0,0 +1,11 @@ +import * as Context from './context'; +import { GitHub } from './utils'; +import { OctokitOptions } from '@octokit/core/dist-types/types'; +export declare const context: Context.Context; +/** + * Returns a hydrated octokit ready to use for GitHub Actions + * + * @param token the repo PAT or GITHUB_TOKEN + * @param options other options to set + */ +export declare function getOctokit(token: string, options?: OctokitOptions): InstanceType; diff --git a/node_modules/@actions/github/lib/github.js b/node_modules/@actions/github/lib/github.js new file mode 100644 index 00000000..f02c9fb6 --- /dev/null +++ b/node_modules/@actions/github/lib/github.js @@ -0,0 +1,36 @@ +"use strict"; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.getOctokit = exports.context = void 0; +const Context = __importStar(require("./context")); +const utils_1 = require("./utils"); +exports.context = new Context.Context(); +/** + * Returns a hydrated octokit ready to use for GitHub Actions + * + * @param token the repo PAT or GITHUB_TOKEN + * @param options other options to set + */ +function getOctokit(token, options) { + return new utils_1.GitHub(utils_1.getOctokitOptions(token, options)); +} +exports.getOctokit = getOctokit; +//# sourceMappingURL=github.js.map \ No newline at end of file diff --git a/node_modules/@actions/github/lib/github.js.map b/node_modules/@actions/github/lib/github.js.map new file mode 100644 index 00000000..717d03e8 --- /dev/null +++ b/node_modules/@actions/github/lib/github.js.map @@ -0,0 +1 @@ +{"version":3,"file":"github.js","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAoC;AACpC,mCAAiD;AAKpC,QAAA,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;AAE5C;;;;;GAKG;AACH,SAAgB,UAAU,CACxB,KAAa,EACb,OAAwB;IAExB,OAAO,IAAI,cAAM,CAAC,yBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AACtD,CAAC;AALD,gCAKC"} \ No newline at end of file diff --git a/node_modules/@actions/github/lib/interfaces.d.ts b/node_modules/@actions/github/lib/interfaces.d.ts new file mode 100644 index 00000000..f8103332 --- /dev/null +++ b/node_modules/@actions/github/lib/interfaces.d.ts @@ -0,0 +1,40 @@ +export interface PayloadRepository { + [key: string]: any; + full_name?: string; + name: string; + owner: { + [key: string]: any; + login: string; + name?: string; + }; + html_url?: string; +} +export interface WebhookPayload { + [key: string]: any; + repository?: PayloadRepository; + issue?: { + [key: string]: any; + number: number; + html_url?: string; + body?: string; + }; + pull_request?: { + [key: string]: any; + number: number; + html_url?: string; + body?: string; + }; + sender?: { + [key: string]: any; + type: string; + }; + action?: string; + installation?: { + id: number; + [key: string]: any; + }; + comment?: { + id: number; + [key: string]: any; + }; +} diff --git a/node_modules/@actions/github/lib/interfaces.js b/node_modules/@actions/github/lib/interfaces.js new file mode 100644 index 00000000..a660b5e3 --- /dev/null +++ b/node_modules/@actions/github/lib/interfaces.js @@ -0,0 +1,4 @@ +"use strict"; +/* eslint-disable @typescript-eslint/no-explicit-any */ +Object.defineProperty(exports, "__esModule", { value: true }); +//# sourceMappingURL=interfaces.js.map \ No newline at end of file diff --git a/node_modules/@actions/github/lib/interfaces.js.map b/node_modules/@actions/github/lib/interfaces.js.map new file mode 100644 index 00000000..dc2c9609 --- /dev/null +++ b/node_modules/@actions/github/lib/interfaces.js.map @@ -0,0 +1 @@ +{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA,uDAAuD"} \ No newline at end of file diff --git a/node_modules/@actions/github/lib/internal/utils.d.ts b/node_modules/@actions/github/lib/internal/utils.d.ts new file mode 100644 index 00000000..5790d91f --- /dev/null +++ b/node_modules/@actions/github/lib/internal/utils.d.ts @@ -0,0 +1,6 @@ +/// +import * as http from 'http'; +import { OctokitOptions } from '@octokit/core/dist-types/types'; +export declare function getAuthString(token: string, options: OctokitOptions): string | undefined; +export declare function getProxyAgent(destinationUrl: string): http.Agent; +export declare function getApiBaseUrl(): string; diff --git a/node_modules/@actions/github/lib/internal/utils.js b/node_modules/@actions/github/lib/internal/utils.js new file mode 100644 index 00000000..175a4dae --- /dev/null +++ b/node_modules/@actions/github/lib/internal/utils.js @@ -0,0 +1,43 @@ +"use strict"; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.getApiBaseUrl = exports.getProxyAgent = exports.getAuthString = void 0; +const httpClient = __importStar(require("@actions/http-client")); +function getAuthString(token, options) { + if (!token && !options.auth) { + throw new Error('Parameter token or opts.auth is required'); + } + else if (token && options.auth) { + throw new Error('Parameters token and opts.auth may not both be specified'); + } + return typeof options.auth === 'string' ? options.auth : `token ${token}`; +} +exports.getAuthString = getAuthString; +function getProxyAgent(destinationUrl) { + const hc = new httpClient.HttpClient(); + return hc.getAgent(destinationUrl); +} +exports.getProxyAgent = getProxyAgent; +function getApiBaseUrl() { + return process.env['GITHUB_API_URL'] || 'https://api.github.com'; +} +exports.getApiBaseUrl = getApiBaseUrl; +//# sourceMappingURL=utils.js.map \ No newline at end of file diff --git a/node_modules/@actions/github/lib/internal/utils.js.map b/node_modules/@actions/github/lib/internal/utils.js.map new file mode 100644 index 00000000..f1f519d5 --- /dev/null +++ b/node_modules/@actions/github/lib/internal/utils.js.map @@ -0,0 +1 @@ +{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/internal/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AACA,iEAAkD;AAGlD,SAAgB,aAAa,CAC3B,KAAa,EACb,OAAuB;IAEvB,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;KAC5D;SAAM,IAAI,KAAK,IAAI,OAAO,CAAC,IAAI,EAAE;QAChC,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;KAC5E;IAED,OAAO,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,KAAK,EAAE,CAAA;AAC3E,CAAC;AAXD,sCAWC;AAED,SAAgB,aAAa,CAAC,cAAsB;IAClD,MAAM,EAAE,GAAG,IAAI,UAAU,CAAC,UAAU,EAAE,CAAA;IACtC,OAAO,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;AACpC,CAAC;AAHD,sCAGC;AAED,SAAgB,aAAa;IAC3B,OAAO,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,wBAAwB,CAAA;AAClE,CAAC;AAFD,sCAEC"} \ No newline at end of file diff --git a/node_modules/@actions/github/lib/utils.d.ts b/node_modules/@actions/github/lib/utils.d.ts new file mode 100644 index 00000000..fe28cbd3 --- /dev/null +++ b/node_modules/@actions/github/lib/utils.d.ts @@ -0,0 +1,14 @@ +import * as Context from './context'; +import { Octokit } from '@octokit/core'; +import { OctokitOptions } from '@octokit/core/dist-types/types'; +export declare const context: Context.Context; +export declare const GitHub: typeof Octokit & import("@octokit/core/dist-types/types").Constructor; +/** + * Convience function to correctly format Octokit Options to pass into the constructor. + * + * @param token the repo PAT or GITHUB_TOKEN + * @param options other options to set + */ +export declare function getOctokitOptions(token: string, options?: OctokitOptions): OctokitOptions; diff --git a/node_modules/@actions/github/lib/utils.js b/node_modules/@actions/github/lib/utils.js new file mode 100644 index 00000000..afb40e95 --- /dev/null +++ b/node_modules/@actions/github/lib/utils.js @@ -0,0 +1,54 @@ +"use strict"; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.getOctokitOptions = exports.GitHub = exports.context = void 0; +const Context = __importStar(require("./context")); +const Utils = __importStar(require("./internal/utils")); +// octokit + plugins +const core_1 = require("@octokit/core"); +const plugin_rest_endpoint_methods_1 = require("@octokit/plugin-rest-endpoint-methods"); +const plugin_paginate_rest_1 = require("@octokit/plugin-paginate-rest"); +exports.context = new Context.Context(); +const baseUrl = Utils.getApiBaseUrl(); +const defaults = { + baseUrl, + request: { + agent: Utils.getProxyAgent(baseUrl) + } +}; +exports.GitHub = core_1.Octokit.plugin(plugin_rest_endpoint_methods_1.restEndpointMethods, plugin_paginate_rest_1.paginateRest).defaults(defaults); +/** + * Convience function to correctly format Octokit Options to pass into the constructor. + * + * @param token the repo PAT or GITHUB_TOKEN + * @param options other options to set + */ +function getOctokitOptions(token, options) { + const opts = Object.assign({}, options || {}); // Shallow clone - don't mutate the object provided by the caller + // Auth + const auth = Utils.getAuthString(token, opts); + if (auth) { + opts.auth = auth; + } + return opts; +} +exports.getOctokitOptions = getOctokitOptions; +//# sourceMappingURL=utils.js.map \ No newline at end of file diff --git a/node_modules/@actions/github/lib/utils.js.map b/node_modules/@actions/github/lib/utils.js.map new file mode 100644 index 00000000..3a6f6b42 --- /dev/null +++ b/node_modules/@actions/github/lib/utils.js.map @@ -0,0 +1 @@ +{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAoC;AACpC,wDAAyC;AAEzC,oBAAoB;AACpB,wCAAqC;AAErC,wFAAyE;AACzE,wEAA0D;AAE7C,QAAA,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;AAE5C,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,EAAE,CAAA;AACrC,MAAM,QAAQ,GAAG;IACf,OAAO;IACP,OAAO,EAAE;QACP,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC;KACpC;CACF,CAAA;AAEY,QAAA,MAAM,GAAG,cAAO,CAAC,MAAM,CAClC,kDAAmB,EACnB,mCAAY,CACb,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAEpB;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,KAAa,EACb,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,IAAI,EAAE,CAAC,CAAA,CAAC,iEAAiE;IAE/G,OAAO;IACP,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAC7C,IAAI,IAAI,EAAE;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;KACjB;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAbD,8CAaC"} \ No newline at end of file diff --git a/node_modules/@actions/github/package.json b/node_modules/@actions/github/package.json new file mode 100644 index 00000000..091cebce --- /dev/null +++ b/node_modules/@actions/github/package.json @@ -0,0 +1,50 @@ +{ + "name": "@actions/github", + "version": "5.0.0", + "description": "Actions github lib", + "keywords": [ + "github", + "actions" + ], + "homepage": "https://github.com/actions/toolkit/tree/main/packages/github", + "license": "MIT", + "main": "lib/github.js", + "types": "lib/github.d.ts", + "directories": { + "lib": "lib", + "test": "__tests__" + }, + "files": [ + "lib", + "!.DS_Store" + ], + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/actions/toolkit.git", + "directory": "packages/github" + }, + "scripts": { + "audit-moderate": "npm install && npm audit --json --audit-level=moderate > audit.json", + "test": "jest", + "build": "tsc", + "format": "prettier --write **/*.ts", + "format-check": "prettier --check **/*.ts", + "tsc": "tsc" + }, + "bugs": { + "url": "https://github.com/actions/toolkit/issues" + }, + "dependencies": { + "@actions/http-client": "^1.0.11", + "@octokit/core": "^3.4.0", + "@octokit/plugin-paginate-rest": "^2.13.3", + "@octokit/plugin-rest-endpoint-methods": "^5.1.1" + }, + "devDependencies": { + "jest": "^26.6.3", + "proxy": "^1.0.2" + } +} diff --git a/node_modules/@actions/http-client/LICENSE b/node_modules/@actions/http-client/LICENSE new file mode 100644 index 00000000..5823a51c --- /dev/null +++ b/node_modules/@actions/http-client/LICENSE @@ -0,0 +1,21 @@ +Actions Http Client for Node.js + +Copyright (c) GitHub, Inc. + +All rights reserved. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and +associated documentation files (the "Software"), to deal in the Software without restriction, +including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT +LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN +NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/@actions/http-client/README.md b/node_modules/@actions/http-client/README.md new file mode 100644 index 00000000..be61eb35 --- /dev/null +++ b/node_modules/@actions/http-client/README.md @@ -0,0 +1,79 @@ + +

+ +

+ +# Actions Http-Client + +[![Http Status](https://github.com/actions/http-client/workflows/http-tests/badge.svg)](https://github.com/actions/http-client/actions) + +A lightweight HTTP client optimized for use with actions, TypeScript with generics and async await. + +## Features + + - HTTP client with TypeScript generics and async/await/Promises + - Typings included so no need to acquire separately (great for intellisense and no versioning drift) + - [Proxy support](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners#using-a-proxy-server-with-self-hosted-runners) just works with actions and the runner + - Targets ES2019 (runner runs actions with node 12+). Only supported on node 12+. + - Basic, Bearer and PAT Support out of the box. Extensible handlers for others. + - Redirects supported + +Features and releases [here](./RELEASES.md) + +## Install + +``` +npm install @actions/http-client --save +``` + +## Samples + +See the [HTTP](./__tests__) tests for detailed examples. + +## Errors + +### HTTP + +The HTTP client does not throw unless truly exceptional. + +* A request that successfully executes resulting in a 404, 500 etc... will return a response object with a status code and a body. +* Redirects (3xx) will be followed by default. + +See [HTTP tests](./__tests__) for detailed examples. + +## Debugging + +To enable detailed console logging of all HTTP requests and responses, set the NODE_DEBUG environment varible: + +``` +export NODE_DEBUG=http +``` + +## Node support + +The http-client is built using the latest LTS version of Node 12. It may work on previous node LTS versions but it's tested and officially supported on Node12+. + +## Support and Versioning + +We follow semver and will hold compatibility between major versions and increment the minor version with new features and capabilities (while holding compat). + +## Contributing + +We welcome PRs. Please create an issue and if applicable, a design before proceeding with code. + +once: + +```bash +$ npm install +``` + +To build: + +```bash +$ npm run build +``` + +To run all tests: +```bash +$ npm test +``` diff --git a/node_modules/@actions/http-client/RELEASES.md b/node_modules/@actions/http-client/RELEASES.md new file mode 100644 index 00000000..935178a8 --- /dev/null +++ b/node_modules/@actions/http-client/RELEASES.md @@ -0,0 +1,26 @@ +## Releases + +## 1.0.10 + +Contains a bug fix where proxy is defined without a user and password. see [PR here](https://github.com/actions/http-client/pull/42) + +## 1.0.9 +Throw HttpClientError instead of a generic Error from the \Json() helper methods when the server responds with a non-successful status code. + +## 1.0.8 +Fixed security issue where a redirect (e.g. 302) to another domain would pass headers. The fix was to strip the authorization header if the hostname was different. More [details in PR #27](https://github.com/actions/http-client/pull/27) + +## 1.0.7 +Update NPM dependencies and add 429 to the list of HttpCodes + +## 1.0.6 +Automatically sends Content-Type and Accept application/json headers for \Json() helper methods if not set in the client or parameters. + +## 1.0.5 +Adds \Json() helper methods for json over http scenarios. + +## 1.0.4 +Started to add \Json() helper methods. Do not use this release for that. Use >= 1.0.5 since there was an issue with types. + +## 1.0.1 to 1.0.3 +Adds proxy support. diff --git a/node_modules/@actions/http-client/actions.png b/node_modules/@actions/http-client/actions.png new file mode 100644 index 0000000000000000000000000000000000000000..1857ef375592b5bbce3f2b225865d32428c13acb GIT binary patch literal 33889 zcmdSAWpo|Qt{`fRDQ0Hon3-{RMHd;v*6ILy$;QPLW6i;9yF`M$b-X%*4t`#KA?+ z#Lmjd!v2MbnURT$fsvDeiG_}liJOs~n~j6$UyTGv&B4TsTUk{6U$lUCd?eqTob0$6 z7+hUl>0Mdq0S@L2Ok7+*9Lx;N%yd8qI!AX~Cqp+nTSwA=V-PiUGqpm$->BgQ>Nt zjj64ZBM_G9Kd^S+08RkMZ-D;|>i=~APXvIXm6Q7qjsJEmHa7nu;pimh0%YS~0{L&D z9aY`!Oc|6-9Rbb`#-?H}z+sa9;l_?z#KF|i3E-d#09gNfq7?r>^ zQFH*9Sy%%*9F--6iKN6t*qON4+3A?+nf?w}PL5m3*3rq(*4R`^l#c``9(oH46K)PB zE@o3k7Bf0CP9sJ-RxV=>I!;bjLpoLyBMwt8BMv53HXxzDbH*(SFn0c<1pj{D&H2-K1x1@z5a9-X2WjrdT_W!!FwjlbeFx-a5e++?-#Q2W}n3|CM z>#@cEwFLe_>-x1p?x8CM7DQ>Xvbu>DsQVHXoAhy>gqn z>gjO-V?maH7Jj?#i42M?D)#mzCxD8^MN~)-DP~>fTP~Eaq_D@u-aXHQd^VTk z*#p~?@D6P5-#$zn4QM@GVC$S}5kA}ow(HF`j3C7vn>+O_4d)TbAk)uwf) z8;`w+c_-s`{uq~fjZSKU_(txjUVgLF*r5@ox2}yds~nRvKJyBai8*h+XH2)_>wTS z>l>Cf1-`Q0bUD!G6Sg1=Z<@HccOuqJ)EsrAraGJyemSn=tSgGU-n(ge*Qke?Lon^l z?f1>*6$Tmu5zz`T$xn#I@~f& z)pq!{S}#k>bKTr=N^hC(h);+CEkfc1iXaJ9q0Y#`1A*|Yu1<@p)7(Dd(r7v8b&;db zu$R>JYHJ~4F>}(7bbZ6G1k|A{pfV+U6N2{EUV5Od|Hk>Y#Q${^^64;TR=x9xurQK0 zu3rbGQIv=kNf|UT0AxS>S27VABpwn9p!2)Xnam!MLiW|{D#oal$#a2e-HeZ2dS;se z@`zkYY480XjfMtl^s;#@3L3g9KCgToH`{B56`>S-+msKMuhddBK6q)MI=vtm0uj|~ zNAa+{UxOgkS5+93PuEQTir%EnoqMmh7l8pBU*%fYcygXFQ#fzF)-sOev%*Hr5*l|Qyo3@&8%9t6QQm@_JH{{3oCP_Azu?;k zcAQh%v=Hv zhbCMA5+8oN%C?IdyQ5s%+dW`Cg(lNylrZhV(L{L8{y2;9Oay4)}%s;!3-7zJ-?i zQ6<)XIp58`w70Ia`zp(?I|{RNLM+eit)nk{^19n_n8oUlJVgpOa+^w42j^q?oGB-z4tGyF#M9r(w8^bq_8lF^DllFIQre4Y@tMkw? zkBWO$ZtWG}i&|sX`!(tYK+Z&&3MxZHdHzVPXu6I+DsyBzC{8nLs!R}rg6$oheC0i~ z+h4t)aHA)*nY^!fD6cc$6r*|^y;z4F8Xpbxr`qHCfE+`Q)t}kSBsPg~+orc$jo2Jl5r%Z*sut1@U940uk?wYH?73~ksYH4FLwAS)n)a7$OSL1yPaQje?MRSE`^?ZbodVPvxus+MXIGbB!(vwU6~tN z4V*196SUlB`3oiWMnY4|1dq}4vRT8|4M7n1uoCXE**BlNHrFN_+Db$LthFSf>|Y;? zCJEBiN^0n8YOx>W+h^M|sKC{1#`ueu@7B4iq`$R+#1WJP;&OY`>KwiQN(Tj1Hxscj z&u0OlC)2)i$1YlZuT=I6u16Gn*3OnR!w{i#R~|KkXOuTTalu8^3Q;&6ntO>e1NjS5 zabyBs9HY#zBCKz)*Q60%D7jQ6x!fyB07-n6=En>S@1;@n+~e$LWwA_DB0R;NOKs!6 z4e`v^AMk`3Eg$VBDmZk97qKS~*>O^2SdAN;MFgygqP$n`gi#S={DJ>SxQ2x!L3vw> zlCk=Qm^O3gJ*OgnuwKR}a$9hP7TXR=4thakK^euwzR9rUkEv-b5TKk*z+4!uNfjn~A>jGPV-|pP6~@Twd|@oAm9M3i zlOEL3LR;+}Kd=i@c2baZ&_<%09w|Ze@iF)8O1Iqhm{$nIkSrt$DFfjdA^Qj#tEyY~ zeJJ8bMI5ZljqVD&O>SN@((oc~(zbj}uQq--%R5 zCSCI&DnD~)zpdu);cmQ4hvk0^dI*})1*Hxwugk78Qa9_Qq+4(rR1rRBPW;m8BfPcP z^y6SO{m!&Cy5ZT(&_bL3gE-Mc^!J#4c*rgr{OFk)+#kV;h&Gm zPJiZ_*~qoqVqA@fHfzaZCC{p?;u`%DzgYyOy(s|U-NeT0&O&-uttsk@ODYApq*?vz zo9803%|-XljrV%!?sna;P1szSXySZ)5R+~DXL+2-CZ&xoh zAr!d4g9N1p4i5!#6pVF_Og&Jj=<&I^6w7mb9A;gcOf_uv8=1$-7_xf~4N0%YITI?7 z+#E8k`8MlFb!Jg*zgU?_xRjP*xRUr|LHl0xi9mVVq|Nd?u%K2&yE#y)+ct}0A4#HF zOP2-S9?x$V7?5r(B*X*cI> zWx7wV#oezuAEkM*{#062W)j@(0GpZ*+-&dwcfo~2Zl?fOqXUPaGPcplk5%_t^n{nd zVD9X&fLJ}45sCDDQ$j?%J47_E1oH((d2et^Y!Ms45Vsr3>KiIO(irvlgSVz@_y@x* z5n6SzW9Pgo%0f{ zmI`V@=<~ai$7&J~S}clWX<^>;@SKRTP~Zw(IK*jh$wso=vv4#^Q90EMHGDU)k|jt2 zpFebS`bhrJwchlVNn48AqauE(MasJ6N#k3oa6utNP@X`f<#}2vNe=~=M5Q8_<$}OM zIHqMV2`FSF^e`{gT|NW)RV!+{_&d&g{S&_kg=;x%K2?D3WPyz*>K%(2^IJPySaTzq z@Q^6pMz{XhM^jX>Iv}n%q%XKc`6keK#{8(#ks@@l^SMA}rRJAfT5WLndS@_yhcq&I zq2$8@~RomQQ88|x3}+mCY#^3a01Ev)*k&`@|pJ8LR0uVS5rWJLN)M{AZu>ez}^oKWBmSIh9ZQ`%sT7P`Ok&-}oB zI;p=B^k-Af&| z2_i`$a3KQRmmK_67ESvdjp@-78czdXT?RJQlq!fR8Dh4Ny+!^MzH*CN$}lt>Gezo4Mfdvkn5{KaV?h=O|Mp9I zFYTv2=W@`_=yW(%J1CwQa^z-Ar zn#uvPkWlJ`537bveayM1JX)#PGKPMwKU%|Gl)ne*Sg#J4BL4M-s(4PwmQowY^4fD} zkNinF&&1if9L?@KmeBAJc#_sV?Cq-Hc`1rFQk+S_>RNIJ6U1q7D*1cZNIoa~lPp90 ztF5{F51AJueduyI--5lRVZuM{vEfw8IY<|?KXt6Q*gFdF+=!5`$3EPjMc^Qij*=FL z!Ehl9PEaECA@*>14X#Z77%-08G!Z;}Pb*`gzo;%XTIP@Er0G`w+P&IEzR^OkMfcPm zJq*<9{y$os|9s6Ob5=1+xk~W^e{asut4-uB*kDcHcMF~8HAr$R_E;+MaCAqX;Km+p#6dKhwkaG`>fVpwrX~d(?$7~pV*;cw4$Y}3mF#Se_taq zXO(pTcPQj|L&Sh(H?)X$N?`Wm&yFhM&w?KUBP0>#VC@o?KGnliUpihlaH5tS;slGh zbcN?pLm;%_>n@-iP$cOj7c&Mk-V#_m7NOTD=K=ajIn*Uh9PV@zmg(Z2gBaGFGWHgvJDY-%0&E~|VVtr*k!jq9 z?y6`CJu$Y$cnx1iy6*1I5JQ*itg)Y(5QK{}L^%^E=B>AHlD?*aK671+6YN#s&1yG( zXvEz=UhJlqUS!cEqI|A4SDha(z0*g`M2PwI!_0F80#7E728E|2eN^2c#V@(H!J2?| z9``a~AxE6wmsqyAE|P%9FRmtAl(|nJ(*T&e0IO%f9Cv*(5UCsL7NtVNII%9itlmLG zyH>%O6=+Y~;dBGXG1DH>w|02s6j&*G!gGe5AZo5B1 z2Pq@65Y`n2lQgrruGFc~W;bNB>9z%+N%n^}ifwa7#Y=E69C(bG)h8sm9qDKYQ`}H9 z{{ZI9Hi2Qh%rC>QJ6~&MczARD;vLZ_6JzBm!0Q+lsHJvN_PZK!^;D$TT~XBfRB5zx z#hV(gsIx z2Tg=PAvv{>!jaFN&pOCwj88Rr8c;B{n6`Y~y{BRkas^}HJ;+znb|SB+HT{wlVl}$4 zeQs-G^#g6!R)}#L@Z5Nf%u{h-+@Z>79e+K4IIN1Jz@YK@*^(3QN_=`fl#eq_*QSXJ z9QV^;bAc|I>Ir8Xysn+l99j5v81NP$33bE?LF2(v^6_rsXp4@GnXK?nY=f<5ufnoo z973oxz7fMN*`=@DYOvAiBlo4D?W8V65MA@bC^IQ%aqK?PN^8ZFrqK+JJB|k8=(*=D znWA`oZm*h`tprV*->^mn0y4)x(>d?X+i3BGb^%3aR$5BaeBLEgPM(|}JRw6Y0{`eB z*|Jm-c4)(!K)Rq^>PmEq=K1XaQwBO{s^%JnN4E!IcAGL6YwBmBeV_E@OFLQok#{3) z0?=y&{|yuNL=2+YtVEhk#C;hEr>0Fik+9PEA@6=3SXyGfhevi1fHW4S&Xt-Yb)BN{ zuZbGxy5``2uJPXdI-|o4V};#n9kHl>tU(zU2#^$?&yfI^Fh8i%VxnO~|K7EtMOa!( zZ&&g9iBdBhITAS{VVd`dgn91k$QP7!6u>exW!1B*8!>*3HooO#7pt1*mFb5PCB+b! z3>fzJOq9n2GBqm$AtKk4!WK&Fc?qJ%;MPasnWISB0DAgt6ks;N<8!@fVj}Vt`ec|U zk4Hh1PGmc*^>UT0ZZkc|mN2NYqmJLGOC~>BK%YY1%M1VJO|7LBYWnj$>UAL#?U1a` z2jAQNnH4AFwu+M1z-zi*k?;f_RicT<>e&0#{pgxNZ1Ed2X<>Lk;5OpTsFjR`?=i~d zcVWnj!9rHuw?{?52Wia;TpyKw%#$qh`?gFu+*sg;HbPpS#V)roS!?U1hKADK;&5o$ zh!rlj`#ozwHE&P@{uKYy4o$(2$|p&yEu)fSVEW49@6wLN=?2XP@7+v?wY!m^DOIW8 zKrqai(g-Cx3+5XUc|>khv@Nl4CuDF%@bn{;_+_4yIh(NtBvn?b5dh)ohOR9`bBgPI ze}}(iuQ4i~Ael2I>M8+Y9>@sWs;-UiYd#gbRh`J7d(~srJV9zufm#L|no_F5{uS1= z6d@>YbDAvoEgIUoE_A%cm5X2t^tOM-ra7y2YUJG$hF@9?-8d9}dlQ_&d?Ie(i@Q1e z^VLuu4Xj1SXSA1W*ewJ+4G5rRqW|@y?AA+?RkSiI^)|6MryQmd6p=ygl)tM#4o9G} zcqiQG&niKOgr!W~=B;WH@qf_Vhs8qxKGF*KOntAHg(%(M-fWfXwzRhg;8k6;ImnQ} zkn<*vJ>EjXClPJWtO(4TLr!Y=3WJ4NW{9U}{H<+GytH5}H3w>Kq(8^E%5-tOGr+w> zImL;shJw^%OW!l-@Eq4Rx^&J8QDyT|Qlmlgq(dHkEpo)Fyx3w}X?gxVJHo+b&E&mw zl0H=!V)K)L5;M8uPx_xvTtb4N)|C1#wDU<Y(@RL4IBsb1^-j$$C-CaoyDS7-&)bxDG9z?juL3R6*fu zUkV^Q4X56BH_XkG+Wpn_A4c9Kh-*}+Z)cPn?9ffk<<0vC%xkX@U1t^&#YRdrxkd!E z5P&t1r_XESL={n8D1D+OLGy^`TQL%vK z5qx0$%ixgvX;9qSNHxm|bQ-f6MduOaiL^7=W-B}!Sk4K0nRYy4nkmkbzrMYh4qC6Y{muPK8fhoD)SNSJ!z9!l*KaO5KpBmCTY1%HGKJemUB+Yu0A2~j z{p=^C-p_+ZLP$YKNE*z#gvSXmeR&Eq7g9oc;=K>Kn#pWEdnf`#f>$CgY$jv$t@blaj)>X6+g2hyqWi6_ ziryNNl~fb0xd+3*5r48MExeTc05~fDY*vgE|0Y<=Ye9hs+IKu^o#Jg{V6$_^%snbQ zUE^4$0wSFA4dJ^rY@JbY2vuuTmUWTS-c6Ts|CV{aB|l!co=49~d3F-#b5*v@n#%**);wSf zCb-tQ1|I#DjqJmPhXq03Q@k3S;dSptW_Pi7PgsR@c)weU^C>NMw8Qwty7hkT;;od4 z=~feL<(#XyjAZJRGxb|o=S~r$#i3#nq}mEJ5`DEO3%ke(?Pq?f;iT35*vUCPD>p6^ z4dbB9P)Pt5q3-L8lTFyVdFGGS6XC!eL6YxWPFS_^3Io_ISYL*V;H)x%lk ze60aN?dc3YHdX?EUvltN^IWAHH<JwGY?=EKa6+x0<=1dnX0p17ZI;OA&?hHXrHHBog&b0Or zD}+8WV+yuIT^;qCa!z(_#6Me3^Z$moqUmX_@6ic)RqU zRPL|%7vHLbjx%RRv=I-sEtsR^vZ+zAQ)ZW5&vg!$!p_Y)!x1G)+(owvkECjU{K_4IOMvJynI7e(A?|Jt6;c-I+sPeJWYG-l2>1-as zJM673w!2=OtuD;N4`9IAeSx#kQdL(qLckqAY_-Iz4mW%AOf&-)!95Uw8M7JV5}%Dp zo$hFylKxSrspo@P{Ro zb9Pb|NP)nT)4&Gr3hzVv1-^GMXMv8SSFKRP=k|hit)P`Dzb(K0k{oJ6rcNtZO_#{- z1lmpm_m#|OTI$bgYo;tv4lpAzrLQfM+D{Fsp+$of+PLW!8%oMbt> zLaj=`BpH7+E^@0^6dKxKxW(rZ`PW+V+CpMf>uMih7Jf>}KW3RV_rp*Na zR_FcRx(TMX1z{coprCbMvW%V!`ofid>kP0y($uxq4Qie#wcOk(&ipB=3=>5xGg=$n zng|-=Ek=H(hTUb;#^t+50u6e>NK|(C3@9bTRW!1zXLj2QWnUit?axhGs_^b`+aZp3 zlcH!sNfmy7r&Her#*u*mQ^MXK!0MJc#GyXkM9xiZwGYSB`o=|Er|=B9;^BK0Iy0YK z+ieY7y7(72Qu|Fg+6MnUeoAl?MQ@?G986??UDi*2+RDKblpKb3byA~X2&-hd5Bg&U zZQBSxD;!gO5*QPEBQ2QRC04$YllA0Y=U!sbkFyObeF@DO%ArBanMSB#p7lenB1;}` zH3Uk{7aOUt#(>+RytJQ!=+6oa`QYiB?(vj?*bk4;hnt))Q6&sj(gKB5~#o1+3^(y_s zUdWAy;pEzX$p7Wb@Bto4G4;cfM}#Bl#HJf~$?}&gFCM}KS;Lzp3szQJ@llUv*)-s| zh=HE#6ju^=>&o~5UR>6`N?!A+axAMEu)xL;F4V(@m?NYm86z_$8PBwREO`-YAQO>z z)4+Xk`kOroCf^AiOYYY4+bqZ$NHMFQwifc7@SDe88Wswc>&mx!cD`ATuctj$It5e6 z32NnSV!0&)M^n(Z=jrX8zXr{H60$NW0Z-6PmBfUlMLVY~-}ILv4`-$dM5VP(?P4WB z@mQjyF~DnFYni2C8)eW_2b*R}#J9MV&q==*3KLcGhL;hk;#yEJy$0{NxNsrD*Sre0 zL(*YFtwlHJMTd>~68_8V{t}1Uu?(mdzxO*_GC)V$Fn%VrdV&bv7cUrG*C^! zci2^UiUHQxB_f9kIwuth5NthWoANfV*tH@dqo4YtnmYXQc&RsHxtzi5;?u2bTJ0CR zpl;ePqrl=FP8p0hxN$T={8>rbZ_a2?mv9j6T#>oa0@6sdsG6C0DO=Gy<;7KxVwpX)@%oR?y3FhoiAVdQ`Xat zTfIvvx<=5Jxw)?p>`AD6>*I&8(4qKGS*0x9Pgf6ucOcwU`uG#YJGq(K#C8B%t zKvvkpl%WABA31BU`)o&plV{7*lraqDy|PwcvBG3O8Lm>f3o6-F;1Qs(9=zo?b9g8u zCMIXMZ)+^%Y7Yp7q$aQm>=LO$8lpWI!)CMxHZS@Vb4&GHuhv)gtib7e8LNzuir~_i zKV8Go8R`rZpriP2nM`LuFihyPH@qFv{@Undb#}YGh`fU5Qay8<5LyCr@}C05&Bzd) z?%~{(P3l7US!tkMXQ=xWkGlUZhIZ*vYoT&;t!;O9@jZ8LFd)b?*K(e)u`Rz|G&#!f6WNs&9lPmFp4J`5= zcI7fc{hf^Q(}>!UtFc=EidQqjos2j&&T zlE2CDi2Lk8Jv868&U|o&Y~T{rAPGI zY+wslqAw`y3h0ZjIZ3Vo@6|bcGk2E0)%K5{py(xSXYi<;cXj2zDL$Y%i6&Fy1{n(@ z!ow{^kF#|lf*=7H1v#UUGKw-}yO~=a_Jb?qE9#VQY38^+)Lii4rC*|*t0Sp;vaTdC z=JMJ7E+2g)c6}zHt!DO;*XE`u+agb&h;9DTPbnI%EbUZ{sip>JmE`HBJI^Z04)>jG z7v&MBY}f`aqiv99GfDN#&#q89HzZ@Jkn?e}Xqd303AV()H=9_%FOT|-LLY@1*UOS( zVsY4c?ZO^qDeu}idUas$=1(@+8%IoV-M^twP&~IT*~@$$%GaC2VQBmVszBWQ==^iycY^92kUEE4mmMyw3Zg#hAvx?k^6q2t3GU`U6w}tL^)Wa zv-L(x?5k3u<`rwW-LNM(r_5q58S1bXLG*HPQn>LQe2hFtMy{%^orDJ+=sY;Tw|PVn ze(2XgI=BFmgn)YCeKPe=ta3T0b$C?dkL`Y!J8pye){9Z;E9f=?bcc8JWBoI3G9-_z zHql^QfB198Eq5mIsGGFNK(^*yjkOd99F&Y%wP(HFAtLnOHZuaE$*?z4`+k z8g`?Lt2WibiSnlio| z8Y*wQWJl)>FsXg6cR5V56E?)X$j1i-sP^Y12OGQ2!QzjR&&`Z4L{>FQ@L`0aO%cLn z4ac}pWQ->Zk$W9X(s~AnQkHZ^69DKbrb)pDz?qG!5`W;TuRf7+Mv(-}^H;Y2f@YIU zoQIKDHWGz!NUl&r7qUd|Q*Tgfr)?yi)c#ls{^hlEm(1llgSE1=9Q{)g%wVc7zUvv^ z>Yz)Zrs0+}{n1-L=~t@6>&i#|N3BH2!UyStn+JYq*&zMwcyMk_{a3E9L4xzcaWWM( zi`DBPWu=nTq6Gl#&bnH+%QU6$=X7MOXEjRPIsG}_=m)=Oe->OUoh{;P95oEGWLdhT zmH@NFzky-?UKfJc^e{|t1%A%$8B}UTg_+1y{cE2oUoa?F@m($P{g}W*rT2G)N`ap{ z(Z#t2e54#4H}6Rkn(xoTEmYwONt@6$V>E}ejo;VN-P_S)PEa17?}|z{MjD#0R`hdk+3;6Rp6PLyhEmHhG()rT_9V zwsY~2y;hWkhE=mcePmM?y@k4DM*Lj@EDh8wAxF(~w{I?*OI3sCAjsc(X>4cxti zJU1M{PmwLd3r~h4(Wcyuv31U|gmT;#IkTZhR+1N(K@@cF8U9?;a*=9m$YNWu=-zIS&l`I*!GvXCUoSNTX&p1uzM;| zyheBXcNO||1dRa%fqkHHH1gMO5e%f#n^KXppO@J^8d)Gomt% z4UPRzjahUR;G^ddC{VZ3F`Z3`9mTF$KHbZaH%kg@NRrjQzLC<&3S+3ZRza@>mc80O zc&xb5Z_k-IPg86v3??Rb{ZWKwv(u4NOBSP;IZI#N&;YvuZ5Q*s`Ia)&VQZlPAwg#% zND~!{-YujpJGW*XDR)S5_9%|S!n?*5o_q#}1j^n?0BA81I*q>6lj_s!R5f$qg->}D z`f8TD36}M_L0&Y$&>$}Q6{XGWvW7gHSph8_QdrG!Olr9p91ERX@S0m9e0zK%>Xq!4>Eml&Rpz_)7u52Ug0j;?U#i*7 z{LYP&^p=6&P0zc-WzDhgYX`=&wOHVkvR|L)zRyMDO^7saNVT*l;D?hz91T*4XL^5G zzv#R~x6$7PW9A_oq^~GmDcw&{kkX&N81{cS6r`y%-pNM|(+OzL&*#JurXf4+jlaQS zWh;`h$!zPzUH39NEQ$EFaUFCQnp4et%CR)reC@`qL^y^wU_wC)mQ`!SV}?6#t2(*cSl`U{Vr@dFYT>z$`F*r2 zck2WTQdkh#_dLghl9E1;Y})BuMs6Nw(KU9jkyV7jCS0ZfL-zE$@AG`+)(;jVba<=94LZ%^kxQSFH!y)oEw;aT6Bn9}P*1s2*-zxqNvXk+{-|KAsIybh zX?ji_*Plo~1#!Arp*lGeAv~c(?VM_6L||dFS5zx;H24D+wb(%mecaCH`=t`ibv>@# z)_hJI&G(UFwA4TU4BDR~dCulUVh5OY%|;tfj})tnJQYY$CsNcOz2(1~ z1IK^!xN(tyTGe(e4UyW%PD<{+Z{D32uQ{AYMH&Zr8+sEA-^nTm=(bQ}mIy1Mp=9d0 zk(kQz-eWa^pbkbGK7TL1c}7LtI-AF|&{|sl+{p~Tk-}gw%ajb;Hx{*v#{+Lfb`_#e z8?}6Wrg6YMUvZf@t2;4%zPc;r+R)dZz`vc!trL#;WRrI6d3l zAF%G(8?anCLHYYq-bX(By`z2YCsX(*mjD#=amYo4-`oe=LV*%(1R}}5@c$HTBEz3o zqJNtg&OXwPj?nAMSrCP(!QF3D%nf2S))N*D7RPnDBGjvbPcYiu>UH)+VEtrY30YiP zFXMhx?2XI}EvrKU*z6{$Hrd)1aw5t1_QjNkoo7Yv0t!92k1^x01~EwmT1BpVxVpD zEAzku?#Ub+@4wMLC7H&KXk4ycWC>T7DRW+iT{3ya9o63@Vt;041vvJ0DXuyZ0e9Ozv$RM zfO&liuq|@D!8tx28##&N7mlHUaeQc{=!}bDb?R(ofq;F{Pg6z&^Xhf*35jr<1va)be@+VMsgHyuR>*r zhYIXX!Ml32OR7H5Bg2eAByK|ixdQK8#>sR!rL53?h|rICI5xhD{?BwHUmcV6vBxH! zm>j!)VoXr#oX%WrAS%4=Z%icRH41@7`vs|ZXzz?QzX=aHU6;~-QpoH{F8YWe^9#Di zlP&$SM@2a#hu9v;>BhaEG_W-KF7X_qvYt6l4bhK^z~;P9Dv@aI_I2|0?laEs=x-;? zO+F_&b9nYNR&U0fM#Ds(iIPT$As*X5`70tR=|h22AhDD!OnFD zdgck;%uxJP>RQ@)&#K;e1)IL1Gad#$m{Xx2o|<$>js&&>mFa!^CUfG8+Zqe%QL>Sy z+r`2#kJ)i!b`tS`DR1DttDpZ~!V>wME3vGH#%x$0Gix zi+bpn)dcb`PxO@46k43=PAaD(qYk^R+1pGZ1PQV=4D-5F(IOK2j~8wo^#Y&kV}m`l zD0wNlGYvv&p54T1Td%$EF1a|8s|6jegSev#EpLpDEaX&vV4#re-fP^W(Dy%;a811; znPvtG&Ht&k+Fv$wFxyJX)aEt{uc3igcOKXjfW(3VT09bvo*wK`7NHRzzKLgf@z<}q zz;5!{!S-lm7o7#lx1NSu=;KrQ=)o}zTQ}vOO$+dIm**oFx2G}nIkA6UCzSJz3_I_m zx-u^PDg~t`Z4JBcBqsPB@m!Zu!OdYOhO*s5=#)k8b0zN^Eh3EL)~*fWMiV*n6Oy!f zRG&b}&BZd7M6MzgsX2O`s!SB0yZ9`AH2;QGH>db1M|eTw%hNtSqhI_>w=q|G(~o=2 z4~S3B5kx3+NMTKM3IM&EgRL;CB8V5^)Cq$bRMYqF#4bb z3}mY%Kd}JW${Yyh*LtBFPl5*H3P;8GCfJr>moW)xIM> zDn$eW%rl)v@8(zhcJ@!Mf9s0hR@>dHBhx9wh*j0^+A3r- z_;O`xd0V-~9Ke9rg<}sWItJ6Q^P~HC!K*aUIFAw15vE69=n^)>BV~P?Xw>1xY_?^j zHh5x9T*kH@h2t&rFN3{COJYVxQx)q0bpjrV?* z@uOR=qR%UDn)!MBi$NWa$sXIn#^k|0=#}x|Z7F7Yi$=cXQj~^@_oMI15teheJ1}*Y zH5$;lBfETChI(~08l_7x1{Zr)&9}hji?J6gZCOkx*sFo~i$RR#GpiaM*=H#vVWAS5 z@YDiUt63!sv)YT8whF}EVEyc+=@Ajgy7EBO#?5YSx?R>L_Qtw14&R*J%Qy)URC;dO z4P{O!H7Fj)oApTioF)!)&dj~+Egj(Z5C(sXQ6fqYQRcEjv~%+bZEG-1~{9 zbgXS>Rno=*7`=16r4u0jInkX^lijPEN6fVI^FJ7vW~i2b+C-&&SMhNQ=hzarAxjyCODN`LxTCUwKt(yWIA1C+%_d+!#` zc#eVPT#y84#@q}3oWE<9dOQ8O8uG(*$tNG1q)s!c_vC7vS>`7DH(zB7*Ncwe zX6Id;jLwbc1wLoB@vGCvmz3#;Sl(deG87-=FH!9cKmodSfa1XkgA+47q;6=*;X0Op zipyn>_JBh%0<0RS7xDDMlw1@aYN^Y*Q7kVi=y3S+n*$=oy8fR2864$uydQ1RFAo%5 z(;R}nTb?eS8VOW{X2YxKN^HPbUu>Fq$x!EiRcu3TU0lr}`s@MX1Yr_B8L0=RLD+V1 z%E>j1y@aZOzo<-u(9?d+Ll(uAk(Bu4=%7&kpf1nm74Z~9D>aIfEJI|$ZO#+>`X#mhG4+2Lnuih>Q+ zbJb04uyn~mAOmO({KISL`7ccs^`s;2h}R`?XrobOtZ1kPqd8^mH&L;UzFs4BNfWyg zKg{-K_S%_FxTqFfO0j;&Dh^1X8YSvQ-^HU?KU}8ZLw%%_Idx&?MOG|6g%0(N+DwA# z;U=Ius|{F!MMKDx6Ffbj^LAD;JN1t(zjZC*!5M7VQ;DwEkRIROhAgyI@lP16Jh!ON zVEVlk=?8y7JP3ocEH7}_P+1U}Qua~d+56d~x&X1{Q; zi~6_Uj!0WbBsQhY)fmETFxp5J6eE_-yCO}3)2oGf!7feOCw`M-L%xHxs)!#rF!&1W z)QMkH@Tc{Mp>PjIzBg+iuI`R(KI|T&pn&*EBz{lJgksl4?G_f_2+!h;P}nt2JMb`q->AkMpIj^KG;)G z!TlWSl>br&TfffA%Gj#@TaSHUx^H~TcH2<Db7`gcYd{7r8^Cs;_OT98(uRsoC!?66d~da zD#P4*7L)?TMoLa38dAA~$+mM!M3ANMs8m^pXD&>pw^z8ZrlxHcva{)o=kEL5MzgZV zLQ+9(6lzlfxutBp8Q|AQdjITkeb1LWn5!0#bIPk0v*7RY7$GgJz8;`JPeha^vlxCg zmB@?p)L(WP;xmrsQ3{T>+j~;S(ol=3M*Rm849yt@ioTt5nP**$OKqmL*`26ZANf*3W59;f9_|C*ATw^+QS(Plru<9Y(1% zTrl$i^9Ci>X=ChYcPysy_@cl&8HI^B1d(wWQ>OCHT2S8TK5{LvF@_xaBkw_~Z?e-_ zY=YLT!lb2ECJ=6~58acDGncn>JWmBmuF~t4uk!P^erfR|K6~c)D87*6+_&$F-%!z| zRI1;D-yAGl!bX#`^NUlx~|#Swr$(CjgD<6 zJ5D<6*zDN0(Q(JNZQDG#`?;?7H=O->eVJ>|nzP0jRkhCjLBEe{V)}vCMdyL2E8|kk zKV)sgeE?m{(_YIfb`ov7UG7jWB6-M#f`0fPmuYWMdJgNIChJ5@KK|{N4a_?Pvb- z1|K5>3Ow@p`H1C6$L$It3tDbx2G^wV5rI-}Jw5T+%V~;;oNjg;H6U&0yiKxxZfm>l z1{R7%35BWDJdjsgl-@qP zLqbAxFy}e1@F=tsll|lhx`ZsQjV1LE-8yKJ#4c+m|g@ zW!j&lf=L{mxyKhV1|O>^t+|(9_|i-h!ca==4y}etSk8}>BULL9`V*P#(wje%M636z zGrXAJ>fV(95?Wi3fk}nqJBZDU9eZ3pa>~TK*r}9yDXsnr&4MFaYfMXC801$kP%Q9T z{*jO_zHl1a0x9xB%7MUtrEbySSDHw#06!K;rENBS)5ka|)BP9!$^rZd?YR-G;@j#5e2b{Kxto z&;9CuKU~E`{!;srJ`4+nQ*t>G52L?Wo|%l@njcqHQ5DavOsQ^ixq;Vx%!ZQZ2_^%# zk-)geIVBm=b<1!4=rq9IWWgcy0x3fmP#As3t;TswO>;gF)h$wy;v3;%@(?_WsW$LC zNT}9Ls0S{XMt4+E200LZ)%(=b->TepaOmH=L$0Qytojz2c226aU=+J6!zi0`KtE<; z9_|knaa~_y(;2kJ9S&ls#n#>7*}~?XB;f%N+%zGzrF{aFOKKErjH6CzGeb9^!$ZJX0=@dSWVpsB%-5hV4 zv7l6&NE!mak`-7!=I_#OuQzOg8+X;}cYXyAY{ScPYita-lv*O`WN2&oS#G)Re7t_1 zF}6pJS%m#}cSxA!2>i!fQ~KskG2Nmz61WBA1mF)$yhtYngWv088BJ&Xj)@Ss_le|K z6*v5MY%jDQ?wcv@(*3QmHmGA?G>&2Le=d{>ew=ke&W|2yA@YeXQqdKbNrY{FPS(^s z(OVUou9~^oq^i6fBy_|7xPMmEtkQ{Q_wwtIiJ5%FfQso8^c6fsB#=JSx!Qf1n}`ww z@M!uRzbn?|LfBCcutY{|(O{l$1t&Ha$xY_$vXYCAU`Qbn^^v%<{# z-r7PP)N^<=?Pn=6P*_dy(V$)LWAa%onMd%)^RYN%#6vm5#o&ZUI!zEIHjj+Wg3fzY zO&Of!A6=d0v<;OglJMJ_@}DZ?gs?Q-b&RF=(kcy;OmpJ$s(9nKKGC)O3@E01$JfCl&62| z5rA(8y})X<0kC8C{LPHDaTbCkJ_fOzH}l#Kh$7yo;9*nf_STm_E$Ayf&l9!|2!3Yo z>`6Gk4_MqRMmiYf8FAFeQsGy5prPxr&)hK|c74LIaG-pIjUm%^gSgeXicJneodWO$ zvTzNqw>Da{l+h0iF)I$Jcz#f~;}EuAUN+Gl`QEQb5y|A@jUz}Pr1jrJ7f4ySNUcdE zBd|1_1hoX!h4Qe(N6PYn+XR#PKjcb0cDt%?+;Pn4iKm7y$V8zpVr{>@Xm*@upGLnRm6O%vT_2C?E zlt+DQNLn~Y!i!Sn^6Ryt#lnW;s%Y~Lf2ViZm>Y~QLIy_i2ZvzR`n1X?-7I&X5Y0-4 zunvzEEF2lChGiBjq24{E+v`Q+27vE#aU!V*zwi|N1dXT1f_E7Hd;$`6>eJ+nMS%tu zom~Y;BQMcMdSW)`sG{@i*!z`XP;C1Br*Va5;*U?@-c@}#?B&>)qipgVR$-_@JCkMV zK|QW#bC=uk22|K?)yQGpm9c@%BL6_=rXe27Y&kgeZ&c3H-4Bod^tjc;P08X|PLoKArztsdd zoptqF++c&zef0wKqN4*vq5p22-%gvJ-^XPv>%1Rc446UJHoe+t1v7wAnn*=sG|4G3 zufwP1q6mzBL9Xzj2{-jg;1 zKZ1}z`VHD*_G`0gIOw(Ds|iegI51r%oWWK^$gpR5wCZo@)?`rTHYQPIv_E*R`)$jB- zef16w1*1tVE-}6Yw&@?d54D3$P43V;R!E+1i}vVoW1`}<2dgtnSuG@q9Lu&VIn7`7 zkz@LQ|Lg0U>{M!bo9Wh|7gaR3*nvH*|A$cQ(vDr2+wwp&QE4Wjt((1Cl6XWrDk(N~ z7GZmBZM{XW5tE9sPvv||UOMmyL@|u!YP)BN(F9e#p=;65ep}k5m^hS7zKAIy&`K^Y z^PMq+RZph9{-WZ}j$g1XQx_j5Y)vt8b+Qt5_EwW%eqkx3BC_4)KkuH%?jvHuBt_KA zT5hq(;mH!HRYuU7?XG@sg4H4e2IowTYc|jE`F_g$Oy(Qe!{j}!qJg36iWt?kS(#(( z8q7kM{s@W7UdwKjH|>gppec$Nf*@bgqg4=}Xx=6rsW-<-nb?6mTYT)CPn8VIKSF|e zj0B+JJnqe;805U&A?o{JS2fxniP#@))-8VLJK_ARL?9HiJ2VI3%cvItNz^Z5bz21I z_N8A~!C-3@)7rLFwDcKbd;wKHjSj{niGNkKV!sv$`Qui&oP(^ex*Zp`pqXl!nrF<$~phHiMhn09CeRvAhb8(B#&a+CgB6p8*xH z;ec_@J4jpWJ<`AGzHV{x`_d%e{h<)Uf4oFVDzq<5V@R7@Jm;fJZbM8Kb4pB*_`Li) z*A-e&{WFQshQsnSMoYn`H&826=?eS8)nY=4m%ib0v?L|Wf7!ALIkCBX-tTEcMeYhH zDP8%~3NykMH@H*$&ez?%D7XWRb)V@H>!5N5)Ptc*XRH?u%m-KvYOYtP|oTl014Ez1ut zYJ5`EAGA01aHbBqaQrDinhv7Q{%AOjqNJ@%N7pr0edh^v@2(NUt;j#=pOnV9D(54h ztNRH4Z%(*0FY?kOQsANE*p8f;wlM2xyCZtH2 zPijt6q7jAAkq$(nkk>XqNkR?HBZFW87e3n2rihRzhhnl)g_mlN7S1Fi1b!Sj4x z-+)F)uk|K+QSiMs;D2kghJah9-3w`A%RcN8WS{q=t49hL=mJpnE}0j!G#Q7I60(!1 z(8-&NA{<}oef~KPQHL$?wRm56M0}_;XW4`%37xT#Pa3dkFs~R@ZH0yi(tau}?J<|A`R5EI8tZy@~)U^E6)!!2p>Uawv_OIfE;ia~FLe zJ6|C+s-1>8tV= ztXNnAzY!{ggFd$($jXb2K&lD*Jl@uS1)EmN9lOwCspS&EGff zDO=9NA3ASq^XDzr1xx?QD>tWk#A*!rod1{FU=K@RnBSt)Q-g?%lKQL!c(y4_ti_tH zI9>Kx1@FB#?$75nP~0x}H8$ji*Fw!|+u>YrG(AnH!Z-~I^Ly-NjLHXxpx(rG`X z$YHP~`@t`zWB-V)X_7RJeu#4$u5eCbb8#9Cyl#m?OpqX;UjwePBVf0Tq@|NOUhAcg zj@e(U=`OY5^l5LvO&Rk#c?oxx!_4iiPwWHHpk;JWzQA+Lczn^BtpIO`MG0U~XFS#2 zV0pGX+web}c%2;lSM)@nRGge)1-xd3yejUHuA`DbrWjB%-#OCQf3Ygm)=C{pF{!~+ zB~q=D!~7x6$FOxxFlLE1D*!7OiZ(0}Qibz+!u>t*GFC5KV>qS)gii^ta!i#@XvHm6 zRoiccF_f%fgfLrJ3x_!iJ9JYg6>f4UxDf9BAkwEe8^Qohu7adkq(q;=0Hzlc6cDgm zQP>0F6=;mkRf z|7`&Im&i5PbMy9%9#QLvg&7nh@)xVdSOIsqCd6HRhC6W%FCO}f!gXaEGIxTDyUMpQMY-e=paTv z;zCh~3WfBc=9P#$szB=PpfTuwL=By7>@mwy&j7M+PhocP?R=ccitBwpFixGB>e+{$`;W>ZASmI4@b- z7Q#lb0Tu947Y|!loOLi`L}#fBR<*`SYR| zCcCdEp~$1zzW3$@_*#;r(x5i(f>vWY%ZG`^P^uO`LzAE*)@th&qg-kDs8{n$c$i{* z9wG{7SVsEpal&Js$CfrW?*v>n5I$QUa=UCLY2RyU(vjJAPnWH3^F6AfGJJ{&XSK=n8RKqEMF`5sN5};7+eIinno1cO zu6l+NcSqshWM4xowOgUV5F#k?frut$b*)}A$pvL)c-f&4uD>=W7I{&84oM-{thp%< zq7cTN-2M(3(jWmUo1n(uxH~ubw{;8mZaP_Oql~<7ZyS(Atk6n$b38HPCrCtz9r5ti z1~H*>y*s&L8ph^Jg|L84p8%#a7RSFaA{2>$=+_{)xb$>->guZKv^gTo{Kp4s6RFwI zfX|~Uz=jKXMh;=J*i;6_SJbT#RUQQGw0yJ_5T8Zh2jQX+))x83=8T zIMsm6W)3Wfq)eenff-7YSO-}7SOqF|vDhmd4F1bQhRv*7=_D@P$%%(%SG^h=P7%7i z^zpSg$W?N1qh&`Mx)u&~W219}xZbDizxJrdSsvumXsbkZat!lFQBB8^!kbvHlEWDR zo+#vzDg~nq(R-h)ziKJ&qoR+G3Ki5?e}!2*3k9DqWz3oGtgG|>unwXOgM5^OFR)-x zOs?}iGS^137TV)tov@P;_|T> zv7PKy9;8b^FGWrp9QVrVp$YhEK2vxZ00SjRYM!ZsWd}irvj~kp6bb z4~eBY{RJnu%qjWV|FfTq5T4#WY3($Dc?m2Wpz*f3`@NOxv!m(MZ>Fxbq8Wh+SU~~F z)x^H4Wo{2X{60wj>R^k`Ct}evb%w4djUhxm!+LSCsrYGXuERLap(IM2i3Wx0ydfjH z^Na>OivcyDitL+alGIaZl3(#WLo0mq1l>D7)jSJ z@9rTHom7p}et!0ihg*YKCHRC$!mVRG08(ECX(YVG0?hL5n|H<9<;O?~LB(Ou305M7 z2}L4dxAIM--jp~r1f1W}iu+b$snt3vt*O05&Y{3ho`OAJ_FYVm#dSo{O#Y^Yz9$AbBgO%6aByc?28N*s_FxvjRb$M z7z{tei{HhR*XVA*HQrK*4eU{F+YXkA-Ewzxm`LR_Y|iN$rd^t6>1>eUX8A1f&?& zAg?f|^6BD~;xYUYngNQ=vI}e1p*it~uV22Erj96RT(RR;f)^5kl0sp&F5bwdA@mVr zqhc%zI^I+gHPT8_lUUA#(-U}oCUw|o#^%F@0uXL7Jcz4<2Lrdk?Xzyf2b!Y=ckud2 z%1lQdT|JyW1AOItVw!S4w^h3d5FqV=1@3ltzK5OQ|KJ?`rdOvqxKQ}ZLCD#rOH9jQ z2)nw}ABYtu5BM(vu0ux=mmM`_XvA|ImJAvkrMPqrR82^+aaY@6&gB%-ZDW60+w(_= zz>QwlV8d4O+7IEXaR(D`~ikn-C0^lcRF@)YvgTP+Y<=?`L)wM=gz z%Kha6QUh~y0Oz{{Y%Wdf`y)JM-4Yi3#tFHC>QS!0pZQ4*(6sz}NhSyew~y2zoZ%3r zrurfUlPo~4dYaB-Au#!jZ-IQO(su2AmsfLK*JZJ##`0yA(J%S)fz*%D`+P_9xwDIZ=7a%-PtJQjANj^RW^lpZn$ma(zBcHDhsUaDw`{5~r=$V)iaJX+ zO5p1SLQP)piJuM1h*hrc_ma2n*5T!!b&`Vd8^tG?h2Nv2)wN^gHMN-6L94s;v&A%H zG5`6N%OBmYcyco(;#cD!J8nuRuhW5|y}XWwzvY=db5@q?oK59~6oY*Lsd~EA>swXC;AVpNw=@17$d-r5p+co_Uwb>sdDS8wxvdWw>Q~l8YiGWv? zRUbFE7djg^(@NLy9k6XOJvM6jTyRygBCeJX7nkeDG=e<$1a<+2=`m^!pMYB@Nm$ZnlG>6owirK}ic9RkVZ zHCqnDQkR_jqyO#t3_ZcLYadl*#_~o~&O@Ol?lvUIa(@TMhVwPW;j+hqBjkxwYkgN* zV?ACS$GFB2SAzOZoJiFg?`jjo6QH?$h!!#{Q!uH3%)`JyU^ggb`h7|JzW1<06$nF` zDA4nl{{vB#(APozHpHFtt;^^KjRZ4~8oE;FbaO(^=e;-QI6j)vX51%>N?FueR^Nfk z(7!I9&uwQXrw328vdUt+Q{~-#aSPTVJxn+f(Og(lwtyfaycO4Ydds{sT#%F}_JJ93 zv+EDF z3v-Mmmmg!S&*kxxmoqjBbI=@iCaqJURaSqhP-TP$ii@i`;t0L^t`@5Ua{Wr6%w3dJ z5X{PwQw5m3A1@?h+aZ8|r$nInh;YI|i;(Z3orZ;|s|==Sc60mA3Xd(>GIloE@Inl* z>xhPWpj1r}OMcRDTrK=nwX3V{1@$)a6KTTxj^qBPaQJ}9b>pPSI98r~x1{}^HebURPEU2BC?k&Hp0)Zr?t|TdwVM!61 z1?ijmcpgDAtOZiR8l<_Lg!^mAnZ@6I$3`dfiI7j`bg0|d!sjoW!%WX5_zbj7_O1RJ zV9voHwJxPUn?cl9Pw?~pbu0>-Ew{F2gJ9xzT>I^;rphdM>W>T0{CJQt7ao^*8&~^q z8|_-!7W>JADzRG|dkcl*rtisQ^l5)o;nznpTEDIg6fTnmJL=V+hY5$~&il|a35Cok zJKm1F)yS{DO;#zjb_$Tw4E0^KMt*Ql4!BrzaRpEZ(3)~w~v%{xm zGjjvKi~{X2#I%JfOSG%$&-;%9MXje)Nu_xz)=QtYZk3zb`?5; z4Yw_;!>PqJJ(pDE3qdSYkC&MvCHCkKTsHlYmc)}`)G^Uy196$G+uA<=Ac)>driL7! zm~m*yM4Bog>9qZyu4a36EzyD>ZOK6xKd=GnMM`jd(4YDXsNPv`1*{iC4jp>0W0B-5 zJx+LN;zsw&$Vpf{Fid_gGTIt75||*o8TniLA2y4HZwA{xa;aJ5HZdm_f=>KYxDyny#HLU=mgfzOMF4HoEKVKKA>JMa<#URDgyA zQ^Dv6i?0tEJ<o|v*m)sQf zK()QT@{0hxe|v&iZKo@U8ecbf%|C8&9q3OMV&%^`R2HT)Dnb$WqgQG`#tR z_=8E^F-9lN=98`aUgI9=gH<|?{!t}y0F@?Z(H@lcq^hG$`UWB6s+&T zvXfRiO>_Bqr9|UoitnG7xQ&zWcuu#{9znpyIxW|uS?;U_?gk(P7pS-&FnNZu0eM2y zzb;WQGkqyS@ovb0LgrH~oQZ#S^f+d_;&&iskBm4dmn|W={3{@q5C#QE!f~^F7!DA3YId6VjJy^zZh- zLkTDZzXn}p@S5c>T9H>(P@&nbfPC7`JK8cmt6EYuJ;Qo^W>v})-UIS{BA99^e<`9sm!5qpjPr(bvp-;WgLKnaE)8(o7SU#$?lWVdrXd8p<&3Y z&K!J|i$8OtPkn?=LtcOn?>Z1enSsJ8m{1X=sGw`~szwbG4d6xdT7qPO*i zCwsm7W}mz&9LY;Gz9FaIEtb%ov>wmTR-_n^qr)`rk^(FQ{)W_xXfG zV_h4Va%7*!*L~A|Z8jCs?66}!0ii|Lnt%KY;qE1g!St)H#G5qJp7QjlNbzmYhW8&yb^+)G49(!BAXi(M#0d6pOo5xUJF=$D`6a=(eBa+vPxHe7(F>=w>^^DQIelokO ztIiyLRk5&Nhku={VG+%*gTc)Y$WUnY1e*IITLEm@JjGzvbS3z?^*n4u&UzT&cOMoAZK@Ent&t- z&Y{{pxK}9)j#+hbLqUrz(Vs$w7O{~n8Ch%Dj9IS@Sk*@daGxGiw%lfP2ZaS^s% zNT18&W(wC8XB{Dj2?5p?;ahwkY%1{eL^nhai;)65E(|GahE5;Vc~C%y)0smEeaK?@ z0sI2ns4#Oopy>^ZkM3K;)#~V1*OxBCrsSd_3s2Zuss>LEUDMyiIP~|e`;NG0SRrt| zfaH4~Y=FnZ{H||2d*WxGKBQEi>k*kDtpwLY7nXlGhlVDTiAK)LBMpfC4LTRZzEc^# z=JTqY1cy8Ef|)5^W9VO$_3`BGBH*Vv=P?Re+s^Nky92-ZhkHlP=AK%sn{xQ6`it8u zKe@WSj&w79j9(qYi~!MRx(qL3(%0(u<-=P7z2FP<6`gKGx?RzGp9 z=$645->%rs2#{+qHD_jYwP*@RoK!}O>FJ;EFV%0B8=Jx9zCK%GqKUS4QRG?adrR_J z96vqknOx+A&~2N<%_t;YxBT`NT%BGjzdL#dez?#g3qm#KAziNzg9(Tflczd2dMh($ zI&EMAdT7Ns?p#yuCm_U6rrwRhvBWM%*~hj5Cmsq5=!2fOh(s2DGoZa{h$?zMU?Np1P|&f=#|H*Q4osp$?Np5824UsjhKR7;eM?y$INl@6vdj81AUq`j zfF%P1|9^VyZ{Ha-L6DdPuv?dT{+9aPKE1_*a+KD&!F8yV z+n9k-2d0^H+sbh$vl!=^^7i42X&&%IGxc}Z-_*3YG7Q{VdE zBYbx{`e29n03!8HFB1*KSMPzwtL#qd%Z!~nAxV%)KB4uepu|aSZoe6AkR7Pht!G(~ zX8EOQf!MJ!$<73iF>baJ8dLS~E)wq{&6+OTk)0tz`TEAp7CI_*W7|!x#`dPV-?pk9 z(qkhK@(JoxT=W+mFY7L*_1HcSSNu+g(NA5ij>rZH*2L3IbN;@e!BuZ^Vln(r z!BaS{3Sq7qPVJzapQ8Mf#$h7OMKF^bVM`NOnSwRDRX(}EC5l*Ii%U>P%|}BIXFN?L z+kfh7QaA5VC&xfflOThsz@f|1V7r}X&UaoRtcHZBA z9KE08P$;JN*!csC0e#UvQoWHwAAr{>k#R-LHqA?7uC|y-r$tF7Lt{i`4R7H{>;l;&W~9<3iwk4zKc$#9iLhI&DA<7jwP# zK-?cwU{qO2j9DlJ6A?tR+8@d(2poWEukyMB3SXHbj8)4+Pe1E=Si5N9y_i2)17P&* zuS(|5zhegeeLu~BD|m0)!Dt6!8*NvpnKxYxy$}81 zSf6pU*)EKdKtb;Hu5n8ZWNiMy_IOna-tq6&<-y_C8}#NalSB?g)8RX1s2AxUw2Ma} zhGt*U_mq-!_E_=u#*pa9lw4`)Sruk=WWmigQ*nqKkg65Y-G>gt`;Z0E%E7V+T0#rJTVzunZ%-RjvJg^e{|ZKIsmy<$()2f z-)8t*^$>XMh^?amH@D_674`4%kyMv=`Rj~#K! zpT#wG-%hH)Z!|IhLE%|VTU!NFEdzJC-`Q2>bOItBz8L9MPrVhB2CVoy;Sy-aM<)DQ zyBX$Y7Q#@7SRI*~gceiC0*H_bnCQ#U(B~%$fx;c}uD#;T)Ol?osdoz6I}$KC?f1$o zBhq0fht9;9y(Th^>{ThKvW;(Jf&mZ|3gL7Sn=g%Rwj&y7IjKUPV(;?899a5nKZ|BmY1pKkPw zCn}Ql3!x~~ja@PXWCZr4BqVY6OnkNG9R9kqI*U-&&}c5`@uEmP_{}Kai!E^1uYQ)N zOFz%fbjM^%)W}(7P;WkvLHl3tWeV{dfx2$JPA~`4^Wu@iRcoWy5OWGInjLe6kJ*+& zM!u6^MPw|s@4*$ZIIGXA_-3F(@e?J}^|a772)&neRE^g4D$+nA?7s1(f2xXHhZM+v z680S(C~iID*yMOw5AA*UxxOlUVQY8&>I=*P;RYtx;T*?hx5A4Sr6@S1iBLK|Jtx7Y zH+=kO9)i#~FBS{>dcrKT!rYK|@WxuM=2P6FTl8c-`y>fGLUQMk=? zwLdVbn%G9u!wG>*p&N6^*uJC3VsRBY74%v8c6pP2w^^L1Nq`NeMJcZrvm8*iPKyeC zn9^dFGh}|(6rgb?fD7jB*|l~QHhyH+@58=Wss?h95C6GKnSQDbDuX-?FrOf{4O{6e$ApaMPlFqK{Q_>sgv9N;{VM(cts5%UZ{u zO0LeWvbb8|>@Avkxl9qfIlV~BG2`4*c3-?691*Pz)N~HbURaE8RE{9% zlH-tE^Z$8|kpbt0p(|USUYdlMF^hg86R={2=n;y4vk-GAQb>~}vMaN(9AI#k zm>ApjxEv|V(#F?b?bI)KhE`H%3;6RhuHPzn!bB7f;e^e z9wspzxy6wVB2Ud!d7=38h1Mc|xGkLJe?6vFwD6?V+TE-+zPIHwB^Ee`o>;gLM;>kb zhLf~4{vgGi?|e5A+I2P9X2$)H%1IGu#$^z+9N}+_+HHTN>gRvu8RQS{5vNJ{YaC0& zOIu(G`al`4Vf_3!)U}p?A288*9wQ|K1e6yYAMbiK47e9=W*txiL*AM(QN1n_BI0Pt zP8z5yu?i`xvz)+{CF{*EF1cK|3hvc;e+HL(0teWch1qG{K9alBWt-vVk+T0WEV}mG z{&=E(IOjah{+XJ^`cVuz6{QE58dKBI0P(R7$^o*K++|e@6v)~Xj@Ez@Z0P&KbUtqX z{JPliwoN|3hrGVJ>$+;|INF4zFH*9kY+Tn-69RTZ_{}gFfN5%N9A#>6I$7!@E7xI| zf?cu;&$;ni6%{`@7b*f2jLwKEU)OY98|FYIx9G{GyJM(+4#&}$xkM=J=rvwPlqc3`qu48Y%CD&3ebK-z5ZG-(0Y&beh>0R16ckKyV10NCUU z{AE($hP~sy9?T}4zZ+R`A#aUK$tr#Ifcch27yH#erbKT#Wg1&q8&SW|N7cM+GNR z&rS_!t%Q1Yz3SVMS3rx+3R7|t9Ijc1g(NnVVZ3dw{-i>y@gy@&np*NcOSA@J5qjl% zzbxl=$g8*|_su<=F#$zFZILAb7*Y@zHsWJ4Fj*KOsU^ zM1Y{+>nL%vU2jB^jE{Z_ffNH$U}Mej;IV&{BfcP->hZ1Bl`Dx47li^Qr-wR5>RckG zmnzzp5;ts>LxZDP>@X?WXnJ|>*^0%l3Pn*S3g5Jvvpp*s!89r8Ho5}km3hC`h<#7- zaudUZ2#T|nhX!S+fE+mSE!A;?yJ^u7n(J<3p-2wKj{fVu@jjG*Iwo1fu|rW3a89Dl zkc0vWv{Umbeul7KKiZeiQIX%APjsb9JSS8Ssc}k{gdUO-{0yiK}8fpmb=mMf%pQyMnPLE++7HSYLz%fGOyNj83geSr_lv+xv2x zlk3qtZp#EnP`A>oW?FAJL>-1?&jn2d9D7qNPCNpdo?E3B zJb+z>>m4UJ9#(i?LfHvOm}te*@~81y`B9P^x18zQ+XFkvJ&{g|JQfe2q+zN8Nu<|+ z3uz-u&wJ2x)#BnJr=`3}Z_MSi?bZp#5!>J1YI!9r9$D+fN2|_*&xfzccX)iLrRCjZ z#NOaqs{T*z_qcLr_4au>e}uBCqx|vjEFr*Z+LQxK-Cn-d-LtU(=^|%|p}pF5gb*Pr zhX=GhFRPA&dgj+45g89H2$MXVl`cfv4N-N++h)cR=KFn7C$3`&wklHbFnk5j4w%R< zoM7M&A=2{TlG0IS7hE_X>g1}r6#~%4ETL&yBKezWRcYB?ZjszlIxlzOi!<2J1vs&_ zQNLYAozr-k;#Z&0kh$>eW)2U~0D&CH`ec2HnDYMH1Dl)8*&-eDDer5TtLyNw7`7eA zG^p*#D&JF{?U{gF2BfpV7RX6y^1mU9?RmFGmN;=ErX{xCv;JW~0|f9Im#^yftnqok z(2z{Ucn^dfH|rB+?W$*KOssh$8eU%gbZ8(6h3Mg1fG2sPtz{9?)IwlPQ{o3JJ92Cy+QA zne_AZGQ69wN4ZN2oMq0S27@ZW zl`037`Ti26@6Yvzo=XgK-0%2@gqZIP*mT(uX`?s4b?u2bntO~qr%#7m znh+fvQKC+EB3DyNNtfIG=)y-5H4zH1DS^r_d{@OXeAsf6(B>N1Aplu4P(Czl`&Ouu zGV(h(xGzC(KFRN&U)ZA86-g?NJb2d_soRkgIc%CdXBL?41q}!`;hiFoUVShsKkd?# zvv4jR2uk!39ifO)z!G4FIZdKz4ZPhHY&LFJzzGaAK*`y#()~+n zK`tJ2p6;(cEf+KEPG~>W@vn+uk)#1SNH0KOaVH>Zd@ZPK;KM&2nOlK&AW$w)E= zl5`F3FGk{Bm>|RhUZ^6(mv&*ia|fKRy6YiPGzPhQXG6KSxubrg+?(RsL^2ap=qNG= zh9((!&p%M6obN)E6gUeoEeu9eu*^1&Vsl@>$6M83s% z9}ZRzA617#7b$|zv5dLo`Pt(hZlW`yzFNFo>`EAu!&6wY`-3&TBgl}u!?E0fa3w3% z1~|^yL#b49`s0xF26>9_%{rI$)7tFWbV8i9c%oF#x3!(Crc!&(tPCYxmIezbDZZ|+ zT*zT{Yq{0^vj6sicB%5!BkXd6smUBhqc8T8yoibItntJk|B4iXc*dP9uIh9a9Si7V zV*$&=6v6s{%j3Ci&4BgiU0}&>3bZHXV_1h8E}jg?AyGVCwb0R|=aqZEn`Gi&^NpZE z^f%;a1W7cn$Df_BdOuaArSe1(F+`u9M14g`Y4Be;{PvHV2Vis1Wm6fCDRs4LX@Mo> zdgp;{;>w;%qt1UCPr_et3Ve{!Y$yX7-ANF7WMm6jP$Ci)?)`)uVOf!pSFpeINJ&U^ zOps8J#vjK;J)UaRsqz5yQa$2bqkT3;+NC literal 0 HcmV?d00001 diff --git a/node_modules/@actions/http-client/auth.d.ts b/node_modules/@actions/http-client/auth.d.ts new file mode 100644 index 00000000..1094189c --- /dev/null +++ b/node_modules/@actions/http-client/auth.d.ts @@ -0,0 +1,23 @@ +import ifm = require('./interfaces'); +export declare class BasicCredentialHandler implements ifm.IRequestHandler { + username: string; + password: string; + constructor(username: string, password: string); + prepareRequest(options: any): void; + canHandleAuthentication(response: ifm.IHttpClientResponse): boolean; + handleAuthentication(httpClient: ifm.IHttpClient, requestInfo: ifm.IRequestInfo, objs: any): Promise; +} +export declare class BearerCredentialHandler implements ifm.IRequestHandler { + token: string; + constructor(token: string); + prepareRequest(options: any): void; + canHandleAuthentication(response: ifm.IHttpClientResponse): boolean; + handleAuthentication(httpClient: ifm.IHttpClient, requestInfo: ifm.IRequestInfo, objs: any): Promise; +} +export declare class PersonalAccessTokenCredentialHandler implements ifm.IRequestHandler { + token: string; + constructor(token: string); + prepareRequest(options: any): void; + canHandleAuthentication(response: ifm.IHttpClientResponse): boolean; + handleAuthentication(httpClient: ifm.IHttpClient, requestInfo: ifm.IRequestInfo, objs: any): Promise; +} diff --git a/node_modules/@actions/http-client/auth.js b/node_modules/@actions/http-client/auth.js new file mode 100644 index 00000000..67a58aa7 --- /dev/null +++ b/node_modules/@actions/http-client/auth.js @@ -0,0 +1,58 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +class BasicCredentialHandler { + constructor(username, password) { + this.username = username; + this.password = password; + } + prepareRequest(options) { + options.headers['Authorization'] = + 'Basic ' + + Buffer.from(this.username + ':' + this.password).toString('base64'); + } + // This handler cannot handle 401 + canHandleAuthentication(response) { + return false; + } + handleAuthentication(httpClient, requestInfo, objs) { + return null; + } +} +exports.BasicCredentialHandler = BasicCredentialHandler; +class BearerCredentialHandler { + constructor(token) { + this.token = token; + } + // currently implements pre-authorization + // TODO: support preAuth = false where it hooks on 401 + prepareRequest(options) { + options.headers['Authorization'] = 'Bearer ' + this.token; + } + // This handler cannot handle 401 + canHandleAuthentication(response) { + return false; + } + handleAuthentication(httpClient, requestInfo, objs) { + return null; + } +} +exports.BearerCredentialHandler = BearerCredentialHandler; +class PersonalAccessTokenCredentialHandler { + constructor(token) { + this.token = token; + } + // currently implements pre-authorization + // TODO: support preAuth = false where it hooks on 401 + prepareRequest(options) { + options.headers['Authorization'] = + 'Basic ' + Buffer.from('PAT:' + this.token).toString('base64'); + } + // This handler cannot handle 401 + canHandleAuthentication(response) { + return false; + } + handleAuthentication(httpClient, requestInfo, objs) { + return null; + } +} +exports.PersonalAccessTokenCredentialHandler = PersonalAccessTokenCredentialHandler; diff --git a/node_modules/@actions/http-client/index.d.ts b/node_modules/@actions/http-client/index.d.ts new file mode 100644 index 00000000..9583dc72 --- /dev/null +++ b/node_modules/@actions/http-client/index.d.ts @@ -0,0 +1,124 @@ +/// +import http = require('http'); +import ifm = require('./interfaces'); +export declare enum HttpCodes { + OK = 200, + MultipleChoices = 300, + MovedPermanently = 301, + ResourceMoved = 302, + SeeOther = 303, + NotModified = 304, + UseProxy = 305, + SwitchProxy = 306, + TemporaryRedirect = 307, + PermanentRedirect = 308, + BadRequest = 400, + Unauthorized = 401, + PaymentRequired = 402, + Forbidden = 403, + NotFound = 404, + MethodNotAllowed = 405, + NotAcceptable = 406, + ProxyAuthenticationRequired = 407, + RequestTimeout = 408, + Conflict = 409, + Gone = 410, + TooManyRequests = 429, + InternalServerError = 500, + NotImplemented = 501, + BadGateway = 502, + ServiceUnavailable = 503, + GatewayTimeout = 504 +} +export declare enum Headers { + Accept = "accept", + ContentType = "content-type" +} +export declare enum MediaTypes { + ApplicationJson = "application/json" +} +/** + * Returns the proxy URL, depending upon the supplied url and proxy environment variables. + * @param serverUrl The server URL where the request will be sent. For example, https://api.github.com + */ +export declare function getProxyUrl(serverUrl: string): string; +export declare class HttpClientError extends Error { + constructor(message: string, statusCode: number); + statusCode: number; + result?: any; +} +export declare class HttpClientResponse implements ifm.IHttpClientResponse { + constructor(message: http.IncomingMessage); + message: http.IncomingMessage; + readBody(): Promise; +} +export declare function isHttps(requestUrl: string): boolean; +export declare class HttpClient { + userAgent: string | undefined; + handlers: ifm.IRequestHandler[]; + requestOptions: ifm.IRequestOptions; + private _ignoreSslError; + private _socketTimeout; + private _allowRedirects; + private _allowRedirectDowngrade; + private _maxRedirects; + private _allowRetries; + private _maxRetries; + private _agent; + private _proxyAgent; + private _keepAlive; + private _disposed; + constructor(userAgent?: string, handlers?: ifm.IRequestHandler[], requestOptions?: ifm.IRequestOptions); + options(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise; + get(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise; + del(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise; + post(requestUrl: string, data: string, additionalHeaders?: ifm.IHeaders): Promise; + patch(requestUrl: string, data: string, additionalHeaders?: ifm.IHeaders): Promise; + put(requestUrl: string, data: string, additionalHeaders?: ifm.IHeaders): Promise; + head(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise; + sendStream(verb: string, requestUrl: string, stream: NodeJS.ReadableStream, additionalHeaders?: ifm.IHeaders): Promise; + /** + * Gets a typed object from an endpoint + * Be aware that not found returns a null. Other errors (4xx, 5xx) reject the promise + */ + getJson(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise>; + postJson(requestUrl: string, obj: any, additionalHeaders?: ifm.IHeaders): Promise>; + putJson(requestUrl: string, obj: any, additionalHeaders?: ifm.IHeaders): Promise>; + patchJson(requestUrl: string, obj: any, additionalHeaders?: ifm.IHeaders): Promise>; + /** + * Makes a raw http request. + * All other methods such as get, post, patch, and request ultimately call this. + * Prefer get, del, post and patch + */ + request(verb: string, requestUrl: string, data: string | NodeJS.ReadableStream, headers: ifm.IHeaders): Promise; + /** + * Needs to be called if keepAlive is set to true in request options. + */ + dispose(): void; + /** + * Raw request. + * @param info + * @param data + */ + requestRaw(info: ifm.IRequestInfo, data: string | NodeJS.ReadableStream): Promise; + /** + * Raw request with callback. + * @param info + * @param data + * @param onResult + */ + requestRawWithCallback(info: ifm.IRequestInfo, data: string | NodeJS.ReadableStream, onResult: (err: any, res: ifm.IHttpClientResponse) => void): void; + /** + * Gets an http agent. This function is useful when you need an http agent that handles + * routing through a proxy server - depending upon the url and proxy environment variables. + * @param serverUrl The server URL where the request will be sent. For example, https://api.github.com + */ + getAgent(serverUrl: string): http.Agent; + private _prepareRequest; + private _mergeHeaders; + private _getExistingOrDefaultHeader; + private _getAgent; + private _performExponentialBackoff; + private static dateTimeDeserializer; + private _processResponse; +} diff --git a/node_modules/@actions/http-client/index.js b/node_modules/@actions/http-client/index.js new file mode 100644 index 00000000..43b2b103 --- /dev/null +++ b/node_modules/@actions/http-client/index.js @@ -0,0 +1,537 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +const http = require("http"); +const https = require("https"); +const pm = require("./proxy"); +let tunnel; +var HttpCodes; +(function (HttpCodes) { + HttpCodes[HttpCodes["OK"] = 200] = "OK"; + HttpCodes[HttpCodes["MultipleChoices"] = 300] = "MultipleChoices"; + HttpCodes[HttpCodes["MovedPermanently"] = 301] = "MovedPermanently"; + HttpCodes[HttpCodes["ResourceMoved"] = 302] = "ResourceMoved"; + HttpCodes[HttpCodes["SeeOther"] = 303] = "SeeOther"; + HttpCodes[HttpCodes["NotModified"] = 304] = "NotModified"; + HttpCodes[HttpCodes["UseProxy"] = 305] = "UseProxy"; + HttpCodes[HttpCodes["SwitchProxy"] = 306] = "SwitchProxy"; + HttpCodes[HttpCodes["TemporaryRedirect"] = 307] = "TemporaryRedirect"; + HttpCodes[HttpCodes["PermanentRedirect"] = 308] = "PermanentRedirect"; + HttpCodes[HttpCodes["BadRequest"] = 400] = "BadRequest"; + HttpCodes[HttpCodes["Unauthorized"] = 401] = "Unauthorized"; + HttpCodes[HttpCodes["PaymentRequired"] = 402] = "PaymentRequired"; + HttpCodes[HttpCodes["Forbidden"] = 403] = "Forbidden"; + HttpCodes[HttpCodes["NotFound"] = 404] = "NotFound"; + HttpCodes[HttpCodes["MethodNotAllowed"] = 405] = "MethodNotAllowed"; + HttpCodes[HttpCodes["NotAcceptable"] = 406] = "NotAcceptable"; + HttpCodes[HttpCodes["ProxyAuthenticationRequired"] = 407] = "ProxyAuthenticationRequired"; + HttpCodes[HttpCodes["RequestTimeout"] = 408] = "RequestTimeout"; + HttpCodes[HttpCodes["Conflict"] = 409] = "Conflict"; + HttpCodes[HttpCodes["Gone"] = 410] = "Gone"; + HttpCodes[HttpCodes["TooManyRequests"] = 429] = "TooManyRequests"; + HttpCodes[HttpCodes["InternalServerError"] = 500] = "InternalServerError"; + HttpCodes[HttpCodes["NotImplemented"] = 501] = "NotImplemented"; + HttpCodes[HttpCodes["BadGateway"] = 502] = "BadGateway"; + HttpCodes[HttpCodes["ServiceUnavailable"] = 503] = "ServiceUnavailable"; + HttpCodes[HttpCodes["GatewayTimeout"] = 504] = "GatewayTimeout"; +})(HttpCodes = exports.HttpCodes || (exports.HttpCodes = {})); +var Headers; +(function (Headers) { + Headers["Accept"] = "accept"; + Headers["ContentType"] = "content-type"; +})(Headers = exports.Headers || (exports.Headers = {})); +var MediaTypes; +(function (MediaTypes) { + MediaTypes["ApplicationJson"] = "application/json"; +})(MediaTypes = exports.MediaTypes || (exports.MediaTypes = {})); +/** + * Returns the proxy URL, depending upon the supplied url and proxy environment variables. + * @param serverUrl The server URL where the request will be sent. For example, https://api.github.com + */ +function getProxyUrl(serverUrl) { + let proxyUrl = pm.getProxyUrl(new URL(serverUrl)); + return proxyUrl ? proxyUrl.href : ''; +} +exports.getProxyUrl = getProxyUrl; +const HttpRedirectCodes = [ + HttpCodes.MovedPermanently, + HttpCodes.ResourceMoved, + HttpCodes.SeeOther, + HttpCodes.TemporaryRedirect, + HttpCodes.PermanentRedirect +]; +const HttpResponseRetryCodes = [ + HttpCodes.BadGateway, + HttpCodes.ServiceUnavailable, + HttpCodes.GatewayTimeout +]; +const RetryableHttpVerbs = ['OPTIONS', 'GET', 'DELETE', 'HEAD']; +const ExponentialBackoffCeiling = 10; +const ExponentialBackoffTimeSlice = 5; +class HttpClientError extends Error { + constructor(message, statusCode) { + super(message); + this.name = 'HttpClientError'; + this.statusCode = statusCode; + Object.setPrototypeOf(this, HttpClientError.prototype); + } +} +exports.HttpClientError = HttpClientError; +class HttpClientResponse { + constructor(message) { + this.message = message; + } + readBody() { + return new Promise(async (resolve, reject) => { + let output = Buffer.alloc(0); + this.message.on('data', (chunk) => { + output = Buffer.concat([output, chunk]); + }); + this.message.on('end', () => { + resolve(output.toString()); + }); + }); + } +} +exports.HttpClientResponse = HttpClientResponse; +function isHttps(requestUrl) { + let parsedUrl = new URL(requestUrl); + return parsedUrl.protocol === 'https:'; +} +exports.isHttps = isHttps; +class HttpClient { + constructor(userAgent, handlers, requestOptions) { + this._ignoreSslError = false; + this._allowRedirects = true; + this._allowRedirectDowngrade = false; + this._maxRedirects = 50; + this._allowRetries = false; + this._maxRetries = 1; + this._keepAlive = false; + this._disposed = false; + this.userAgent = userAgent; + this.handlers = handlers || []; + this.requestOptions = requestOptions; + if (requestOptions) { + if (requestOptions.ignoreSslError != null) { + this._ignoreSslError = requestOptions.ignoreSslError; + } + this._socketTimeout = requestOptions.socketTimeout; + if (requestOptions.allowRedirects != null) { + this._allowRedirects = requestOptions.allowRedirects; + } + if (requestOptions.allowRedirectDowngrade != null) { + this._allowRedirectDowngrade = requestOptions.allowRedirectDowngrade; + } + if (requestOptions.maxRedirects != null) { + this._maxRedirects = Math.max(requestOptions.maxRedirects, 0); + } + if (requestOptions.keepAlive != null) { + this._keepAlive = requestOptions.keepAlive; + } + if (requestOptions.allowRetries != null) { + this._allowRetries = requestOptions.allowRetries; + } + if (requestOptions.maxRetries != null) { + this._maxRetries = requestOptions.maxRetries; + } + } + } + options(requestUrl, additionalHeaders) { + return this.request('OPTIONS', requestUrl, null, additionalHeaders || {}); + } + get(requestUrl, additionalHeaders) { + return this.request('GET', requestUrl, null, additionalHeaders || {}); + } + del(requestUrl, additionalHeaders) { + return this.request('DELETE', requestUrl, null, additionalHeaders || {}); + } + post(requestUrl, data, additionalHeaders) { + return this.request('POST', requestUrl, data, additionalHeaders || {}); + } + patch(requestUrl, data, additionalHeaders) { + return this.request('PATCH', requestUrl, data, additionalHeaders || {}); + } + put(requestUrl, data, additionalHeaders) { + return this.request('PUT', requestUrl, data, additionalHeaders || {}); + } + head(requestUrl, additionalHeaders) { + return this.request('HEAD', requestUrl, null, additionalHeaders || {}); + } + sendStream(verb, requestUrl, stream, additionalHeaders) { + return this.request(verb, requestUrl, stream, additionalHeaders); + } + /** + * Gets a typed object from an endpoint + * Be aware that not found returns a null. Other errors (4xx, 5xx) reject the promise + */ + async getJson(requestUrl, additionalHeaders = {}) { + additionalHeaders[Headers.Accept] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.Accept, MediaTypes.ApplicationJson); + let res = await this.get(requestUrl, additionalHeaders); + return this._processResponse(res, this.requestOptions); + } + async postJson(requestUrl, obj, additionalHeaders = {}) { + let data = JSON.stringify(obj, null, 2); + additionalHeaders[Headers.Accept] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.Accept, MediaTypes.ApplicationJson); + additionalHeaders[Headers.ContentType] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.ContentType, MediaTypes.ApplicationJson); + let res = await this.post(requestUrl, data, additionalHeaders); + return this._processResponse(res, this.requestOptions); + } + async putJson(requestUrl, obj, additionalHeaders = {}) { + let data = JSON.stringify(obj, null, 2); + additionalHeaders[Headers.Accept] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.Accept, MediaTypes.ApplicationJson); + additionalHeaders[Headers.ContentType] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.ContentType, MediaTypes.ApplicationJson); + let res = await this.put(requestUrl, data, additionalHeaders); + return this._processResponse(res, this.requestOptions); + } + async patchJson(requestUrl, obj, additionalHeaders = {}) { + let data = JSON.stringify(obj, null, 2); + additionalHeaders[Headers.Accept] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.Accept, MediaTypes.ApplicationJson); + additionalHeaders[Headers.ContentType] = this._getExistingOrDefaultHeader(additionalHeaders, Headers.ContentType, MediaTypes.ApplicationJson); + let res = await this.patch(requestUrl, data, additionalHeaders); + return this._processResponse(res, this.requestOptions); + } + /** + * Makes a raw http request. + * All other methods such as get, post, patch, and request ultimately call this. + * Prefer get, del, post and patch + */ + async request(verb, requestUrl, data, headers) { + if (this._disposed) { + throw new Error('Client has already been disposed.'); + } + let parsedUrl = new URL(requestUrl); + let info = this._prepareRequest(verb, parsedUrl, headers); + // Only perform retries on reads since writes may not be idempotent. + let maxTries = this._allowRetries && RetryableHttpVerbs.indexOf(verb) != -1 + ? this._maxRetries + 1 + : 1; + let numTries = 0; + let response; + while (numTries < maxTries) { + response = await this.requestRaw(info, data); + // Check if it's an authentication challenge + if (response && + response.message && + response.message.statusCode === HttpCodes.Unauthorized) { + let authenticationHandler; + for (let i = 0; i < this.handlers.length; i++) { + if (this.handlers[i].canHandleAuthentication(response)) { + authenticationHandler = this.handlers[i]; + break; + } + } + if (authenticationHandler) { + return authenticationHandler.handleAuthentication(this, info, data); + } + else { + // We have received an unauthorized response but have no handlers to handle it. + // Let the response return to the caller. + return response; + } + } + let redirectsRemaining = this._maxRedirects; + while (HttpRedirectCodes.indexOf(response.message.statusCode) != -1 && + this._allowRedirects && + redirectsRemaining > 0) { + const redirectUrl = response.message.headers['location']; + if (!redirectUrl) { + // if there's no location to redirect to, we won't + break; + } + let parsedRedirectUrl = new URL(redirectUrl); + if (parsedUrl.protocol == 'https:' && + parsedUrl.protocol != parsedRedirectUrl.protocol && + !this._allowRedirectDowngrade) { + throw new Error('Redirect from HTTPS to HTTP protocol. This downgrade is not allowed for security reasons. If you want to allow this behavior, set the allowRedirectDowngrade option to true.'); + } + // we need to finish reading the response before reassigning response + // which will leak the open socket. + await response.readBody(); + // strip authorization header if redirected to a different hostname + if (parsedRedirectUrl.hostname !== parsedUrl.hostname) { + for (let header in headers) { + // header names are case insensitive + if (header.toLowerCase() === 'authorization') { + delete headers[header]; + } + } + } + // let's make the request with the new redirectUrl + info = this._prepareRequest(verb, parsedRedirectUrl, headers); + response = await this.requestRaw(info, data); + redirectsRemaining--; + } + if (HttpResponseRetryCodes.indexOf(response.message.statusCode) == -1) { + // If not a retry code, return immediately instead of retrying + return response; + } + numTries += 1; + if (numTries < maxTries) { + await response.readBody(); + await this._performExponentialBackoff(numTries); + } + } + return response; + } + /** + * Needs to be called if keepAlive is set to true in request options. + */ + dispose() { + if (this._agent) { + this._agent.destroy(); + } + this._disposed = true; + } + /** + * Raw request. + * @param info + * @param data + */ + requestRaw(info, data) { + return new Promise((resolve, reject) => { + let callbackForResult = function (err, res) { + if (err) { + reject(err); + } + resolve(res); + }; + this.requestRawWithCallback(info, data, callbackForResult); + }); + } + /** + * Raw request with callback. + * @param info + * @param data + * @param onResult + */ + requestRawWithCallback(info, data, onResult) { + let socket; + if (typeof data === 'string') { + info.options.headers['Content-Length'] = Buffer.byteLength(data, 'utf8'); + } + let callbackCalled = false; + let handleResult = (err, res) => { + if (!callbackCalled) { + callbackCalled = true; + onResult(err, res); + } + }; + let req = info.httpModule.request(info.options, (msg) => { + let res = new HttpClientResponse(msg); + handleResult(null, res); + }); + req.on('socket', sock => { + socket = sock; + }); + // If we ever get disconnected, we want the socket to timeout eventually + req.setTimeout(this._socketTimeout || 3 * 60000, () => { + if (socket) { + socket.end(); + } + handleResult(new Error('Request timeout: ' + info.options.path), null); + }); + req.on('error', function (err) { + // err has statusCode property + // res should have headers + handleResult(err, null); + }); + if (data && typeof data === 'string') { + req.write(data, 'utf8'); + } + if (data && typeof data !== 'string') { + data.on('close', function () { + req.end(); + }); + data.pipe(req); + } + else { + req.end(); + } + } + /** + * Gets an http agent. This function is useful when you need an http agent that handles + * routing through a proxy server - depending upon the url and proxy environment variables. + * @param serverUrl The server URL where the request will be sent. For example, https://api.github.com + */ + getAgent(serverUrl) { + let parsedUrl = new URL(serverUrl); + return this._getAgent(parsedUrl); + } + _prepareRequest(method, requestUrl, headers) { + const info = {}; + info.parsedUrl = requestUrl; + const usingSsl = info.parsedUrl.protocol === 'https:'; + info.httpModule = usingSsl ? https : http; + const defaultPort = usingSsl ? 443 : 80; + info.options = {}; + info.options.host = info.parsedUrl.hostname; + info.options.port = info.parsedUrl.port + ? parseInt(info.parsedUrl.port) + : defaultPort; + info.options.path = + (info.parsedUrl.pathname || '') + (info.parsedUrl.search || ''); + info.options.method = method; + info.options.headers = this._mergeHeaders(headers); + if (this.userAgent != null) { + info.options.headers['user-agent'] = this.userAgent; + } + info.options.agent = this._getAgent(info.parsedUrl); + // gives handlers an opportunity to participate + if (this.handlers) { + this.handlers.forEach(handler => { + handler.prepareRequest(info.options); + }); + } + return info; + } + _mergeHeaders(headers) { + const lowercaseKeys = obj => Object.keys(obj).reduce((c, k) => ((c[k.toLowerCase()] = obj[k]), c), {}); + if (this.requestOptions && this.requestOptions.headers) { + return Object.assign({}, lowercaseKeys(this.requestOptions.headers), lowercaseKeys(headers)); + } + return lowercaseKeys(headers || {}); + } + _getExistingOrDefaultHeader(additionalHeaders, header, _default) { + const lowercaseKeys = obj => Object.keys(obj).reduce((c, k) => ((c[k.toLowerCase()] = obj[k]), c), {}); + let clientHeader; + if (this.requestOptions && this.requestOptions.headers) { + clientHeader = lowercaseKeys(this.requestOptions.headers)[header]; + } + return additionalHeaders[header] || clientHeader || _default; + } + _getAgent(parsedUrl) { + let agent; + let proxyUrl = pm.getProxyUrl(parsedUrl); + let useProxy = proxyUrl && proxyUrl.hostname; + if (this._keepAlive && useProxy) { + agent = this._proxyAgent; + } + if (this._keepAlive && !useProxy) { + agent = this._agent; + } + // if agent is already assigned use that agent. + if (!!agent) { + return agent; + } + const usingSsl = parsedUrl.protocol === 'https:'; + let maxSockets = 100; + if (!!this.requestOptions) { + maxSockets = this.requestOptions.maxSockets || http.globalAgent.maxSockets; + } + if (useProxy) { + // If using proxy, need tunnel + if (!tunnel) { + tunnel = require('tunnel'); + } + const agentOptions = { + maxSockets: maxSockets, + keepAlive: this._keepAlive, + proxy: { + ...((proxyUrl.username || proxyUrl.password) && { + proxyAuth: `${proxyUrl.username}:${proxyUrl.password}` + }), + host: proxyUrl.hostname, + port: proxyUrl.port + } + }; + let tunnelAgent; + const overHttps = proxyUrl.protocol === 'https:'; + if (usingSsl) { + tunnelAgent = overHttps ? tunnel.httpsOverHttps : tunnel.httpsOverHttp; + } + else { + tunnelAgent = overHttps ? tunnel.httpOverHttps : tunnel.httpOverHttp; + } + agent = tunnelAgent(agentOptions); + this._proxyAgent = agent; + } + // if reusing agent across request and tunneling agent isn't assigned create a new agent + if (this._keepAlive && !agent) { + const options = { keepAlive: this._keepAlive, maxSockets: maxSockets }; + agent = usingSsl ? new https.Agent(options) : new http.Agent(options); + this._agent = agent; + } + // if not using private agent and tunnel agent isn't setup then use global agent + if (!agent) { + agent = usingSsl ? https.globalAgent : http.globalAgent; + } + if (usingSsl && this._ignoreSslError) { + // we don't want to set NODE_TLS_REJECT_UNAUTHORIZED=0 since that will affect request for entire process + // http.RequestOptions doesn't expose a way to modify RequestOptions.agent.options + // we have to cast it to any and change it directly + agent.options = Object.assign(agent.options || {}, { + rejectUnauthorized: false + }); + } + return agent; + } + _performExponentialBackoff(retryNumber) { + retryNumber = Math.min(ExponentialBackoffCeiling, retryNumber); + const ms = ExponentialBackoffTimeSlice * Math.pow(2, retryNumber); + return new Promise(resolve => setTimeout(() => resolve(), ms)); + } + static dateTimeDeserializer(key, value) { + if (typeof value === 'string') { + let a = new Date(value); + if (!isNaN(a.valueOf())) { + return a; + } + } + return value; + } + async _processResponse(res, options) { + return new Promise(async (resolve, reject) => { + const statusCode = res.message.statusCode; + const response = { + statusCode: statusCode, + result: null, + headers: {} + }; + // not found leads to null obj returned + if (statusCode == HttpCodes.NotFound) { + resolve(response); + } + let obj; + let contents; + // get the result from the body + try { + contents = await res.readBody(); + if (contents && contents.length > 0) { + if (options && options.deserializeDates) { + obj = JSON.parse(contents, HttpClient.dateTimeDeserializer); + } + else { + obj = JSON.parse(contents); + } + response.result = obj; + } + response.headers = res.message.headers; + } + catch (err) { + // Invalid resource (contents not json); leaving result obj null + } + // note that 3xx redirects are handled by the http layer. + if (statusCode > 299) { + let msg; + // if exception/error in body, attempt to get better error + if (obj && obj.message) { + msg = obj.message; + } + else if (contents && contents.length > 0) { + // it may be the case that the exception is in the body message as string + msg = contents; + } + else { + msg = 'Failed request: (' + statusCode + ')'; + } + let err = new HttpClientError(msg, statusCode); + err.result = response.result; + reject(err); + } + else { + resolve(response); + } + }); + } +} +exports.HttpClient = HttpClient; diff --git a/node_modules/@actions/http-client/interfaces.d.ts b/node_modules/@actions/http-client/interfaces.d.ts new file mode 100644 index 00000000..78bd85b3 --- /dev/null +++ b/node_modules/@actions/http-client/interfaces.d.ts @@ -0,0 +1,49 @@ +/// +import http = require('http'); +export interface IHeaders { + [key: string]: any; +} +export interface IHttpClient { + options(requestUrl: string, additionalHeaders?: IHeaders): Promise; + get(requestUrl: string, additionalHeaders?: IHeaders): Promise; + del(requestUrl: string, additionalHeaders?: IHeaders): Promise; + post(requestUrl: string, data: string, additionalHeaders?: IHeaders): Promise; + patch(requestUrl: string, data: string, additionalHeaders?: IHeaders): Promise; + put(requestUrl: string, data: string, additionalHeaders?: IHeaders): Promise; + sendStream(verb: string, requestUrl: string, stream: NodeJS.ReadableStream, additionalHeaders?: IHeaders): Promise; + request(verb: string, requestUrl: string, data: string | NodeJS.ReadableStream, headers: IHeaders): Promise; + requestRaw(info: IRequestInfo, data: string | NodeJS.ReadableStream): Promise; + requestRawWithCallback(info: IRequestInfo, data: string | NodeJS.ReadableStream, onResult: (err: any, res: IHttpClientResponse) => void): void; +} +export interface IRequestHandler { + prepareRequest(options: http.RequestOptions): void; + canHandleAuthentication(response: IHttpClientResponse): boolean; + handleAuthentication(httpClient: IHttpClient, requestInfo: IRequestInfo, objs: any): Promise; +} +export interface IHttpClientResponse { + message: http.IncomingMessage; + readBody(): Promise; +} +export interface IRequestInfo { + options: http.RequestOptions; + parsedUrl: URL; + httpModule: any; +} +export interface IRequestOptions { + headers?: IHeaders; + socketTimeout?: number; + ignoreSslError?: boolean; + allowRedirects?: boolean; + allowRedirectDowngrade?: boolean; + maxRedirects?: number; + maxSockets?: number; + keepAlive?: boolean; + deserializeDates?: boolean; + allowRetries?: boolean; + maxRetries?: number; +} +export interface ITypedResponse { + statusCode: number; + result: T | null; + headers: Object; +} diff --git a/node_modules/@actions/http-client/interfaces.js b/node_modules/@actions/http-client/interfaces.js new file mode 100644 index 00000000..c8ad2e54 --- /dev/null +++ b/node_modules/@actions/http-client/interfaces.js @@ -0,0 +1,2 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); diff --git a/node_modules/@actions/http-client/package.json b/node_modules/@actions/http-client/package.json new file mode 100644 index 00000000..0c99fd41 --- /dev/null +++ b/node_modules/@actions/http-client/package.json @@ -0,0 +1,39 @@ +{ + "name": "@actions/http-client", + "version": "1.0.11", + "description": "Actions Http Client", + "main": "index.js", + "scripts": { + "build": "rm -Rf ./_out && tsc && cp package*.json ./_out && cp *.md ./_out && cp LICENSE ./_out && cp actions.png ./_out", + "test": "jest", + "format": "prettier --write *.ts && prettier --write **/*.ts", + "format-check": "prettier --check *.ts && prettier --check **/*.ts", + "audit-check": "npm audit --audit-level=moderate" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/actions/http-client.git" + }, + "keywords": [ + "Actions", + "Http" + ], + "author": "GitHub, Inc.", + "license": "MIT", + "bugs": { + "url": "https://github.com/actions/http-client/issues" + }, + "homepage": "https://github.com/actions/http-client#readme", + "devDependencies": { + "@types/jest": "^25.1.4", + "@types/node": "^12.12.31", + "jest": "^25.1.0", + "prettier": "^2.0.4", + "proxy": "^1.0.1", + "ts-jest": "^25.2.1", + "typescript": "^3.8.3" + }, + "dependencies": { + "tunnel": "0.0.6" + } +} diff --git a/node_modules/@actions/http-client/proxy.d.ts b/node_modules/@actions/http-client/proxy.d.ts new file mode 100644 index 00000000..45998654 --- /dev/null +++ b/node_modules/@actions/http-client/proxy.d.ts @@ -0,0 +1,2 @@ +export declare function getProxyUrl(reqUrl: URL): URL | undefined; +export declare function checkBypass(reqUrl: URL): boolean; diff --git a/node_modules/@actions/http-client/proxy.js b/node_modules/@actions/http-client/proxy.js new file mode 100644 index 00000000..88f00ecd --- /dev/null +++ b/node_modules/@actions/http-client/proxy.js @@ -0,0 +1,57 @@ +"use strict"; +Object.defineProperty(exports, "__esModule", { value: true }); +function getProxyUrl(reqUrl) { + let usingSsl = reqUrl.protocol === 'https:'; + let proxyUrl; + if (checkBypass(reqUrl)) { + return proxyUrl; + } + let proxyVar; + if (usingSsl) { + proxyVar = process.env['https_proxy'] || process.env['HTTPS_PROXY']; + } + else { + proxyVar = process.env['http_proxy'] || process.env['HTTP_PROXY']; + } + if (proxyVar) { + proxyUrl = new URL(proxyVar); + } + return proxyUrl; +} +exports.getProxyUrl = getProxyUrl; +function checkBypass(reqUrl) { + if (!reqUrl.hostname) { + return false; + } + let noProxy = process.env['no_proxy'] || process.env['NO_PROXY'] || ''; + if (!noProxy) { + return false; + } + // Determine the request port + let reqPort; + if (reqUrl.port) { + reqPort = Number(reqUrl.port); + } + else if (reqUrl.protocol === 'http:') { + reqPort = 80; + } + else if (reqUrl.protocol === 'https:') { + reqPort = 443; + } + // Format the request hostname and hostname with port + let upperReqHosts = [reqUrl.hostname.toUpperCase()]; + if (typeof reqPort === 'number') { + upperReqHosts.push(`${upperReqHosts[0]}:${reqPort}`); + } + // Compare request host against noproxy + for (let upperNoProxyItem of noProxy + .split(',') + .map(x => x.trim().toUpperCase()) + .filter(x => x)) { + if (upperReqHosts.some(x => x === upperNoProxyItem)) { + return true; + } + } + return false; +} +exports.checkBypass = checkBypass; diff --git a/node_modules/@actions/io/LICENSE.md b/node_modules/@actions/io/LICENSE.md new file mode 100644 index 00000000..dbae2edb --- /dev/null +++ b/node_modules/@actions/io/LICENSE.md @@ -0,0 +1,9 @@ +The MIT License (MIT) + +Copyright 2019 GitHub + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/node_modules/@actions/io/README.md b/node_modules/@actions/io/README.md new file mode 100644 index 00000000..9aadf2f9 --- /dev/null +++ b/node_modules/@actions/io/README.md @@ -0,0 +1,53 @@ +# `@actions/io` + +> Core functions for cli filesystem scenarios + +## Usage + +#### mkdir -p + +Recursively make a directory. Follows rules specified in [man mkdir](https://linux.die.net/man/1/mkdir) with the `-p` option specified: + +```js +const io = require('@actions/io'); + +await io.mkdirP('path/to/make'); +``` + +#### cp/mv + +Copy or move files or folders. Follows rules specified in [man cp](https://linux.die.net/man/1/cp) and [man mv](https://linux.die.net/man/1/mv): + +```js +const io = require('@actions/io'); + +// Recursive must be true for directories +const options = { recursive: true, force: false } + +await io.cp('path/to/directory', 'path/to/dest', options); +await io.mv('path/to/file', 'path/to/dest'); +``` + +#### rm -rf + +Remove a file or folder recursively. Follows rules specified in [man rm](https://linux.die.net/man/1/rm) with the `-r` and `-f` rules specified. + +```js +const io = require('@actions/io'); + +await io.rmRF('path/to/directory'); +await io.rmRF('path/to/file'); +``` + +#### which + +Get the path to a tool and resolves via paths. Follows the rules specified in [man which](https://linux.die.net/man/1/which). + +```js +const exec = require('@actions/exec'); +const io = require('@actions/io'); + +const pythonPath: string = await io.which('python', true) + +await exec.exec(`"${pythonPath}"`, ['main.py']); +``` diff --git a/node_modules/@actions/io/lib/io-util.d.ts b/node_modules/@actions/io/lib/io-util.d.ts new file mode 100644 index 00000000..0cddd318 --- /dev/null +++ b/node_modules/@actions/io/lib/io-util.d.ts @@ -0,0 +1,19 @@ +/// +import * as fs from 'fs'; +export declare const chmod: typeof fs.promises.chmod, copyFile: typeof fs.promises.copyFile, lstat: typeof fs.promises.lstat, mkdir: typeof fs.promises.mkdir, readdir: typeof fs.promises.readdir, readlink: typeof fs.promises.readlink, rename: typeof fs.promises.rename, rmdir: typeof fs.promises.rmdir, stat: typeof fs.promises.stat, symlink: typeof fs.promises.symlink, unlink: typeof fs.promises.unlink; +export declare const IS_WINDOWS: boolean; +export declare function exists(fsPath: string): Promise; +export declare function isDirectory(fsPath: string, useStat?: boolean): Promise; +/** + * On OSX/Linux, true if path starts with '/'. On Windows, true for paths like: + * \, \hello, \\hello\share, C:, and C:\hello (and corresponding alternate separator cases). + */ +export declare function isRooted(p: string): boolean; +/** + * Best effort attempt to determine whether a file exists and is executable. + * @param filePath file path to check + * @param extensions additional file extensions to try + * @return if file exists and is executable, returns the file path. otherwise empty string. + */ +export declare function tryGetExecutablePath(filePath: string, extensions: string[]): Promise; +export declare function getCmdPath(): string; diff --git a/node_modules/@actions/io/lib/io-util.js b/node_modules/@actions/io/lib/io-util.js new file mode 100644 index 00000000..aae903cb --- /dev/null +++ b/node_modules/@actions/io/lib/io-util.js @@ -0,0 +1,177 @@ +"use strict"; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +var _a; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.getCmdPath = exports.tryGetExecutablePath = exports.isRooted = exports.isDirectory = exports.exists = exports.IS_WINDOWS = exports.unlink = exports.symlink = exports.stat = exports.rmdir = exports.rename = exports.readlink = exports.readdir = exports.mkdir = exports.lstat = exports.copyFile = exports.chmod = void 0; +const fs = __importStar(require("fs")); +const path = __importStar(require("path")); +_a = fs.promises, exports.chmod = _a.chmod, exports.copyFile = _a.copyFile, exports.lstat = _a.lstat, exports.mkdir = _a.mkdir, exports.readdir = _a.readdir, exports.readlink = _a.readlink, exports.rename = _a.rename, exports.rmdir = _a.rmdir, exports.stat = _a.stat, exports.symlink = _a.symlink, exports.unlink = _a.unlink; +exports.IS_WINDOWS = process.platform === 'win32'; +function exists(fsPath) { + return __awaiter(this, void 0, void 0, function* () { + try { + yield exports.stat(fsPath); + } + catch (err) { + if (err.code === 'ENOENT') { + return false; + } + throw err; + } + return true; + }); +} +exports.exists = exists; +function isDirectory(fsPath, useStat = false) { + return __awaiter(this, void 0, void 0, function* () { + const stats = useStat ? yield exports.stat(fsPath) : yield exports.lstat(fsPath); + return stats.isDirectory(); + }); +} +exports.isDirectory = isDirectory; +/** + * On OSX/Linux, true if path starts with '/'. On Windows, true for paths like: + * \, \hello, \\hello\share, C:, and C:\hello (and corresponding alternate separator cases). + */ +function isRooted(p) { + p = normalizeSeparators(p); + if (!p) { + throw new Error('isRooted() parameter "p" cannot be empty'); + } + if (exports.IS_WINDOWS) { + return (p.startsWith('\\') || /^[A-Z]:/i.test(p) // e.g. \ or \hello or \\hello + ); // e.g. C: or C:\hello + } + return p.startsWith('/'); +} +exports.isRooted = isRooted; +/** + * Best effort attempt to determine whether a file exists and is executable. + * @param filePath file path to check + * @param extensions additional file extensions to try + * @return if file exists and is executable, returns the file path. otherwise empty string. + */ +function tryGetExecutablePath(filePath, extensions) { + return __awaiter(this, void 0, void 0, function* () { + let stats = undefined; + try { + // test file exists + stats = yield exports.stat(filePath); + } + catch (err) { + if (err.code !== 'ENOENT') { + // eslint-disable-next-line no-console + console.log(`Unexpected error attempting to determine if executable file exists '${filePath}': ${err}`); + } + } + if (stats && stats.isFile()) { + if (exports.IS_WINDOWS) { + // on Windows, test for valid extension + const upperExt = path.extname(filePath).toUpperCase(); + if (extensions.some(validExt => validExt.toUpperCase() === upperExt)) { + return filePath; + } + } + else { + if (isUnixExecutable(stats)) { + return filePath; + } + } + } + // try each extension + const originalFilePath = filePath; + for (const extension of extensions) { + filePath = originalFilePath + extension; + stats = undefined; + try { + stats = yield exports.stat(filePath); + } + catch (err) { + if (err.code !== 'ENOENT') { + // eslint-disable-next-line no-console + console.log(`Unexpected error attempting to determine if executable file exists '${filePath}': ${err}`); + } + } + if (stats && stats.isFile()) { + if (exports.IS_WINDOWS) { + // preserve the case of the actual file (since an extension was appended) + try { + const directory = path.dirname(filePath); + const upperName = path.basename(filePath).toUpperCase(); + for (const actualName of yield exports.readdir(directory)) { + if (upperName === actualName.toUpperCase()) { + filePath = path.join(directory, actualName); + break; + } + } + } + catch (err) { + // eslint-disable-next-line no-console + console.log(`Unexpected error attempting to determine the actual case of the file '${filePath}': ${err}`); + } + return filePath; + } + else { + if (isUnixExecutable(stats)) { + return filePath; + } + } + } + } + return ''; + }); +} +exports.tryGetExecutablePath = tryGetExecutablePath; +function normalizeSeparators(p) { + p = p || ''; + if (exports.IS_WINDOWS) { + // convert slashes on Windows + p = p.replace(/\//g, '\\'); + // remove redundant slashes + return p.replace(/\\\\+/g, '\\'); + } + // remove redundant slashes + return p.replace(/\/\/+/g, '/'); +} +// on Mac/Linux, test the execute bit +// R W X R W X R W X +// 256 128 64 32 16 8 4 2 1 +function isUnixExecutable(stats) { + return ((stats.mode & 1) > 0 || + ((stats.mode & 8) > 0 && stats.gid === process.getgid()) || + ((stats.mode & 64) > 0 && stats.uid === process.getuid())); +} +// Get the path of cmd.exe in windows +function getCmdPath() { + var _a; + return (_a = process.env['COMSPEC']) !== null && _a !== void 0 ? _a : `cmd.exe`; +} +exports.getCmdPath = getCmdPath; +//# sourceMappingURL=io-util.js.map \ No newline at end of file diff --git a/node_modules/@actions/io/lib/io-util.js.map b/node_modules/@actions/io/lib/io-util.js.map new file mode 100644 index 00000000..ad5eebbb --- /dev/null +++ b/node_modules/@actions/io/lib/io-util.js.map @@ -0,0 +1 @@ +{"version":3,"file":"io-util.js","sourceRoot":"","sources":["../src/io-util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAwB;AACxB,2CAA4B;AAEf,KAYT,EAAE,CAAC,QAAQ,EAXb,aAAK,aACL,gBAAQ,gBACR,aAAK,aACL,aAAK,aACL,eAAO,eACP,gBAAQ,gBACR,cAAM,cACN,aAAK,aACL,YAAI,YACJ,eAAO,eACP,cAAM,aACO;AAEF,QAAA,UAAU,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAA;AAEtD,SAAsB,MAAM,CAAC,MAAc;;QACzC,IAAI;YACF,MAAM,YAAI,CAAC,MAAM,CAAC,CAAA;SACnB;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE;gBACzB,OAAO,KAAK,CAAA;aACb;YAED,MAAM,GAAG,CAAA;SACV;QAED,OAAO,IAAI,CAAA;IACb,CAAC;CAAA;AAZD,wBAYC;AAED,SAAsB,WAAW,CAC/B,MAAc,EACd,OAAO,GAAG,KAAK;;QAEf,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,MAAM,YAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,aAAK,CAAC,MAAM,CAAC,CAAA;QAChE,OAAO,KAAK,CAAC,WAAW,EAAE,CAAA;IAC5B,CAAC;CAAA;AAND,kCAMC;AAED;;;GAGG;AACH,SAAgB,QAAQ,CAAC,CAAS;IAChC,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAA;IAC1B,IAAI,CAAC,CAAC,EAAE;QACN,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;KAC5D;IAED,IAAI,kBAAU,EAAE;QACd,OAAO,CACL,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,8BAA8B;SACxE,CAAA,CAAC,sBAAsB;KACzB;IAED,OAAO,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;AAC1B,CAAC;AAbD,4BAaC;AAED;;;;;GAKG;AACH,SAAsB,oBAAoB,CACxC,QAAgB,EAChB,UAAoB;;QAEpB,IAAI,KAAK,GAAyB,SAAS,CAAA;QAC3C,IAAI;YACF,mBAAmB;YACnB,KAAK,GAAG,MAAM,YAAI,CAAC,QAAQ,CAAC,CAAA;SAC7B;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE;gBACzB,sCAAsC;gBACtC,OAAO,CAAC,GAAG,CACT,uEAAuE,QAAQ,MAAM,GAAG,EAAE,CAC3F,CAAA;aACF;SACF;QACD,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE;YAC3B,IAAI,kBAAU,EAAE;gBACd,uCAAuC;gBACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAA;gBACrD,IAAI,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,EAAE;oBACpE,OAAO,QAAQ,CAAA;iBAChB;aACF;iBAAM;gBACL,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;oBAC3B,OAAO,QAAQ,CAAA;iBAChB;aACF;SACF;QAED,qBAAqB;QACrB,MAAM,gBAAgB,GAAG,QAAQ,CAAA;QACjC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;YAClC,QAAQ,GAAG,gBAAgB,GAAG,SAAS,CAAA;YAEvC,KAAK,GAAG,SAAS,CAAA;YACjB,IAAI;gBACF,KAAK,GAAG,MAAM,YAAI,CAAC,QAAQ,CAAC,CAAA;aAC7B;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE;oBACzB,sCAAsC;oBACtC,OAAO,CAAC,GAAG,CACT,uEAAuE,QAAQ,MAAM,GAAG,EAAE,CAC3F,CAAA;iBACF;aACF;YAED,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE;gBAC3B,IAAI,kBAAU,EAAE;oBACd,yEAAyE;oBACzE,IAAI;wBACF,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;wBACxC,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAA;wBACvD,KAAK,MAAM,UAAU,IAAI,MAAM,eAAO,CAAC,SAAS,CAAC,EAAE;4BACjD,IAAI,SAAS,KAAK,UAAU,CAAC,WAAW,EAAE,EAAE;gCAC1C,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;gCAC3C,MAAK;6BACN;yBACF;qBACF;oBAAC,OAAO,GAAG,EAAE;wBACZ,sCAAsC;wBACtC,OAAO,CAAC,GAAG,CACT,yEAAyE,QAAQ,MAAM,GAAG,EAAE,CAC7F,CAAA;qBACF;oBAED,OAAO,QAAQ,CAAA;iBAChB;qBAAM;oBACL,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;wBAC3B,OAAO,QAAQ,CAAA;qBAChB;iBACF;aACF;SACF;QAED,OAAO,EAAE,CAAA;IACX,CAAC;CAAA;AA5ED,oDA4EC;AAED,SAAS,mBAAmB,CAAC,CAAS;IACpC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAA;IACX,IAAI,kBAAU,EAAE;QACd,6BAA6B;QAC7B,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAE1B,2BAA2B;QAC3B,OAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;KACjC;IAED,2BAA2B;IAC3B,OAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;AACjC,CAAC;AAED,qCAAqC;AACrC,6BAA6B;AAC7B,6BAA6B;AAC7B,SAAS,gBAAgB,CAAC,KAAe;IACvC,OAAO,CACL,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC;QACpB,CAAC,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;QACxD,CAAC,CAAC,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAC1D,CAAA;AACH,CAAC;AAED,qCAAqC;AACrC,SAAgB,UAAU;;IACxB,aAAO,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,mCAAI,SAAS,CAAA;AAC5C,CAAC;AAFD,gCAEC"} \ No newline at end of file diff --git a/node_modules/@actions/io/lib/io.d.ts b/node_modules/@actions/io/lib/io.d.ts new file mode 100644 index 00000000..a674522f --- /dev/null +++ b/node_modules/@actions/io/lib/io.d.ts @@ -0,0 +1,64 @@ +/** + * Interface for cp/mv options + */ +export interface CopyOptions { + /** Optional. Whether to recursively copy all subdirectories. Defaults to false */ + recursive?: boolean; + /** Optional. Whether to overwrite existing files in the destination. Defaults to true */ + force?: boolean; + /** Optional. Whether to copy the source directory along with all the files. Only takes effect when recursive=true and copying a directory. Default is true*/ + copySourceDirectory?: boolean; +} +/** + * Interface for cp/mv options + */ +export interface MoveOptions { + /** Optional. Whether to overwrite existing files in the destination. Defaults to true */ + force?: boolean; +} +/** + * Copies a file or folder. + * Based off of shelljs - https://github.com/shelljs/shelljs/blob/9237f66c52e5daa40458f94f9565e18e8132f5a6/src/cp.js + * + * @param source source path + * @param dest destination path + * @param options optional. See CopyOptions. + */ +export declare function cp(source: string, dest: string, options?: CopyOptions): Promise; +/** + * Moves a path. + * + * @param source source path + * @param dest destination path + * @param options optional. See MoveOptions. + */ +export declare function mv(source: string, dest: string, options?: MoveOptions): Promise; +/** + * Remove a path recursively with force + * + * @param inputPath path to remove + */ +export declare function rmRF(inputPath: string): Promise; +/** + * Make a directory. Creates the full path with folders in between + * Will throw if it fails + * + * @param fsPath path to create + * @returns Promise + */ +export declare function mkdirP(fsPath: string): Promise; +/** + * Returns path of a tool had the tool actually been invoked. Resolves via paths. + * If you check and the tool does not exist, it will throw. + * + * @param tool name of the tool + * @param check whether to check if tool exists + * @returns Promise path to tool + */ +export declare function which(tool: string, check?: boolean): Promise; +/** + * Returns a list of all occurrences of the given tool on the system path. + * + * @returns Promise the paths of the tool + */ +export declare function findInPath(tool: string): Promise; diff --git a/node_modules/@actions/io/lib/io.js b/node_modules/@actions/io/lib/io.js new file mode 100644 index 00000000..4dc1fc34 --- /dev/null +++ b/node_modules/@actions/io/lib/io.js @@ -0,0 +1,341 @@ +"use strict"; +var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } }); +}) : (function(o, m, k, k2) { + if (k2 === undefined) k2 = k; + o[k2] = m[k]; +})); +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { + Object.defineProperty(o, "default", { enumerable: true, value: v }); +}) : function(o, v) { + o["default"] = v; +}); +var __importStar = (this && this.__importStar) || function (mod) { + if (mod && mod.__esModule) return mod; + var result = {}; + if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); + __setModuleDefault(result, mod); + return result; +}; +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.findInPath = exports.which = exports.mkdirP = exports.rmRF = exports.mv = exports.cp = void 0; +const assert_1 = require("assert"); +const childProcess = __importStar(require("child_process")); +const path = __importStar(require("path")); +const util_1 = require("util"); +const ioUtil = __importStar(require("./io-util")); +const exec = util_1.promisify(childProcess.exec); +const execFile = util_1.promisify(childProcess.execFile); +/** + * Copies a file or folder. + * Based off of shelljs - https://github.com/shelljs/shelljs/blob/9237f66c52e5daa40458f94f9565e18e8132f5a6/src/cp.js + * + * @param source source path + * @param dest destination path + * @param options optional. See CopyOptions. + */ +function cp(source, dest, options = {}) { + return __awaiter(this, void 0, void 0, function* () { + const { force, recursive, copySourceDirectory } = readCopyOptions(options); + const destStat = (yield ioUtil.exists(dest)) ? yield ioUtil.stat(dest) : null; + // Dest is an existing file, but not forcing + if (destStat && destStat.isFile() && !force) { + return; + } + // If dest is an existing directory, should copy inside. + const newDest = destStat && destStat.isDirectory() && copySourceDirectory + ? path.join(dest, path.basename(source)) + : dest; + if (!(yield ioUtil.exists(source))) { + throw new Error(`no such file or directory: ${source}`); + } + const sourceStat = yield ioUtil.stat(source); + if (sourceStat.isDirectory()) { + if (!recursive) { + throw new Error(`Failed to copy. ${source} is a directory, but tried to copy without recursive flag.`); + } + else { + yield cpDirRecursive(source, newDest, 0, force); + } + } + else { + if (path.relative(source, newDest) === '') { + // a file cannot be copied to itself + throw new Error(`'${newDest}' and '${source}' are the same file`); + } + yield copyFile(source, newDest, force); + } + }); +} +exports.cp = cp; +/** + * Moves a path. + * + * @param source source path + * @param dest destination path + * @param options optional. See MoveOptions. + */ +function mv(source, dest, options = {}) { + return __awaiter(this, void 0, void 0, function* () { + if (yield ioUtil.exists(dest)) { + let destExists = true; + if (yield ioUtil.isDirectory(dest)) { + // If dest is directory copy src into dest + dest = path.join(dest, path.basename(source)); + destExists = yield ioUtil.exists(dest); + } + if (destExists) { + if (options.force == null || options.force) { + yield rmRF(dest); + } + else { + throw new Error('Destination already exists'); + } + } + } + yield mkdirP(path.dirname(dest)); + yield ioUtil.rename(source, dest); + }); +} +exports.mv = mv; +/** + * Remove a path recursively with force + * + * @param inputPath path to remove + */ +function rmRF(inputPath) { + return __awaiter(this, void 0, void 0, function* () { + if (ioUtil.IS_WINDOWS) { + // Node doesn't provide a delete operation, only an unlink function. This means that if the file is being used by another + // program (e.g. antivirus), it won't be deleted. To address this, we shell out the work to rd/del. + // Check for invalid characters + // https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file + if (/[*"<>|]/.test(inputPath)) { + throw new Error('File path must not contain `*`, `"`, `<`, `>` or `|` on Windows'); + } + try { + const cmdPath = ioUtil.getCmdPath(); + if (yield ioUtil.isDirectory(inputPath, true)) { + yield exec(`${cmdPath} /s /c "rd /s /q "%inputPath%""`, { + env: { inputPath } + }); + } + else { + yield exec(`${cmdPath} /s /c "del /f /a "%inputPath%""`, { + env: { inputPath } + }); + } + } + catch (err) { + // if you try to delete a file that doesn't exist, desired result is achieved + // other errors are valid + if (err.code !== 'ENOENT') + throw err; + } + // Shelling out fails to remove a symlink folder with missing source, this unlink catches that + try { + yield ioUtil.unlink(inputPath); + } + catch (err) { + // if you try to delete a file that doesn't exist, desired result is achieved + // other errors are valid + if (err.code !== 'ENOENT') + throw err; + } + } + else { + let isDir = false; + try { + isDir = yield ioUtil.isDirectory(inputPath); + } + catch (err) { + // if you try to delete a file that doesn't exist, desired result is achieved + // other errors are valid + if (err.code !== 'ENOENT') + throw err; + return; + } + if (isDir) { + yield execFile(`rm`, [`-rf`, `${inputPath}`]); + } + else { + yield ioUtil.unlink(inputPath); + } + } + }); +} +exports.rmRF = rmRF; +/** + * Make a directory. Creates the full path with folders in between + * Will throw if it fails + * + * @param fsPath path to create + * @returns Promise + */ +function mkdirP(fsPath) { + return __awaiter(this, void 0, void 0, function* () { + assert_1.ok(fsPath, 'a path argument must be provided'); + yield ioUtil.mkdir(fsPath, { recursive: true }); + }); +} +exports.mkdirP = mkdirP; +/** + * Returns path of a tool had the tool actually been invoked. Resolves via paths. + * If you check and the tool does not exist, it will throw. + * + * @param tool name of the tool + * @param check whether to check if tool exists + * @returns Promise path to tool + */ +function which(tool, check) { + return __awaiter(this, void 0, void 0, function* () { + if (!tool) { + throw new Error("parameter 'tool' is required"); + } + // recursive when check=true + if (check) { + const result = yield which(tool, false); + if (!result) { + if (ioUtil.IS_WINDOWS) { + throw new Error(`Unable to locate executable file: ${tool}. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also verify the file has a valid extension for an executable file.`); + } + else { + throw new Error(`Unable to locate executable file: ${tool}. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also check the file mode to verify the file is executable.`); + } + } + return result; + } + const matches = yield findInPath(tool); + if (matches && matches.length > 0) { + return matches[0]; + } + return ''; + }); +} +exports.which = which; +/** + * Returns a list of all occurrences of the given tool on the system path. + * + * @returns Promise the paths of the tool + */ +function findInPath(tool) { + return __awaiter(this, void 0, void 0, function* () { + if (!tool) { + throw new Error("parameter 'tool' is required"); + } + // build the list of extensions to try + const extensions = []; + if (ioUtil.IS_WINDOWS && process.env['PATHEXT']) { + for (const extension of process.env['PATHEXT'].split(path.delimiter)) { + if (extension) { + extensions.push(extension); + } + } + } + // if it's rooted, return it if exists. otherwise return empty. + if (ioUtil.isRooted(tool)) { + const filePath = yield ioUtil.tryGetExecutablePath(tool, extensions); + if (filePath) { + return [filePath]; + } + return []; + } + // if any path separators, return empty + if (tool.includes(path.sep)) { + return []; + } + // build the list of directories + // + // Note, technically "where" checks the current directory on Windows. From a toolkit perspective, + // it feels like we should not do this. Checking the current directory seems like more of a use + // case of a shell, and the which() function exposed by the toolkit should strive for consistency + // across platforms. + const directories = []; + if (process.env.PATH) { + for (const p of process.env.PATH.split(path.delimiter)) { + if (p) { + directories.push(p); + } + } + } + // find all matches + const matches = []; + for (const directory of directories) { + const filePath = yield ioUtil.tryGetExecutablePath(path.join(directory, tool), extensions); + if (filePath) { + matches.push(filePath); + } + } + return matches; + }); +} +exports.findInPath = findInPath; +function readCopyOptions(options) { + const force = options.force == null ? true : options.force; + const recursive = Boolean(options.recursive); + const copySourceDirectory = options.copySourceDirectory == null + ? true + : Boolean(options.copySourceDirectory); + return { force, recursive, copySourceDirectory }; +} +function cpDirRecursive(sourceDir, destDir, currentDepth, force) { + return __awaiter(this, void 0, void 0, function* () { + // Ensure there is not a run away recursive copy + if (currentDepth >= 255) + return; + currentDepth++; + yield mkdirP(destDir); + const files = yield ioUtil.readdir(sourceDir); + for (const fileName of files) { + const srcFile = `${sourceDir}/${fileName}`; + const destFile = `${destDir}/${fileName}`; + const srcFileStat = yield ioUtil.lstat(srcFile); + if (srcFileStat.isDirectory()) { + // Recurse + yield cpDirRecursive(srcFile, destFile, currentDepth, force); + } + else { + yield copyFile(srcFile, destFile, force); + } + } + // Change the mode for the newly created directory + yield ioUtil.chmod(destDir, (yield ioUtil.stat(sourceDir)).mode); + }); +} +// Buffered file copy +function copyFile(srcFile, destFile, force) { + return __awaiter(this, void 0, void 0, function* () { + if ((yield ioUtil.lstat(srcFile)).isSymbolicLink()) { + // unlink/re-link it + try { + yield ioUtil.lstat(destFile); + yield ioUtil.unlink(destFile); + } + catch (e) { + // Try to override file permission + if (e.code === 'EPERM') { + yield ioUtil.chmod(destFile, '0666'); + yield ioUtil.unlink(destFile); + } + // other errors = it doesn't exist, no work to do + } + // Copy over symlink + const symlinkFull = yield ioUtil.readlink(srcFile); + yield ioUtil.symlink(symlinkFull, destFile, ioUtil.IS_WINDOWS ? 'junction' : null); + } + else if (!(yield ioUtil.exists(destFile)) || force) { + yield ioUtil.copyFile(srcFile, destFile); + } + }); +} +//# sourceMappingURL=io.js.map \ No newline at end of file diff --git a/node_modules/@actions/io/lib/io.js.map b/node_modules/@actions/io/lib/io.js.map new file mode 100644 index 00000000..3249d7d8 --- /dev/null +++ b/node_modules/@actions/io/lib/io.js.map @@ -0,0 +1 @@ +{"version":3,"file":"io.js","sourceRoot":"","sources":["../src/io.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAAyB;AACzB,4DAA6C;AAC7C,2CAA4B;AAC5B,+BAA8B;AAC9B,kDAAmC;AAEnC,MAAM,IAAI,GAAG,gBAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;AACzC,MAAM,QAAQ,GAAG,gBAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;AAsBjD;;;;;;;GAOG;AACH,SAAsB,EAAE,CACtB,MAAc,EACd,IAAY,EACZ,UAAuB,EAAE;;QAEzB,MAAM,EAAC,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CAAA;QAExE,MAAM,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAC7E,4CAA4C;QAC5C,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE;YAC3C,OAAM;SACP;QAED,wDAAwD;QACxD,MAAM,OAAO,GACX,QAAQ,IAAI,QAAQ,CAAC,WAAW,EAAE,IAAI,mBAAmB;YACvD,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACxC,CAAC,CAAC,IAAI,CAAA;QAEV,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,8BAA8B,MAAM,EAAE,CAAC,CAAA;SACxD;QACD,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAE5C,IAAI,UAAU,CAAC,WAAW,EAAE,EAAE;YAC5B,IAAI,CAAC,SAAS,EAAE;gBACd,MAAM,IAAI,KAAK,CACb,mBAAmB,MAAM,4DAA4D,CACtF,CAAA;aACF;iBAAM;gBACL,MAAM,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,CAAA;aAChD;SACF;aAAM;YACL,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE;gBACzC,oCAAoC;gBACpC,MAAM,IAAI,KAAK,CAAC,IAAI,OAAO,UAAU,MAAM,qBAAqB,CAAC,CAAA;aAClE;YAED,MAAM,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;SACvC;IACH,CAAC;CAAA;AAxCD,gBAwCC;AAED;;;;;;GAMG;AACH,SAAsB,EAAE,CACtB,MAAc,EACd,IAAY,EACZ,UAAuB,EAAE;;QAEzB,IAAI,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YAC7B,IAAI,UAAU,GAAG,IAAI,CAAA;YACrB,IAAI,MAAM,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE;gBAClC,0CAA0C;gBAC1C,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;gBAC7C,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;aACvC;YAED,IAAI,UAAU,EAAE;gBACd,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE;oBAC1C,MAAM,IAAI,CAAC,IAAI,CAAC,CAAA;iBACjB;qBAAM;oBACL,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;iBAC9C;aACF;SACF;QACD,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;QAChC,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACnC,CAAC;CAAA;AAvBD,gBAuBC;AAED;;;;GAIG;AACH,SAAsB,IAAI,CAAC,SAAiB;;QAC1C,IAAI,MAAM,CAAC,UAAU,EAAE;YACrB,yHAAyH;YACzH,mGAAmG;YAEnG,+BAA+B;YAC/B,sEAAsE;YACtE,IAAI,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;gBAC7B,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAA;aACF;YACD,IAAI;gBACF,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAA;gBACnC,IAAI,MAAM,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE;oBAC7C,MAAM,IAAI,CAAC,GAAG,OAAO,iCAAiC,EAAE;wBACtD,GAAG,EAAE,EAAC,SAAS,EAAC;qBACjB,CAAC,CAAA;iBACH;qBAAM;oBACL,MAAM,IAAI,CAAC,GAAG,OAAO,kCAAkC,EAAE;wBACvD,GAAG,EAAE,EAAC,SAAS,EAAC;qBACjB,CAAC,CAAA;iBACH;aACF;YAAC,OAAO,GAAG,EAAE;gBACZ,6EAA6E;gBAC7E,yBAAyB;gBACzB,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ;oBAAE,MAAM,GAAG,CAAA;aACrC;YAED,8FAA8F;YAC9F,IAAI;gBACF,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;aAC/B;YAAC,OAAO,GAAG,EAAE;gBACZ,6EAA6E;gBAC7E,yBAAyB;gBACzB,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ;oBAAE,MAAM,GAAG,CAAA;aACrC;SACF;aAAM;YACL,IAAI,KAAK,GAAG,KAAK,CAAA;YACjB,IAAI;gBACF,KAAK,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;aAC5C;YAAC,OAAO,GAAG,EAAE;gBACZ,6EAA6E;gBAC7E,yBAAyB;gBACzB,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ;oBAAE,MAAM,GAAG,CAAA;gBACpC,OAAM;aACP;YAED,IAAI,KAAK,EAAE;gBACT,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,CAAA;aAC9C;iBAAM;gBACL,MAAM,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;aAC/B;SACF;IACH,CAAC;CAAA;AAtDD,oBAsDC;AAED;;;;;;GAMG;AACH,SAAsB,MAAM,CAAC,MAAc;;QACzC,WAAE,CAAC,MAAM,EAAE,kCAAkC,CAAC,CAAA;QAC9C,MAAM,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAA;IAC/C,CAAC;CAAA;AAHD,wBAGC;AAED;;;;;;;GAOG;AACH,SAAsB,KAAK,CAAC,IAAY,EAAE,KAAe;;QACvD,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;SAChD;QAED,4BAA4B;QAC5B,IAAI,KAAK,EAAE;YACT,MAAM,MAAM,GAAW,MAAM,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YAE/C,IAAI,CAAC,MAAM,EAAE;gBACX,IAAI,MAAM,CAAC,UAAU,EAAE;oBACrB,MAAM,IAAI,KAAK,CACb,qCAAqC,IAAI,wMAAwM,CAClP,CAAA;iBACF;qBAAM;oBACL,MAAM,IAAI,KAAK,CACb,qCAAqC,IAAI,gMAAgM,CAC1O,CAAA;iBACF;aACF;YAED,OAAO,MAAM,CAAA;SACd;QAED,MAAM,OAAO,GAAa,MAAM,UAAU,CAAC,IAAI,CAAC,CAAA;QAEhD,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,OAAO,OAAO,CAAC,CAAC,CAAC,CAAA;SAClB;QAED,OAAO,EAAE,CAAA;IACX,CAAC;CAAA;AA/BD,sBA+BC;AAED;;;;GAIG;AACH,SAAsB,UAAU,CAAC,IAAY;;QAC3C,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;SAChD;QAED,sCAAsC;QACtC,MAAM,UAAU,GAAa,EAAE,CAAA;QAC/B,IAAI,MAAM,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;YAC/C,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;gBACpE,IAAI,SAAS,EAAE;oBACb,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;iBAC3B;aACF;SACF;QAED,+DAA+D;QAC/D,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACzB,MAAM,QAAQ,GAAW,MAAM,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;YAE5E,IAAI,QAAQ,EAAE;gBACZ,OAAO,CAAC,QAAQ,CAAC,CAAA;aAClB;YAED,OAAO,EAAE,CAAA;SACV;QAED,uCAAuC;QACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAC3B,OAAO,EAAE,CAAA;SACV;QAED,gCAAgC;QAChC,EAAE;QACF,iGAAiG;QACjG,+FAA+F;QAC/F,iGAAiG;QACjG,oBAAoB;QACpB,MAAM,WAAW,GAAa,EAAE,CAAA;QAEhC,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;YACpB,KAAK,MAAM,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;gBACtD,IAAI,CAAC,EAAE;oBACL,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;iBACpB;aACF;SACF;QAED,mBAAmB;QACnB,MAAM,OAAO,GAAa,EAAE,CAAA;QAE5B,KAAK,MAAM,SAAS,IAAI,WAAW,EAAE;YACnC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAChD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAC1B,UAAU,CACX,CAAA;YACD,IAAI,QAAQ,EAAE;gBACZ,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;aACvB;SACF;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;CAAA;AA7DD,gCA6DC;AAED,SAAS,eAAe,CAAC,OAAoB;IAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAA;IAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IAC5C,MAAM,mBAAmB,GACvB,OAAO,CAAC,mBAAmB,IAAI,IAAI;QACjC,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAC1C,OAAO,EAAC,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAC,CAAA;AAChD,CAAC;AAED,SAAe,cAAc,CAC3B,SAAiB,EACjB,OAAe,EACf,YAAoB,EACpB,KAAc;;QAEd,gDAAgD;QAChD,IAAI,YAAY,IAAI,GAAG;YAAE,OAAM;QAC/B,YAAY,EAAE,CAAA;QAEd,MAAM,MAAM,CAAC,OAAO,CAAC,CAAA;QAErB,MAAM,KAAK,GAAa,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;QAEvD,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE;YAC5B,MAAM,OAAO,GAAG,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAA;YAC1C,MAAM,QAAQ,GAAG,GAAG,OAAO,IAAI,QAAQ,EAAE,CAAA;YACzC,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YAE/C,IAAI,WAAW,CAAC,WAAW,EAAE,EAAE;gBAC7B,UAAU;gBACV,MAAM,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK,CAAC,CAAA;aAC7D;iBAAM;gBACL,MAAM,QAAQ,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;aACzC;SACF;QAED,kDAAkD;QAClD,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IAClE,CAAC;CAAA;AAED,qBAAqB;AACrB,SAAe,QAAQ,CACrB,OAAe,EACf,QAAgB,EAChB,KAAc;;QAEd,IAAI,CAAC,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,EAAE,EAAE;YAClD,oBAAoB;YACpB,IAAI;gBACF,MAAM,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;gBAC5B,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;aAC9B;YAAC,OAAO,CAAC,EAAE;gBACV,kCAAkC;gBAClC,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO,EAAE;oBACtB,MAAM,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;oBACpC,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;iBAC9B;gBACD,iDAAiD;aAClD;YAED,oBAAoB;YACpB,MAAM,WAAW,GAAW,MAAM,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;YAC1D,MAAM,MAAM,CAAC,OAAO,CAClB,WAAW,EACX,QAAQ,EACR,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CACtC,CAAA;SACF;aAAM,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK,EAAE;YACpD,MAAM,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;SACzC;IACH,CAAC;CAAA"} \ No newline at end of file diff --git a/node_modules/@actions/io/package.json b/node_modules/@actions/io/package.json new file mode 100644 index 00000000..114e8e59 --- /dev/null +++ b/node_modules/@actions/io/package.json @@ -0,0 +1,37 @@ +{ + "name": "@actions/io", + "version": "1.1.1", + "description": "Actions io lib", + "keywords": [ + "github", + "actions", + "io" + ], + "homepage": "https://github.com/actions/toolkit/tree/main/packages/io", + "license": "MIT", + "main": "lib/io.js", + "types": "lib/io.d.ts", + "directories": { + "lib": "lib", + "test": "__tests__" + }, + "files": [ + "lib" + ], + "publishConfig": { + "access": "public" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/actions/toolkit.git", + "directory": "packages/io" + }, + "scripts": { + "audit-moderate": "npm install && npm audit --json --audit-level=moderate > audit.json", + "test": "echo \"Error: run tests from root\" && exit 1", + "tsc": "tsc" + }, + "bugs": { + "url": "https://github.com/actions/toolkit/issues" + } +} diff --git a/node_modules/@octokit/auth-token/LICENSE b/node_modules/@octokit/auth-token/LICENSE new file mode 100644 index 00000000..ef2c18ee --- /dev/null +++ b/node_modules/@octokit/auth-token/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/@octokit/auth-token/README.md b/node_modules/@octokit/auth-token/README.md new file mode 100644 index 00000000..b4791f0d --- /dev/null +++ b/node_modules/@octokit/auth-token/README.md @@ -0,0 +1,271 @@ +# auth-token.js + +> GitHub API token authentication for browsers and Node.js + +[![@latest](https://img.shields.io/npm/v/@octokit/auth-token.svg)](https://www.npmjs.com/package/@octokit/auth-token) +[![Build Status](https://github.com/octokit/auth-token.js/workflows/Test/badge.svg)](https://github.com/octokit/auth-token.js/actions?query=workflow%3ATest) + +`@octokit/auth-token` is the simplest of [GitHub’s authentication strategies](https://github.com/octokit/auth.js). + +It is useful if you want to support multiple authentication strategies, as it’s API is compatible with its sibling packages for [basic](https://github.com/octokit/auth-basic.js), [GitHub App](https://github.com/octokit/auth-app.js) and [OAuth app](https://github.com/octokit/auth.js) authentication. + + + +- [Usage](#usage) +- [`createTokenAuth(token) options`](#createtokenauthtoken-options) +- [`auth()`](#auth) +- [Authentication object](#authentication-object) +- [`auth.hook(request, route, options)` or `auth.hook(request, options)`](#authhookrequest-route-options-or-authhookrequest-options) +- [Find more information](#find-more-information) + - [Find out what scopes are enabled for oauth tokens](#find-out-what-scopes-are-enabled-for-oauth-tokens) + - [Find out if token is a personal access token or if it belongs to an OAuth app](#find-out-if-token-is-a-personal-access-token-or-if-it-belongs-to-an-oauth-app) + - [Find out what permissions are enabled for a repository](#find-out-what-permissions-are-enabled-for-a-repository) + - [Use token for git operations](#use-token-for-git-operations) +- [License](#license) + + + +## Usage + + + + + + +
+Browsers + + +Load `@octokit/auth-token` directly from [cdn.skypack.dev](https://cdn.skypack.dev) + +```html + +``` + +
+Node + + +Install with npm install @octokit/auth-token + +```js +const { createTokenAuth } = require("@octokit/auth-token"); +// or: import { createTokenAuth } from "@octokit/auth-token"; +``` + +
+ +```js +const auth = createTokenAuth("1234567890abcdef1234567890abcdef12345678"); +const authentication = await auth(); +// { +// type: 'token', +// token: '1234567890abcdef1234567890abcdef12345678', +// tokenType: 'oauth' +// } +``` + +## `createTokenAuth(token) options` + +The `createTokenAuth` method accepts a single argument of type string, which is the token. The passed token can be one of the following: + +- [Personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) +- [OAuth access token](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/) +- Installation access token ([GitHub App Installation](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)) +- [GITHUB_TOKEN provided to GitHub Actions](https://developer.github.com/actions/creating-github-actions/accessing-the-runtime-environment/#environment-variables) + +Examples + +```js +// Personal access token or OAuth access token +createTokenAuth("1234567890abcdef1234567890abcdef12345678"); + +// Installation access token or GitHub Action token +createTokenAuth("v1.d3d433526f780fbcc3129004e2731b3904ad0b86"); +``` + +## `auth()` + +The `auth()` method has no options. It returns a promise which resolves with the the authentication object. + +## Authentication object + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ name + + type + + description +
+ type + + string + + "token" +
+ token + + string + + The provided token. +
+ tokenType + + string + + Can be either "oauth" for personal access tokens and OAuth tokens, or "installation" for installation access tokens (includes GITHUB_TOKEN provided to GitHub Actions) +
+ +## `auth.hook(request, route, options)` or `auth.hook(request, options)` + +`auth.hook()` hooks directly into the request life cycle. It authenticates the request using the provided token. + +The `request` option is an instance of [`@octokit/request`](https://github.com/octokit/request.js#readme). The `route`/`options` parameters are the same as for the [`request()` method](https://github.com/octokit/request.js#request). + +`auth.hook()` can be called directly to send an authenticated request + +```js +const { data: authorizations } = await auth.hook( + request, + "GET /authorizations" +); +``` + +Or it can be passed as option to [`request()`](https://github.com/octokit/request.js#request). + +```js +const requestWithAuth = request.defaults({ + request: { + hook: auth.hook, + }, +}); + +const { data: authorizations } = await requestWithAuth("GET /authorizations"); +``` + +## Find more information + +`auth()` does not send any requests, it only transforms the provided token string into an authentication object. + +Here is a list of things you can do to retrieve further information + +### Find out what scopes are enabled for oauth tokens + +Note that this does not work for installations. There is no way to retrieve permissions based on an installation access tokens. + +```js +const TOKEN = "1234567890abcdef1234567890abcdef12345678"; + +const auth = createTokenAuth(TOKEN); +const authentication = await auth(); + +const response = await request("HEAD /", { + headers: authentication.headers, +}); +const scopes = response.headers["x-oauth-scopes"].split(/,\s+/); + +if (scopes.length) { + console.log( + `"${TOKEN}" has ${scopes.length} scopes enabled: ${scopes.join(", ")}` + ); +} else { + console.log(`"${TOKEN}" has no scopes enabled`); +} +``` + +### Find out if token is a personal access token or if it belongs to an OAuth app + +```js +const TOKEN = "1234567890abcdef1234567890abcdef12345678"; + +const auth = createTokenAuth(TOKEN); +const authentication = await auth(); + +const response = await request("HEAD /", { + headers: authentication.headers, +}); +const clientId = response.headers["x-oauth-client-id"]; + +if (clientId) { + console.log( + `"${token}" is an OAuth token, its app’s client_id is ${clientId}.` + ); +} else { + console.log(`"${token}" is a personal access token`); +} +``` + +### Find out what permissions are enabled for a repository + +Note that the `permissions` key is not set when authenticated using an installation access token. + +```js +const TOKEN = "1234567890abcdef1234567890abcdef12345678"; + +const auth = createTokenAuth(TOKEN); +const authentication = await auth(); + +const response = await request("GET /repos/{owner}/{repo}", { + owner: 'octocat', + repo: 'hello-world' + headers: authentication.headers +}); + +console.log(response.data.permissions) +// { +// admin: true, +// push: true, +// pull: true +// } +``` + +### Use token for git operations + +Both OAuth and installation access tokens can be used for git operations. However, when using with an installation, [the token must be prefixed with `x-access-token`](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#http-based-git-access-by-an-installation). + +This example is using the [`execa`](https://github.com/sindresorhus/execa) package to run a `git push` command. + +```js +const TOKEN = "1234567890abcdef1234567890abcdef12345678"; + +const auth = createTokenAuth(TOKEN); +const { token, tokenType } = await auth(); +const tokenWithPrefix = + tokenType === "installation" ? `x-access-token:${token}` : token; + +const repositoryUrl = `https://${tokenWithPrefix}@github.com/octocat/hello-world.git`; + +const { stdout } = await execa("git", ["push", repositoryUrl]); +console.log(stdout); +``` + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/auth-token/dist-node/index.js b/node_modules/@octokit/auth-token/dist-node/index.js new file mode 100644 index 00000000..1394a5da --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-node/index.js @@ -0,0 +1,49 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +async function auth(token) { + const tokenType = token.split(/\./).length === 3 ? "app" : /^v\d+\./.test(token) ? "installation" : "oauth"; + return { + type: "token", + token: token, + tokenType + }; +} + +/** + * Prefix token for usage in the Authorization header + * + * @param token OAuth token or JSON Web Token + */ +function withAuthorizationPrefix(token) { + if (token.split(/\./).length === 3) { + return `bearer ${token}`; + } + + return `token ${token}`; +} + +async function hook(token, request, route, parameters) { + const endpoint = request.endpoint.merge(route, parameters); + endpoint.headers.authorization = withAuthorizationPrefix(token); + return request(endpoint); +} + +const createTokenAuth = function createTokenAuth(token) { + if (!token) { + throw new Error("[@octokit/auth-token] No token passed to createTokenAuth"); + } + + if (typeof token !== "string") { + throw new Error("[@octokit/auth-token] Token passed to createTokenAuth is not a string"); + } + + token = token.replace(/^(token|bearer) +/i, ""); + return Object.assign(auth.bind(null, token), { + hook: hook.bind(null, token) + }); +}; + +exports.createTokenAuth = createTokenAuth; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/auth-token/dist-node/index.js.map b/node_modules/@octokit/auth-token/dist-node/index.js.map new file mode 100644 index 00000000..46cf5e12 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/auth.js","../dist-src/with-authorization-prefix.js","../dist-src/hook.js","../dist-src/index.js"],"sourcesContent":["export async function auth(token) {\n const tokenType = token.split(/\\./).length === 3\n ? \"app\"\n : /^v\\d+\\./.test(token)\n ? \"installation\"\n : \"oauth\";\n return {\n type: \"token\",\n token: token,\n tokenType\n };\n}\n","/**\n * Prefix token for usage in the Authorization header\n *\n * @param token OAuth token or JSON Web Token\n */\nexport function withAuthorizationPrefix(token) {\n if (token.split(/\\./).length === 3) {\n return `bearer ${token}`;\n }\n return `token ${token}`;\n}\n","import { withAuthorizationPrefix } from \"./with-authorization-prefix\";\nexport async function hook(token, request, route, parameters) {\n const endpoint = request.endpoint.merge(route, parameters);\n endpoint.headers.authorization = withAuthorizationPrefix(token);\n return request(endpoint);\n}\n","import { auth } from \"./auth\";\nimport { hook } from \"./hook\";\nexport const createTokenAuth = function createTokenAuth(token) {\n if (!token) {\n throw new Error(\"[@octokit/auth-token] No token passed to createTokenAuth\");\n }\n if (typeof token !== \"string\") {\n throw new Error(\"[@octokit/auth-token] Token passed to createTokenAuth is not a string\");\n }\n token = token.replace(/^(token|bearer) +/i, \"\");\n return Object.assign(auth.bind(null, token), {\n hook: hook.bind(null, token)\n });\n};\n"],"names":["auth","token","tokenType","split","length","test","type","withAuthorizationPrefix","hook","request","route","parameters","endpoint","merge","headers","authorization","createTokenAuth","Error","replace","Object","assign","bind"],"mappings":";;;;AAAO,eAAeA,IAAf,CAAoBC,KAApB,EAA2B;AAC9B,QAAMC,SAAS,GAAGD,KAAK,CAACE,KAAN,CAAY,IAAZ,EAAkBC,MAAlB,KAA6B,CAA7B,GACZ,KADY,GAEZ,UAAUC,IAAV,CAAeJ,KAAf,IACI,cADJ,GAEI,OAJV;AAKA,SAAO;AACHK,IAAAA,IAAI,EAAE,OADH;AAEHL,IAAAA,KAAK,EAAEA,KAFJ;AAGHC,IAAAA;AAHG,GAAP;AAKH;;ACXD;AACA;AACA;AACA;AACA;AACA,AAAO,SAASK,uBAAT,CAAiCN,KAAjC,EAAwC;AAC3C,MAAIA,KAAK,CAACE,KAAN,CAAY,IAAZ,EAAkBC,MAAlB,KAA6B,CAAjC,EAAoC;AAChC,WAAQ,UAASH,KAAM,EAAvB;AACH;;AACD,SAAQ,SAAQA,KAAM,EAAtB;AACH;;ACTM,eAAeO,IAAf,CAAoBP,KAApB,EAA2BQ,OAA3B,EAAoCC,KAApC,EAA2CC,UAA3C,EAAuD;AAC1D,QAAMC,QAAQ,GAAGH,OAAO,CAACG,QAAR,CAAiBC,KAAjB,CAAuBH,KAAvB,EAA8BC,UAA9B,CAAjB;AACAC,EAAAA,QAAQ,CAACE,OAAT,CAAiBC,aAAjB,GAAiCR,uBAAuB,CAACN,KAAD,CAAxD;AACA,SAAOQ,OAAO,CAACG,QAAD,CAAd;AACH;;MCHYI,eAAe,GAAG,SAASA,eAAT,CAAyBf,KAAzB,EAAgC;AAC3D,MAAI,CAACA,KAAL,EAAY;AACR,UAAM,IAAIgB,KAAJ,CAAU,0DAAV,CAAN;AACH;;AACD,MAAI,OAAOhB,KAAP,KAAiB,QAArB,EAA+B;AAC3B,UAAM,IAAIgB,KAAJ,CAAU,uEAAV,CAAN;AACH;;AACDhB,EAAAA,KAAK,GAAGA,KAAK,CAACiB,OAAN,CAAc,oBAAd,EAAoC,EAApC,CAAR;AACA,SAAOC,MAAM,CAACC,MAAP,CAAcpB,IAAI,CAACqB,IAAL,CAAU,IAAV,EAAgBpB,KAAhB,CAAd,EAAsC;AACzCO,IAAAA,IAAI,EAAEA,IAAI,CAACa,IAAL,CAAU,IAAV,EAAgBpB,KAAhB;AADmC,GAAtC,CAAP;AAGH,CAXM;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/auth-token/dist-src/auth.js b/node_modules/@octokit/auth-token/dist-src/auth.js new file mode 100644 index 00000000..2d5005c2 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-src/auth.js @@ -0,0 +1,12 @@ +export async function auth(token) { + const tokenType = token.split(/\./).length === 3 + ? "app" + : /^v\d+\./.test(token) + ? "installation" + : "oauth"; + return { + type: "token", + token: token, + tokenType + }; +} diff --git a/node_modules/@octokit/auth-token/dist-src/hook.js b/node_modules/@octokit/auth-token/dist-src/hook.js new file mode 100644 index 00000000..f8e47f0c --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-src/hook.js @@ -0,0 +1,6 @@ +import { withAuthorizationPrefix } from "./with-authorization-prefix"; +export async function hook(token, request, route, parameters) { + const endpoint = request.endpoint.merge(route, parameters); + endpoint.headers.authorization = withAuthorizationPrefix(token); + return request(endpoint); +} diff --git a/node_modules/@octokit/auth-token/dist-src/index.js b/node_modules/@octokit/auth-token/dist-src/index.js new file mode 100644 index 00000000..114fd455 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-src/index.js @@ -0,0 +1,14 @@ +import { auth } from "./auth"; +import { hook } from "./hook"; +export const createTokenAuth = function createTokenAuth(token) { + if (!token) { + throw new Error("[@octokit/auth-token] No token passed to createTokenAuth"); + } + if (typeof token !== "string") { + throw new Error("[@octokit/auth-token] Token passed to createTokenAuth is not a string"); + } + token = token.replace(/^(token|bearer) +/i, ""); + return Object.assign(auth.bind(null, token), { + hook: hook.bind(null, token) + }); +}; diff --git a/node_modules/@octokit/auth-token/dist-src/types.js b/node_modules/@octokit/auth-token/dist-src/types.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-src/types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/auth-token/dist-src/with-authorization-prefix.js b/node_modules/@octokit/auth-token/dist-src/with-authorization-prefix.js new file mode 100644 index 00000000..90358136 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-src/with-authorization-prefix.js @@ -0,0 +1,11 @@ +/** + * Prefix token for usage in the Authorization header + * + * @param token OAuth token or JSON Web Token + */ +export function withAuthorizationPrefix(token) { + if (token.split(/\./).length === 3) { + return `bearer ${token}`; + } + return `token ${token}`; +} diff --git a/node_modules/@octokit/auth-token/dist-types/auth.d.ts b/node_modules/@octokit/auth-token/dist-types/auth.d.ts new file mode 100644 index 00000000..dc418358 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-types/auth.d.ts @@ -0,0 +1,2 @@ +import { Token, Authentication } from "./types"; +export declare function auth(token: Token): Promise; diff --git a/node_modules/@octokit/auth-token/dist-types/hook.d.ts b/node_modules/@octokit/auth-token/dist-types/hook.d.ts new file mode 100644 index 00000000..21e4b6fc --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-types/hook.d.ts @@ -0,0 +1,2 @@ +import { AnyResponse, EndpointOptions, RequestInterface, RequestParameters, Route, Token } from "./types"; +export declare function hook(token: Token, request: RequestInterface, route: Route | EndpointOptions, parameters?: RequestParameters): Promise; diff --git a/node_modules/@octokit/auth-token/dist-types/index.d.ts b/node_modules/@octokit/auth-token/dist-types/index.d.ts new file mode 100644 index 00000000..59994293 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-types/index.d.ts @@ -0,0 +1,7 @@ +import { StrategyInterface, Token, Authentication } from "./types"; +export declare type Types = { + StrategyOptions: Token; + AuthOptions: never; + Authentication: Authentication; +}; +export declare const createTokenAuth: StrategyInterface; diff --git a/node_modules/@octokit/auth-token/dist-types/types.d.ts b/node_modules/@octokit/auth-token/dist-types/types.d.ts new file mode 100644 index 00000000..c302dc9e --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-types/types.d.ts @@ -0,0 +1,28 @@ +import * as OctokitTypes from "@octokit/types"; +export declare type AnyResponse = OctokitTypes.OctokitResponse; +export declare type StrategyInterface = OctokitTypes.StrategyInterface<[ + Token +], [ +], Authentication>; +export declare type EndpointDefaults = OctokitTypes.EndpointDefaults; +export declare type EndpointOptions = OctokitTypes.EndpointOptions; +export declare type RequestParameters = OctokitTypes.RequestParameters; +export declare type RequestInterface = OctokitTypes.RequestInterface; +export declare type Route = OctokitTypes.Route; +export declare type Token = string; +export declare type OAuthTokenAuthentication = { + type: "token"; + tokenType: "oauth"; + token: Token; +}; +export declare type InstallationTokenAuthentication = { + type: "token"; + tokenType: "installation"; + token: Token; +}; +export declare type AppAuthentication = { + type: "token"; + tokenType: "app"; + token: Token; +}; +export declare type Authentication = OAuthTokenAuthentication | InstallationTokenAuthentication | AppAuthentication; diff --git a/node_modules/@octokit/auth-token/dist-types/with-authorization-prefix.d.ts b/node_modules/@octokit/auth-token/dist-types/with-authorization-prefix.d.ts new file mode 100644 index 00000000..2e52c31d --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-types/with-authorization-prefix.d.ts @@ -0,0 +1,6 @@ +/** + * Prefix token for usage in the Authorization header + * + * @param token OAuth token or JSON Web Token + */ +export declare function withAuthorizationPrefix(token: string): string; diff --git a/node_modules/@octokit/auth-token/dist-web/index.js b/node_modules/@octokit/auth-token/dist-web/index.js new file mode 100644 index 00000000..c15ca122 --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-web/index.js @@ -0,0 +1,46 @@ +async function auth(token) { + const tokenType = token.split(/\./).length === 3 + ? "app" + : /^v\d+\./.test(token) + ? "installation" + : "oauth"; + return { + type: "token", + token: token, + tokenType + }; +} + +/** + * Prefix token for usage in the Authorization header + * + * @param token OAuth token or JSON Web Token + */ +function withAuthorizationPrefix(token) { + if (token.split(/\./).length === 3) { + return `bearer ${token}`; + } + return `token ${token}`; +} + +async function hook(token, request, route, parameters) { + const endpoint = request.endpoint.merge(route, parameters); + endpoint.headers.authorization = withAuthorizationPrefix(token); + return request(endpoint); +} + +const createTokenAuth = function createTokenAuth(token) { + if (!token) { + throw new Error("[@octokit/auth-token] No token passed to createTokenAuth"); + } + if (typeof token !== "string") { + throw new Error("[@octokit/auth-token] Token passed to createTokenAuth is not a string"); + } + token = token.replace(/^(token|bearer) +/i, ""); + return Object.assign(auth.bind(null, token), { + hook: hook.bind(null, token) + }); +}; + +export { createTokenAuth }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/auth-token/dist-web/index.js.map b/node_modules/@octokit/auth-token/dist-web/index.js.map new file mode 100644 index 00000000..60de4a6b --- /dev/null +++ b/node_modules/@octokit/auth-token/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/auth.js","../dist-src/with-authorization-prefix.js","../dist-src/hook.js","../dist-src/index.js"],"sourcesContent":["export async function auth(token) {\n const tokenType = token.split(/\\./).length === 3\n ? \"app\"\n : /^v\\d+\\./.test(token)\n ? \"installation\"\n : \"oauth\";\n return {\n type: \"token\",\n token: token,\n tokenType\n };\n}\n","/**\n * Prefix token for usage in the Authorization header\n *\n * @param token OAuth token or JSON Web Token\n */\nexport function withAuthorizationPrefix(token) {\n if (token.split(/\\./).length === 3) {\n return `bearer ${token}`;\n }\n return `token ${token}`;\n}\n","import { withAuthorizationPrefix } from \"./with-authorization-prefix\";\nexport async function hook(token, request, route, parameters) {\n const endpoint = request.endpoint.merge(route, parameters);\n endpoint.headers.authorization = withAuthorizationPrefix(token);\n return request(endpoint);\n}\n","import { auth } from \"./auth\";\nimport { hook } from \"./hook\";\nexport const createTokenAuth = function createTokenAuth(token) {\n if (!token) {\n throw new Error(\"[@octokit/auth-token] No token passed to createTokenAuth\");\n }\n if (typeof token !== \"string\") {\n throw new Error(\"[@octokit/auth-token] Token passed to createTokenAuth is not a string\");\n }\n token = token.replace(/^(token|bearer) +/i, \"\");\n return Object.assign(auth.bind(null, token), {\n hook: hook.bind(null, token)\n });\n};\n"],"names":[],"mappings":"AAAO,eAAe,IAAI,CAAC,KAAK,EAAE;AAClC,IAAI,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;AACpD,UAAU,KAAK;AACf,UAAU,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;AAC/B,cAAc,cAAc;AAC5B,cAAc,OAAO,CAAC;AACtB,IAAI,OAAO;AACX,QAAQ,IAAI,EAAE,OAAO;AACrB,QAAQ,KAAK,EAAE,KAAK;AACpB,QAAQ,SAAS;AACjB,KAAK,CAAC;AACN;;ACXA;AACA;AACA;AACA;AACA;AACA,AAAO,SAAS,uBAAuB,CAAC,KAAK,EAAE;AAC/C,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;AACxC,QAAQ,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;AACjC,KAAK;AACL,IAAI,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AAC5B,CAAC;;ACTM,eAAe,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE;AAC9D,IAAI,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AAC/D,IAAI,QAAQ,CAAC,OAAO,CAAC,aAAa,GAAG,uBAAuB,CAAC,KAAK,CAAC,CAAC;AACpE,IAAI,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC7B,CAAC;;ACHW,MAAC,eAAe,GAAG,SAAS,eAAe,CAAC,KAAK,EAAE;AAC/D,IAAI,IAAI,CAAC,KAAK,EAAE;AAChB,QAAQ,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;AACpF,KAAK;AACL,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AACnC,QAAQ,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;AACjG,KAAK;AACL,IAAI,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;AACpD,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;AACjD,QAAQ,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC;AACpC,KAAK,CAAC,CAAC;AACP,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/auth-token/package.json b/node_modules/@octokit/auth-token/package.json new file mode 100644 index 00000000..5be9ea7a --- /dev/null +++ b/node_modules/@octokit/auth-token/package.json @@ -0,0 +1,48 @@ +{ + "name": "@octokit/auth-token", + "description": "GitHub API token authentication for browsers and Node.js", + "version": "2.4.5", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "github", + "octokit", + "authentication", + "api" + ], + "homepage": "https://github.com/octokit/auth-token.js#readme", + "bugs": { + "url": "https://github.com/octokit/auth-token.js/issues" + }, + "repository": "https://github.com/octokit/auth-token.js", + "dependencies": { + "@octokit/types": "^6.0.3" + }, + "devDependencies": { + "@octokit/core": "^3.0.0", + "@octokit/request": "^5.3.0", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/fetch-mock": "^7.3.1", + "@types/jest": "^26.0.0", + "fetch-mock": "^9.0.0", + "jest": "^26.0.0", + "semantic-release": "^17.0.0", + "ts-jest": "^26.0.0", + "typescript": "^4.0.0" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/core/LICENSE b/node_modules/@octokit/core/LICENSE new file mode 100644 index 00000000..ef2c18ee --- /dev/null +++ b/node_modules/@octokit/core/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/@octokit/core/README.md b/node_modules/@octokit/core/README.md new file mode 100644 index 00000000..0372f459 --- /dev/null +++ b/node_modules/@octokit/core/README.md @@ -0,0 +1,440 @@ +# core.js + +> Extendable client for GitHub's REST & GraphQL APIs + +[![@latest](https://img.shields.io/npm/v/@octokit/core.svg)](https://www.npmjs.com/package/@octokit/core) +[![Build Status](https://github.com/octokit/core.js/workflows/Test/badge.svg)](https://github.com/octokit/core.js/actions?query=workflow%3ATest+branch%3Amaster) + + + +- [Usage](#usage) + - [REST API example](#rest-api-example) + - [GraphQL example](#graphql-example) +- [Options](#options) +- [Defaults](#defaults) +- [Authentication](#authentication) +- [Logging](#logging) +- [Hooks](#hooks) +- [Plugins](#plugins) +- [Build your own Octokit with Plugins and Defaults](#build-your-own-octokit-with-plugins-and-defaults) +- [LICENSE](#license) + + + +If you need a minimalistic library to utilize GitHub's [REST API](https://developer.github.com/v3/) and [GraphQL API](https://developer.github.com/v4/) which you can extend with plugins as needed, then `@octokit/core` is a great starting point. + +If you don't need the Plugin API then using [`@octokit/request`](https://github.com/octokit/request.js/) or [`@octokit/graphql`](https://github.com/octokit/graphql.js/) directly is a good alternative. + +## Usage + + + + + + +
+Browsers + +Load @octokit/core directly from cdn.skypack.dev + +```html + +``` + +
+Node + + +Install with npm install @octokit/core + +```js +const { Octokit } = require("@octokit/core"); +// or: import { Octokit } from "@octokit/core"; +``` + +
+ +### REST API example + +```js +// Create a personal access token at https://github.com/settings/tokens/new?scopes=repo +const octokit = new Octokit({ auth: `personal-access-token123` }); + +const response = await octokit.request("GET /orgs/{org}/repos", { + org: "octokit", + type: "private", +}); +``` + +See [`@octokit/request`](https://github.com/octokit/request.js) for full documentation of the `.request` method. + +### GraphQL example + +```js +const octokit = new Octokit({ auth: `secret123` }); + +const response = await octokit.graphql( + `query ($login: String!) { + organization(login: $login) { + repositories(privacy: PRIVATE) { + totalCount + } + } + }`, + { login: "octokit" } +); +``` + +See [`@octokit/graphql`](https://github.com/octokit/graphql.js) for full documentation of the `.graphql` method. + +## Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ name + + type + + description +
+ options.authStrategy + + Function + + Defaults to @octokit/auth-token. See Authentication below for examples. +
+ options.auth + + String or Object + + See Authentication below for examples. +
+ options.baseUrl + + String + + +When using with GitHub Enterprise Server, set `options.baseUrl` to the root URL of the API. For example, if your GitHub Enterprise Server's hostname is `github.acme-inc.com`, then set `options.baseUrl` to `https://github.acme-inc.com/api/v3`. Example + +```js +const octokit = new Octokit({ + baseUrl: "https://github.acme-inc.com/api/v3", +}); +``` + +
+ options.previews + + Array of Strings + + +Some REST API endpoints require preview headers to be set, or enable +additional features. Preview headers can be set on a per-request basis, e.g. + +```js +octokit.request("POST /repos/{owner}/{repo}/pulls", { + mediaType: { + previews: ["shadow-cat"], + }, + owner, + repo, + title: "My pull request", + base: "master", + head: "my-feature", + draft: true, +}); +``` + +You can also set previews globally, by setting the `options.previews` option on the constructor. Example: + +```js +const octokit = new Octokit({ + previews: ["shadow-cat"], +}); +``` + +
+ options.request + + Object + + +Set a default request timeout (`options.request.timeout`) or an [`http(s).Agent`](https://nodejs.org/api/http.html#http_class_http_agent) e.g. for proxy usage (Node only, `options.request.agent`). + +There are more `options.request.*` options, see [`@octokit/request` options](https://github.com/octokit/request.js#request). `options.request` can also be set on a per-request basis. + +
+ options.timeZone + + String + + +Sets the `Time-Zone` header which defines a timezone according to the [list of names from the Olson database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + +```js +const octokit = new Octokit({ + timeZone: "America/Los_Angeles", +}); +``` + +The time zone header will determine the timezone used for generating the timestamp when creating commits. See [GitHub's Timezones documentation](https://developer.github.com/v3/#timezones). + +
+ options.userAgent + + String + + +A custom user agent string for your app or library. Example + +```js +const octokit = new Octokit({ + userAgent: "my-app/v1.2.3", +}); +``` + +
+ +## Defaults + +You can create a new Octokit class with customized default options. + +```js +const MyOctokit = Octokit.defaults({ + auth: "personal-access-token123", + baseUrl: "https://github.acme-inc.com/api/v3", + userAgent: "my-app/v1.2.3", +}); +const octokit1 = new MyOctokit(); +const octokit2 = new MyOctokit(); +``` + +If you pass additional options to your new constructor, the options will be merged shallowly. + +```js +const MyOctokit = Octokit.defaults({ + foo: { + opt1: 1, + }, +}); +const octokit = new MyOctokit({ + foo: { + opt2: 1, + }, +}); +// options will be { foo: { opt2: 1 }} +``` + +If you need a deep or conditional merge, you can pass a function instead. + +```js +const MyOctokit = Octokit.defaults((options) => { + return { + foo: Object.assign({}, options.foo, { opt2: 1 }), + }; +}); +const octokit = new MyOctokit({ + foo: { opt2: 1 }, +}); +// options will be { foo: { opt1: 1, opt2: 1 }} +``` + +Be careful about mutating the `options` object in the `Octokit.defaults` callback, as it can have unforeseen consequences. + +## Authentication + +Authentication is optional for some REST API endpoints accessing public data, but is required for GraphQL queries. Using authentication also increases your [API rate limit](https://developer.github.com/v3/#rate-limiting). + +By default, Octokit authenticates using the [token authentication strategy](https://github.com/octokit/auth-token.js). Pass in a token using `options.auth`. It can be a personal access token, an OAuth token, an installation access token or a JSON Web Token for GitHub App authentication. The `Authorization` header will be set according to the type of token. + +```js +import { Octokit } from "@octokit/core"; + +const octokit = new Octokit({ + auth: "mypersonalaccesstoken123", +}); + +const { data } = await octokit.request("/user"); +``` + +To use a different authentication strategy, set `options.authStrategy`. A list of authentication strategies is available at [octokit/authentication-strategies.js](https://github.com/octokit/authentication-strategies.js/#readme). + +Example + +```js +import { Octokit } from "@octokit/core"; +import { createAppAuth } from "@octokit/auth-app"; + +const appOctokit = new Octokit({ + authStrategy: createAppAuth, + auth: { + appId: 123, + privateKey: process.env.PRIVATE_KEY, + }, +}); + +const { data } = await appOctokit.request("/app"); +``` + +The `.auth()` method returned by the current authentication strategy can be accessed at `octokit.auth()`. Example + +```js +const { token } = await appOctokit.auth({ + type: "installation", + installationId: 123, +}); +``` + +## Logging + +There are four built-in log methods + +1. `octokit.log.debug(message[, additionalInfo])` +1. `octokit.log.info(message[, additionalInfo])` +1. `octokit.log.warn(message[, additionalInfo])` +1. `octokit.log.error(message[, additionalInfo])` + +They can be configured using the [`log` client option](client-options). By default, `octokit.log.debug()` and `octokit.log.info()` are no-ops, while the other two call `console.warn()` and `console.error()` respectively. + +This is useful if you build reusable [plugins](#plugins). + +If you would like to make the log level configurable using an environment variable or external option, we recommend the [console-log-level](https://github.com/watson/console-log-level) package. Example + +```js +const octokit = new Octokit({ + log: require("console-log-level")({ level: "info" }), +}); +``` + +## Hooks + +You can customize Octokit's request lifecycle with hooks. + +```js +octokit.hook.before("request", async (options) => { + validate(options); +}); +octokit.hook.after("request", async (response, options) => { + console.log(`${options.method} ${options.url}: ${response.status}`); +}); +octokit.hook.error("request", async (error, options) => { + if (error.status === 304) { + return findInCache(error.headers.etag); + } + + throw error; +}); +octokit.hook.wrap("request", async (request, options) => { + // add logic before, after, catch errors or replace the request altogether + return request(options); +}); +``` + +See [before-after-hook](https://github.com/gr2m/before-after-hook#readme) for more documentation on hooks. + +## Plugins + +Octokit’s functionality can be extended using plugins. The `Octokit.plugin()` method accepts a plugin (or many) and returns a new constructor. + +A plugin is a function which gets two arguments: + +1. the current instance +2. the options passed to the constructor. + +In order to extend `octokit`'s API, the plugin must return an object with the new methods. + +```js +// index.js +const { Octokit } = require("@octokit/core") +const MyOctokit = Octokit.plugin( + require("./lib/my-plugin"), + require("octokit-plugin-example") +); + +const octokit = new MyOctokit({ greeting: "Moin moin" }); +octokit.helloWorld(); // logs "Moin moin, world!" +octokit.request("GET /"); // logs "GET / - 200 in 123ms" + +// lib/my-plugin.js +module.exports = (octokit, options = { greeting: "Hello" }) => { + // hook into the request lifecycle + octokit.hook.wrap("request", async (request, options) => { + const time = Date.now(); + const response = await request(options); + console.log( + `${options.method} ${options.url} – ${response.status} in ${Date.now() - + time}ms` + ); + return response; + }); + + // add a custom method + return { + helloWorld: () => console.log(`${options.greeting}, world!`); + } +}; +``` + +## Build your own Octokit with Plugins and Defaults + +You can build your own Octokit class with preset default options and plugins. In fact, this is mostly how the `@octokit/` modules work, such as [`@octokit/action`](https://github.com/octokit/action.js): + +```js +const { Octokit } = require("@octokit/core"); +const MyActionOctokit = Octokit.plugin( + require("@octokit/plugin-paginate-rest"), + require("@octokit/plugin-throttling"), + require("@octokit/plugin-retry") +).defaults({ + authStrategy: require("@octokit/auth-action"), + userAgent: `my-octokit-action/v1.2.3`, +}); + +const octokit = new MyActionOctokit(); +const installations = await octokit.paginate("GET /app/installations"); +``` + +## LICENSE + +[MIT](LICENSE) diff --git a/node_modules/@octokit/core/dist-node/index.js b/node_modules/@octokit/core/dist-node/index.js new file mode 100644 index 00000000..62983432 --- /dev/null +++ b/node_modules/@octokit/core/dist-node/index.js @@ -0,0 +1,175 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +var universalUserAgent = require('universal-user-agent'); +var beforeAfterHook = require('before-after-hook'); +var request = require('@octokit/request'); +var graphql = require('@octokit/graphql'); +var authToken = require('@octokit/auth-token'); + +function _objectWithoutPropertiesLoose(source, excluded) { + if (source == null) return {}; + var target = {}; + var sourceKeys = Object.keys(source); + var key, i; + + for (i = 0; i < sourceKeys.length; i++) { + key = sourceKeys[i]; + if (excluded.indexOf(key) >= 0) continue; + target[key] = source[key]; + } + + return target; +} + +function _objectWithoutProperties(source, excluded) { + if (source == null) return {}; + + var target = _objectWithoutPropertiesLoose(source, excluded); + + var key, i; + + if (Object.getOwnPropertySymbols) { + var sourceSymbolKeys = Object.getOwnPropertySymbols(source); + + for (i = 0; i < sourceSymbolKeys.length; i++) { + key = sourceSymbolKeys[i]; + if (excluded.indexOf(key) >= 0) continue; + if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; + target[key] = source[key]; + } + } + + return target; +} + +const VERSION = "3.4.0"; + +class Octokit { + constructor(options = {}) { + const hook = new beforeAfterHook.Collection(); + const requestDefaults = { + baseUrl: request.request.endpoint.DEFAULTS.baseUrl, + headers: {}, + request: Object.assign({}, options.request, { + // @ts-ignore internal usage only, no need to type + hook: hook.bind(null, "request") + }), + mediaType: { + previews: [], + format: "" + } + }; // prepend default user agent with `options.userAgent` if set + + requestDefaults.headers["user-agent"] = [options.userAgent, `octokit-core.js/${VERSION} ${universalUserAgent.getUserAgent()}`].filter(Boolean).join(" "); + + if (options.baseUrl) { + requestDefaults.baseUrl = options.baseUrl; + } + + if (options.previews) { + requestDefaults.mediaType.previews = options.previews; + } + + if (options.timeZone) { + requestDefaults.headers["time-zone"] = options.timeZone; + } + + this.request = request.request.defaults(requestDefaults); + this.graphql = graphql.withCustomRequest(this.request).defaults(requestDefaults); + this.log = Object.assign({ + debug: () => {}, + info: () => {}, + warn: console.warn.bind(console), + error: console.error.bind(console) + }, options.log); + this.hook = hook; // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance + // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered. + // (2) If only `options.auth` is set, use the default token authentication strategy. + // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance. + // TODO: type `options.auth` based on `options.authStrategy`. + + if (!options.authStrategy) { + if (!options.auth) { + // (1) + this.auth = async () => ({ + type: "unauthenticated" + }); + } else { + // (2) + const auth = authToken.createTokenAuth(options.auth); // @ts-ignore ¯\_(ツ)_/¯ + + hook.wrap("request", auth.hook); + this.auth = auth; + } + } else { + const { + authStrategy + } = options, + otherOptions = _objectWithoutProperties(options, ["authStrategy"]); + + const auth = authStrategy(Object.assign({ + request: this.request, + log: this.log, + // we pass the current octokit instance as well as its constructor options + // to allow for authentication strategies that return a new octokit instance + // that shares the same internal state as the current one. The original + // requirement for this was the "event-octokit" authentication strategy + // of https://github.com/probot/octokit-auth-probot. + octokit: this, + octokitOptions: otherOptions + }, options.auth)); // @ts-ignore ¯\_(ツ)_/¯ + + hook.wrap("request", auth.hook); + this.auth = auth; + } // apply plugins + // https://stackoverflow.com/a/16345172 + + + const classConstructor = this.constructor; + classConstructor.plugins.forEach(plugin => { + Object.assign(this, plugin(this, options)); + }); + } + + static defaults(defaults) { + const OctokitWithDefaults = class extends this { + constructor(...args) { + const options = args[0] || {}; + + if (typeof defaults === "function") { + super(defaults(options)); + return; + } + + super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent ? { + userAgent: `${options.userAgent} ${defaults.userAgent}` + } : null)); + } + + }; + return OctokitWithDefaults; + } + /** + * Attach a plugin (or many) to your Octokit instance. + * + * @example + * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...) + */ + + + static plugin(...newPlugins) { + var _a; + + const currentPlugins = this.plugins; + const NewOctokit = (_a = class extends this {}, _a.plugins = currentPlugins.concat(newPlugins.filter(plugin => !currentPlugins.includes(plugin))), _a); + return NewOctokit; + } + +} +Octokit.VERSION = VERSION; +Octokit.plugins = []; + +exports.Octokit = Octokit; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/core/dist-node/index.js.map b/node_modules/@octokit/core/dist-node/index.js.map new file mode 100644 index 00000000..4c344365 --- /dev/null +++ b/node_modules/@octokit/core/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"3.4.0\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { Collection } from \"before-after-hook\";\nimport { request } from \"@octokit/request\";\nimport { withCustomRequest } from \"@octokit/graphql\";\nimport { createTokenAuth } from \"@octokit/auth-token\";\nimport { VERSION } from \"./version\";\nexport class Octokit {\n constructor(options = {}) {\n const hook = new Collection();\n const requestDefaults = {\n baseUrl: request.endpoint.DEFAULTS.baseUrl,\n headers: {},\n request: Object.assign({}, options.request, {\n // @ts-ignore internal usage only, no need to type\n hook: hook.bind(null, \"request\"),\n }),\n mediaType: {\n previews: [],\n format: \"\",\n },\n };\n // prepend default user agent with `options.userAgent` if set\n requestDefaults.headers[\"user-agent\"] = [\n options.userAgent,\n `octokit-core.js/${VERSION} ${getUserAgent()}`,\n ]\n .filter(Boolean)\n .join(\" \");\n if (options.baseUrl) {\n requestDefaults.baseUrl = options.baseUrl;\n }\n if (options.previews) {\n requestDefaults.mediaType.previews = options.previews;\n }\n if (options.timeZone) {\n requestDefaults.headers[\"time-zone\"] = options.timeZone;\n }\n this.request = request.defaults(requestDefaults);\n this.graphql = withCustomRequest(this.request).defaults(requestDefaults);\n this.log = Object.assign({\n debug: () => { },\n info: () => { },\n warn: console.warn.bind(console),\n error: console.error.bind(console),\n }, options.log);\n this.hook = hook;\n // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance\n // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered.\n // (2) If only `options.auth` is set, use the default token authentication strategy.\n // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance.\n // TODO: type `options.auth` based on `options.authStrategy`.\n if (!options.authStrategy) {\n if (!options.auth) {\n // (1)\n this.auth = async () => ({\n type: \"unauthenticated\",\n });\n }\n else {\n // (2)\n const auth = createTokenAuth(options.auth);\n // @ts-ignore ¯\\_(ツ)_/¯\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n }\n else {\n const { authStrategy, ...otherOptions } = options;\n const auth = authStrategy(Object.assign({\n request: this.request,\n log: this.log,\n // we pass the current octokit instance as well as its constructor options\n // to allow for authentication strategies that return a new octokit instance\n // that shares the same internal state as the current one. The original\n // requirement for this was the \"event-octokit\" authentication strategy\n // of https://github.com/probot/octokit-auth-probot.\n octokit: this,\n octokitOptions: otherOptions,\n }, options.auth));\n // @ts-ignore ¯\\_(ツ)_/¯\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n // apply plugins\n // https://stackoverflow.com/a/16345172\n const classConstructor = this.constructor;\n classConstructor.plugins.forEach((plugin) => {\n Object.assign(this, plugin(this, options));\n });\n }\n static defaults(defaults) {\n const OctokitWithDefaults = class extends this {\n constructor(...args) {\n const options = args[0] || {};\n if (typeof defaults === \"function\") {\n super(defaults(options));\n return;\n }\n super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent\n ? {\n userAgent: `${options.userAgent} ${defaults.userAgent}`,\n }\n : null));\n }\n };\n return OctokitWithDefaults;\n }\n /**\n * Attach a plugin (or many) to your Octokit instance.\n *\n * @example\n * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)\n */\n static plugin(...newPlugins) {\n var _a;\n const currentPlugins = this.plugins;\n const NewOctokit = (_a = class extends this {\n },\n _a.plugins = currentPlugins.concat(newPlugins.filter((plugin) => !currentPlugins.includes(plugin))),\n _a);\n return NewOctokit;\n }\n}\nOctokit.VERSION = VERSION;\nOctokit.plugins = [];\n"],"names":["VERSION","Octokit","constructor","options","hook","Collection","requestDefaults","baseUrl","request","endpoint","DEFAULTS","headers","Object","assign","bind","mediaType","previews","format","userAgent","getUserAgent","filter","Boolean","join","timeZone","defaults","graphql","withCustomRequest","log","debug","info","warn","console","error","authStrategy","auth","type","createTokenAuth","wrap","otherOptions","octokit","octokitOptions","classConstructor","plugins","forEach","plugin","OctokitWithDefaults","args","newPlugins","_a","currentPlugins","NewOctokit","concat","includes"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACMA,MAAMC,OAAN,CAAc;AACjBC,EAAAA,WAAW,CAACC,OAAO,GAAG,EAAX,EAAe;AACtB,UAAMC,IAAI,GAAG,IAAIC,0BAAJ,EAAb;AACA,UAAMC,eAAe,GAAG;AACpBC,MAAAA,OAAO,EAAEC,eAAO,CAACC,QAAR,CAAiBC,QAAjB,CAA0BH,OADf;AAEpBI,MAAAA,OAAO,EAAE,EAFW;AAGpBH,MAAAA,OAAO,EAAEI,MAAM,CAACC,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACK,OAA1B,EAAmC;AACxC;AACAJ,QAAAA,IAAI,EAAEA,IAAI,CAACU,IAAL,CAAU,IAAV,EAAgB,SAAhB;AAFkC,OAAnC,CAHW;AAOpBC,MAAAA,SAAS,EAAE;AACPC,QAAAA,QAAQ,EAAE,EADH;AAEPC,QAAAA,MAAM,EAAE;AAFD;AAPS,KAAxB,CAFsB;;AAetBX,IAAAA,eAAe,CAACK,OAAhB,CAAwB,YAAxB,IAAwC,CACpCR,OAAO,CAACe,SAD4B,EAEnC,mBAAkBlB,OAAQ,IAAGmB,+BAAY,EAAG,EAFT,EAInCC,MAJmC,CAI5BC,OAJ4B,EAKnCC,IALmC,CAK9B,GAL8B,CAAxC;;AAMA,QAAInB,OAAO,CAACI,OAAZ,EAAqB;AACjBD,MAAAA,eAAe,CAACC,OAAhB,GAA0BJ,OAAO,CAACI,OAAlC;AACH;;AACD,QAAIJ,OAAO,CAACa,QAAZ,EAAsB;AAClBV,MAAAA,eAAe,CAACS,SAAhB,CAA0BC,QAA1B,GAAqCb,OAAO,CAACa,QAA7C;AACH;;AACD,QAAIb,OAAO,CAACoB,QAAZ,EAAsB;AAClBjB,MAAAA,eAAe,CAACK,OAAhB,CAAwB,WAAxB,IAAuCR,OAAO,CAACoB,QAA/C;AACH;;AACD,SAAKf,OAAL,GAAeA,eAAO,CAACgB,QAAR,CAAiBlB,eAAjB,CAAf;AACA,SAAKmB,OAAL,GAAeC,yBAAiB,CAAC,KAAKlB,OAAN,CAAjB,CAAgCgB,QAAhC,CAAyClB,eAAzC,CAAf;AACA,SAAKqB,GAAL,GAAWf,MAAM,CAACC,MAAP,CAAc;AACrBe,MAAAA,KAAK,EAAE,MAAM,EADQ;AAErBC,MAAAA,IAAI,EAAE,MAAM,EAFS;AAGrBC,MAAAA,IAAI,EAAEC,OAAO,CAACD,IAAR,CAAahB,IAAb,CAAkBiB,OAAlB,CAHe;AAIrBC,MAAAA,KAAK,EAAED,OAAO,CAACC,KAAR,CAAclB,IAAd,CAAmBiB,OAAnB;AAJc,KAAd,EAKR5B,OAAO,CAACwB,GALA,CAAX;AAMA,SAAKvB,IAAL,GAAYA,IAAZ,CAtCsB;AAwCtB;AACA;AACA;AACA;;AACA,QAAI,CAACD,OAAO,CAAC8B,YAAb,EAA2B;AACvB,UAAI,CAAC9B,OAAO,CAAC+B,IAAb,EAAmB;AACf;AACA,aAAKA,IAAL,GAAY,aAAa;AACrBC,UAAAA,IAAI,EAAE;AADe,SAAb,CAAZ;AAGH,OALD,MAMK;AACD;AACA,cAAMD,IAAI,GAAGE,yBAAe,CAACjC,OAAO,CAAC+B,IAAT,CAA5B,CAFC;;AAID9B,QAAAA,IAAI,CAACiC,IAAL,CAAU,SAAV,EAAqBH,IAAI,CAAC9B,IAA1B;AACA,aAAK8B,IAAL,GAAYA,IAAZ;AACH;AACJ,KAdD,MAeK;AACD,YAAM;AAAED,QAAAA;AAAF,UAAoC9B,OAA1C;AAAA,YAAyBmC,YAAzB,4BAA0CnC,OAA1C;;AACA,YAAM+B,IAAI,GAAGD,YAAY,CAACrB,MAAM,CAACC,MAAP,CAAc;AACpCL,QAAAA,OAAO,EAAE,KAAKA,OADsB;AAEpCmB,QAAAA,GAAG,EAAE,KAAKA,GAF0B;AAGpC;AACA;AACA;AACA;AACA;AACAY,QAAAA,OAAO,EAAE,IAR2B;AASpCC,QAAAA,cAAc,EAAEF;AAToB,OAAd,EAUvBnC,OAAO,CAAC+B,IAVe,CAAD,CAAzB,CAFC;;AAcD9B,MAAAA,IAAI,CAACiC,IAAL,CAAU,SAAV,EAAqBH,IAAI,CAAC9B,IAA1B;AACA,WAAK8B,IAAL,GAAYA,IAAZ;AACH,KA3EqB;AA6EtB;;;AACA,UAAMO,gBAAgB,GAAG,KAAKvC,WAA9B;AACAuC,IAAAA,gBAAgB,CAACC,OAAjB,CAAyBC,OAAzB,CAAkCC,MAAD,IAAY;AACzChC,MAAAA,MAAM,CAACC,MAAP,CAAc,IAAd,EAAoB+B,MAAM,CAAC,IAAD,EAAOzC,OAAP,CAA1B;AACH,KAFD;AAGH;;AACc,SAARqB,QAAQ,CAACA,QAAD,EAAW;AACtB,UAAMqB,mBAAmB,GAAG,cAAc,IAAd,CAAmB;AAC3C3C,MAAAA,WAAW,CAAC,GAAG4C,IAAJ,EAAU;AACjB,cAAM3C,OAAO,GAAG2C,IAAI,CAAC,CAAD,CAAJ,IAAW,EAA3B;;AACA,YAAI,OAAOtB,QAAP,KAAoB,UAAxB,EAAoC;AAChC,gBAAMA,QAAQ,CAACrB,OAAD,CAAd;AACA;AACH;;AACD,cAAMS,MAAM,CAACC,MAAP,CAAc,EAAd,EAAkBW,QAAlB,EAA4BrB,OAA5B,EAAqCA,OAAO,CAACe,SAAR,IAAqBM,QAAQ,CAACN,SAA9B,GACrC;AACEA,UAAAA,SAAS,EAAG,GAAEf,OAAO,CAACe,SAAU,IAAGM,QAAQ,CAACN,SAAU;AADxD,SADqC,GAIrC,IAJA,CAAN;AAKH;;AAZ0C,KAA/C;AAcA,WAAO2B,mBAAP;AACH;AACD;AACJ;AACA;AACA;AACA;AACA;;;AACiB,SAAND,MAAM,CAAC,GAAGG,UAAJ,EAAgB;AACzB,QAAIC,EAAJ;;AACA,UAAMC,cAAc,GAAG,KAAKP,OAA5B;AACA,UAAMQ,UAAU,IAAIF,EAAE,GAAG,cAAc,IAAd,CAAmB,EAAxB,EAEhBA,EAAE,CAACN,OAAH,GAAaO,cAAc,CAACE,MAAf,CAAsBJ,UAAU,CAAC3B,MAAX,CAAmBwB,MAAD,IAAY,CAACK,cAAc,CAACG,QAAf,CAAwBR,MAAxB,CAA/B,CAAtB,CAFG,EAGhBI,EAHY,CAAhB;AAIA,WAAOE,UAAP;AACH;;AAnHgB;AAqHrBjD,OAAO,CAACD,OAAR,GAAkBA,OAAlB;AACAC,OAAO,CAACyC,OAAR,GAAkB,EAAlB;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/core/dist-src/index.js b/node_modules/@octokit/core/dist-src/index.js new file mode 100644 index 00000000..bdbc335b --- /dev/null +++ b/node_modules/@octokit/core/dist-src/index.js @@ -0,0 +1,125 @@ +import { getUserAgent } from "universal-user-agent"; +import { Collection } from "before-after-hook"; +import { request } from "@octokit/request"; +import { withCustomRequest } from "@octokit/graphql"; +import { createTokenAuth } from "@octokit/auth-token"; +import { VERSION } from "./version"; +export class Octokit { + constructor(options = {}) { + const hook = new Collection(); + const requestDefaults = { + baseUrl: request.endpoint.DEFAULTS.baseUrl, + headers: {}, + request: Object.assign({}, options.request, { + // @ts-ignore internal usage only, no need to type + hook: hook.bind(null, "request"), + }), + mediaType: { + previews: [], + format: "", + }, + }; + // prepend default user agent with `options.userAgent` if set + requestDefaults.headers["user-agent"] = [ + options.userAgent, + `octokit-core.js/${VERSION} ${getUserAgent()}`, + ] + .filter(Boolean) + .join(" "); + if (options.baseUrl) { + requestDefaults.baseUrl = options.baseUrl; + } + if (options.previews) { + requestDefaults.mediaType.previews = options.previews; + } + if (options.timeZone) { + requestDefaults.headers["time-zone"] = options.timeZone; + } + this.request = request.defaults(requestDefaults); + this.graphql = withCustomRequest(this.request).defaults(requestDefaults); + this.log = Object.assign({ + debug: () => { }, + info: () => { }, + warn: console.warn.bind(console), + error: console.error.bind(console), + }, options.log); + this.hook = hook; + // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance + // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered. + // (2) If only `options.auth` is set, use the default token authentication strategy. + // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance. + // TODO: type `options.auth` based on `options.authStrategy`. + if (!options.authStrategy) { + if (!options.auth) { + // (1) + this.auth = async () => ({ + type: "unauthenticated", + }); + } + else { + // (2) + const auth = createTokenAuth(options.auth); + // @ts-ignore ¯\_(ツ)_/¯ + hook.wrap("request", auth.hook); + this.auth = auth; + } + } + else { + const { authStrategy, ...otherOptions } = options; + const auth = authStrategy(Object.assign({ + request: this.request, + log: this.log, + // we pass the current octokit instance as well as its constructor options + // to allow for authentication strategies that return a new octokit instance + // that shares the same internal state as the current one. The original + // requirement for this was the "event-octokit" authentication strategy + // of https://github.com/probot/octokit-auth-probot. + octokit: this, + octokitOptions: otherOptions, + }, options.auth)); + // @ts-ignore ¯\_(ツ)_/¯ + hook.wrap("request", auth.hook); + this.auth = auth; + } + // apply plugins + // https://stackoverflow.com/a/16345172 + const classConstructor = this.constructor; + classConstructor.plugins.forEach((plugin) => { + Object.assign(this, plugin(this, options)); + }); + } + static defaults(defaults) { + const OctokitWithDefaults = class extends this { + constructor(...args) { + const options = args[0] || {}; + if (typeof defaults === "function") { + super(defaults(options)); + return; + } + super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent + ? { + userAgent: `${options.userAgent} ${defaults.userAgent}`, + } + : null)); + } + }; + return OctokitWithDefaults; + } + /** + * Attach a plugin (or many) to your Octokit instance. + * + * @example + * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...) + */ + static plugin(...newPlugins) { + var _a; + const currentPlugins = this.plugins; + const NewOctokit = (_a = class extends this { + }, + _a.plugins = currentPlugins.concat(newPlugins.filter((plugin) => !currentPlugins.includes(plugin))), + _a); + return NewOctokit; + } +} +Octokit.VERSION = VERSION; +Octokit.plugins = []; diff --git a/node_modules/@octokit/core/dist-src/types.js b/node_modules/@octokit/core/dist-src/types.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/core/dist-src/types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/core/dist-src/version.js b/node_modules/@octokit/core/dist-src/version.js new file mode 100644 index 00000000..6c03212c --- /dev/null +++ b/node_modules/@octokit/core/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "3.4.0"; diff --git a/node_modules/@octokit/core/dist-types/index.d.ts b/node_modules/@octokit/core/dist-types/index.d.ts new file mode 100644 index 00000000..b757c5bc --- /dev/null +++ b/node_modules/@octokit/core/dist-types/index.d.ts @@ -0,0 +1,30 @@ +import { HookCollection } from "before-after-hook"; +import { request } from "@octokit/request"; +import { graphql } from "@octokit/graphql"; +import { Constructor, Hooks, OctokitOptions, OctokitPlugin, ReturnTypeOf, UnionToIntersection } from "./types"; +export declare class Octokit { + static VERSION: string; + static defaults>(this: S, defaults: OctokitOptions | Function): S; + static plugins: OctokitPlugin[]; + /** + * Attach a plugin (or many) to your Octokit instance. + * + * @example + * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...) + */ + static plugin & { + plugins: any[]; + }, T extends OctokitPlugin[]>(this: S, ...newPlugins: T): S & Constructor>>; + constructor(options?: OctokitOptions); + request: typeof request; + graphql: typeof graphql; + log: { + debug: (message: string, additionalInfo?: object) => any; + info: (message: string, additionalInfo?: object) => any; + warn: (message: string, additionalInfo?: object) => any; + error: (message: string, additionalInfo?: object) => any; + [key: string]: any; + }; + hook: HookCollection; + auth: (...args: unknown[]) => Promise; +} diff --git a/node_modules/@octokit/core/dist-types/types.d.ts b/node_modules/@octokit/core/dist-types/types.d.ts new file mode 100644 index 00000000..86ae62d8 --- /dev/null +++ b/node_modules/@octokit/core/dist-types/types.d.ts @@ -0,0 +1,44 @@ +import * as OctokitTypes from "@octokit/types"; +import { RequestError } from "@octokit/request-error"; +import { Octokit } from "."; +export declare type RequestParameters = OctokitTypes.RequestParameters; +export declare type OctokitOptions = { + authStrategy?: any; + auth?: any; + userAgent?: string; + previews?: string[]; + baseUrl?: string; + log?: { + debug: (message: string) => unknown; + info: (message: string) => unknown; + warn: (message: string) => unknown; + error: (message: string) => unknown; + }; + request?: OctokitTypes.RequestRequestOptions; + timeZone?: string; + [option: string]: any; +}; +export declare type Constructor = new (...args: any[]) => T; +export declare type ReturnTypeOf = T extends AnyFunction ? ReturnType : T extends AnyFunction[] ? UnionToIntersection> : never; +/** + * @author https://stackoverflow.com/users/2887218/jcalz + * @see https://stackoverflow.com/a/50375286/10325032 + */ +export declare type UnionToIntersection = (Union extends any ? (argument: Union) => void : never) extends (argument: infer Intersection) => void ? Intersection : never; +declare type AnyFunction = (...args: any) => any; +export declare type OctokitPlugin = (octokit: Octokit, options: OctokitOptions) => { + [key: string]: any; +} | void; +export declare type Hooks = { + request: { + Options: Required; + Result: OctokitTypes.OctokitResponse; + Error: RequestError | Error; + }; + [key: string]: { + Options: unknown; + Result: unknown; + Error: unknown; + }; +}; +export {}; diff --git a/node_modules/@octokit/core/dist-types/version.d.ts b/node_modules/@octokit/core/dist-types/version.d.ts new file mode 100644 index 00000000..d19afac4 --- /dev/null +++ b/node_modules/@octokit/core/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "3.4.0"; diff --git a/node_modules/@octokit/core/dist-web/index.js b/node_modules/@octokit/core/dist-web/index.js new file mode 100644 index 00000000..08ecf0be --- /dev/null +++ b/node_modules/@octokit/core/dist-web/index.js @@ -0,0 +1,130 @@ +import { getUserAgent } from 'universal-user-agent'; +import { Collection } from 'before-after-hook'; +import { request } from '@octokit/request'; +import { withCustomRequest } from '@octokit/graphql'; +import { createTokenAuth } from '@octokit/auth-token'; + +const VERSION = "3.4.0"; + +class Octokit { + constructor(options = {}) { + const hook = new Collection(); + const requestDefaults = { + baseUrl: request.endpoint.DEFAULTS.baseUrl, + headers: {}, + request: Object.assign({}, options.request, { + // @ts-ignore internal usage only, no need to type + hook: hook.bind(null, "request"), + }), + mediaType: { + previews: [], + format: "", + }, + }; + // prepend default user agent with `options.userAgent` if set + requestDefaults.headers["user-agent"] = [ + options.userAgent, + `octokit-core.js/${VERSION} ${getUserAgent()}`, + ] + .filter(Boolean) + .join(" "); + if (options.baseUrl) { + requestDefaults.baseUrl = options.baseUrl; + } + if (options.previews) { + requestDefaults.mediaType.previews = options.previews; + } + if (options.timeZone) { + requestDefaults.headers["time-zone"] = options.timeZone; + } + this.request = request.defaults(requestDefaults); + this.graphql = withCustomRequest(this.request).defaults(requestDefaults); + this.log = Object.assign({ + debug: () => { }, + info: () => { }, + warn: console.warn.bind(console), + error: console.error.bind(console), + }, options.log); + this.hook = hook; + // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance + // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered. + // (2) If only `options.auth` is set, use the default token authentication strategy. + // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance. + // TODO: type `options.auth` based on `options.authStrategy`. + if (!options.authStrategy) { + if (!options.auth) { + // (1) + this.auth = async () => ({ + type: "unauthenticated", + }); + } + else { + // (2) + const auth = createTokenAuth(options.auth); + // @ts-ignore ¯\_(ツ)_/¯ + hook.wrap("request", auth.hook); + this.auth = auth; + } + } + else { + const { authStrategy, ...otherOptions } = options; + const auth = authStrategy(Object.assign({ + request: this.request, + log: this.log, + // we pass the current octokit instance as well as its constructor options + // to allow for authentication strategies that return a new octokit instance + // that shares the same internal state as the current one. The original + // requirement for this was the "event-octokit" authentication strategy + // of https://github.com/probot/octokit-auth-probot. + octokit: this, + octokitOptions: otherOptions, + }, options.auth)); + // @ts-ignore ¯\_(ツ)_/¯ + hook.wrap("request", auth.hook); + this.auth = auth; + } + // apply plugins + // https://stackoverflow.com/a/16345172 + const classConstructor = this.constructor; + classConstructor.plugins.forEach((plugin) => { + Object.assign(this, plugin(this, options)); + }); + } + static defaults(defaults) { + const OctokitWithDefaults = class extends this { + constructor(...args) { + const options = args[0] || {}; + if (typeof defaults === "function") { + super(defaults(options)); + return; + } + super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent + ? { + userAgent: `${options.userAgent} ${defaults.userAgent}`, + } + : null)); + } + }; + return OctokitWithDefaults; + } + /** + * Attach a plugin (or many) to your Octokit instance. + * + * @example + * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...) + */ + static plugin(...newPlugins) { + var _a; + const currentPlugins = this.plugins; + const NewOctokit = (_a = class extends this { + }, + _a.plugins = currentPlugins.concat(newPlugins.filter((plugin) => !currentPlugins.includes(plugin))), + _a); + return NewOctokit; + } +} +Octokit.VERSION = VERSION; +Octokit.plugins = []; + +export { Octokit }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/core/dist-web/index.js.map b/node_modules/@octokit/core/dist-web/index.js.map new file mode 100644 index 00000000..b5f8f91e --- /dev/null +++ b/node_modules/@octokit/core/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"3.4.0\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { Collection } from \"before-after-hook\";\nimport { request } from \"@octokit/request\";\nimport { withCustomRequest } from \"@octokit/graphql\";\nimport { createTokenAuth } from \"@octokit/auth-token\";\nimport { VERSION } from \"./version\";\nexport class Octokit {\n constructor(options = {}) {\n const hook = new Collection();\n const requestDefaults = {\n baseUrl: request.endpoint.DEFAULTS.baseUrl,\n headers: {},\n request: Object.assign({}, options.request, {\n // @ts-ignore internal usage only, no need to type\n hook: hook.bind(null, \"request\"),\n }),\n mediaType: {\n previews: [],\n format: \"\",\n },\n };\n // prepend default user agent with `options.userAgent` if set\n requestDefaults.headers[\"user-agent\"] = [\n options.userAgent,\n `octokit-core.js/${VERSION} ${getUserAgent()}`,\n ]\n .filter(Boolean)\n .join(\" \");\n if (options.baseUrl) {\n requestDefaults.baseUrl = options.baseUrl;\n }\n if (options.previews) {\n requestDefaults.mediaType.previews = options.previews;\n }\n if (options.timeZone) {\n requestDefaults.headers[\"time-zone\"] = options.timeZone;\n }\n this.request = request.defaults(requestDefaults);\n this.graphql = withCustomRequest(this.request).defaults(requestDefaults);\n this.log = Object.assign({\n debug: () => { },\n info: () => { },\n warn: console.warn.bind(console),\n error: console.error.bind(console),\n }, options.log);\n this.hook = hook;\n // (1) If neither `options.authStrategy` nor `options.auth` are set, the `octokit` instance\n // is unauthenticated. The `this.auth()` method is a no-op and no request hook is registered.\n // (2) If only `options.auth` is set, use the default token authentication strategy.\n // (3) If `options.authStrategy` is set then use it and pass in `options.auth`. Always pass own request as many strategies accept a custom request instance.\n // TODO: type `options.auth` based on `options.authStrategy`.\n if (!options.authStrategy) {\n if (!options.auth) {\n // (1)\n this.auth = async () => ({\n type: \"unauthenticated\",\n });\n }\n else {\n // (2)\n const auth = createTokenAuth(options.auth);\n // @ts-ignore ¯\\_(ツ)_/¯\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n }\n else {\n const { authStrategy, ...otherOptions } = options;\n const auth = authStrategy(Object.assign({\n request: this.request,\n log: this.log,\n // we pass the current octokit instance as well as its constructor options\n // to allow for authentication strategies that return a new octokit instance\n // that shares the same internal state as the current one. The original\n // requirement for this was the \"event-octokit\" authentication strategy\n // of https://github.com/probot/octokit-auth-probot.\n octokit: this,\n octokitOptions: otherOptions,\n }, options.auth));\n // @ts-ignore ¯\\_(ツ)_/¯\n hook.wrap(\"request\", auth.hook);\n this.auth = auth;\n }\n // apply plugins\n // https://stackoverflow.com/a/16345172\n const classConstructor = this.constructor;\n classConstructor.plugins.forEach((plugin) => {\n Object.assign(this, plugin(this, options));\n });\n }\n static defaults(defaults) {\n const OctokitWithDefaults = class extends this {\n constructor(...args) {\n const options = args[0] || {};\n if (typeof defaults === \"function\") {\n super(defaults(options));\n return;\n }\n super(Object.assign({}, defaults, options, options.userAgent && defaults.userAgent\n ? {\n userAgent: `${options.userAgent} ${defaults.userAgent}`,\n }\n : null));\n }\n };\n return OctokitWithDefaults;\n }\n /**\n * Attach a plugin (or many) to your Octokit instance.\n *\n * @example\n * const API = Octokit.plugin(plugin1, plugin2, plugin3, ...)\n */\n static plugin(...newPlugins) {\n var _a;\n const currentPlugins = this.plugins;\n const NewOctokit = (_a = class extends this {\n },\n _a.plugins = currentPlugins.concat(newPlugins.filter((plugin) => !currentPlugins.includes(plugin))),\n _a);\n return NewOctokit;\n }\n}\nOctokit.VERSION = VERSION;\nOctokit.plugins = [];\n"],"names":[],"mappings":";;;;;;AAAO,MAAM,OAAO,GAAG,mBAAmB;;ACMnC,MAAM,OAAO,CAAC;AACrB,IAAI,WAAW,CAAC,OAAO,GAAG,EAAE,EAAE;AAC9B,QAAQ,MAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;AACtC,QAAQ,MAAM,eAAe,GAAG;AAChC,YAAY,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO;AACtD,YAAY,OAAO,EAAE,EAAE;AACvB,YAAY,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,EAAE;AACxD;AACA,gBAAgB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC;AAChD,aAAa,CAAC;AACd,YAAY,SAAS,EAAE;AACvB,gBAAgB,QAAQ,EAAE,EAAE;AAC5B,gBAAgB,MAAM,EAAE,EAAE;AAC1B,aAAa;AACb,SAAS,CAAC;AACV;AACA,QAAQ,eAAe,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG;AAChD,YAAY,OAAO,CAAC,SAAS;AAC7B,YAAY,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AAC1D,SAAS;AACT,aAAa,MAAM,CAAC,OAAO,CAAC;AAC5B,aAAa,IAAI,CAAC,GAAG,CAAC,CAAC;AACvB,QAAQ,IAAI,OAAO,CAAC,OAAO,EAAE;AAC7B,YAAY,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;AACtD,SAAS;AACT,QAAQ,IAAI,OAAO,CAAC,QAAQ,EAAE;AAC9B,YAAY,eAAe,CAAC,SAAS,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;AAClE,SAAS;AACT,QAAQ,IAAI,OAAO,CAAC,QAAQ,EAAE;AAC9B,YAAY,eAAe,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;AACpE,SAAS;AACT,QAAQ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;AACzD,QAAQ,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;AACjF,QAAQ,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC;AACjC,YAAY,KAAK,EAAE,MAAM,GAAG;AAC5B,YAAY,IAAI,EAAE,MAAM,GAAG;AAC3B,YAAY,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;AAC5C,YAAY,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;AAC9C,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;AACxB,QAAQ,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AACzB;AACA;AACA;AACA;AACA;AACA,QAAQ,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;AACnC,YAAY,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;AAC/B;AACA,gBAAgB,IAAI,CAAC,IAAI,GAAG,aAAa;AACzC,oBAAoB,IAAI,EAAE,iBAAiB;AAC3C,iBAAiB,CAAC,CAAC;AACnB,aAAa;AACb,iBAAiB;AACjB;AACA,gBAAgB,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC3D;AACA,gBAAgB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;AAChD,gBAAgB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AACjC,aAAa;AACb,SAAS;AACT,aAAa;AACb,YAAY,MAAM,EAAE,YAAY,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC;AAC9D,YAAY,MAAM,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC;AACpD,gBAAgB,OAAO,EAAE,IAAI,CAAC,OAAO;AACrC,gBAAgB,GAAG,EAAE,IAAI,CAAC,GAAG;AAC7B;AACA;AACA;AACA;AACA;AACA,gBAAgB,OAAO,EAAE,IAAI;AAC7B,gBAAgB,cAAc,EAAE,YAAY;AAC5C,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9B;AACA,YAAY,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5C,YAAY,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;AAC7B,SAAS;AACT;AACA;AACA,QAAQ,MAAM,gBAAgB,GAAG,IAAI,CAAC,WAAW,CAAC;AAClD,QAAQ,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK;AACrD,YAAY,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;AACvD,SAAS,CAAC,CAAC;AACX,KAAK;AACL,IAAI,OAAO,QAAQ,CAAC,QAAQ,EAAE;AAC9B,QAAQ,MAAM,mBAAmB,GAAG,cAAc,IAAI,CAAC;AACvD,YAAY,WAAW,CAAC,GAAG,IAAI,EAAE;AACjC,gBAAgB,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAC9C,gBAAgB,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;AACpD,oBAAoB,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;AAC7C,oBAAoB,OAAO;AAC3B,iBAAiB;AACjB,gBAAgB,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,SAAS,IAAI,QAAQ,CAAC,SAAS;AAClG,sBAAsB;AACtB,wBAAwB,SAAS,EAAE,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;AAC/E,qBAAqB;AACrB,sBAAsB,IAAI,CAAC,CAAC,CAAC;AAC7B,aAAa;AACb,SAAS,CAAC;AACV,QAAQ,OAAO,mBAAmB,CAAC;AACnC,KAAK;AACL;AACA;AACA;AACA;AACA;AACA;AACA,IAAI,OAAO,MAAM,CAAC,GAAG,UAAU,EAAE;AACjC,QAAQ,IAAI,EAAE,CAAC;AACf,QAAQ,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC;AAC5C,QAAQ,MAAM,UAAU,IAAI,EAAE,GAAG,cAAc,IAAI,CAAC;AACpD,aAAa;AACb,YAAY,EAAE,CAAC,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAC/G,YAAY,EAAE,CAAC,CAAC;AAChB,QAAQ,OAAO,UAAU,CAAC;AAC1B,KAAK;AACL,CAAC;AACD,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;AAC1B,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/core/package.json b/node_modules/@octokit/core/package.json new file mode 100644 index 00000000..6c826a7e --- /dev/null +++ b/node_modules/@octokit/core/package.json @@ -0,0 +1,58 @@ +{ + "name": "@octokit/core", + "description": "Extendable client for GitHub's REST & GraphQL APIs", + "version": "3.4.0", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "octokit", + "github", + "api", + "sdk", + "toolkit" + ], + "repository": "github:octokit/core.js", + "dependencies": { + "@octokit/auth-token": "^2.4.4", + "@octokit/graphql": "^4.5.8", + "@octokit/request": "^5.4.12", + "@octokit/request-error": "^2.0.5", + "@octokit/types": "^6.0.3", + "before-after-hook": "^2.2.0", + "universal-user-agent": "^6.0.0" + }, + "devDependencies": { + "@octokit/auth": "^3.0.1", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/fetch-mock": "^7.3.1", + "@types/jest": "^26.0.0", + "@types/lolex": "^5.1.0", + "@types/node": "^14.0.4", + "@types/node-fetch": "^2.5.0", + "fetch-mock": "^9.0.0", + "http-proxy-agent": "^4.0.1", + "jest": "^26.1.0", + "lolex": "^6.0.0", + "prettier": "^2.0.4", + "proxy": "^1.0.1", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "ts-jest": "^26.1.3", + "typescript": "^4.0.2" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/endpoint/LICENSE b/node_modules/@octokit/endpoint/LICENSE new file mode 100644 index 00000000..af5366d0 --- /dev/null +++ b/node_modules/@octokit/endpoint/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2018 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/@octokit/endpoint/README.md b/node_modules/@octokit/endpoint/README.md new file mode 100644 index 00000000..ec54be2c --- /dev/null +++ b/node_modules/@octokit/endpoint/README.md @@ -0,0 +1,421 @@ +# endpoint.js + +> Turns GitHub REST API endpoints into generic request options + +[![@latest](https://img.shields.io/npm/v/@octokit/endpoint.svg)](https://www.npmjs.com/package/@octokit/endpoint) +![Build Status](https://github.com/octokit/endpoint.js/workflows/Test/badge.svg) + +`@octokit/endpoint` combines [GitHub REST API routes](https://developer.github.com/v3/) with your parameters and turns them into generic request options that can be used in any request library. + + + + + +- [Usage](#usage) +- [API](#api) + - [`endpoint(route, options)` or `endpoint(options)`](#endpointroute-options-or-endpointoptions) + - [`endpoint.defaults()`](#endpointdefaults) + - [`endpoint.DEFAULTS`](#endpointdefaults) + - [`endpoint.merge(route, options)` or `endpoint.merge(options)`](#endpointmergeroute-options-or-endpointmergeoptions) + - [`endpoint.parse()`](#endpointparse) +- [Special cases](#special-cases) + - [The `data` parameter – set request body directly](#the-data-parameter-%E2%80%93-set-request-body-directly) + - [Set parameters for both the URL/query and the request body](#set-parameters-for-both-the-urlquery-and-the-request-body) +- [LICENSE](#license) + + + +## Usage + + + + + + +
+Browsers + +Load @octokit/endpoint directly from cdn.pika.dev + +```html + +``` + +
+Node + + +Install with npm install @octokit/endpoint + +```js +const { endpoint } = require("@octokit/endpoint"); +// or: import { endpoint } from "@octokit/endpoint"; +``` + +
+ +Example for [List organization repositories](https://developer.github.com/v3/repos/#list-organization-repositories) + +```js +const requestOptions = endpoint("GET /orgs/:org/repos", { + headers: { + authorization: "token 0000000000000000000000000000000000000001", + }, + org: "octokit", + type: "private", +}); +``` + +The resulting `requestOptions` looks as follows + +```json +{ + "method": "GET", + "url": "https://api.github.com/orgs/octokit/repos?type=private", + "headers": { + "accept": "application/vnd.github.v3+json", + "authorization": "token 0000000000000000000000000000000000000001", + "user-agent": "octokit/endpoint.js v1.2.3" + } +} +``` + +You can pass `requestOptions` to common request libraries + +```js +const { url, ...options } = requestOptions; +// using with fetch (https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) +fetch(url, options); +// using with request (https://github.com/request/request) +request(requestOptions); +// using with got (https://github.com/sindresorhus/got) +got[options.method](url, options); +// using with axios +axios(requestOptions); +``` + +## API + +### `endpoint(route, options)` or `endpoint(options)` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ name + + type + + description +
+ route + + String + + If set, it has to be a string consisting of URL and the request method, e.g., GET /orgs/:org. If it’s set to a URL, only the method defaults to GET. +
+ options.method + + String + + Required unless route is set. Any supported http verb. Defaults to GET. +
+ options.url + + String + + Required unless route is set. A path or full URL which may contain :variable or {variable} placeholders, + e.g., /orgs/:org/repos. The url is parsed using url-template. +
+ options.baseUrl + + String + + Defaults to https://api.github.com. +
+ options.headers + + Object + + Custom headers. Passed headers are merged with defaults:
+ headers['user-agent'] defaults to octokit-endpoint.js/1.2.3 (where 1.2.3 is the released version).
+ headers['accept'] defaults to application/vnd.github.v3+json.
+
+ options.mediaType.format + + String + + Media type param, such as raw, diff, or text+json. See Media Types. Setting options.mediaType.format will amend the headers.accept value. +
+ options.mediaType.previews + + Array of Strings + + Name of previews, such as mercy, symmetra, or scarlet-witch. See API Previews. If options.mediaType.previews was set as default, the new previews will be merged into the default ones. Setting options.mediaType.previews will amend the headers.accept value. options.mediaType.previews will be merged with an existing array set using .defaults(). +
+ options.data + + Any + + Set request body directly instead of setting it to JSON based on additional parameters. See "The data parameter" below. +
+ options.request + + Object + + Pass custom meta information for the request. The request object will be returned as is. +
+ +All other options will be passed depending on the `method` and `url` options. + +1. If the option key has a placeholder in the `url`, it will be used as the replacement. For example, if the passed options are `{url: '/orgs/:org/repos', org: 'foo'}` the returned `options.url` is `https://api.github.com/orgs/foo/repos`. +2. If the `method` is `GET` or `HEAD`, the option is passed as a query parameter. +3. Otherwise, the parameter is passed in the request body as a JSON key. + +**Result** + +`endpoint()` is a synchronous method and returns an object with the following keys: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ key + + type + + description +
methodStringThe http method. Always lowercase.
urlStringThe url with placeholders replaced with passed parameters.
headersObjectAll header names are lowercased.
bodyAnyThe request body if one is present. Only for PATCH, POST, PUT, DELETE requests.
requestObjectRequest meta option, it will be returned as it was passed into endpoint()
+ +### `endpoint.defaults()` + +Override or set default options. Example: + +```js +const request = require("request"); +const myEndpoint = require("@octokit/endpoint").defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", + headers: { + "user-agent": "myApp/1.2.3", + authorization: `token 0000000000000000000000000000000000000001`, + }, + org: "my-project", + per_page: 100, +}); + +request(myEndpoint(`GET /orgs/:org/repos`)); +``` + +You can call `.defaults()` again on the returned method, the defaults will cascade. + +```js +const myProjectEndpoint = endpoint.defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", + headers: { + "user-agent": "myApp/1.2.3", + }, + org: "my-project", +}); +const myProjectEndpointWithAuth = myProjectEndpoint.defaults({ + headers: { + authorization: `token 0000000000000000000000000000000000000001`, + }, +}); +``` + +`myProjectEndpointWithAuth` now defaults the `baseUrl`, `headers['user-agent']`, +`org` and `headers['authorization']` on top of `headers['accept']` that is set +by the global default. + +### `endpoint.DEFAULTS` + +The current default options. + +```js +endpoint.DEFAULTS.baseUrl; // https://api.github.com +const myEndpoint = endpoint.defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", +}); +myEndpoint.DEFAULTS.baseUrl; // https://github-enterprise.acme-inc.com/api/v3 +``` + +### `endpoint.merge(route, options)` or `endpoint.merge(options)` + +Get the defaulted endpoint options, but without parsing them into request options: + +```js +const myProjectEndpoint = endpoint.defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", + headers: { + "user-agent": "myApp/1.2.3", + }, + org: "my-project", +}); +myProjectEndpoint.merge("GET /orgs/:org/repos", { + headers: { + authorization: `token 0000000000000000000000000000000000000001`, + }, + org: "my-secret-project", + type: "private", +}); + +// { +// baseUrl: 'https://github-enterprise.acme-inc.com/api/v3', +// method: 'GET', +// url: '/orgs/:org/repos', +// headers: { +// accept: 'application/vnd.github.v3+json', +// authorization: `token 0000000000000000000000000000000000000001`, +// 'user-agent': 'myApp/1.2.3' +// }, +// org: 'my-secret-project', +// type: 'private' +// } +``` + +### `endpoint.parse()` + +Stateless method to turn endpoint options into request options. Calling +`endpoint(options)` is the same as calling `endpoint.parse(endpoint.merge(options))`. + +## Special cases + + + +### The `data` parameter – set request body directly + +Some endpoints such as [Render a Markdown document in raw mode](https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode) don’t have parameters that are sent as request body keys, instead, the request body needs to be set directly. In these cases, set the `data` parameter. + +```js +const options = endpoint("POST /markdown/raw", { + data: "Hello world github/linguist#1 **cool**, and #1!", + headers: { + accept: "text/html;charset=utf-8", + "content-type": "text/plain", + }, +}); + +// options is +// { +// method: 'post', +// url: 'https://api.github.com/markdown/raw', +// headers: { +// accept: 'text/html;charset=utf-8', +// 'content-type': 'text/plain', +// 'user-agent': userAgent +// }, +// body: 'Hello world github/linguist#1 **cool**, and #1!' +// } +``` + +### Set parameters for both the URL/query and the request body + +There are API endpoints that accept both query parameters as well as a body. In that case, you need to add the query parameters as templates to `options.url`, as defined in the [RFC 6570 URI Template specification](https://tools.ietf.org/html/rfc6570). + +Example + +```js +endpoint( + "POST https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", + { + name: "example.zip", + label: "short description", + headers: { + "content-type": "text/plain", + "content-length": 14, + authorization: `token 0000000000000000000000000000000000000001`, + }, + data: "Hello, world!", + } +); +``` + +## LICENSE + +[MIT](LICENSE) diff --git a/node_modules/@octokit/endpoint/dist-node/index.js b/node_modules/@octokit/endpoint/dist-node/index.js new file mode 100644 index 00000000..35f5878c --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-node/index.js @@ -0,0 +1,379 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } + +var isPlainObject = _interopDefault(require('is-plain-object')); +var universalUserAgent = require('universal-user-agent'); + +function lowercaseKeys(object) { + if (!object) { + return {}; + } + + return Object.keys(object).reduce((newObj, key) => { + newObj[key.toLowerCase()] = object[key]; + return newObj; + }, {}); +} + +function mergeDeep(defaults, options) { + const result = Object.assign({}, defaults); + Object.keys(options).forEach(key => { + if (isPlainObject(options[key])) { + if (!(key in defaults)) Object.assign(result, { + [key]: options[key] + });else result[key] = mergeDeep(defaults[key], options[key]); + } else { + Object.assign(result, { + [key]: options[key] + }); + } + }); + return result; +} + +function merge(defaults, route, options) { + if (typeof route === "string") { + let [method, url] = route.split(" "); + options = Object.assign(url ? { + method, + url + } : { + url: method + }, options); + } else { + options = Object.assign({}, route); + } // lowercase header names before merging with defaults to avoid duplicates + + + options.headers = lowercaseKeys(options.headers); + const mergedOptions = mergeDeep(defaults || {}, options); // mediaType.previews arrays are merged, instead of overwritten + + if (defaults && defaults.mediaType.previews.length) { + mergedOptions.mediaType.previews = defaults.mediaType.previews.filter(preview => !mergedOptions.mediaType.previews.includes(preview)).concat(mergedOptions.mediaType.previews); + } + + mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map(preview => preview.replace(/-preview/, "")); + return mergedOptions; +} + +function addQueryParameters(url, parameters) { + const separator = /\?/.test(url) ? "&" : "?"; + const names = Object.keys(parameters); + + if (names.length === 0) { + return url; + } + + return url + separator + names.map(name => { + if (name === "q") { + return "q=" + parameters.q.split("+").map(encodeURIComponent).join("+"); + } + + return `${name}=${encodeURIComponent(parameters[name])}`; + }).join("&"); +} + +const urlVariableRegex = /\{[^}]+\}/g; + +function removeNonChars(variableName) { + return variableName.replace(/^\W+|\W+$/g, "").split(/,/); +} + +function extractUrlVariableNames(url) { + const matches = url.match(urlVariableRegex); + + if (!matches) { + return []; + } + + return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []); +} + +function omit(object, keysToOmit) { + return Object.keys(object).filter(option => !keysToOmit.includes(option)).reduce((obj, key) => { + obj[key] = object[key]; + return obj; + }, {}); +} + +// Based on https://github.com/bramstein/url-template, licensed under BSD +// TODO: create separate package. +// +// Copyright (c) 2012-2014, Bram Stein +// All rights reserved. +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions +// are met: +// 1. Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// 2. Redistributions in binary form must reproduce the above copyright +// notice, this list of conditions and the following disclaimer in the +// documentation and/or other materials provided with the distribution. +// 3. The name of the author may not be used to endorse or promote products +// derived from this software without specific prior written permission. +// THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED +// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO +// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY +// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +/* istanbul ignore file */ +function encodeReserved(str) { + return str.split(/(%[0-9A-Fa-f]{2})/g).map(function (part) { + if (!/%[0-9A-Fa-f]/.test(part)) { + part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]"); + } + + return part; + }).join(""); +} + +function encodeUnreserved(str) { + return encodeURIComponent(str).replace(/[!'()*]/g, function (c) { + return "%" + c.charCodeAt(0).toString(16).toUpperCase(); + }); +} + +function encodeValue(operator, value, key) { + value = operator === "+" || operator === "#" ? encodeReserved(value) : encodeUnreserved(value); + + if (key) { + return encodeUnreserved(key) + "=" + value; + } else { + return value; + } +} + +function isDefined(value) { + return value !== undefined && value !== null; +} + +function isKeyOperator(operator) { + return operator === ";" || operator === "&" || operator === "?"; +} + +function getValues(context, operator, key, modifier) { + var value = context[key], + result = []; + + if (isDefined(value) && value !== "") { + if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") { + value = value.toString(); + + if (modifier && modifier !== "*") { + value = value.substring(0, parseInt(modifier, 10)); + } + + result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : "")); + } else { + if (modifier === "*") { + if (Array.isArray(value)) { + value.filter(isDefined).forEach(function (value) { + result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : "")); + }); + } else { + Object.keys(value).forEach(function (k) { + if (isDefined(value[k])) { + result.push(encodeValue(operator, value[k], k)); + } + }); + } + } else { + const tmp = []; + + if (Array.isArray(value)) { + value.filter(isDefined).forEach(function (value) { + tmp.push(encodeValue(operator, value)); + }); + } else { + Object.keys(value).forEach(function (k) { + if (isDefined(value[k])) { + tmp.push(encodeUnreserved(k)); + tmp.push(encodeValue(operator, value[k].toString())); + } + }); + } + + if (isKeyOperator(operator)) { + result.push(encodeUnreserved(key) + "=" + tmp.join(",")); + } else if (tmp.length !== 0) { + result.push(tmp.join(",")); + } + } + } + } else { + if (operator === ";") { + if (isDefined(value)) { + result.push(encodeUnreserved(key)); + } + } else if (value === "" && (operator === "&" || operator === "?")) { + result.push(encodeUnreserved(key) + "="); + } else if (value === "") { + result.push(""); + } + } + + return result; +} + +function parseUrl(template) { + return { + expand: expand.bind(null, template) + }; +} + +function expand(template, context) { + var operators = ["+", "#", ".", "/", ";", "?", "&"]; + return template.replace(/\{([^\{\}]+)\}|([^\{\}]+)/g, function (_, expression, literal) { + if (expression) { + let operator = ""; + const values = []; + + if (operators.indexOf(expression.charAt(0)) !== -1) { + operator = expression.charAt(0); + expression = expression.substr(1); + } + + expression.split(/,/g).forEach(function (variable) { + var tmp = /([^:\*]*)(?::(\d+)|(\*))?/.exec(variable); + values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3])); + }); + + if (operator && operator !== "+") { + var separator = ","; + + if (operator === "?") { + separator = "&"; + } else if (operator !== "#") { + separator = operator; + } + + return (values.length !== 0 ? operator : "") + values.join(separator); + } else { + return values.join(","); + } + } else { + return encodeReserved(literal); + } + }); +} + +function parse(options) { + // https://fetch.spec.whatwg.org/#methods + let method = options.method.toUpperCase(); // replace :varname with {varname} to make it RFC 6570 compatible + + let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{+$1}"); + let headers = Object.assign({}, options.headers); + let body; + let parameters = omit(options, ["method", "baseUrl", "url", "headers", "request", "mediaType"]); // extract variable names from URL to calculate remaining variables later + + const urlVariableNames = extractUrlVariableNames(url); + url = parseUrl(url).expand(parameters); + + if (!/^http/.test(url)) { + url = options.baseUrl + url; + } + + const omittedParameters = Object.keys(options).filter(option => urlVariableNames.includes(option)).concat("baseUrl"); + const remainingParameters = omit(parameters, omittedParameters); + const isBinaryRequset = /application\/octet-stream/i.test(headers.accept); + + if (!isBinaryRequset) { + if (options.mediaType.format) { + // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw + headers.accept = headers.accept.split(/,/).map(preview => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)).join(","); + } + + if (options.mediaType.previews.length) { + const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || []; + headers.accept = previewsFromAcceptHeader.concat(options.mediaType.previews).map(preview => { + const format = options.mediaType.format ? `.${options.mediaType.format}` : "+json"; + return `application/vnd.github.${preview}-preview${format}`; + }).join(","); + } + } // for GET/HEAD requests, set URL query parameters from remaining parameters + // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters + + + if (["GET", "HEAD"].includes(method)) { + url = addQueryParameters(url, remainingParameters); + } else { + if ("data" in remainingParameters) { + body = remainingParameters.data; + } else { + if (Object.keys(remainingParameters).length) { + body = remainingParameters; + } else { + headers["content-length"] = 0; + } + } + } // default content-type for JSON if body is set + + + if (!headers["content-type"] && typeof body !== "undefined") { + headers["content-type"] = "application/json; charset=utf-8"; + } // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body. + // fetch does not allow to set `content-length` header, but we can set body to an empty string + + + if (["PATCH", "PUT"].includes(method) && typeof body === "undefined") { + body = ""; + } // Only return body/request keys if present + + + return Object.assign({ + method, + url, + headers + }, typeof body !== "undefined" ? { + body + } : null, options.request ? { + request: options.request + } : null); +} + +function endpointWithDefaults(defaults, route, options) { + return parse(merge(defaults, route, options)); +} + +function withDefaults(oldDefaults, newDefaults) { + const DEFAULTS = merge(oldDefaults, newDefaults); + const endpoint = endpointWithDefaults.bind(null, DEFAULTS); + return Object.assign(endpoint, { + DEFAULTS, + defaults: withDefaults.bind(null, DEFAULTS), + merge: merge.bind(null, DEFAULTS), + parse + }); +} + +const VERSION = "6.0.2"; + +const userAgent = `octokit-endpoint.js/${VERSION} ${universalUserAgent.getUserAgent()}`; // DEFAULTS has all properties set that EndpointOptions has, except url. +// So we use RequestParameters and add method as additional required property. + +const DEFAULTS = { + method: "GET", + baseUrl: "https://api.github.com", + headers: { + accept: "application/vnd.github.v3+json", + "user-agent": userAgent + }, + mediaType: { + format: "", + previews: [] + } +}; + +const endpoint = withDefaults(null, DEFAULTS); + +exports.endpoint = endpoint; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/endpoint/dist-node/index.js.map b/node_modules/@octokit/endpoint/dist-node/index.js.map new file mode 100644 index 00000000..911601bf --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import isPlainObject from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach((key) => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter((preview) => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map((name) => {\n if (name === \"q\") {\n return (\"q=\" + parameters.q.split(\"+\").map(encodeURIComponent).join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter((option) => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part).replace(/%5B/g, \"[\").replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return \"%\" + c.charCodeAt(0).toString(16).toUpperCase();\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template),\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{+$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\",\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter((option) => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequset = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequset) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map((preview) => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map((preview) => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n else {\n headers[\"content-length\"] = 0;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse,\n });\n}\n","export const VERSION = \"6.0.2\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent,\n },\n mediaType: {\n format: \"\",\n previews: [],\n },\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":["lowercaseKeys","object","Object","keys","reduce","newObj","key","toLowerCase","mergeDeep","defaults","options","result","assign","forEach","isPlainObject","merge","route","method","url","split","headers","mergedOptions","mediaType","previews","length","filter","preview","includes","concat","map","replace","addQueryParameters","parameters","separator","test","names","name","q","encodeURIComponent","join","urlVariableRegex","removeNonChars","variableName","extractUrlVariableNames","matches","match","a","b","omit","keysToOmit","option","obj","encodeReserved","str","part","encodeURI","encodeUnreserved","c","charCodeAt","toString","toUpperCase","encodeValue","operator","value","isDefined","undefined","isKeyOperator","getValues","context","modifier","substring","parseInt","push","Array","isArray","k","tmp","parseUrl","template","expand","bind","operators","_","expression","literal","values","indexOf","charAt","substr","variable","exec","parse","body","urlVariableNames","baseUrl","omittedParameters","remainingParameters","isBinaryRequset","accept","format","previewsFromAcceptHeader","data","request","endpointWithDefaults","withDefaults","oldDefaults","newDefaults","DEFAULTS","endpoint","VERSION","userAgent","getUserAgent"],"mappings":";;;;;;;;;AAAO,SAASA,aAAT,CAAuBC,MAAvB,EAA+B;AAClC,MAAI,CAACA,MAAL,EAAa;AACT,WAAO,EAAP;AACH;;AACD,SAAOC,MAAM,CAACC,IAAP,CAAYF,MAAZ,EAAoBG,MAApB,CAA2B,CAACC,MAAD,EAASC,GAAT,KAAiB;AAC/CD,IAAAA,MAAM,CAACC,GAAG,CAACC,WAAJ,EAAD,CAAN,GAA4BN,MAAM,CAACK,GAAD,CAAlC;AACA,WAAOD,MAAP;AACH,GAHM,EAGJ,EAHI,CAAP;AAIH;;ACPM,SAASG,SAAT,CAAmBC,QAAnB,EAA6BC,OAA7B,EAAsC;AACzC,QAAMC,MAAM,GAAGT,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBH,QAAlB,CAAf;AACAP,EAAAA,MAAM,CAACC,IAAP,CAAYO,OAAZ,EAAqBG,OAArB,CAA8BP,GAAD,IAAS;AAClC,QAAIQ,aAAa,CAACJ,OAAO,CAACJ,GAAD,CAAR,CAAjB,EAAiC;AAC7B,UAAI,EAAEA,GAAG,IAAIG,QAAT,CAAJ,EACIP,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;AAAE,SAACL,GAAD,GAAOI,OAAO,CAACJ,GAAD;AAAhB,OAAtB,EADJ,KAGIK,MAAM,CAACL,GAAD,CAAN,GAAcE,SAAS,CAACC,QAAQ,CAACH,GAAD,CAAT,EAAgBI,OAAO,CAACJ,GAAD,CAAvB,CAAvB;AACP,KALD,MAMK;AACDJ,MAAAA,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;AAAE,SAACL,GAAD,GAAOI,OAAO,CAACJ,GAAD;AAAhB,OAAtB;AACH;AACJ,GAVD;AAWA,SAAOK,MAAP;AACH;;ACbM,SAASI,KAAT,CAAeN,QAAf,EAAyBO,KAAzB,EAAgCN,OAAhC,EAAyC;AAC5C,MAAI,OAAOM,KAAP,KAAiB,QAArB,EAA+B;AAC3B,QAAI,CAACC,MAAD,EAASC,GAAT,IAAgBF,KAAK,CAACG,KAAN,CAAY,GAAZ,CAApB;AACAT,IAAAA,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAcM,GAAG,GAAG;AAAED,MAAAA,MAAF;AAAUC,MAAAA;AAAV,KAAH,GAAqB;AAAEA,MAAAA,GAAG,EAAED;AAAP,KAAtC,EAAuDP,OAAvD,CAAV;AACH,GAHD,MAIK;AACDA,IAAAA,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBI,KAAlB,CAAV;AACH,GAP2C;;;AAS5CN,EAAAA,OAAO,CAACU,OAAR,GAAkBpB,aAAa,CAACU,OAAO,CAACU,OAAT,CAA/B;AACA,QAAMC,aAAa,GAAGb,SAAS,CAACC,QAAQ,IAAI,EAAb,EAAiBC,OAAjB,CAA/B,CAV4C;;AAY5C,MAAID,QAAQ,IAAIA,QAAQ,CAACa,SAAT,CAAmBC,QAAnB,CAA4BC,MAA5C,EAAoD;AAChDH,IAAAA,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCd,QAAQ,CAACa,SAAT,CAAmBC,QAAnB,CAC9BE,MAD8B,CACtBC,OAAD,IAAa,CAACL,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCI,QAAjC,CAA0CD,OAA1C,CADS,EAE9BE,MAF8B,CAEvBP,aAAa,CAACC,SAAd,CAAwBC,QAFD,CAAnC;AAGH;;AACDF,EAAAA,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCF,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCM,GAAjC,CAAsCH,OAAD,IAAaA,OAAO,CAACI,OAAR,CAAgB,UAAhB,EAA4B,EAA5B,CAAlD,CAAnC;AACA,SAAOT,aAAP;AACH;;ACrBM,SAASU,kBAAT,CAA4Bb,GAA5B,EAAiCc,UAAjC,EAA6C;AAChD,QAAMC,SAAS,GAAG,KAAKC,IAAL,CAAUhB,GAAV,IAAiB,GAAjB,GAAuB,GAAzC;AACA,QAAMiB,KAAK,GAAGjC,MAAM,CAACC,IAAP,CAAY6B,UAAZ,CAAd;;AACA,MAAIG,KAAK,CAACX,MAAN,KAAiB,CAArB,EAAwB;AACpB,WAAON,GAAP;AACH;;AACD,SAAQA,GAAG,GACPe,SADI,GAEJE,KAAK,CACAN,GADL,CACUO,IAAD,IAAU;AACf,QAAIA,IAAI,KAAK,GAAb,EAAkB;AACd,aAAQ,OAAOJ,UAAU,CAACK,CAAX,CAAalB,KAAb,CAAmB,GAAnB,EAAwBU,GAAxB,CAA4BS,kBAA5B,EAAgDC,IAAhD,CAAqD,GAArD,CAAf;AACH;;AACD,WAAQ,GAAEH,IAAK,IAAGE,kBAAkB,CAACN,UAAU,CAACI,IAAD,CAAX,CAAmB,EAAvD;AACH,GAND,EAOKG,IAPL,CAOU,GAPV,CAFJ;AAUH;;AChBD,MAAMC,gBAAgB,GAAG,YAAzB;;AACA,SAASC,cAAT,CAAwBC,YAAxB,EAAsC;AAClC,SAAOA,YAAY,CAACZ,OAAb,CAAqB,YAArB,EAAmC,EAAnC,EAAuCX,KAAvC,CAA6C,GAA7C,CAAP;AACH;;AACD,AAAO,SAASwB,uBAAT,CAAiCzB,GAAjC,EAAsC;AACzC,QAAM0B,OAAO,GAAG1B,GAAG,CAAC2B,KAAJ,CAAUL,gBAAV,CAAhB;;AACA,MAAI,CAACI,OAAL,EAAc;AACV,WAAO,EAAP;AACH;;AACD,SAAOA,OAAO,CAACf,GAAR,CAAYY,cAAZ,EAA4BrC,MAA5B,CAAmC,CAAC0C,CAAD,EAAIC,CAAJ,KAAUD,CAAC,CAAClB,MAAF,CAASmB,CAAT,CAA7C,EAA0D,EAA1D,CAAP;AACH;;ACVM,SAASC,IAAT,CAAc/C,MAAd,EAAsBgD,UAAtB,EAAkC;AACrC,SAAO/C,MAAM,CAACC,IAAP,CAAYF,MAAZ,EACFwB,MADE,CACMyB,MAAD,IAAY,CAACD,UAAU,CAACtB,QAAX,CAAoBuB,MAApB,CADlB,EAEF9C,MAFE,CAEK,CAAC+C,GAAD,EAAM7C,GAAN,KAAc;AACtB6C,IAAAA,GAAG,CAAC7C,GAAD,CAAH,GAAWL,MAAM,CAACK,GAAD,CAAjB;AACA,WAAO6C,GAAP;AACH,GALM,EAKJ,EALI,CAAP;AAMH;;ACPD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AACA;AACA,SAASC,cAAT,CAAwBC,GAAxB,EAA6B;AACzB,SAAOA,GAAG,CACLlC,KADE,CACI,oBADJ,EAEFU,GAFE,CAEE,UAAUyB,IAAV,EAAgB;AACrB,QAAI,CAAC,eAAepB,IAAf,CAAoBoB,IAApB,CAAL,EAAgC;AAC5BA,MAAAA,IAAI,GAAGC,SAAS,CAACD,IAAD,CAAT,CAAgBxB,OAAhB,CAAwB,MAAxB,EAAgC,GAAhC,EAAqCA,OAArC,CAA6C,MAA7C,EAAqD,GAArD,CAAP;AACH;;AACD,WAAOwB,IAAP;AACH,GAPM,EAQFf,IARE,CAQG,EARH,CAAP;AASH;;AACD,SAASiB,gBAAT,CAA0BH,GAA1B,EAA+B;AAC3B,SAAOf,kBAAkB,CAACe,GAAD,CAAlB,CAAwBvB,OAAxB,CAAgC,UAAhC,EAA4C,UAAU2B,CAAV,EAAa;AAC5D,WAAO,MAAMA,CAAC,CAACC,UAAF,CAAa,CAAb,EAAgBC,QAAhB,CAAyB,EAAzB,EAA6BC,WAA7B,EAAb;AACH,GAFM,CAAP;AAGH;;AACD,SAASC,WAAT,CAAqBC,QAArB,EAA+BC,KAA/B,EAAsCzD,GAAtC,EAA2C;AACvCyD,EAAAA,KAAK,GACDD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,GACMV,cAAc,CAACW,KAAD,CADpB,GAEMP,gBAAgB,CAACO,KAAD,CAH1B;;AAIA,MAAIzD,GAAJ,EAAS;AACL,WAAOkD,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAAxB,GAA8ByD,KAArC;AACH,GAFD,MAGK;AACD,WAAOA,KAAP;AACH;AACJ;;AACD,SAASC,SAAT,CAAmBD,KAAnB,EAA0B;AACtB,SAAOA,KAAK,KAAKE,SAAV,IAAuBF,KAAK,KAAK,IAAxC;AACH;;AACD,SAASG,aAAT,CAAuBJ,QAAvB,EAAiC;AAC7B,SAAOA,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,IAAwCA,QAAQ,KAAK,GAA5D;AACH;;AACD,SAASK,SAAT,CAAmBC,OAAnB,EAA4BN,QAA5B,EAAsCxD,GAAtC,EAA2C+D,QAA3C,EAAqD;AACjD,MAAIN,KAAK,GAAGK,OAAO,CAAC9D,GAAD,CAAnB;AAAA,MAA0BK,MAAM,GAAG,EAAnC;;AACA,MAAIqD,SAAS,CAACD,KAAD,CAAT,IAAoBA,KAAK,KAAK,EAAlC,EAAsC;AAClC,QAAI,OAAOA,KAAP,KAAiB,QAAjB,IACA,OAAOA,KAAP,KAAiB,QADjB,IAEA,OAAOA,KAAP,KAAiB,SAFrB,EAEgC;AAC5BA,MAAAA,KAAK,GAAGA,KAAK,CAACJ,QAAN,EAAR;;AACA,UAAIU,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;AAC9BN,QAAAA,KAAK,GAAGA,KAAK,CAACO,SAAN,CAAgB,CAAhB,EAAmBC,QAAQ,CAACF,QAAD,EAAW,EAAX,CAA3B,CAAR;AACH;;AACD1D,MAAAA,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBG,aAAa,CAACJ,QAAD,CAAb,GAA0BxD,GAA1B,GAAgC,EAAlD,CAAvB;AACH,KARD,MASK;AACD,UAAI+D,QAAQ,KAAK,GAAjB,EAAsB;AAClB,YAAII,KAAK,CAACC,OAAN,CAAcX,KAAd,CAAJ,EAA0B;AACtBA,UAAAA,KAAK,CAACtC,MAAN,CAAauC,SAAb,EAAwBnD,OAAxB,CAAgC,UAAUkD,KAAV,EAAiB;AAC7CpD,YAAAA,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBG,aAAa,CAACJ,QAAD,CAAb,GAA0BxD,GAA1B,GAAgC,EAAlD,CAAvB;AACH,WAFD;AAGH,SAJD,MAKK;AACDJ,UAAAA,MAAM,CAACC,IAAP,CAAY4D,KAAZ,EAAmBlD,OAAnB,CAA2B,UAAU8D,CAAV,EAAa;AACpC,gBAAIX,SAAS,CAACD,KAAK,CAACY,CAAD,CAAN,CAAb,EAAyB;AACrBhE,cAAAA,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACY,CAAD,CAAhB,EAAqBA,CAArB,CAAvB;AACH;AACJ,WAJD;AAKH;AACJ,OAbD,MAcK;AACD,cAAMC,GAAG,GAAG,EAAZ;;AACA,YAAIH,KAAK,CAACC,OAAN,CAAcX,KAAd,CAAJ,EAA0B;AACtBA,UAAAA,KAAK,CAACtC,MAAN,CAAauC,SAAb,EAAwBnD,OAAxB,CAAgC,UAAUkD,KAAV,EAAiB;AAC7Ca,YAAAA,GAAG,CAACJ,IAAJ,CAASX,WAAW,CAACC,QAAD,EAAWC,KAAX,CAApB;AACH,WAFD;AAGH,SAJD,MAKK;AACD7D,UAAAA,MAAM,CAACC,IAAP,CAAY4D,KAAZ,EAAmBlD,OAAnB,CAA2B,UAAU8D,CAAV,EAAa;AACpC,gBAAIX,SAAS,CAACD,KAAK,CAACY,CAAD,CAAN,CAAb,EAAyB;AACrBC,cAAAA,GAAG,CAACJ,IAAJ,CAAShB,gBAAgB,CAACmB,CAAD,CAAzB;AACAC,cAAAA,GAAG,CAACJ,IAAJ,CAASX,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACY,CAAD,CAAL,CAAShB,QAAT,EAAX,CAApB;AACH;AACJ,WALD;AAMH;;AACD,YAAIO,aAAa,CAACJ,QAAD,CAAjB,EAA6B;AACzBnD,UAAAA,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAAxB,GAA8BsE,GAAG,CAACrC,IAAJ,CAAS,GAAT,CAA1C;AACH,SAFD,MAGK,IAAIqC,GAAG,CAACpD,MAAJ,KAAe,CAAnB,EAAsB;AACvBb,UAAAA,MAAM,CAAC6D,IAAP,CAAYI,GAAG,CAACrC,IAAJ,CAAS,GAAT,CAAZ;AACH;AACJ;AACJ;AACJ,GAhDD,MAiDK;AACD,QAAIuB,QAAQ,KAAK,GAAjB,EAAsB;AAClB,UAAIE,SAAS,CAACD,KAAD,CAAb,EAAsB;AAClBpD,QAAAA,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAA5B;AACH;AACJ,KAJD,MAKK,IAAIyD,KAAK,KAAK,EAAV,KAAiBD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAlD,CAAJ,EAA4D;AAC7DnD,MAAAA,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAApC;AACH,KAFI,MAGA,IAAIyD,KAAK,KAAK,EAAd,EAAkB;AACnBpD,MAAAA,MAAM,CAAC6D,IAAP,CAAY,EAAZ;AACH;AACJ;;AACD,SAAO7D,MAAP;AACH;;AACD,AAAO,SAASkE,QAAT,CAAkBC,QAAlB,EAA4B;AAC/B,SAAO;AACHC,IAAAA,MAAM,EAAEA,MAAM,CAACC,IAAP,CAAY,IAAZ,EAAkBF,QAAlB;AADL,GAAP;AAGH;;AACD,SAASC,MAAT,CAAgBD,QAAhB,EAA0BV,OAA1B,EAAmC;AAC/B,MAAIa,SAAS,GAAG,CAAC,GAAD,EAAM,GAAN,EAAW,GAAX,EAAgB,GAAhB,EAAqB,GAArB,EAA0B,GAA1B,EAA+B,GAA/B,CAAhB;AACA,SAAOH,QAAQ,CAAChD,OAAT,CAAiB,4BAAjB,EAA+C,UAAUoD,CAAV,EAAaC,UAAb,EAAyBC,OAAzB,EAAkC;AACpF,QAAID,UAAJ,EAAgB;AACZ,UAAIrB,QAAQ,GAAG,EAAf;AACA,YAAMuB,MAAM,GAAG,EAAf;;AACA,UAAIJ,SAAS,CAACK,OAAV,CAAkBH,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAlB,MAA4C,CAAC,CAAjD,EAAoD;AAChDzB,QAAAA,QAAQ,GAAGqB,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAX;AACAJ,QAAAA,UAAU,GAAGA,UAAU,CAACK,MAAX,CAAkB,CAAlB,CAAb;AACH;;AACDL,MAAAA,UAAU,CAAChE,KAAX,CAAiB,IAAjB,EAAuBN,OAAvB,CAA+B,UAAU4E,QAAV,EAAoB;AAC/C,YAAIb,GAAG,GAAG,4BAA4Bc,IAA5B,CAAiCD,QAAjC,CAAV;AACAJ,QAAAA,MAAM,CAACb,IAAP,CAAYL,SAAS,CAACC,OAAD,EAAUN,QAAV,EAAoBc,GAAG,CAAC,CAAD,CAAvB,EAA4BA,GAAG,CAAC,CAAD,CAAH,IAAUA,GAAG,CAAC,CAAD,CAAzC,CAArB;AACH,OAHD;;AAIA,UAAId,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;AAC9B,YAAI7B,SAAS,GAAG,GAAhB;;AACA,YAAI6B,QAAQ,KAAK,GAAjB,EAAsB;AAClB7B,UAAAA,SAAS,GAAG,GAAZ;AACH,SAFD,MAGK,IAAI6B,QAAQ,KAAK,GAAjB,EAAsB;AACvB7B,UAAAA,SAAS,GAAG6B,QAAZ;AACH;;AACD,eAAO,CAACuB,MAAM,CAAC7D,MAAP,KAAkB,CAAlB,GAAsBsC,QAAtB,GAAiC,EAAlC,IAAwCuB,MAAM,CAAC9C,IAAP,CAAYN,SAAZ,CAA/C;AACH,OATD,MAUK;AACD,eAAOoD,MAAM,CAAC9C,IAAP,CAAY,GAAZ,CAAP;AACH;AACJ,KAxBD,MAyBK;AACD,aAAOa,cAAc,CAACgC,OAAD,CAArB;AACH;AACJ,GA7BM,CAAP;AA8BH;;AC/JM,SAASO,KAAT,CAAejF,OAAf,EAAwB;AAC3B;AACA,MAAIO,MAAM,GAAGP,OAAO,CAACO,MAAR,CAAe2C,WAAf,EAAb,CAF2B;;AAI3B,MAAI1C,GAAG,GAAG,CAACR,OAAO,CAACQ,GAAR,IAAe,GAAhB,EAAqBY,OAArB,CAA6B,cAA7B,EAA6C,OAA7C,CAAV;AACA,MAAIV,OAAO,GAAGlB,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBF,OAAO,CAACU,OAA1B,CAAd;AACA,MAAIwE,IAAJ;AACA,MAAI5D,UAAU,GAAGgB,IAAI,CAACtC,OAAD,EAAU,CAC3B,QAD2B,EAE3B,SAF2B,EAG3B,KAH2B,EAI3B,SAJ2B,EAK3B,SAL2B,EAM3B,WAN2B,CAAV,CAArB,CAP2B;;AAgB3B,QAAMmF,gBAAgB,GAAGlD,uBAAuB,CAACzB,GAAD,CAAhD;AACAA,EAAAA,GAAG,GAAG2D,QAAQ,CAAC3D,GAAD,CAAR,CAAc6D,MAAd,CAAqB/C,UAArB,CAAN;;AACA,MAAI,CAAC,QAAQE,IAAR,CAAahB,GAAb,CAAL,EAAwB;AACpBA,IAAAA,GAAG,GAAGR,OAAO,CAACoF,OAAR,GAAkB5E,GAAxB;AACH;;AACD,QAAM6E,iBAAiB,GAAG7F,MAAM,CAACC,IAAP,CAAYO,OAAZ,EACrBe,MADqB,CACbyB,MAAD,IAAY2C,gBAAgB,CAAClE,QAAjB,CAA0BuB,MAA1B,CADE,EAErBtB,MAFqB,CAEd,SAFc,CAA1B;AAGA,QAAMoE,mBAAmB,GAAGhD,IAAI,CAAChB,UAAD,EAAa+D,iBAAb,CAAhC;AACA,QAAME,eAAe,GAAG,6BAA6B/D,IAA7B,CAAkCd,OAAO,CAAC8E,MAA1C,CAAxB;;AACA,MAAI,CAACD,eAAL,EAAsB;AAClB,QAAIvF,OAAO,CAACY,SAAR,CAAkB6E,MAAtB,EAA8B;AAC1B;AACA/E,MAAAA,OAAO,CAAC8E,MAAR,GAAiB9E,OAAO,CAAC8E,MAAR,CACZ/E,KADY,CACN,GADM,EAEZU,GAFY,CAEPH,OAAD,IAAaA,OAAO,CAACI,OAAR,CAAgB,kDAAhB,EAAqE,uBAAsBpB,OAAO,CAACY,SAAR,CAAkB6E,MAAO,EAApH,CAFL,EAGZ5D,IAHY,CAGP,GAHO,CAAjB;AAIH;;AACD,QAAI7B,OAAO,CAACY,SAAR,CAAkBC,QAAlB,CAA2BC,MAA/B,EAAuC;AACnC,YAAM4E,wBAAwB,GAAGhF,OAAO,CAAC8E,MAAR,CAAerD,KAAf,CAAqB,qBAArB,KAA+C,EAAhF;AACAzB,MAAAA,OAAO,CAAC8E,MAAR,GAAiBE,wBAAwB,CACpCxE,MADY,CACLlB,OAAO,CAACY,SAAR,CAAkBC,QADb,EAEZM,GAFY,CAEPH,OAAD,IAAa;AAClB,cAAMyE,MAAM,GAAGzF,OAAO,CAACY,SAAR,CAAkB6E,MAAlB,GACR,IAAGzF,OAAO,CAACY,SAAR,CAAkB6E,MAAO,EADpB,GAET,OAFN;AAGA,eAAQ,0BAAyBzE,OAAQ,WAAUyE,MAAO,EAA1D;AACH,OAPgB,EAQZ5D,IARY,CAQP,GARO,CAAjB;AASH;AACJ,GA9C0B;AAgD3B;;;AACA,MAAI,CAAC,KAAD,EAAQ,MAAR,EAAgBZ,QAAhB,CAAyBV,MAAzB,CAAJ,EAAsC;AAClCC,IAAAA,GAAG,GAAGa,kBAAkB,CAACb,GAAD,EAAM8E,mBAAN,CAAxB;AACH,GAFD,MAGK;AACD,QAAI,UAAUA,mBAAd,EAAmC;AAC/BJ,MAAAA,IAAI,GAAGI,mBAAmB,CAACK,IAA3B;AACH,KAFD,MAGK;AACD,UAAInG,MAAM,CAACC,IAAP,CAAY6F,mBAAZ,EAAiCxE,MAArC,EAA6C;AACzCoE,QAAAA,IAAI,GAAGI,mBAAP;AACH,OAFD,MAGK;AACD5E,QAAAA,OAAO,CAAC,gBAAD,CAAP,GAA4B,CAA5B;AACH;AACJ;AACJ,GAhE0B;;;AAkE3B,MAAI,CAACA,OAAO,CAAC,cAAD,CAAR,IAA4B,OAAOwE,IAAP,KAAgB,WAAhD,EAA6D;AACzDxE,IAAAA,OAAO,CAAC,cAAD,CAAP,GAA0B,iCAA1B;AACH,GApE0B;AAsE3B;;;AACA,MAAI,CAAC,OAAD,EAAU,KAAV,EAAiBO,QAAjB,CAA0BV,MAA1B,KAAqC,OAAO2E,IAAP,KAAgB,WAAzD,EAAsE;AAClEA,IAAAA,IAAI,GAAG,EAAP;AACH,GAzE0B;;;AA2E3B,SAAO1F,MAAM,CAACU,MAAP,CAAc;AAAEK,IAAAA,MAAF;AAAUC,IAAAA,GAAV;AAAeE,IAAAA;AAAf,GAAd,EAAwC,OAAOwE,IAAP,KAAgB,WAAhB,GAA8B;AAAEA,IAAAA;AAAF,GAA9B,GAAyC,IAAjF,EAAuFlF,OAAO,CAAC4F,OAAR,GAAkB;AAAEA,IAAAA,OAAO,EAAE5F,OAAO,CAAC4F;AAAnB,GAAlB,GAAiD,IAAxI,CAAP;AACH;;AC9EM,SAASC,oBAAT,CAA8B9F,QAA9B,EAAwCO,KAAxC,EAA+CN,OAA/C,EAAwD;AAC3D,SAAOiF,KAAK,CAAC5E,KAAK,CAACN,QAAD,EAAWO,KAAX,EAAkBN,OAAlB,CAAN,CAAZ;AACH;;ACDM,SAAS8F,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;AACnD,QAAMC,QAAQ,GAAG5F,KAAK,CAAC0F,WAAD,EAAcC,WAAd,CAAtB;AACA,QAAME,QAAQ,GAAGL,oBAAoB,CAACvB,IAArB,CAA0B,IAA1B,EAAgC2B,QAAhC,CAAjB;AACA,SAAOzG,MAAM,CAACU,MAAP,CAAcgG,QAAd,EAAwB;AAC3BD,IAAAA,QAD2B;AAE3BlG,IAAAA,QAAQ,EAAE+F,YAAY,CAACxB,IAAb,CAAkB,IAAlB,EAAwB2B,QAAxB,CAFiB;AAG3B5F,IAAAA,KAAK,EAAEA,KAAK,CAACiE,IAAN,CAAW,IAAX,EAAiB2B,QAAjB,CAHoB;AAI3BhB,IAAAA;AAJ2B,GAAxB,CAAP;AAMH;;ACZM,MAAMkB,OAAO,GAAG,mBAAhB;;ACEP,MAAMC,SAAS,GAAI,uBAAsBD,OAAQ,IAAGE,+BAAY,EAAG,EAAnE;AAEA;;AACA,AAAO,MAAMJ,QAAQ,GAAG;AACpB1F,EAAAA,MAAM,EAAE,KADY;AAEpB6E,EAAAA,OAAO,EAAE,wBAFW;AAGpB1E,EAAAA,OAAO,EAAE;AACL8E,IAAAA,MAAM,EAAE,gCADH;AAEL,kBAAcY;AAFT,GAHW;AAOpBxF,EAAAA,SAAS,EAAE;AACP6E,IAAAA,MAAM,EAAE,EADD;AAEP5E,IAAAA,QAAQ,EAAE;AAFH;AAPS,CAAjB;;MCHMqF,QAAQ,GAAGJ,YAAY,CAAC,IAAD,EAAOG,QAAP,CAA7B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/dist-src/defaults.js b/node_modules/@octokit/endpoint/dist-src/defaults.js new file mode 100644 index 00000000..456e586a --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/defaults.js @@ -0,0 +1,17 @@ +import { getUserAgent } from "universal-user-agent"; +import { VERSION } from "./version"; +const userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`; +// DEFAULTS has all properties set that EndpointOptions has, except url. +// So we use RequestParameters and add method as additional required property. +export const DEFAULTS = { + method: "GET", + baseUrl: "https://api.github.com", + headers: { + accept: "application/vnd.github.v3+json", + "user-agent": userAgent, + }, + mediaType: { + format: "", + previews: [], + }, +}; diff --git a/node_modules/@octokit/endpoint/dist-src/endpoint-with-defaults.js b/node_modules/@octokit/endpoint/dist-src/endpoint-with-defaults.js new file mode 100644 index 00000000..5763758f --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/endpoint-with-defaults.js @@ -0,0 +1,5 @@ +import { merge } from "./merge"; +import { parse } from "./parse"; +export function endpointWithDefaults(defaults, route, options) { + return parse(merge(defaults, route, options)); +} diff --git a/node_modules/@octokit/endpoint/dist-src/index.js b/node_modules/@octokit/endpoint/dist-src/index.js new file mode 100644 index 00000000..599917f9 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/index.js @@ -0,0 +1,3 @@ +import { withDefaults } from "./with-defaults"; +import { DEFAULTS } from "./defaults"; +export const endpoint = withDefaults(null, DEFAULTS); diff --git a/node_modules/@octokit/endpoint/dist-src/merge.js b/node_modules/@octokit/endpoint/dist-src/merge.js new file mode 100644 index 00000000..d79ae65b --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/merge.js @@ -0,0 +1,22 @@ +import { lowercaseKeys } from "./util/lowercase-keys"; +import { mergeDeep } from "./util/merge-deep"; +export function merge(defaults, route, options) { + if (typeof route === "string") { + let [method, url] = route.split(" "); + options = Object.assign(url ? { method, url } : { url: method }, options); + } + else { + options = Object.assign({}, route); + } + // lowercase header names before merging with defaults to avoid duplicates + options.headers = lowercaseKeys(options.headers); + const mergedOptions = mergeDeep(defaults || {}, options); + // mediaType.previews arrays are merged, instead of overwritten + if (defaults && defaults.mediaType.previews.length) { + mergedOptions.mediaType.previews = defaults.mediaType.previews + .filter((preview) => !mergedOptions.mediaType.previews.includes(preview)) + .concat(mergedOptions.mediaType.previews); + } + mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, "")); + return mergedOptions; +} diff --git a/node_modules/@octokit/endpoint/dist-src/parse.js b/node_modules/@octokit/endpoint/dist-src/parse.js new file mode 100644 index 00000000..91197c83 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/parse.js @@ -0,0 +1,81 @@ +import { addQueryParameters } from "./util/add-query-parameters"; +import { extractUrlVariableNames } from "./util/extract-url-variable-names"; +import { omit } from "./util/omit"; +import { parseUrl } from "./util/url-template"; +export function parse(options) { + // https://fetch.spec.whatwg.org/#methods + let method = options.method.toUpperCase(); + // replace :varname with {varname} to make it RFC 6570 compatible + let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{+$1}"); + let headers = Object.assign({}, options.headers); + let body; + let parameters = omit(options, [ + "method", + "baseUrl", + "url", + "headers", + "request", + "mediaType", + ]); + // extract variable names from URL to calculate remaining variables later + const urlVariableNames = extractUrlVariableNames(url); + url = parseUrl(url).expand(parameters); + if (!/^http/.test(url)) { + url = options.baseUrl + url; + } + const omittedParameters = Object.keys(options) + .filter((option) => urlVariableNames.includes(option)) + .concat("baseUrl"); + const remainingParameters = omit(parameters, omittedParameters); + const isBinaryRequset = /application\/octet-stream/i.test(headers.accept); + if (!isBinaryRequset) { + if (options.mediaType.format) { + // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw + headers.accept = headers.accept + .split(/,/) + .map((preview) => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)) + .join(","); + } + if (options.mediaType.previews.length) { + const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || []; + headers.accept = previewsFromAcceptHeader + .concat(options.mediaType.previews) + .map((preview) => { + const format = options.mediaType.format + ? `.${options.mediaType.format}` + : "+json"; + return `application/vnd.github.${preview}-preview${format}`; + }) + .join(","); + } + } + // for GET/HEAD requests, set URL query parameters from remaining parameters + // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters + if (["GET", "HEAD"].includes(method)) { + url = addQueryParameters(url, remainingParameters); + } + else { + if ("data" in remainingParameters) { + body = remainingParameters.data; + } + else { + if (Object.keys(remainingParameters).length) { + body = remainingParameters; + } + else { + headers["content-length"] = 0; + } + } + } + // default content-type for JSON if body is set + if (!headers["content-type"] && typeof body !== "undefined") { + headers["content-type"] = "application/json; charset=utf-8"; + } + // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body. + // fetch does not allow to set `content-length` header, but we can set body to an empty string + if (["PATCH", "PUT"].includes(method) && typeof body === "undefined") { + body = ""; + } + // Only return body/request keys if present + return Object.assign({ method, url, headers }, typeof body !== "undefined" ? { body } : null, options.request ? { request: options.request } : null); +} diff --git a/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js b/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js new file mode 100644 index 00000000..d26be314 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js @@ -0,0 +1,17 @@ +export function addQueryParameters(url, parameters) { + const separator = /\?/.test(url) ? "&" : "?"; + const names = Object.keys(parameters); + if (names.length === 0) { + return url; + } + return (url + + separator + + names + .map((name) => { + if (name === "q") { + return ("q=" + parameters.q.split("+").map(encodeURIComponent).join("+")); + } + return `${name}=${encodeURIComponent(parameters[name])}`; + }) + .join("&")); +} diff --git a/node_modules/@octokit/endpoint/dist-src/util/extract-url-variable-names.js b/node_modules/@octokit/endpoint/dist-src/util/extract-url-variable-names.js new file mode 100644 index 00000000..3e75db28 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/util/extract-url-variable-names.js @@ -0,0 +1,11 @@ +const urlVariableRegex = /\{[^}]+\}/g; +function removeNonChars(variableName) { + return variableName.replace(/^\W+|\W+$/g, "").split(/,/); +} +export function extractUrlVariableNames(url) { + const matches = url.match(urlVariableRegex); + if (!matches) { + return []; + } + return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []); +} diff --git a/node_modules/@octokit/endpoint/dist-src/util/lowercase-keys.js b/node_modules/@octokit/endpoint/dist-src/util/lowercase-keys.js new file mode 100644 index 00000000..07806425 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/util/lowercase-keys.js @@ -0,0 +1,9 @@ +export function lowercaseKeys(object) { + if (!object) { + return {}; + } + return Object.keys(object).reduce((newObj, key) => { + newObj[key.toLowerCase()] = object[key]; + return newObj; + }, {}); +} diff --git a/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js b/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js new file mode 100644 index 00000000..eca9a72b --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js @@ -0,0 +1,16 @@ +import isPlainObject from "is-plain-object"; +export function mergeDeep(defaults, options) { + const result = Object.assign({}, defaults); + Object.keys(options).forEach((key) => { + if (isPlainObject(options[key])) { + if (!(key in defaults)) + Object.assign(result, { [key]: options[key] }); + else + result[key] = mergeDeep(defaults[key], options[key]); + } + else { + Object.assign(result, { [key]: options[key] }); + } + }); + return result; +} diff --git a/node_modules/@octokit/endpoint/dist-src/util/omit.js b/node_modules/@octokit/endpoint/dist-src/util/omit.js new file mode 100644 index 00000000..62450310 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/util/omit.js @@ -0,0 +1,8 @@ +export function omit(object, keysToOmit) { + return Object.keys(object) + .filter((option) => !keysToOmit.includes(option)) + .reduce((obj, key) => { + obj[key] = object[key]; + return obj; + }, {}); +} diff --git a/node_modules/@octokit/endpoint/dist-src/util/url-template.js b/node_modules/@octokit/endpoint/dist-src/util/url-template.js new file mode 100644 index 00000000..439b3fee --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/util/url-template.js @@ -0,0 +1,164 @@ +// Based on https://github.com/bramstein/url-template, licensed under BSD +// TODO: create separate package. +// +// Copyright (c) 2012-2014, Bram Stein +// All rights reserved. +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions +// are met: +// 1. Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// 2. Redistributions in binary form must reproduce the above copyright +// notice, this list of conditions and the following disclaimer in the +// documentation and/or other materials provided with the distribution. +// 3. The name of the author may not be used to endorse or promote products +// derived from this software without specific prior written permission. +// THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED +// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO +// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY +// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +/* istanbul ignore file */ +function encodeReserved(str) { + return str + .split(/(%[0-9A-Fa-f]{2})/g) + .map(function (part) { + if (!/%[0-9A-Fa-f]/.test(part)) { + part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]"); + } + return part; + }) + .join(""); +} +function encodeUnreserved(str) { + return encodeURIComponent(str).replace(/[!'()*]/g, function (c) { + return "%" + c.charCodeAt(0).toString(16).toUpperCase(); + }); +} +function encodeValue(operator, value, key) { + value = + operator === "+" || operator === "#" + ? encodeReserved(value) + : encodeUnreserved(value); + if (key) { + return encodeUnreserved(key) + "=" + value; + } + else { + return value; + } +} +function isDefined(value) { + return value !== undefined && value !== null; +} +function isKeyOperator(operator) { + return operator === ";" || operator === "&" || operator === "?"; +} +function getValues(context, operator, key, modifier) { + var value = context[key], result = []; + if (isDefined(value) && value !== "") { + if (typeof value === "string" || + typeof value === "number" || + typeof value === "boolean") { + value = value.toString(); + if (modifier && modifier !== "*") { + value = value.substring(0, parseInt(modifier, 10)); + } + result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : "")); + } + else { + if (modifier === "*") { + if (Array.isArray(value)) { + value.filter(isDefined).forEach(function (value) { + result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : "")); + }); + } + else { + Object.keys(value).forEach(function (k) { + if (isDefined(value[k])) { + result.push(encodeValue(operator, value[k], k)); + } + }); + } + } + else { + const tmp = []; + if (Array.isArray(value)) { + value.filter(isDefined).forEach(function (value) { + tmp.push(encodeValue(operator, value)); + }); + } + else { + Object.keys(value).forEach(function (k) { + if (isDefined(value[k])) { + tmp.push(encodeUnreserved(k)); + tmp.push(encodeValue(operator, value[k].toString())); + } + }); + } + if (isKeyOperator(operator)) { + result.push(encodeUnreserved(key) + "=" + tmp.join(",")); + } + else if (tmp.length !== 0) { + result.push(tmp.join(",")); + } + } + } + } + else { + if (operator === ";") { + if (isDefined(value)) { + result.push(encodeUnreserved(key)); + } + } + else if (value === "" && (operator === "&" || operator === "?")) { + result.push(encodeUnreserved(key) + "="); + } + else if (value === "") { + result.push(""); + } + } + return result; +} +export function parseUrl(template) { + return { + expand: expand.bind(null, template), + }; +} +function expand(template, context) { + var operators = ["+", "#", ".", "/", ";", "?", "&"]; + return template.replace(/\{([^\{\}]+)\}|([^\{\}]+)/g, function (_, expression, literal) { + if (expression) { + let operator = ""; + const values = []; + if (operators.indexOf(expression.charAt(0)) !== -1) { + operator = expression.charAt(0); + expression = expression.substr(1); + } + expression.split(/,/g).forEach(function (variable) { + var tmp = /([^:\*]*)(?::(\d+)|(\*))?/.exec(variable); + values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3])); + }); + if (operator && operator !== "+") { + var separator = ","; + if (operator === "?") { + separator = "&"; + } + else if (operator !== "#") { + separator = operator; + } + return (values.length !== 0 ? operator : "") + values.join(separator); + } + else { + return values.join(","); + } + } + else { + return encodeReserved(literal); + } + }); +} diff --git a/node_modules/@octokit/endpoint/dist-src/version.js b/node_modules/@octokit/endpoint/dist-src/version.js new file mode 100644 index 00000000..8a0d49cd --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "6.0.2"; diff --git a/node_modules/@octokit/endpoint/dist-src/with-defaults.js b/node_modules/@octokit/endpoint/dist-src/with-defaults.js new file mode 100644 index 00000000..81baf6cf --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-src/with-defaults.js @@ -0,0 +1,13 @@ +import { endpointWithDefaults } from "./endpoint-with-defaults"; +import { merge } from "./merge"; +import { parse } from "./parse"; +export function withDefaults(oldDefaults, newDefaults) { + const DEFAULTS = merge(oldDefaults, newDefaults); + const endpoint = endpointWithDefaults.bind(null, DEFAULTS); + return Object.assign(endpoint, { + DEFAULTS, + defaults: withDefaults.bind(null, DEFAULTS), + merge: merge.bind(null, DEFAULTS), + parse, + }); +} diff --git a/node_modules/@octokit/endpoint/dist-types/defaults.d.ts b/node_modules/@octokit/endpoint/dist-types/defaults.d.ts new file mode 100644 index 00000000..30fcd203 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/defaults.d.ts @@ -0,0 +1,2 @@ +import { EndpointDefaults } from "@octokit/types"; +export declare const DEFAULTS: EndpointDefaults; diff --git a/node_modules/@octokit/endpoint/dist-types/endpoint-with-defaults.d.ts b/node_modules/@octokit/endpoint/dist-types/endpoint-with-defaults.d.ts new file mode 100644 index 00000000..ff39e5e7 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/endpoint-with-defaults.d.ts @@ -0,0 +1,3 @@ +import { EndpointOptions, RequestParameters, Route } from "@octokit/types"; +import { DEFAULTS } from "./defaults"; +export declare function endpointWithDefaults(defaults: typeof DEFAULTS, route: Route | EndpointOptions, options?: RequestParameters): import("@octokit/types").RequestOptions; diff --git a/node_modules/@octokit/endpoint/dist-types/index.d.ts b/node_modules/@octokit/endpoint/dist-types/index.d.ts new file mode 100644 index 00000000..1ede1366 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/index.d.ts @@ -0,0 +1 @@ +export declare const endpoint: import("@octokit/types").EndpointInterface; diff --git a/node_modules/@octokit/endpoint/dist-types/merge.d.ts b/node_modules/@octokit/endpoint/dist-types/merge.d.ts new file mode 100644 index 00000000..b75a15ec --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/merge.d.ts @@ -0,0 +1,2 @@ +import { EndpointDefaults, RequestParameters, Route } from "@octokit/types"; +export declare function merge(defaults: EndpointDefaults | null, route?: Route | RequestParameters, options?: RequestParameters): EndpointDefaults; diff --git a/node_modules/@octokit/endpoint/dist-types/parse.d.ts b/node_modules/@octokit/endpoint/dist-types/parse.d.ts new file mode 100644 index 00000000..fbe21440 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/parse.d.ts @@ -0,0 +1,2 @@ +import { EndpointDefaults, RequestOptions } from "@octokit/types"; +export declare function parse(options: EndpointDefaults): RequestOptions; diff --git a/node_modules/@octokit/endpoint/dist-types/util/add-query-parameters.d.ts b/node_modules/@octokit/endpoint/dist-types/util/add-query-parameters.d.ts new file mode 100644 index 00000000..4b192ac4 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/util/add-query-parameters.d.ts @@ -0,0 +1,4 @@ +export declare function addQueryParameters(url: string, parameters: { + [x: string]: string | undefined; + q?: string; +}): string; diff --git a/node_modules/@octokit/endpoint/dist-types/util/extract-url-variable-names.d.ts b/node_modules/@octokit/endpoint/dist-types/util/extract-url-variable-names.d.ts new file mode 100644 index 00000000..93586d4d --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/util/extract-url-variable-names.d.ts @@ -0,0 +1 @@ +export declare function extractUrlVariableNames(url: string): string[]; diff --git a/node_modules/@octokit/endpoint/dist-types/util/lowercase-keys.d.ts b/node_modules/@octokit/endpoint/dist-types/util/lowercase-keys.d.ts new file mode 100644 index 00000000..1daf3073 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/util/lowercase-keys.d.ts @@ -0,0 +1,5 @@ +export declare function lowercaseKeys(object?: { + [key: string]: any; +}): { + [key: string]: any; +}; diff --git a/node_modules/@octokit/endpoint/dist-types/util/merge-deep.d.ts b/node_modules/@octokit/endpoint/dist-types/util/merge-deep.d.ts new file mode 100644 index 00000000..914411cf --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/util/merge-deep.d.ts @@ -0,0 +1 @@ +export declare function mergeDeep(defaults: any, options: any): object; diff --git a/node_modules/@octokit/endpoint/dist-types/util/omit.d.ts b/node_modules/@octokit/endpoint/dist-types/util/omit.d.ts new file mode 100644 index 00000000..06927d6b --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/util/omit.d.ts @@ -0,0 +1,5 @@ +export declare function omit(object: { + [key: string]: any; +}, keysToOmit: string[]): { + [key: string]: any; +}; diff --git a/node_modules/@octokit/endpoint/dist-types/util/url-template.d.ts b/node_modules/@octokit/endpoint/dist-types/util/url-template.d.ts new file mode 100644 index 00000000..5d967cab --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/util/url-template.d.ts @@ -0,0 +1,3 @@ +export declare function parseUrl(template: string): { + expand: (context: object) => string; +}; diff --git a/node_modules/@octokit/endpoint/dist-types/version.d.ts b/node_modules/@octokit/endpoint/dist-types/version.d.ts new file mode 100644 index 00000000..8aaf0c65 --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "6.0.2"; diff --git a/node_modules/@octokit/endpoint/dist-types/with-defaults.d.ts b/node_modules/@octokit/endpoint/dist-types/with-defaults.d.ts new file mode 100644 index 00000000..6f5afd1e --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-types/with-defaults.d.ts @@ -0,0 +1,2 @@ +import { EndpointInterface, RequestParameters, EndpointDefaults } from "@octokit/types"; +export declare function withDefaults(oldDefaults: EndpointDefaults | null, newDefaults: RequestParameters): EndpointInterface; diff --git a/node_modules/@octokit/endpoint/dist-web/index.js b/node_modules/@octokit/endpoint/dist-web/index.js new file mode 100644 index 00000000..87b4369e --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-web/index.js @@ -0,0 +1,369 @@ +import isPlainObject from 'is-plain-object'; +import { getUserAgent } from 'universal-user-agent'; + +function lowercaseKeys(object) { + if (!object) { + return {}; + } + return Object.keys(object).reduce((newObj, key) => { + newObj[key.toLowerCase()] = object[key]; + return newObj; + }, {}); +} + +function mergeDeep(defaults, options) { + const result = Object.assign({}, defaults); + Object.keys(options).forEach((key) => { + if (isPlainObject(options[key])) { + if (!(key in defaults)) + Object.assign(result, { [key]: options[key] }); + else + result[key] = mergeDeep(defaults[key], options[key]); + } + else { + Object.assign(result, { [key]: options[key] }); + } + }); + return result; +} + +function merge(defaults, route, options) { + if (typeof route === "string") { + let [method, url] = route.split(" "); + options = Object.assign(url ? { method, url } : { url: method }, options); + } + else { + options = Object.assign({}, route); + } + // lowercase header names before merging with defaults to avoid duplicates + options.headers = lowercaseKeys(options.headers); + const mergedOptions = mergeDeep(defaults || {}, options); + // mediaType.previews arrays are merged, instead of overwritten + if (defaults && defaults.mediaType.previews.length) { + mergedOptions.mediaType.previews = defaults.mediaType.previews + .filter((preview) => !mergedOptions.mediaType.previews.includes(preview)) + .concat(mergedOptions.mediaType.previews); + } + mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, "")); + return mergedOptions; +} + +function addQueryParameters(url, parameters) { + const separator = /\?/.test(url) ? "&" : "?"; + const names = Object.keys(parameters); + if (names.length === 0) { + return url; + } + return (url + + separator + + names + .map((name) => { + if (name === "q") { + return ("q=" + parameters.q.split("+").map(encodeURIComponent).join("+")); + } + return `${name}=${encodeURIComponent(parameters[name])}`; + }) + .join("&")); +} + +const urlVariableRegex = /\{[^}]+\}/g; +function removeNonChars(variableName) { + return variableName.replace(/^\W+|\W+$/g, "").split(/,/); +} +function extractUrlVariableNames(url) { + const matches = url.match(urlVariableRegex); + if (!matches) { + return []; + } + return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []); +} + +function omit(object, keysToOmit) { + return Object.keys(object) + .filter((option) => !keysToOmit.includes(option)) + .reduce((obj, key) => { + obj[key] = object[key]; + return obj; + }, {}); +} + +// Based on https://github.com/bramstein/url-template, licensed under BSD +// TODO: create separate package. +// +// Copyright (c) 2012-2014, Bram Stein +// All rights reserved. +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions +// are met: +// 1. Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// 2. Redistributions in binary form must reproduce the above copyright +// notice, this list of conditions and the following disclaimer in the +// documentation and/or other materials provided with the distribution. +// 3. The name of the author may not be used to endorse or promote products +// derived from this software without specific prior written permission. +// THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED +// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO +// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY +// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +/* istanbul ignore file */ +function encodeReserved(str) { + return str + .split(/(%[0-9A-Fa-f]{2})/g) + .map(function (part) { + if (!/%[0-9A-Fa-f]/.test(part)) { + part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]"); + } + return part; + }) + .join(""); +} +function encodeUnreserved(str) { + return encodeURIComponent(str).replace(/[!'()*]/g, function (c) { + return "%" + c.charCodeAt(0).toString(16).toUpperCase(); + }); +} +function encodeValue(operator, value, key) { + value = + operator === "+" || operator === "#" + ? encodeReserved(value) + : encodeUnreserved(value); + if (key) { + return encodeUnreserved(key) + "=" + value; + } + else { + return value; + } +} +function isDefined(value) { + return value !== undefined && value !== null; +} +function isKeyOperator(operator) { + return operator === ";" || operator === "&" || operator === "?"; +} +function getValues(context, operator, key, modifier) { + var value = context[key], result = []; + if (isDefined(value) && value !== "") { + if (typeof value === "string" || + typeof value === "number" || + typeof value === "boolean") { + value = value.toString(); + if (modifier && modifier !== "*") { + value = value.substring(0, parseInt(modifier, 10)); + } + result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : "")); + } + else { + if (modifier === "*") { + if (Array.isArray(value)) { + value.filter(isDefined).forEach(function (value) { + result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : "")); + }); + } + else { + Object.keys(value).forEach(function (k) { + if (isDefined(value[k])) { + result.push(encodeValue(operator, value[k], k)); + } + }); + } + } + else { + const tmp = []; + if (Array.isArray(value)) { + value.filter(isDefined).forEach(function (value) { + tmp.push(encodeValue(operator, value)); + }); + } + else { + Object.keys(value).forEach(function (k) { + if (isDefined(value[k])) { + tmp.push(encodeUnreserved(k)); + tmp.push(encodeValue(operator, value[k].toString())); + } + }); + } + if (isKeyOperator(operator)) { + result.push(encodeUnreserved(key) + "=" + tmp.join(",")); + } + else if (tmp.length !== 0) { + result.push(tmp.join(",")); + } + } + } + } + else { + if (operator === ";") { + if (isDefined(value)) { + result.push(encodeUnreserved(key)); + } + } + else if (value === "" && (operator === "&" || operator === "?")) { + result.push(encodeUnreserved(key) + "="); + } + else if (value === "") { + result.push(""); + } + } + return result; +} +function parseUrl(template) { + return { + expand: expand.bind(null, template), + }; +} +function expand(template, context) { + var operators = ["+", "#", ".", "/", ";", "?", "&"]; + return template.replace(/\{([^\{\}]+)\}|([^\{\}]+)/g, function (_, expression, literal) { + if (expression) { + let operator = ""; + const values = []; + if (operators.indexOf(expression.charAt(0)) !== -1) { + operator = expression.charAt(0); + expression = expression.substr(1); + } + expression.split(/,/g).forEach(function (variable) { + var tmp = /([^:\*]*)(?::(\d+)|(\*))?/.exec(variable); + values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3])); + }); + if (operator && operator !== "+") { + var separator = ","; + if (operator === "?") { + separator = "&"; + } + else if (operator !== "#") { + separator = operator; + } + return (values.length !== 0 ? operator : "") + values.join(separator); + } + else { + return values.join(","); + } + } + else { + return encodeReserved(literal); + } + }); +} + +function parse(options) { + // https://fetch.spec.whatwg.org/#methods + let method = options.method.toUpperCase(); + // replace :varname with {varname} to make it RFC 6570 compatible + let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{+$1}"); + let headers = Object.assign({}, options.headers); + let body; + let parameters = omit(options, [ + "method", + "baseUrl", + "url", + "headers", + "request", + "mediaType", + ]); + // extract variable names from URL to calculate remaining variables later + const urlVariableNames = extractUrlVariableNames(url); + url = parseUrl(url).expand(parameters); + if (!/^http/.test(url)) { + url = options.baseUrl + url; + } + const omittedParameters = Object.keys(options) + .filter((option) => urlVariableNames.includes(option)) + .concat("baseUrl"); + const remainingParameters = omit(parameters, omittedParameters); + const isBinaryRequset = /application\/octet-stream/i.test(headers.accept); + if (!isBinaryRequset) { + if (options.mediaType.format) { + // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw + headers.accept = headers.accept + .split(/,/) + .map((preview) => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)) + .join(","); + } + if (options.mediaType.previews.length) { + const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || []; + headers.accept = previewsFromAcceptHeader + .concat(options.mediaType.previews) + .map((preview) => { + const format = options.mediaType.format + ? `.${options.mediaType.format}` + : "+json"; + return `application/vnd.github.${preview}-preview${format}`; + }) + .join(","); + } + } + // for GET/HEAD requests, set URL query parameters from remaining parameters + // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters + if (["GET", "HEAD"].includes(method)) { + url = addQueryParameters(url, remainingParameters); + } + else { + if ("data" in remainingParameters) { + body = remainingParameters.data; + } + else { + if (Object.keys(remainingParameters).length) { + body = remainingParameters; + } + else { + headers["content-length"] = 0; + } + } + } + // default content-type for JSON if body is set + if (!headers["content-type"] && typeof body !== "undefined") { + headers["content-type"] = "application/json; charset=utf-8"; + } + // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body. + // fetch does not allow to set `content-length` header, but we can set body to an empty string + if (["PATCH", "PUT"].includes(method) && typeof body === "undefined") { + body = ""; + } + // Only return body/request keys if present + return Object.assign({ method, url, headers }, typeof body !== "undefined" ? { body } : null, options.request ? { request: options.request } : null); +} + +function endpointWithDefaults(defaults, route, options) { + return parse(merge(defaults, route, options)); +} + +function withDefaults(oldDefaults, newDefaults) { + const DEFAULTS = merge(oldDefaults, newDefaults); + const endpoint = endpointWithDefaults.bind(null, DEFAULTS); + return Object.assign(endpoint, { + DEFAULTS, + defaults: withDefaults.bind(null, DEFAULTS), + merge: merge.bind(null, DEFAULTS), + parse, + }); +} + +const VERSION = "6.0.2"; + +const userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`; +// DEFAULTS has all properties set that EndpointOptions has, except url. +// So we use RequestParameters and add method as additional required property. +const DEFAULTS = { + method: "GET", + baseUrl: "https://api.github.com", + headers: { + accept: "application/vnd.github.v3+json", + "user-agent": userAgent, + }, + mediaType: { + format: "", + previews: [], + }, +}; + +const endpoint = withDefaults(null, DEFAULTS); + +export { endpoint }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/endpoint/dist-web/index.js.map b/node_modules/@octokit/endpoint/dist-web/index.js.map new file mode 100644 index 00000000..8f1749ba --- /dev/null +++ b/node_modules/@octokit/endpoint/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import isPlainObject from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach((key) => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter((preview) => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map((name) => {\n if (name === \"q\") {\n return (\"q=\" + parameters.q.split(\"+\").map(encodeURIComponent).join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter((option) => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part).replace(/%5B/g, \"[\").replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return \"%\" + c.charCodeAt(0).toString(16).toUpperCase();\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template),\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{+$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\",\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter((option) => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequset = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequset) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map((preview) => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map((preview) => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n else {\n headers[\"content-length\"] = 0;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse,\n });\n}\n","export const VERSION = \"6.0.2\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent,\n },\n mediaType: {\n format: \"\",\n previews: [],\n },\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":[],"mappings":";;;AAAO,SAAS,aAAa,CAAC,MAAM,EAAE;AACtC,IAAI,IAAI,CAAC,MAAM,EAAE;AACjB,QAAQ,OAAO,EAAE,CAAC;AAClB,KAAK;AACL,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK;AACvD,QAAQ,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAChD,QAAQ,OAAO,MAAM,CAAC;AACtB,KAAK,EAAE,EAAE,CAAC,CAAC;AACX;;ACPO,SAAS,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE;AAC7C,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;AAC/C,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,KAAK;AAC1C,QAAQ,IAAI,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE;AACzC,YAAY,IAAI,EAAE,GAAG,IAAI,QAAQ,CAAC;AAClC,gBAAgB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAC/D;AACA,gBAAgB,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,SAAS;AACT,aAAa;AACb,YAAY,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAC3D,SAAS;AACT,KAAK,CAAC,CAAC;AACP,IAAI,OAAO,MAAM,CAAC;AAClB,CAAC;;ACbM,SAAS,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;AAChD,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AACnC,QAAQ,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC7C,QAAQ,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;AAClF,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AAC3C,KAAK;AACL;AACA,IAAI,OAAO,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACrD,IAAI,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;AAC7D;AACA,IAAI,IAAI,QAAQ,IAAI,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;AACxD,QAAQ,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ;AACtE,aAAa,MAAM,CAAC,CAAC,OAAO,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACrF,aAAa,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AACtD,KAAK;AACL,IAAI,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC;AAC1H,IAAI,OAAO,aAAa,CAAC;AACzB,CAAC;;ACrBM,SAAS,kBAAkB,CAAC,GAAG,EAAE,UAAU,EAAE;AACpD,IAAI,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC;AACjD,IAAI,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AAC1C,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;AAC5B,QAAQ,OAAO,GAAG,CAAC;AACnB,KAAK;AACL,IAAI,QAAQ,GAAG;AACf,QAAQ,SAAS;AACjB,QAAQ,KAAK;AACb,aAAa,GAAG,CAAC,CAAC,IAAI,KAAK;AAC3B,YAAY,IAAI,IAAI,KAAK,GAAG,EAAE;AAC9B,gBAAgB,QAAQ,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;AAC1F,aAAa;AACb,YAAY,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACrE,SAAS,CAAC;AACV,aAAa,IAAI,CAAC,GAAG,CAAC,EAAE;AACxB,CAAC;;AChBD,MAAM,gBAAgB,GAAG,YAAY,CAAC;AACtC,SAAS,cAAc,CAAC,YAAY,EAAE;AACtC,IAAI,OAAO,YAAY,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC7D,CAAC;AACD,AAAO,SAAS,uBAAuB,CAAC,GAAG,EAAE;AAC7C,IAAI,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAChD,IAAI,IAAI,CAAC,OAAO,EAAE;AAClB,QAAQ,OAAO,EAAE,CAAC;AAClB,KAAK;AACL,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACzE,CAAC;;ACVM,SAAS,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE;AACzC,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;AAC9B,SAAS,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACzD,SAAS,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK;AAC9B,QAAQ,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AAC/B,QAAQ,OAAO,GAAG,CAAC;AACnB,KAAK,EAAE,EAAE,CAAC,CAAC;AACX,CAAC;;ACPD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,cAAc,CAAC,GAAG,EAAE;AAC7B,IAAI,OAAO,GAAG;AACd,SAAS,KAAK,CAAC,oBAAoB,CAAC;AACpC,SAAS,GAAG,CAAC,UAAU,IAAI,EAAE;AAC7B,QAAQ,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;AACxC,YAAY,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC7E,SAAS;AACT,QAAQ,OAAO,IAAI,CAAC;AACpB,KAAK,CAAC;AACN,SAAS,IAAI,CAAC,EAAE,CAAC,CAAC;AAClB,CAAC;AACD,SAAS,gBAAgB,CAAC,GAAG,EAAE;AAC/B,IAAI,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE;AACpE,QAAQ,OAAO,GAAG,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAChE,KAAK,CAAC,CAAC;AACP,CAAC;AACD,SAAS,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE;AAC3C,IAAI,KAAK;AACT,QAAQ,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG;AAC5C,cAAc,cAAc,CAAC,KAAK,CAAC;AACnC,cAAc,gBAAgB,CAAC,KAAK,CAAC,CAAC;AACtC,IAAI,IAAI,GAAG,EAAE;AACb,QAAQ,OAAO,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC;AACnD,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,KAAK,CAAC;AACrB,KAAK;AACL,CAAC;AACD,SAAS,SAAS,CAAC,KAAK,EAAE;AAC1B,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;AACjD,CAAC;AACD,SAAS,aAAa,CAAC,QAAQ,EAAE;AACjC,IAAI,OAAO,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC;AACpE,CAAC;AACD,SAAS,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE;AACrD,IAAI,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;AAC1C,IAAI,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE,EAAE;AAC1C,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ;AACrC,YAAY,OAAO,KAAK,KAAK,QAAQ;AACrC,YAAY,OAAO,KAAK,KAAK,SAAS,EAAE;AACxC,YAAY,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;AACrC,YAAY,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC9C,gBAAgB,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;AACnE,aAAa;AACb,YAAY,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;AAC1F,SAAS;AACT,aAAa;AACb,YAAY,IAAI,QAAQ,KAAK,GAAG,EAAE;AAClC,gBAAgB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AAC1C,oBAAoB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;AACrE,wBAAwB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;AACtG,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,qBAAqB;AACrB,oBAAoB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;AAC5D,wBAAwB,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;AACjD,4BAA4B,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC5E,yBAAyB;AACzB,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,aAAa;AACb,iBAAiB;AACjB,gBAAgB,MAAM,GAAG,GAAG,EAAE,CAAC;AAC/B,gBAAgB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AAC1C,oBAAoB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;AACrE,wBAAwB,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;AAC/D,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,qBAAqB;AACrB,oBAAoB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;AAC5D,wBAAwB,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;AACjD,4BAA4B,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1D,4BAA4B,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;AACjF,yBAAyB;AACzB,qBAAqB,CAAC,CAAC;AACvB,iBAAiB;AACjB,gBAAgB,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE;AAC7C,oBAAoB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC7E,iBAAiB;AACjB,qBAAqB,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;AAC3C,oBAAoB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/C,iBAAiB;AACjB,aAAa;AACb,SAAS;AACT,KAAK;AACL,SAAS;AACT,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC9B,YAAY,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;AAClC,gBAAgB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;AACnD,aAAa;AACb,SAAS;AACT,aAAa,IAAI,KAAK,KAAK,EAAE,KAAK,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC,EAAE;AACzE,YAAY,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AACrD,SAAS;AACT,aAAa,IAAI,KAAK,KAAK,EAAE,EAAE;AAC/B,YAAY,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC5B,SAAS;AACT,KAAK;AACL,IAAI,OAAO,MAAM,CAAC;AAClB,CAAC;AACD,AAAO,SAAS,QAAQ,CAAC,QAAQ,EAAE;AACnC,IAAI,OAAO;AACX,QAAQ,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AAC3C,KAAK,CAAC;AACN,CAAC;AACD,SAAS,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE;AACnC,IAAI,IAAI,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACxD,IAAI,OAAO,QAAQ,CAAC,OAAO,CAAC,4BAA4B,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE;AAC5F,QAAQ,IAAI,UAAU,EAAE;AACxB,YAAY,IAAI,QAAQ,GAAG,EAAE,CAAC;AAC9B,YAAY,MAAM,MAAM,GAAG,EAAE,CAAC;AAC9B,YAAY,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE;AAChE,gBAAgB,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAChD,gBAAgB,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAClD,aAAa;AACb,YAAY,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,QAAQ,EAAE;AAC/D,gBAAgB,IAAI,GAAG,GAAG,2BAA2B,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACrE,gBAAgB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpF,aAAa,CAAC,CAAC;AACf,YAAY,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC9C,gBAAgB,IAAI,SAAS,GAAG,GAAG,CAAC;AACpC,gBAAgB,IAAI,QAAQ,KAAK,GAAG,EAAE;AACtC,oBAAoB,SAAS,GAAG,GAAG,CAAC;AACpC,iBAAiB;AACjB,qBAAqB,IAAI,QAAQ,KAAK,GAAG,EAAE;AAC3C,oBAAoB,SAAS,GAAG,QAAQ,CAAC;AACzC,iBAAiB;AACjB,gBAAgB,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,QAAQ,GAAG,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACtF,aAAa;AACb,iBAAiB;AACjB,gBAAgB,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACxC,aAAa;AACb,SAAS;AACT,aAAa;AACb,YAAY,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC;AAC3C,SAAS;AACT,KAAK,CAAC,CAAC;AACP,CAAC;;AC/JM,SAAS,KAAK,CAAC,OAAO,EAAE;AAC/B;AACA,IAAI,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;AAC9C;AACA,IAAI,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,EAAE,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;AACpE,IAAI,IAAI,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AACrD,IAAI,IAAI,IAAI,CAAC;AACb,IAAI,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE;AACnC,QAAQ,QAAQ;AAChB,QAAQ,SAAS;AACjB,QAAQ,KAAK;AACb,QAAQ,SAAS;AACjB,QAAQ,SAAS;AACjB,QAAQ,WAAW;AACnB,KAAK,CAAC,CAAC;AACP;AACA,IAAI,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC;AAC1D,IAAI,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AAC3C,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;AAC5B,QAAQ,GAAG,GAAG,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;AACpC,KAAK;AACL,IAAI,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AAClD,SAAS,MAAM,CAAC,CAAC,MAAM,KAAK,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC9D,SAAS,MAAM,CAAC,SAAS,CAAC,CAAC;AAC3B,IAAI,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AACpE,IAAI,MAAM,eAAe,GAAG,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAC9E,IAAI,IAAI,CAAC,eAAe,EAAE;AAC1B,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE;AACtC;AACA,YAAY,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM;AAC3C,iBAAiB,KAAK,CAAC,GAAG,CAAC;AAC3B,iBAAiB,GAAG,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,kDAAkD,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzJ,iBAAiB,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,SAAS;AACT,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;AAC/C,YAAY,MAAM,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;AAC/F,YAAY,OAAO,CAAC,MAAM,GAAG,wBAAwB;AACrD,iBAAiB,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC;AACnD,iBAAiB,GAAG,CAAC,CAAC,OAAO,KAAK;AAClC,gBAAgB,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM;AACvD,sBAAsB,CAAC,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AACpD,sBAAsB,OAAO,CAAC;AAC9B,gBAAgB,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;AAC5E,aAAa,CAAC;AACd,iBAAiB,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3B,SAAS;AACT,KAAK;AACL;AACA;AACA,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AAC1C,QAAQ,GAAG,GAAG,kBAAkB,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;AAC3D,KAAK;AACL,SAAS;AACT,QAAQ,IAAI,MAAM,IAAI,mBAAmB,EAAE;AAC3C,YAAY,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;AAC5C,SAAS;AACT,aAAa;AACb,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,EAAE;AACzD,gBAAgB,IAAI,GAAG,mBAAmB,CAAC;AAC3C,aAAa;AACb,iBAAiB;AACjB,gBAAgB,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;AAC9C,aAAa;AACb,SAAS;AACT,KAAK;AACL;AACA,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;AACjE,QAAQ,OAAO,CAAC,cAAc,CAAC,GAAG,iCAAiC,CAAC;AACpE,KAAK;AACL;AACA;AACA,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;AAC1E,QAAQ,IAAI,GAAG,EAAE,CAAC;AAClB,KAAK;AACL;AACA,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,OAAO,IAAI,KAAK,WAAW,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,OAAO,CAAC,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;AACzJ,CAAC;;AC9EM,SAAS,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;AAC/D,IAAI,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AAClD,CAAC;;ACDM,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;AACvD,IAAI,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AACrD,IAAI,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAC/D,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;AACnC,QAAQ,QAAQ;AAChB,QAAQ,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACnD,QAAQ,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACzC,QAAQ,KAAK;AACb,KAAK,CAAC,CAAC;AACP,CAAC;;ACZM,MAAM,OAAO,GAAG,mBAAmB,CAAC;;ACE3C,MAAM,SAAS,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;AACrE;AACA;AACA,AAAO,MAAM,QAAQ,GAAG;AACxB,IAAI,MAAM,EAAE,KAAK;AACjB,IAAI,OAAO,EAAE,wBAAwB;AACrC,IAAI,OAAO,EAAE;AACb,QAAQ,MAAM,EAAE,gCAAgC;AAChD,QAAQ,YAAY,EAAE,SAAS;AAC/B,KAAK;AACL,IAAI,SAAS,EAAE;AACf,QAAQ,MAAM,EAAE,EAAE;AAClB,QAAQ,QAAQ,EAAE,EAAE;AACpB,KAAK;AACL,CAAC,CAAC;;ACdU,MAAC,QAAQ,GAAG,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/LICENSE b/node_modules/@octokit/endpoint/node_modules/@octokit/types/LICENSE new file mode 100644 index 00000000..57bee5f1 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/LICENSE @@ -0,0 +1,7 @@ +MIT License Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/README.md b/node_modules/@octokit/endpoint/node_modules/@octokit/types/README.md new file mode 100644 index 00000000..74079207 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/README.md @@ -0,0 +1,64 @@ +# types.ts + +> Shared TypeScript definitions for Octokit projects + +[![@latest](https://img.shields.io/npm/v/@octokit/types.svg)](https://www.npmjs.com/package/@octokit/types) +[![Build Status](https://github.com/octokit/types.ts/workflows/Test/badge.svg)](https://github.com/octokit/types.ts/actions?workflow=Test) + + + +- [Usage](#usage) +- [Examples](#examples) + - [Get parameter and response data types for a REST API endpoint](#get-parameter-and-response-data-types-for-a-rest-api-endpoint) + - [Get response types from endpoint methods](#get-response-types-from-endpoint-methods) +- [Contributing](#contributing) +- [License](#license) + + + +## Usage + +See all exported types at https://octokit.github.io/types.ts + +## Examples + +### Get parameter and response data types for a REST API endpoint + +```ts +import { Endpoints } from "./src"; + +type listUserReposParameters = Endpoints["GET /repos/:owner/:repo"]["parameters"]; +type listUserReposResponse = Endpoints["GET /repos/:owner/:repo"]["response"]; + +async function listRepos( + options: listUserReposParameters +): listUserReposResponse["data"] { + // ... +} +``` + +### Get response types from endpoint methods + +```ts +import { + GetResponseTypeFromEndpointMethod, + GetResponseDataTypeFromEndpointMethod, +} from "@octokit/types"; +import { Octokit } from "@octokit/rest"; + +const octokit = new Octokit(); +type CreateLabelResponseType = GetResponseTypeFromEndpointMethod< + typeof octokit.issues.createLabel +>; +type CreateLabelResponseDataType = GetResponseDataTypeFromEndpointMethod< + typeof octokit.issues.createLabel +>; +``` + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-node/index.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-node/index.js new file mode 100644 index 00000000..bc41e1a7 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-node/index.js @@ -0,0 +1,8 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +const VERSION = "4.1.6"; + +exports.VERSION = VERSION; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-node/index.js.map b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-node/index.js.map new file mode 100644 index 00000000..2d148d3b --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/VERSION.js"],"sourcesContent":["export const VERSION = \"0.0.0-development\";\n"],"names":["VERSION"],"mappings":";;;;MAAaA,OAAO,GAAG;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/AuthInterface.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/AuthInterface.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/EndpointDefaults.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/EndpointDefaults.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/EndpointInterface.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/EndpointInterface.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/EndpointOptions.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/EndpointOptions.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/Fetch.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/Fetch.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/OctokitResponse.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/OctokitResponse.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestHeaders.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestHeaders.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestInterface.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestInterface.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestMethod.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestMethod.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestOptions.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestOptions.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestParameters.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestParameters.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestRequestOptions.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/RequestRequestOptions.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/ResponseHeaders.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/ResponseHeaders.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/Route.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/Route.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/Signal.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/Signal.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/StrategyInterface.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/StrategyInterface.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/Url.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/Url.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/VERSION.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/VERSION.js new file mode 100644 index 00000000..5464a548 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/VERSION.js @@ -0,0 +1 @@ +export const VERSION = "4.1.6"; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/generated/Endpoints.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/generated/Endpoints.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/index.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/index.js new file mode 100644 index 00000000..5d2d5ae0 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-src/index.js @@ -0,0 +1,20 @@ +export * from "./AuthInterface"; +export * from "./EndpointDefaults"; +export * from "./EndpointInterface"; +export * from "./EndpointOptions"; +export * from "./Fetch"; +export * from "./OctokitResponse"; +export * from "./RequestHeaders"; +export * from "./RequestInterface"; +export * from "./RequestMethod"; +export * from "./RequestOptions"; +export * from "./RequestParameters"; +export * from "./RequestRequestOptions"; +export * from "./ResponseHeaders"; +export * from "./Route"; +export * from "./Signal"; +export * from "./StrategyInterface"; +export * from "./Url"; +export * from "./VERSION"; +export * from "./GetResponseTypeFromEndpointMethod"; +export * from "./generated/Endpoints"; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/AuthInterface.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/AuthInterface.d.ts new file mode 100644 index 00000000..0c19b50d --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/AuthInterface.d.ts @@ -0,0 +1,31 @@ +import { EndpointOptions } from "./EndpointOptions"; +import { OctokitResponse } from "./OctokitResponse"; +import { RequestInterface } from "./RequestInterface"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; +/** + * Interface to implement complex authentication strategies for Octokit. + * An object Implementing the AuthInterface can directly be passed as the + * `auth` option in the Octokit constructor. + * + * For the official implementations of the most common authentication + * strategies, see https://github.com/octokit/auth.js + */ +export interface AuthInterface { + (...args: AuthOptions): Promise; + hook: { + /** + * Sends a request using the passed `request` instance + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: RequestInterface, options: EndpointOptions): Promise>; + /** + * Sends a request using the passed `request` instance + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: RequestInterface, route: Route, parameters?: RequestParameters): Promise>; + }; +} diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts new file mode 100644 index 00000000..a2c23078 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts @@ -0,0 +1,21 @@ +import { RequestHeaders } from "./RequestHeaders"; +import { RequestMethod } from "./RequestMethod"; +import { RequestParameters } from "./RequestParameters"; +import { Url } from "./Url"; +/** + * The `.endpoint()` method is guaranteed to set all keys defined by RequestParameters + * as well as the method property. + */ +export declare type EndpointDefaults = RequestParameters & { + baseUrl: Url; + method: RequestMethod; + url?: Url; + headers: RequestHeaders & { + accept: string; + "user-agent": string; + }; + mediaType: { + format: string; + previews: string[]; + }; +}; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts new file mode 100644 index 00000000..df585bef --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts @@ -0,0 +1,65 @@ +import { EndpointDefaults } from "./EndpointDefaults"; +import { RequestOptions } from "./RequestOptions"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; +import { Endpoints } from "./generated/Endpoints"; +export interface EndpointInterface { + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {object} endpoint Must set `url` unless it's set defaults. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: O & { + method?: string; + } & ("url" extends keyof D ? { + url?: string; + } : { + url: string; + })): RequestOptions & Pick; + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: keyof Endpoints | R, parameters?: P): (R extends keyof Endpoints ? Endpoints[R]["request"] : RequestOptions) & Pick; + /** + * Object with current default route and parameters + */ + DEFAULTS: D & EndpointDefaults; + /** + * Returns a new `endpoint` interface with new defaults + */ + defaults: (newDefaults: O) => EndpointInterface; + merge: { + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * + */ + (route: keyof Endpoints | R, parameters?: P): D & (R extends keyof Endpoints ? Endpoints[R]["request"] & Endpoints[R]["parameters"] : EndpointDefaults) & P; + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ +

(options: P): EndpointDefaults & D & P; + /** + * Returns current default options. + * + * @deprecated use endpoint.DEFAULTS instead + */ + (): D & EndpointDefaults; + }; + /** + * Stateless method to turn endpoint options into request options. + * Calling `endpoint(options)` is the same as calling `endpoint.parse(endpoint.merge(options))`. + * + * @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + parse: (options: O) => RequestOptions & Pick; +} diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts new file mode 100644 index 00000000..b1b91f11 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts @@ -0,0 +1,7 @@ +import { RequestMethod } from "./RequestMethod"; +import { Url } from "./Url"; +import { RequestParameters } from "./RequestParameters"; +export declare type EndpointOptions = RequestParameters & { + method: RequestMethod; + url: Url; +}; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Fetch.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Fetch.d.ts new file mode 100644 index 00000000..cbbd5e8f --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Fetch.d.ts @@ -0,0 +1,4 @@ +/** + * Browser's fetch method (or compatible such as fetch-mock) + */ +export declare type Fetch = any; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts new file mode 100644 index 00000000..70e1a8d4 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts @@ -0,0 +1,5 @@ +declare type Unwrap = T extends Promise ? U : T; +declare type AnyFunction = (...args: any[]) => any; +export declare type GetResponseTypeFromEndpointMethod = Unwrap>; +export declare type GetResponseDataTypeFromEndpointMethod = Unwrap>["data"]; +export {}; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts new file mode 100644 index 00000000..9a2dd7f6 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts @@ -0,0 +1,17 @@ +import { ResponseHeaders } from "./ResponseHeaders"; +import { Url } from "./Url"; +export declare type OctokitResponse = { + headers: ResponseHeaders; + /** + * http response code + */ + status: number; + /** + * URL of response after all redirects + */ + url: Url; + /** + * This is the data you would see in https://developer.Octokit.com/v3/ + */ + data: T; +}; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts new file mode 100644 index 00000000..ac5aae0a --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts @@ -0,0 +1,15 @@ +export declare type RequestHeaders = { + /** + * Avoid setting `headers.accept`, use `mediaType.{format|previews}` option instead. + */ + accept?: string; + /** + * Use `authorization` to send authenticated request, remember `token ` / `bearer ` prefixes. Example: `token 1234567890abcdef1234567890abcdef12345678` + */ + authorization?: string; + /** + * `user-agent` is set do a default and can be overwritten as needed. + */ + "user-agent"?: string; + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestInterface.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestInterface.d.ts new file mode 100644 index 00000000..ef4d8d3a --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestInterface.d.ts @@ -0,0 +1,34 @@ +import { EndpointInterface } from "./EndpointInterface"; +import { OctokitResponse } from "./OctokitResponse"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; +import { Endpoints } from "./generated/Endpoints"; +export interface RequestInterface { + /** + * Sends a request based on endpoint options + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: O & { + method?: string; + } & ("url" extends keyof D ? { + url?: string; + } : { + url: string; + })): Promise>; + /** + * Sends a request based on endpoint options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: keyof Endpoints | R, options?: R extends keyof Endpoints ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters): R extends keyof Endpoints ? Promise : Promise>; + /** + * Returns a new `request` with updated route and parameters + */ + defaults: (newDefaults: O) => RequestInterface; + /** + * Octokit endpoint API, see {@link https://github.com/octokit/endpoint.js|@octokit/endpoint} + */ + endpoint: EndpointInterface; +} diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestMethod.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestMethod.d.ts new file mode 100644 index 00000000..e999c8d9 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestMethod.d.ts @@ -0,0 +1,4 @@ +/** + * HTTP Verb supported by GitHub's REST API + */ +export declare type RequestMethod = "DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT"; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestOptions.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestOptions.d.ts new file mode 100644 index 00000000..97e2181c --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestOptions.d.ts @@ -0,0 +1,14 @@ +import { RequestHeaders } from "./RequestHeaders"; +import { RequestMethod } from "./RequestMethod"; +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { Url } from "./Url"; +/** + * Generic request options as they are returned by the `endpoint()` method + */ +export declare type RequestOptions = { + method: RequestMethod; + url: Url; + headers: RequestHeaders; + body?: any; + request?: RequestRequestOptions; +}; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestParameters.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestParameters.d.ts new file mode 100644 index 00000000..692d193b --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestParameters.d.ts @@ -0,0 +1,45 @@ +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { RequestHeaders } from "./RequestHeaders"; +import { Url } from "./Url"; +/** + * Parameters that can be passed into `request(route, parameters)` or `endpoint(route, parameters)` methods + */ +export declare type RequestParameters = { + /** + * Base URL to be used when a relative URL is passed, such as `/orgs/:org`. + * If `baseUrl` is `https://enterprise.acme-inc.com/api/v3`, then the request + * will be sent to `https://enterprise.acme-inc.com/api/v3/orgs/:org`. + */ + baseUrl?: Url; + /** + * HTTP headers. Use lowercase keys. + */ + headers?: RequestHeaders; + /** + * Media type options, see {@link https://developer.github.com/v3/media/|GitHub Developer Guide} + */ + mediaType?: { + /** + * `json` by default. Can be `raw`, `text`, `html`, `full`, `diff`, `patch`, `sha`, `base64`. Depending on endpoint + */ + format?: string; + /** + * Custom media type names of {@link https://developer.github.com/v3/media/|API Previews} without the `-preview` suffix. + * Example for single preview: `['squirrel-girl']`. + * Example for multiple previews: `['squirrel-girl', 'mister-fantastic']`. + */ + previews?: string[]; + }; + /** + * Pass custom meta information for the request. The `request` object will be returned as is. + */ + request?: RequestRequestOptions; + /** + * Any additional parameter will be passed as follows + * 1. URL parameter if `':parameter'` or `{parameter}` is part of `url` + * 2. Query parameter if `method` is `'GET'` or `'HEAD'` + * 3. Request body if `parameter` is `'data'` + * 4. JSON in the request body in the form of `body[parameter]` unless `parameter` key is `'data'` + */ + [parameter: string]: unknown; +}; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts new file mode 100644 index 00000000..4482a8a4 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts @@ -0,0 +1,26 @@ +/// +import { Agent } from "http"; +import { Fetch } from "./Fetch"; +import { Signal } from "./Signal"; +/** + * Octokit-specific request options which are ignored for the actual request, but can be used by Octokit or plugins to manipulate how the request is sent or how a response is handled + */ +export declare type RequestRequestOptions = { + /** + * Node only. Useful for custom proxy, certificate, or dns lookup. + */ + agent?: Agent; + /** + * Custom replacement for built-in fetch method. Useful for testing or request hooks. + */ + fetch?: Fetch; + /** + * Use an `AbortController` instance to cancel a request. In node you can only cancel streamed requests. + */ + signal?: Signal; + /** + * Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). `options.request.signal` is recommended instead. + */ + timeout?: number; + [option: string]: any; +}; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts new file mode 100644 index 00000000..c8fbe43f --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts @@ -0,0 +1,20 @@ +export declare type ResponseHeaders = { + "cache-control"?: string; + "content-length"?: number; + "content-type"?: string; + date?: string; + etag?: string; + "last-modified"?: string; + link?: string; + location?: string; + server?: string; + status?: string; + vary?: string; + "x-github-mediatype"?: string; + "x-github-request-id"?: string; + "x-oauth-scopes"?: string; + "x-ratelimit-limit"?: string; + "x-ratelimit-remaining"?: string; + "x-ratelimit-reset"?: string; + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Route.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Route.d.ts new file mode 100644 index 00000000..80790444 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Route.d.ts @@ -0,0 +1,4 @@ +/** + * String consisting of an optional HTTP method and relative path or absolute URL. Examples: `'/orgs/:org'`, `'PUT /orgs/:org'`, `GET https://example.com/foo/bar` + */ +export declare type Route = string; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Signal.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Signal.d.ts new file mode 100644 index 00000000..4ebcf24e --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Signal.d.ts @@ -0,0 +1,6 @@ +/** + * Abort signal + * + * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal + */ +export declare type Signal = any; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts new file mode 100644 index 00000000..405cbd23 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts @@ -0,0 +1,4 @@ +import { AuthInterface } from "./AuthInterface"; +export interface StrategyInterface { + (...args: StrategyOptions): AuthInterface; +} diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Url.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Url.d.ts new file mode 100644 index 00000000..acaad633 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/Url.d.ts @@ -0,0 +1,4 @@ +/** + * Relative or absolute URL. Examples: `'/orgs/:org'`, `https://example.com/foo/bar` + */ +export declare type Url = string; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/VERSION.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/VERSION.d.ts new file mode 100644 index 00000000..ef9d17e0 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/VERSION.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "4.1.6"; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts new file mode 100644 index 00000000..3835f2ba --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts @@ -0,0 +1,36972 @@ +import { OctokitResponse } from "../OctokitResponse"; +import { RequestHeaders } from "../RequestHeaders"; +import { RequestRequestOptions } from "../RequestRequestOptions"; +declare type RequiredPreview = { + mediaType: { + previews: [T, ...string[]]; + }; +}; +export interface Endpoints { + /** + * @see https://developer.github.com/v3/apps/#delete-an-installation + */ + "DELETE /app/installations/:installation_id": { + parameters: AppsDeleteInstallationEndpoint; + request: AppsDeleteInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#unsuspend-an-installation + */ + "DELETE /app/installations/:installation_id/suspended": { + parameters: AppsUnsuspendInstallationEndpoint; + request: AppsUnsuspendInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-authorization + */ + "DELETE /applications/:client_id/grant": { + parameters: AppsDeleteAuthorizationEndpoint; + request: AppsDeleteAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application + */ + "DELETE /applications/:client_id/grants/:access_token": { + parameters: AppsRevokeGrantForApplicationEndpoint; + request: AppsRevokeGrantForApplicationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-token + */ + "DELETE /applications/:client_id/token": { + parameters: AppsDeleteTokenEndpoint; + request: AppsDeleteTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application + */ + "DELETE /applications/:client_id/tokens/:access_token": { + parameters: AppsRevokeAuthorizationForApplicationEndpoint; + request: AppsRevokeAuthorizationForApplicationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#delete-a-grant + */ + "DELETE /applications/grants/:grant_id": { + parameters: OauthAuthorizationsDeleteGrantEndpoint; + request: OauthAuthorizationsDeleteGrantRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization + */ + "DELETE /authorizations/:authorization_id": { + parameters: OauthAuthorizationsDeleteAuthorizationEndpoint; + request: OauthAuthorizationsDeleteAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#delete-a-gist + */ + "DELETE /gists/:gist_id": { + parameters: GistsDeleteEndpoint; + request: GistsDeleteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#delete-a-gist-comment + */ + "DELETE /gists/:gist_id/comments/:comment_id": { + parameters: GistsDeleteCommentEndpoint; + request: GistsDeleteCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#unstar-a-gist + */ + "DELETE /gists/:gist_id/star": { + parameters: GistsUnstarEndpoint; + request: GistsUnstarRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#revoke-an-installation-token + */ + "DELETE /installation/token": { + parameters: AppsRevokeInstallationTokenEndpoint; + request: AppsRevokeInstallationTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription + */ + "DELETE /notifications/threads/:thread_id/subscription": { + parameters: ActivityDeleteThreadSubscriptionEndpoint; + request: ActivityDeleteThreadSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#delete-a-self-hosted-runner-from-an-organization + */ + "DELETE /orgs/:org/actions/runners/:runner_id": { + parameters: ActionsDeleteSelfHostedRunnerFromOrgEndpoint; + request: ActionsDeleteSelfHostedRunnerFromOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#delete-an-organization-secret + */ + "DELETE /orgs/:org/actions/secrets/:secret_name": { + parameters: ActionsDeleteOrgSecretEndpoint; + request: ActionsDeleteOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#remove-selected-repository-from-an-organization-secret + */ + "DELETE /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id": { + parameters: ActionsRemoveSelectedRepoFromOrgSecretEndpoint; + request: ActionsRemoveSelectedRepoFromOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/blocking/#unblock-a-user + */ + "DELETE /orgs/:org/blocks/:username": { + parameters: OrgsUnblockUserEndpoint; + request: OrgsUnblockUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#remove-a-credential-authorization-for-an-organization + */ + "DELETE /orgs/:org/credential-authorizations/:credential_id": { + parameters: OrgsRemoveCredentialAuthorizationEndpoint; + request: OrgsRemoveCredentialAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#delete-a-hook + */ + "DELETE /orgs/:org/hooks/:hook_id": { + parameters: OrgsDeleteHookEndpoint; + request: OrgsDeleteHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/orgs/#remove-interaction-restrictions-for-an-organization + */ + "DELETE /orgs/:org/interaction-limits": { + parameters: InteractionsRemoveRestrictionsForOrgEndpoint; + request: InteractionsRemoveRestrictionsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#remove-a-member + */ + "DELETE /orgs/:org/members/:username": { + parameters: OrgsRemoveMemberEndpoint; + request: OrgsRemoveMemberRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#remove-organization-membership + */ + "DELETE /orgs/:org/memberships/:username": { + parameters: OrgsRemoveMembershipEndpoint; + request: OrgsRemoveMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#delete-an-organization-migration-archive + */ + "DELETE /orgs/:org/migrations/:migration_id/archive": { + parameters: MigrationsDeleteArchiveForOrgEndpoint; + request: MigrationsDeleteArchiveForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#unlock-an-organization-repository + */ + "DELETE /orgs/:org/migrations/:migration_id/repos/:repo_name/lock": { + parameters: MigrationsUnlockRepoForOrgEndpoint; + request: MigrationsUnlockRepoForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator + */ + "DELETE /orgs/:org/outside_collaborators/:username": { + parameters: OrgsRemoveOutsideCollaboratorEndpoint; + request: OrgsRemoveOutsideCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#conceal-a-users-membership + */ + "DELETE /orgs/:org/public_members/:username": { + parameters: OrgsConcealMembershipEndpoint; + request: OrgsConcealMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#delete-a-team + */ + "DELETE /orgs/:org/teams/:team_slug": { + parameters: TeamsDeleteInOrgEndpoint; + request: TeamsDeleteInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#delete-a-discussion + */ + "DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number": { + parameters: TeamsDeleteDiscussionInOrgEndpoint; + request: TeamsDeleteDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#delete-a-discussion-comment + */ + "DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsDeleteDiscussionCommentInOrgEndpoint; + request: TeamsDeleteDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-team-discussion-comment-reaction + */ + "DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id": { + parameters: ReactionsDeleteForTeamDiscussionCommentEndpoint; + request: ReactionsDeleteForTeamDiscussionCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-team-discussion-reaction + */ + "DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id": { + parameters: ReactionsDeleteForTeamDiscussionEndpoint; + request: ReactionsDeleteForTeamDiscussionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#remove-team-membership-for-a-user + */ + "DELETE /orgs/:org/teams/:team_slug/memberships/:username": { + parameters: TeamsRemoveMembershipForUserInOrgEndpoint; + request: TeamsRemoveMembershipForUserInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#remove-a-project-from-a-team + */ + "DELETE /orgs/:org/teams/:team_slug/projects/:project_id": { + parameters: TeamsRemoveProjectInOrgEndpoint; + request: TeamsRemoveProjectInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#remove-a-repository-from-a-team + */ + "DELETE /orgs/:org/teams/:team_slug/repos/:owner/:repo": { + parameters: TeamsRemoveRepoInOrgEndpoint; + request: TeamsRemoveRepoInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#delete-a-project + */ + "DELETE /projects/:project_id": { + parameters: ProjectsDeleteEndpoint; + request: ProjectsDeleteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/collaborators/#remove-user-as-a-collaborator + */ + "DELETE /projects/:project_id/collaborators/:username": { + parameters: ProjectsRemoveCollaboratorEndpoint; + request: ProjectsRemoveCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#delete-a-project-column + */ + "DELETE /projects/columns/:column_id": { + parameters: ProjectsDeleteColumnEndpoint; + request: ProjectsDeleteColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#delete-a-project-card + */ + "DELETE /projects/columns/cards/:card_id": { + parameters: ProjectsDeleteCardEndpoint; + request: ProjectsDeleteCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-a-reaction-legacy + */ + "DELETE /reactions/:reaction_id": { + parameters: ReactionsDeleteLegacyEndpoint; + request: ReactionsDeleteLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#delete-a-repository + */ + "DELETE /repos/:owner/:repo": { + parameters: ReposDeleteEndpoint; + request: ReposDeleteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#delete-an-artifact + */ + "DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id": { + parameters: ActionsDeleteArtifactEndpoint; + request: ActionsDeleteArtifactRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#delete-a-self-hosted-runner-from-a-repository + */ + "DELETE /repos/:owner/:repo/actions/runners/:runner_id": { + parameters: ActionsDeleteSelfHostedRunnerFromRepoEndpoint; + request: ActionsDeleteSelfHostedRunnerFromRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#delete-workflow-run-logs + */ + "DELETE /repos/:owner/:repo/actions/runs/:run_id/logs": { + parameters: ActionsDeleteWorkflowRunLogsEndpoint; + request: ActionsDeleteWorkflowRunLogsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#delete-a-repository-secret + */ + "DELETE /repos/:owner/:repo/actions/secrets/:secret_name": { + parameters: ActionsDeleteRepoSecretEndpoint; + request: ActionsDeleteRepoSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#disable-automated-security-fixes + */ + "DELETE /repos/:owner/:repo/automated-security-fixes": { + parameters: ReposDisableAutomatedSecurityFixesEndpoint; + request: ReposDisableAutomatedSecurityFixesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-branch-protection + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection": { + parameters: ReposRemoveBranchProtectionEndpoint; + request: ReposRemoveBranchProtectionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-admin-enforcement-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins": { + parameters: ReposRemoveProtectedBranchAdminEnforcementEndpoint; + request: ReposRemoveProtectedBranchAdminEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": { + parameters: ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint; + request: ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-required-signatures-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures": { + parameters: ReposRemoveProtectedBranchRequiredSignaturesEndpoint; + request: ReposRemoveProtectedBranchRequiredSignaturesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-required-status-checks-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks": { + parameters: ReposRemoveProtectedBranchRequiredStatusChecksEndpoint; + request: ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-required-status-checks-contexts-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": { + parameters: ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint; + request: ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-restrictions-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions": { + parameters: ReposRemoveProtectedBranchRestrictionsEndpoint; + request: ReposRemoveProtectedBranchRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-app-restrictions-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": { + parameters: ReposRemoveProtectedBranchAppRestrictionsEndpoint; + request: ReposRemoveProtectedBranchAppRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-team-restrictions-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": { + parameters: ReposRemoveProtectedBranchTeamRestrictionsEndpoint; + request: ReposRemoveProtectedBranchTeamRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-user-restrictions-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users": { + parameters: ReposRemoveProtectedBranchUserRestrictionsEndpoint; + request: ReposRemoveProtectedBranchUserRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator + */ + "DELETE /repos/:owner/:repo/collaborators/:username": { + parameters: ReposRemoveCollaboratorEndpoint; + request: ReposRemoveCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#delete-a-commit-comment + */ + "DELETE /repos/:owner/:repo/comments/:comment_id": { + parameters: ReposDeleteCommitCommentEndpoint; + request: ReposDeleteCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-a-commit-comment-reaction + */ + "DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id": { + parameters: ReactionsDeleteForCommitCommentEndpoint; + request: ReactionsDeleteForCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#delete-a-file + */ + "DELETE /repos/:owner/:repo/contents/:path": { + parameters: ReposDeleteFileEndpoint; + request: ReposDeleteFileRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#delete-a-deployment + */ + "DELETE /repos/:owner/:repo/deployments/:deployment_id": { + parameters: ReposDeleteDeploymentEndpoint; + request: ReposDeleteDeploymentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/downloads/#delete-a-download + */ + "DELETE /repos/:owner/:repo/downloads/:download_id": { + parameters: ReposDeleteDownloadEndpoint; + request: ReposDeleteDownloadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#delete-a-reference + */ + "DELETE /repos/:owner/:repo/git/refs/:ref": { + parameters: GitDeleteRefEndpoint; + request: GitDeleteRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#delete-a-hook + */ + "DELETE /repos/:owner/:repo/hooks/:hook_id": { + parameters: ReposDeleteHookEndpoint; + request: ReposDeleteHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#cancel-an-import + */ + "DELETE /repos/:owner/:repo/import": { + parameters: MigrationsCancelImportEndpoint; + request: MigrationsCancelImportRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/repos/#remove-interaction-restrictions-for-a-repository + */ + "DELETE /repos/:owner/:repo/interaction-limits": { + parameters: InteractionsRemoveRestrictionsForRepoEndpoint; + request: InteractionsRemoveRestrictionsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation + */ + "DELETE /repos/:owner/:repo/invitations/:invitation_id": { + parameters: ReposDeleteInvitationEndpoint; + request: ReposDeleteInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/assignees": { + parameters: IssuesRemoveAssigneesEndpoint; + request: IssuesRemoveAssigneesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/labels": { + parameters: IssuesRemoveAllLabelsEndpoint; + request: IssuesRemoveAllLabelsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name": { + parameters: IssuesRemoveLabelEndpoint; + request: IssuesRemoveLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#unlock-an-issue + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/lock": { + parameters: IssuesUnlockEndpoint; + request: IssuesUnlockRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-an-issue-reaction + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id": { + parameters: ReactionsDeleteForIssueEndpoint; + request: ReactionsDeleteForIssueRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#delete-an-issue-comment + */ + "DELETE /repos/:owner/:repo/issues/comments/:comment_id": { + parameters: IssuesDeleteCommentEndpoint; + request: IssuesDeleteCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-an-issue-comment-reaction + */ + "DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id": { + parameters: ReactionsDeleteForIssueCommentEndpoint; + request: ReactionsDeleteForIssueCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/keys/#remove-a-deploy-key + */ + "DELETE /repos/:owner/:repo/keys/:key_id": { + parameters: ReposRemoveDeployKeyEndpoint; + request: ReposRemoveDeployKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#delete-a-label + */ + "DELETE /repos/:owner/:repo/labels/:name": { + parameters: IssuesDeleteLabelEndpoint; + request: IssuesDeleteLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#delete-a-milestone + */ + "DELETE /repos/:owner/:repo/milestones/:milestone_number": { + parameters: IssuesDeleteMilestoneEndpoint; + request: IssuesDeleteMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#disable-a-pages-site + */ + "DELETE /repos/:owner/:repo/pages": { + parameters: ReposDisablePagesSiteEndpoint; + request: ReposDisablePagesSiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request + */ + "DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": { + parameters: PullsDeleteReviewRequestEndpoint; + request: PullsDeleteReviewRequestRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review + */ + "DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": { + parameters: PullsDeletePendingReviewEndpoint; + request: PullsDeletePendingReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#delete-a-comment + */ + "DELETE /repos/:owner/:repo/pulls/comments/:comment_id": { + parameters: PullsDeleteCommentEndpoint; + request: PullsDeleteCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-a-pull-request-comment-reaction + */ + "DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id": { + parameters: ReactionsDeleteForPullRequestCommentEndpoint; + request: ReactionsDeleteForPullRequestCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#delete-a-release + */ + "DELETE /repos/:owner/:repo/releases/:release_id": { + parameters: ReposDeleteReleaseEndpoint; + request: ReposDeleteReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#delete-a-release-asset + */ + "DELETE /repos/:owner/:repo/releases/assets/:asset_id": { + parameters: ReposDeleteReleaseAssetEndpoint; + request: ReposDeleteReleaseAssetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription + */ + "DELETE /repos/:owner/:repo/subscription": { + parameters: ActivityDeleteRepoSubscriptionEndpoint; + request: ActivityDeleteRepoSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#disable-vulnerability-alerts + */ + "DELETE /repos/:owner/:repo/vulnerability-alerts": { + parameters: ReposDisableVulnerabilityAlertsEndpoint; + request: ReposDisableVulnerabilityAlertsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#remove-a-user-from-the-organization + */ + "DELETE /scim/v2/organizations/:org/Users/:scim_user_id": { + parameters: ScimRemoveUserFromOrgEndpoint; + request: ScimRemoveUserFromOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#delete-a-team-legacy + */ + "DELETE /teams/:team_id": { + parameters: TeamsDeleteLegacyEndpoint; + request: TeamsDeleteLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy + */ + "DELETE /teams/:team_id/discussions/:discussion_number": { + parameters: TeamsDeleteDiscussionLegacyEndpoint; + request: TeamsDeleteDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#delete-a-discussion-comment-legacy + */ + "DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsDeleteDiscussionCommentLegacyEndpoint; + request: TeamsDeleteDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#remove-team-member-legacy + */ + "DELETE /teams/:team_id/members/:username": { + parameters: TeamsRemoveMemberLegacyEndpoint; + request: TeamsRemoveMemberLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#remove-team-membership-for-a-user-legacy + */ + "DELETE /teams/:team_id/memberships/:username": { + parameters: TeamsRemoveMembershipForUserLegacyEndpoint; + request: TeamsRemoveMembershipForUserLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#remove-a-project-from-a-team-legacy + */ + "DELETE /teams/:team_id/projects/:project_id": { + parameters: TeamsRemoveProjectLegacyEndpoint; + request: TeamsRemoveProjectLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#remove-a-repository-from-a-team-legacy + */ + "DELETE /teams/:team_id/repos/:owner/:repo": { + parameters: TeamsRemoveRepoLegacyEndpoint; + request: TeamsRemoveRepoLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/blocking/#unblock-a-user + */ + "DELETE /user/blocks/:username": { + parameters: UsersUnblockEndpoint; + request: UsersUnblockRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#delete-email-addresses + */ + "DELETE /user/emails": { + parameters: UsersDeleteEmailsEndpoint; + request: UsersDeleteEmailsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#unfollow-a-user + */ + "DELETE /user/following/:username": { + parameters: UsersUnfollowEndpoint; + request: UsersUnfollowRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key + */ + "DELETE /user/gpg_keys/:gpg_key_id": { + parameters: UsersDeleteGpgKeyEndpoint; + request: UsersDeleteGpgKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#remove-repository-from-installation + */ + "DELETE /user/installations/:installation_id/repositories/:repository_id": { + parameters: AppsRemoveRepoFromInstallationEndpoint; + request: AppsRemoveRepoFromInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#delete-a-public-key + */ + "DELETE /user/keys/:key_id": { + parameters: UsersDeletePublicKeyEndpoint; + request: UsersDeletePublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#delete-a-user-migration-archive + */ + "DELETE /user/migrations/:migration_id/archive": { + parameters: MigrationsDeleteArchiveForAuthenticatedUserEndpoint; + request: MigrationsDeleteArchiveForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#unlock-a-user-repository + */ + "DELETE /user/migrations/:migration_id/repos/:repo_name/lock": { + parameters: MigrationsUnlockRepoForAuthenticatedUserEndpoint; + request: MigrationsUnlockRepoForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation + */ + "DELETE /user/repository_invitations/:invitation_id": { + parameters: ReposDeclineInvitationEndpoint; + request: ReposDeclineInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#unstar-a-repository-for-the-authenticated-user + */ + "DELETE /user/starred/:owner/:repo": { + parameters: ActivityUnstarRepoForAuthenticatedUserEndpoint; + request: ActivityUnstarRepoForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-the-authenticated-github-app + */ + "GET /app": { + parameters: AppsGetAuthenticatedEndpoint; + request: AppsGetAuthenticatedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#list-installations + */ + "GET /app/installations": { + parameters: AppsListInstallationsEndpoint; + request: AppsListInstallationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-an-installation + */ + "GET /app/installations/:installation_id": { + parameters: AppsGetInstallationEndpoint; + request: AppsGetInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization + */ + "GET /applications/:client_id/tokens/:access_token": { + parameters: AppsCheckAuthorizationEndpoint; + request: AppsCheckAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#list-your-grants + */ + "GET /applications/grants": { + parameters: OauthAuthorizationsListGrantsEndpoint; + request: OauthAuthorizationsListGrantsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant + */ + "GET /applications/grants/:grant_id": { + parameters: OauthAuthorizationsGetGrantEndpoint; + request: OauthAuthorizationsGetGrantRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-a-single-github-app + */ + "GET /apps/:app_slug": { + parameters: AppsGetBySlugEndpoint; + request: AppsGetBySlugRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations + */ + "GET /authorizations": { + parameters: OauthAuthorizationsListAuthorizationsEndpoint; + request: OauthAuthorizationsListAuthorizationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization + */ + "GET /authorizations/:authorization_id": { + parameters: OauthAuthorizationsGetAuthorizationEndpoint; + request: OauthAuthorizationsGetAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct + */ + "GET /codes_of_conduct": { + parameters: CodesOfConductGetAllCodesOfConductEndpoint; + request: CodesOfConductGetAllCodesOfConductRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct + */ + "GET /codes_of_conduct/:key": { + parameters: CodesOfConductGetConductCodeEndpoint; + request: CodesOfConductGetConductCodeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/emojis/#emojis + */ + "GET /emojis": { + parameters: EmojisGetEndpoint; + request: EmojisGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-events + */ + "GET /events": { + parameters: ActivityListPublicEventsEndpoint; + request: ActivityListPublicEventsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/feeds/#get-feeds + */ + "GET /feeds": { + parameters: ActivityGetFeedsEndpoint; + request: ActivityGetFeedsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-gists-for-the-authenticated-user + */ + "GET /gists": { + parameters: GistsListEndpoint; + request: GistsListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#get-a-gist + */ + "GET /gists/:gist_id": { + parameters: GistsGetEndpoint; + request: GistsGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#get-a-gist-revision + */ + "GET /gists/:gist_id/:sha": { + parameters: GistsGetRevisionEndpoint; + request: GistsGetRevisionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#list-gist-comments + */ + "GET /gists/:gist_id/comments": { + parameters: GistsListCommentsEndpoint; + request: GistsListCommentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#get-a-gist-comment + */ + "GET /gists/:gist_id/comments/:comment_id": { + parameters: GistsGetCommentEndpoint; + request: GistsGetCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-gist-commits + */ + "GET /gists/:gist_id/commits": { + parameters: GistsListCommitsEndpoint; + request: GistsListCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-gist-forks + */ + "GET /gists/:gist_id/forks": { + parameters: GistsListForksEndpoint; + request: GistsListForksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#check-if-a-gist-is-starred + */ + "GET /gists/:gist_id/star": { + parameters: GistsCheckIsStarredEndpoint; + request: GistsCheckIsStarredRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-public-gists + */ + "GET /gists/public": { + parameters: GistsListPublicEndpoint; + request: GistsListPublicRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-starred-gists + */ + "GET /gists/starred": { + parameters: GistsListStarredEndpoint; + request: GistsListStarredRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gitignore/#listing-available-templates + */ + "GET /gitignore/templates": { + parameters: GitignoreListTemplatesEndpoint; + request: GitignoreListTemplatesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gitignore/#get-a-single-template + */ + "GET /gitignore/templates/:name": { + parameters: GitignoreGetTemplateEndpoint; + request: GitignoreGetTemplateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#list-repositories + */ + "GET /installation/repositories": { + parameters: AppsListReposEndpoint; + request: AppsListReposRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#list-issues-assigned-to-the-authenticated-user + */ + "GET /issues": { + parameters: IssuesListEndpoint; + request: IssuesListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/licenses/#list-commonly-used-licenses + */ + "GET /licenses": { + parameters: LicensesListCommonlyUsedEndpoint; + request: LicensesListCommonlyUsedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/licenses/#get-an-individual-license + */ + "GET /licenses/:license": { + parameters: LicensesGetEndpoint; + request: LicensesGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#get-a-subscription-plan-for-an-account + */ + "GET /marketplace_listing/accounts/:account_id": { + parameters: AppsGetSubscriptionPlanForAccountEndpoint; + request: AppsGetSubscriptionPlanForAccountRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-plans + */ + "GET /marketplace_listing/plans": { + parameters: AppsListPlansEndpoint; + request: AppsListPlansRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-accounts-for-a-plan + */ + "GET /marketplace_listing/plans/:plan_id/accounts": { + parameters: AppsListAccountsForPlanEndpoint; + request: AppsListAccountsForPlanRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#get-a-subscription-plan-for-an-account-stubbed + */ + "GET /marketplace_listing/stubbed/accounts/:account_id": { + parameters: AppsGetSubscriptionPlanForAccountStubbedEndpoint; + request: AppsGetSubscriptionPlanForAccountStubbedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-plans-stubbed + */ + "GET /marketplace_listing/stubbed/plans": { + parameters: AppsListPlansStubbedEndpoint; + request: AppsListPlansStubbedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-accounts-for-a-plan-stubbed + */ + "GET /marketplace_listing/stubbed/plans/:plan_id/accounts": { + parameters: AppsListAccountsForPlanStubbedEndpoint; + request: AppsListAccountsForPlanStubbedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/meta/#meta + */ + "GET /meta": { + parameters: MetaGetEndpoint; + request: MetaGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories + */ + "GET /networks/:owner/:repo/events": { + parameters: ActivityListPublicEventsForRepoNetworkEndpoint; + request: ActivityListPublicEventsForRepoNetworkRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#list-notifications-for-the-authenticated-user + */ + "GET /notifications": { + parameters: ActivityListNotificationsForAuthenticatedUserEndpoint; + request: ActivityListNotificationsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#get-a-thread + */ + "GET /notifications/threads/:thread_id": { + parameters: ActivityGetThreadEndpoint; + request: ActivityGetThreadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription-for-the-authenticated-user + */ + "GET /notifications/threads/:thread_id/subscription": { + parameters: ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint; + request: ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-all-organizations + */ + "GET /organizations": { + parameters: OrgsListEndpoint; + request: OrgsListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#get-an-organization + */ + "GET /orgs/:org": { + parameters: OrgsGetEndpoint; + request: OrgsGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#list-self-hosted-runners-for-an-organization + */ + "GET /orgs/:org/actions/runners": { + parameters: ActionsListSelfHostedRunnersForOrgEndpoint; + request: ActionsListSelfHostedRunnersForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#get-a-self-hosted-runner-for-an-organization + */ + "GET /orgs/:org/actions/runners/:runner_id": { + parameters: ActionsGetSelfHostedRunnerForOrgEndpoint; + request: ActionsGetSelfHostedRunnerForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#list-runner-applications-for-an-organization + */ + "GET /orgs/:org/actions/runners/downloads": { + parameters: ActionsListRunnerApplicationsForOrgEndpoint; + request: ActionsListRunnerApplicationsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#list-organization-secrets + */ + "GET /orgs/:org/actions/secrets": { + parameters: ActionsListOrgSecretsEndpoint; + request: ActionsListOrgSecretsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#get-an-organization-secret + */ + "GET /orgs/:org/actions/secrets/:secret_name": { + parameters: ActionsGetOrgSecretEndpoint; + request: ActionsGetOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#list-selected-repositories-for-an-organization-secret + */ + "GET /orgs/:org/actions/secrets/:secret_name/repositories": { + parameters: ActionsListSelectedReposForOrgSecretEndpoint; + request: ActionsListSelectedReposForOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#get-an-organization-public-key + */ + "GET /orgs/:org/actions/secrets/public-key": { + parameters: ActionsGetOrgPublicKeyEndpoint; + request: ActionsGetOrgPublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/blocking/#list-blocked-users + */ + "GET /orgs/:org/blocks": { + parameters: OrgsListBlockedUsersEndpoint; + request: OrgsListBlockedUsersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/blocking/#check-whether-a-user-is-blocked-from-an-organization + */ + "GET /orgs/:org/blocks/:username": { + parameters: OrgsCheckBlockedUserEndpoint; + request: OrgsCheckBlockedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-credential-authorizations-for-an-organization + */ + "GET /orgs/:org/credential-authorizations": { + parameters: OrgsListCredentialAuthorizationsEndpoint; + request: OrgsListCredentialAuthorizationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-organization-events + */ + "GET /orgs/:org/events": { + parameters: ActivityListPublicOrgEventsEndpoint; + request: ActivityListPublicOrgEventsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#list-hooks + */ + "GET /orgs/:org/hooks": { + parameters: OrgsListHooksEndpoint; + request: OrgsListHooksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#get-single-hook + */ + "GET /orgs/:org/hooks/:hook_id": { + parameters: OrgsGetHookEndpoint; + request: OrgsGetHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-an-organization-installation + */ + "GET /orgs/:org/installation": { + parameters: AppsGetOrgInstallationEndpoint; + request: AppsGetOrgInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-installations-for-an-organization + */ + "GET /orgs/:org/installations": { + parameters: OrgsListInstallationsEndpoint; + request: OrgsListInstallationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/orgs/#get-interaction-restrictions-for-an-organization + */ + "GET /orgs/:org/interaction-limits": { + parameters: InteractionsGetRestrictionsForOrgEndpoint; + request: InteractionsGetRestrictionsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#list-pending-organization-invitations + */ + "GET /orgs/:org/invitations": { + parameters: OrgsListPendingInvitationsEndpoint; + request: OrgsListPendingInvitationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#list-organization-invitation-teams + */ + "GET /orgs/:org/invitations/:invitation_id/teams": { + parameters: OrgsListInvitationTeamsEndpoint; + request: OrgsListInvitationTeamsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#list-organization-issues-assigned-to-the-authenticated-user + */ + "GET /orgs/:org/issues": { + parameters: IssuesListForOrgEndpoint; + request: IssuesListForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#members-list + */ + "GET /orgs/:org/members": { + parameters: OrgsListMembersEndpoint; + request: OrgsListMembersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#check-membership + */ + "GET /orgs/:org/members/:username": { + parameters: OrgsCheckMembershipEndpoint; + request: OrgsCheckMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#get-organization-membership + */ + "GET /orgs/:org/memberships/:username": { + parameters: OrgsGetMembershipEndpoint; + request: OrgsGetMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#list-organization-migrations + */ + "GET /orgs/:org/migrations": { + parameters: MigrationsListForOrgEndpoint; + request: MigrationsListForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#get-an-organization-migration-status + */ + "GET /orgs/:org/migrations/:migration_id": { + parameters: MigrationsGetStatusForOrgEndpoint; + request: MigrationsGetStatusForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#download-an-organization-migration-archive + */ + "GET /orgs/:org/migrations/:migration_id/archive": { + parameters: MigrationsDownloadArchiveForOrgEndpoint; + request: MigrationsDownloadArchiveForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#list-repositories-in-an-organization-migration + */ + "GET /orgs/:org/migrations/:migration_id/repositories": { + parameters: MigrationsListReposForOrgEndpoint; + request: MigrationsListReposForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/outside_collaborators/#list-outside-collaborators + */ + "GET /orgs/:org/outside_collaborators": { + parameters: OrgsListOutsideCollaboratorsEndpoint; + request: OrgsListOutsideCollaboratorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#list-organization-projects + */ + "GET /orgs/:org/projects": { + parameters: ProjectsListForOrgEndpoint; + request: ProjectsListForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#public-members-list + */ + "GET /orgs/:org/public_members": { + parameters: OrgsListPublicMembersEndpoint; + request: OrgsListPublicMembersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#check-public-membership + */ + "GET /orgs/:org/public_members/:username": { + parameters: OrgsCheckPublicMembershipEndpoint; + request: OrgsCheckPublicMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-organization-repositories + */ + "GET /orgs/:org/repos": { + parameters: ReposListForOrgEndpoint; + request: ReposListForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#list-idp-groups-for-an-organization + */ + "GET /orgs/:org/team-sync/groups": { + parameters: TeamsListIdPGroupsForOrgEndpoint; + request: TeamsListIdPGroupsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-teams + */ + "GET /orgs/:org/teams": { + parameters: TeamsListEndpoint; + request: TeamsListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#get-a-team-by-name + */ + "GET /orgs/:org/teams/:team_slug": { + parameters: TeamsGetByNameEndpoint; + request: TeamsGetByNameRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#list-discussions + */ + "GET /orgs/:org/teams/:team_slug/discussions": { + parameters: TeamsListDiscussionsInOrgEndpoint; + request: TeamsListDiscussionsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#get-a-discussion + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number": { + parameters: TeamsGetDiscussionInOrgEndpoint; + request: TeamsGetDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#list-discussion-comments + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments": { + parameters: TeamsListDiscussionCommentsInOrgEndpoint; + request: TeamsListDiscussionCommentsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#get-a-discussion-comment + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsGetDiscussionCommentInOrgEndpoint; + request: TeamsGetDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions": { + parameters: ReactionsListForTeamDiscussionCommentInOrgEndpoint; + request: ReactionsListForTeamDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions": { + parameters: ReactionsListForTeamDiscussionInOrgEndpoint; + request: ReactionsListForTeamDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#list-pending-team-invitations + */ + "GET /orgs/:org/teams/:team_slug/invitations": { + parameters: TeamsListPendingInvitationsInOrgEndpoint; + request: TeamsListPendingInvitationsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#list-team-members + */ + "GET /orgs/:org/teams/:team_slug/members": { + parameters: TeamsListMembersInOrgEndpoint; + request: TeamsListMembersInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#get-team-membership-for-a-user + */ + "GET /orgs/:org/teams/:team_slug/memberships/:username": { + parameters: TeamsGetMembershipForUserInOrgEndpoint; + request: TeamsGetMembershipForUserInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-team-projects + */ + "GET /orgs/:org/teams/:team_slug/projects": { + parameters: TeamsListProjectsInOrgEndpoint; + request: TeamsListProjectsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#check-team-permissions-for-a-project + */ + "GET /orgs/:org/teams/:team_slug/projects/:project_id": { + parameters: TeamsCheckPermissionsForProjectInOrgEndpoint; + request: TeamsCheckPermissionsForProjectInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-team-repositories + */ + "GET /orgs/:org/teams/:team_slug/repos": { + parameters: TeamsListReposInOrgEndpoint; + request: TeamsListReposInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#check-team-permissions-for-a-repository + */ + "GET /orgs/:org/teams/:team_slug/repos/:owner/:repo": { + parameters: TeamsCheckPermissionsForRepoInOrgEndpoint; + request: TeamsCheckPermissionsForRepoInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#list-idp-groups-for-a-team + */ + "GET /orgs/:org/teams/:team_slug/team-sync/group-mappings": { + parameters: TeamsListIdPGroupsInOrgEndpoint; + request: TeamsListIdPGroupsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-child-teams + */ + "GET /orgs/:org/teams/:team_slug/teams": { + parameters: TeamsListChildInOrgEndpoint; + request: TeamsListChildInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#get-a-project + */ + "GET /projects/:project_id": { + parameters: ProjectsGetEndpoint; + request: ProjectsGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/collaborators/#list-collaborators + */ + "GET /projects/:project_id/collaborators": { + parameters: ProjectsListCollaboratorsEndpoint; + request: ProjectsListCollaboratorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/collaborators/#review-a-users-permission-level + */ + "GET /projects/:project_id/collaborators/:username/permission": { + parameters: ProjectsReviewUserPermissionLevelEndpoint; + request: ProjectsReviewUserPermissionLevelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#list-project-columns + */ + "GET /projects/:project_id/columns": { + parameters: ProjectsListColumnsEndpoint; + request: ProjectsListColumnsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#get-a-project-column + */ + "GET /projects/columns/:column_id": { + parameters: ProjectsGetColumnEndpoint; + request: ProjectsGetColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#list-project-cards + */ + "GET /projects/columns/:column_id/cards": { + parameters: ProjectsListCardsEndpoint; + request: ProjectsListCardsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#get-a-project-card + */ + "GET /projects/columns/cards/:card_id": { + parameters: ProjectsGetCardEndpoint; + request: ProjectsGetCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status + */ + "GET /rate_limit": { + parameters: RateLimitGetEndpoint; + request: RateLimitGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#get-a-repository + */ + "GET /repos/:owner/:repo": { + parameters: ReposGetEndpoint; + request: ReposGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#get-archive-link + */ + "GET /repos/:owner/:repo/:archive_format/:ref": { + parameters: ReposGetArchiveLinkEndpoint; + request: ReposGetArchiveLinkRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#list-artifacts-for-a-repository + */ + "GET /repos/:owner/:repo/actions/artifacts": { + parameters: ActionsListArtifactsForRepoEndpoint; + request: ActionsListArtifactsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#get-an-artifact + */ + "GET /repos/:owner/:repo/actions/artifacts/:artifact_id": { + parameters: ActionsGetArtifactEndpoint; + request: ActionsGetArtifactRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#download-an-artifact + */ + "GET /repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format": { + parameters: ActionsDownloadArtifactEndpoint; + request: ActionsDownloadArtifactRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-jobs/#get-a-workflow-job + */ + "GET /repos/:owner/:repo/actions/jobs/:job_id": { + parameters: ActionsGetWorkflowJobEndpoint; + request: ActionsGetWorkflowJobRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-jobs/#download-workflow-job-logs + */ + "GET /repos/:owner/:repo/actions/jobs/:job_id/logs": { + parameters: ActionsDownloadWorkflowJobLogsEndpoint; + request: ActionsDownloadWorkflowJobLogsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#list-self-hosted-runners-for-a-repository + */ + "GET /repos/:owner/:repo/actions/runners": { + parameters: ActionsListSelfHostedRunnersForRepoEndpoint; + request: ActionsListSelfHostedRunnersForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#get-a-self-hosted-runner-for-a-repository + */ + "GET /repos/:owner/:repo/actions/runners/:runner_id": { + parameters: ActionsGetSelfHostedRunnerForRepoEndpoint; + request: ActionsGetSelfHostedRunnerForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#list-runner-applications-for-a-repository + */ + "GET /repos/:owner/:repo/actions/runners/downloads": { + parameters: ActionsListRunnerApplicationsForRepoEndpoint; + request: ActionsListRunnerApplicationsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#list-repository-workflow-runs + */ + "GET /repos/:owner/:repo/actions/runs": { + parameters: ActionsListRepoWorkflowRunsEndpoint; + request: ActionsListRepoWorkflowRunsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#get-a-workflow-run + */ + "GET /repos/:owner/:repo/actions/runs/:run_id": { + parameters: ActionsGetWorkflowRunEndpoint; + request: ActionsGetWorkflowRunRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#list-workflow-run-artifacts + */ + "GET /repos/:owner/:repo/actions/runs/:run_id/artifacts": { + parameters: ActionsListWorkflowRunArtifactsEndpoint; + request: ActionsListWorkflowRunArtifactsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-jobs/#list-jobs-for-a-workflow-run + */ + "GET /repos/:owner/:repo/actions/runs/:run_id/jobs": { + parameters: ActionsListJobsForWorkflowRunEndpoint; + request: ActionsListJobsForWorkflowRunRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#download-workflow-run-logs + */ + "GET /repos/:owner/:repo/actions/runs/:run_id/logs": { + parameters: ActionsDownloadWorkflowRunLogsEndpoint; + request: ActionsDownloadWorkflowRunLogsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#get-workflow-run-usage + */ + "GET /repos/:owner/:repo/actions/runs/:run_id/timing": { + parameters: ActionsGetWorkflowRunUsageEndpoint; + request: ActionsGetWorkflowRunUsageRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#list-repository-secrets + */ + "GET /repos/:owner/:repo/actions/secrets": { + parameters: ActionsListRepoSecretsEndpoint; + request: ActionsListRepoSecretsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#get-a-repository-secret + */ + "GET /repos/:owner/:repo/actions/secrets/:secret_name": { + parameters: ActionsGetRepoSecretEndpoint; + request: ActionsGetRepoSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#get-a-repository-public-key + */ + "GET /repos/:owner/:repo/actions/secrets/public-key": { + parameters: ActionsGetRepoPublicKeyEndpoint; + request: ActionsGetRepoPublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflows/#list-repository-workflows + */ + "GET /repos/:owner/:repo/actions/workflows": { + parameters: ActionsListRepoWorkflowsEndpoint; + request: ActionsListRepoWorkflowsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflows/#get-a-workflow + */ + "GET /repos/:owner/:repo/actions/workflows/:workflow_id": { + parameters: ActionsGetWorkflowEndpoint; + request: ActionsGetWorkflowRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#list-workflow-runs + */ + "GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs": { + parameters: ActionsListWorkflowRunsEndpoint; + request: ActionsListWorkflowRunsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflows/#get-workflow-usage + */ + "GET /repos/:owner/:repo/actions/workflows/:workflow_id/timing": { + parameters: ActionsGetWorkflowUsageEndpoint; + request: ActionsGetWorkflowUsageRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/assignees/#list-assignees + */ + "GET /repos/:owner/:repo/assignees": { + parameters: IssuesListAssigneesEndpoint; + request: IssuesListAssigneesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/assignees/#check-if-a-user-can-be-assigned + */ + "GET /repos/:owner/:repo/assignees/:assignee": { + parameters: IssuesCheckUserCanBeAssignedEndpoint; + request: IssuesCheckUserCanBeAssignedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-branches + */ + "GET /repos/:owner/:repo/branches": { + parameters: ReposListBranchesEndpoint; + request: ReposListBranchesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-branch + */ + "GET /repos/:owner/:repo/branches/:branch": { + parameters: ReposGetBranchEndpoint; + request: ReposGetBranchRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-branch-protection + */ + "GET /repos/:owner/:repo/branches/:branch/protection": { + parameters: ReposGetBranchProtectionEndpoint; + request: ReposGetBranchProtectionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-admin-enforcement-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins": { + parameters: ReposGetProtectedBranchAdminEnforcementEndpoint; + request: ReposGetProtectedBranchAdminEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": { + parameters: ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint; + request: ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-required-signatures-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/required_signatures": { + parameters: ReposGetProtectedBranchRequiredSignaturesEndpoint; + request: ReposGetProtectedBranchRequiredSignaturesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-required-status-checks-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks": { + parameters: ReposGetProtectedBranchRequiredStatusChecksEndpoint; + request: ReposGetProtectedBranchRequiredStatusChecksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": { + parameters: ReposListProtectedBranchRequiredStatusChecksContextsEndpoint; + request: ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-restrictions-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions": { + parameters: ReposGetProtectedBranchRestrictionsEndpoint; + request: ReposGetProtectedBranchRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-apps-with-access-to-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": { + parameters: ReposGetAppsWithAccessToProtectedBranchEndpoint; + request: ReposGetAppsWithAccessToProtectedBranchRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-teams-with-access-to-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": { + parameters: ReposGetTeamsWithAccessToProtectedBranchEndpoint; + request: ReposGetTeamsWithAccessToProtectedBranchRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-users-with-access-to-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users": { + parameters: ReposGetUsersWithAccessToProtectedBranchEndpoint; + request: ReposGetUsersWithAccessToProtectedBranchRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#get-a-check-run + */ + "GET /repos/:owner/:repo/check-runs/:check_run_id": { + parameters: ChecksGetEndpoint; + request: ChecksGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#list-check-run-annotations + */ + "GET /repos/:owner/:repo/check-runs/:check_run_id/annotations": { + parameters: ChecksListAnnotationsEndpoint; + request: ChecksListAnnotationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#get-a-check-suite + */ + "GET /repos/:owner/:repo/check-suites/:check_suite_id": { + parameters: ChecksGetSuiteEndpoint; + request: ChecksGetSuiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#list-check-runs-in-a-check-suite + */ + "GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs": { + parameters: ChecksListForSuiteEndpoint; + request: ChecksListForSuiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/code-scanning/#list-code-scanning-alerts-for-a-repository + */ + "GET /repos/:owner/:repo/code-scanning/alerts": { + parameters: CodeScanningListAlertsForRepoEndpoint; + request: CodeScanningListAlertsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/code-scanning/#get-a-code-scanning-alert + */ + "GET /repos/:owner/:repo/code-scanning/alerts/:alert_id": { + parameters: CodeScanningGetAlertEndpoint; + request: CodeScanningGetAlertRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#list-collaborators + */ + "GET /repos/:owner/:repo/collaborators": { + parameters: ReposListCollaboratorsEndpoint; + request: ReposListCollaboratorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator + */ + "GET /repos/:owner/:repo/collaborators/:username": { + parameters: ReposCheckCollaboratorEndpoint; + request: ReposCheckCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level + */ + "GET /repos/:owner/:repo/collaborators/:username/permission": { + parameters: ReposGetCollaboratorPermissionLevelEndpoint; + request: ReposGetCollaboratorPermissionLevelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository + */ + "GET /repos/:owner/:repo/comments": { + parameters: ReposListCommitCommentsEndpoint; + request: ReposListCommitCommentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment + */ + "GET /repos/:owner/:repo/comments/:comment_id": { + parameters: ReposGetCommitCommentEndpoint; + request: ReposGetCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment + */ + "GET /repos/:owner/:repo/comments/:comment_id/reactions": { + parameters: ReactionsListForCommitCommentEndpoint; + request: ReactionsListForCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository + */ + "GET /repos/:owner/:repo/commits": { + parameters: ReposListCommitsEndpoint; + request: ReposListCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#list-branches-for-head-commit + */ + "GET /repos/:owner/:repo/commits/:commit_sha/branches-where-head": { + parameters: ReposListBranchesForHeadCommitEndpoint; + request: ReposListBranchesForHeadCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit + */ + "GET /repos/:owner/:repo/commits/:commit_sha/comments": { + parameters: ReposListCommentsForCommitEndpoint; + request: ReposListCommentsForCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#list-pull-requests-associated-with-commit + */ + "GET /repos/:owner/:repo/commits/:commit_sha/pulls": { + parameters: ReposListPullRequestsAssociatedWithCommitEndpoint; + request: ReposListPullRequestsAssociatedWithCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#get-a-single-commit + */ + "GET /repos/:owner/:repo/commits/:ref": { + parameters: ReposGetCommitEndpoint; + request: ReposGetCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-git-reference + */ + "GET /repos/:owner/:repo/commits/:ref/check-runs": { + parameters: ChecksListForRefEndpoint; + request: ChecksListForRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-git-reference + */ + "GET /repos/:owner/:repo/commits/:ref/check-suites": { + parameters: ChecksListSuitesForRefEndpoint; + request: ChecksListSuitesForRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + */ + "GET /repos/:owner/:repo/commits/:ref/status": { + parameters: ReposGetCombinedStatusForRefEndpoint; + request: ReposGetCombinedStatusForRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref + */ + "GET /repos/:owner/:repo/commits/:ref/statuses": { + parameters: ReposListStatusesForRefEndpoint; + request: ReposListStatusesForRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct + */ + "GET /repos/:owner/:repo/community/code_of_conduct": { + parameters: CodesOfConductGetForRepoEndpoint; + request: CodesOfConductGetForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics + */ + "GET /repos/:owner/:repo/community/profile": { + parameters: ReposRetrieveCommunityProfileMetricsEndpoint; + request: ReposRetrieveCommunityProfileMetricsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#compare-two-commits + */ + "GET /repos/:owner/:repo/compare/:base...:head": { + parameters: ReposCompareCommitsEndpoint; + request: ReposCompareCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#get-contents + */ + "GET /repos/:owner/:repo/contents/:path": { + parameters: ReposGetContentsEndpoint; + request: ReposGetContentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-contributors + */ + "GET /repos/:owner/:repo/contributors": { + parameters: ReposListContributorsEndpoint; + request: ReposListContributorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#list-deployments + */ + "GET /repos/:owner/:repo/deployments": { + parameters: ReposListDeploymentsEndpoint; + request: ReposListDeploymentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#get-a-single-deployment + */ + "GET /repos/:owner/:repo/deployments/:deployment_id": { + parameters: ReposGetDeploymentEndpoint; + request: ReposGetDeploymentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#list-deployment-statuses + */ + "GET /repos/:owner/:repo/deployments/:deployment_id/statuses": { + parameters: ReposListDeploymentStatusesEndpoint; + request: ReposListDeploymentStatusesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#get-a-single-deployment-status + */ + "GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id": { + parameters: ReposGetDeploymentStatusEndpoint; + request: ReposGetDeploymentStatusRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository + */ + "GET /repos/:owner/:repo/downloads": { + parameters: ReposListDownloadsEndpoint; + request: ReposListDownloadsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/downloads/#get-a-single-download + */ + "GET /repos/:owner/:repo/downloads/:download_id": { + parameters: ReposGetDownloadEndpoint; + request: ReposGetDownloadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-repository-events + */ + "GET /repos/:owner/:repo/events": { + parameters: ActivityListRepoEventsEndpoint; + request: ActivityListRepoEventsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/forks/#list-forks + */ + "GET /repos/:owner/:repo/forks": { + parameters: ReposListForksEndpoint; + request: ReposListForksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/blobs/#get-a-blob + */ + "GET /repos/:owner/:repo/git/blobs/:file_sha": { + parameters: GitGetBlobEndpoint; + request: GitGetBlobRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/commits/#get-a-commit + */ + "GET /repos/:owner/:repo/git/commits/:commit_sha": { + parameters: GitGetCommitEndpoint; + request: GitGetCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#list-matching-references + */ + "GET /repos/:owner/:repo/git/matching-refs/:ref": { + parameters: GitListMatchingRefsEndpoint; + request: GitListMatchingRefsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#get-a-reference + */ + "GET /repos/:owner/:repo/git/ref/:ref": { + parameters: GitGetRefEndpoint; + request: GitGetRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/tags/#get-a-tag + */ + "GET /repos/:owner/:repo/git/tags/:tag_sha": { + parameters: GitGetTagEndpoint; + request: GitGetTagRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/trees/#get-a-tree + */ + "GET /repos/:owner/:repo/git/trees/:tree_sha": { + parameters: GitGetTreeEndpoint; + request: GitGetTreeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#list-hooks + */ + "GET /repos/:owner/:repo/hooks": { + parameters: ReposListHooksEndpoint; + request: ReposListHooksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#get-single-hook + */ + "GET /repos/:owner/:repo/hooks/:hook_id": { + parameters: ReposGetHookEndpoint; + request: ReposGetHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#get-an-import-status + */ + "GET /repos/:owner/:repo/import": { + parameters: MigrationsGetImportStatusEndpoint; + request: MigrationsGetImportStatusRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#get-commit-authors + */ + "GET /repos/:owner/:repo/import/authors": { + parameters: MigrationsGetCommitAuthorsEndpoint; + request: MigrationsGetCommitAuthorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#get-large-files + */ + "GET /repos/:owner/:repo/import/large_files": { + parameters: MigrationsGetLargeFilesEndpoint; + request: MigrationsGetLargeFilesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-a-repository-installation + */ + "GET /repos/:owner/:repo/installation": { + parameters: AppsGetRepoInstallationEndpoint; + request: AppsGetRepoInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/repos/#get-interaction-restrictions-for-a-repository + */ + "GET /repos/:owner/:repo/interaction-limits": { + parameters: InteractionsGetRestrictionsForRepoEndpoint; + request: InteractionsGetRestrictionsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository + */ + "GET /repos/:owner/:repo/invitations": { + parameters: ReposListInvitationsEndpoint; + request: ReposListInvitationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#list-repository-issues + */ + "GET /repos/:owner/:repo/issues": { + parameters: IssuesListForRepoEndpoint; + request: IssuesListForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#get-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number": { + parameters: IssuesGetEndpoint; + request: IssuesGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#list-issue-comments + */ + "GET /repos/:owner/:repo/issues/:issue_number/comments": { + parameters: IssuesListCommentsEndpoint; + request: IssuesListCommentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/events/#list-issue-events + */ + "GET /repos/:owner/:repo/issues/:issue_number/events": { + parameters: IssuesListEventsEndpoint; + request: IssuesListEventsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#list-labels-for-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number/labels": { + parameters: IssuesListLabelsOnIssueEndpoint; + request: IssuesListLabelsOnIssueRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number/reactions": { + parameters: ReactionsListForIssueEndpoint; + request: ReactionsListForIssueRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/timeline/#list-timeline-events-for-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number/timeline": { + parameters: IssuesListEventsForTimelineEndpoint; + request: IssuesListEventsForTimelineRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#list-issue-comments-for-a-repository + */ + "GET /repos/:owner/:repo/issues/comments": { + parameters: IssuesListCommentsForRepoEndpoint; + request: IssuesListCommentsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#get-an-issue-comment + */ + "GET /repos/:owner/:repo/issues/comments/:comment_id": { + parameters: IssuesGetCommentEndpoint; + request: IssuesGetCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment + */ + "GET /repos/:owner/:repo/issues/comments/:comment_id/reactions": { + parameters: ReactionsListForIssueCommentEndpoint; + request: ReactionsListForIssueCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/events/#list-issue-events-for-a-repository + */ + "GET /repos/:owner/:repo/issues/events": { + parameters: IssuesListEventsForRepoEndpoint; + request: IssuesListEventsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/events/#get-an-issue-event + */ + "GET /repos/:owner/:repo/issues/events/:event_id": { + parameters: IssuesGetEventEndpoint; + request: IssuesGetEventRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/keys/#list-deploy-keys + */ + "GET /repos/:owner/:repo/keys": { + parameters: ReposListDeployKeysEndpoint; + request: ReposListDeployKeysRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/keys/#get-a-deploy-key + */ + "GET /repos/:owner/:repo/keys/:key_id": { + parameters: ReposGetDeployKeyEndpoint; + request: ReposGetDeployKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#list-labels-for-a-repository + */ + "GET /repos/:owner/:repo/labels": { + parameters: IssuesListLabelsForRepoEndpoint; + request: IssuesListLabelsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#get-a-label + */ + "GET /repos/:owner/:repo/labels/:name": { + parameters: IssuesGetLabelEndpoint; + request: IssuesGetLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-languages + */ + "GET /repos/:owner/:repo/languages": { + parameters: ReposListLanguagesEndpoint; + request: ReposListLanguagesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license + */ + "GET /repos/:owner/:repo/license": { + parameters: LicensesGetForRepoEndpoint; + request: LicensesGetForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#list-milestones + */ + "GET /repos/:owner/:repo/milestones": { + parameters: IssuesListMilestonesEndpoint; + request: IssuesListMilestonesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#get-a-milestone + */ + "GET /repos/:owner/:repo/milestones/:milestone_number": { + parameters: IssuesGetMilestoneEndpoint; + request: IssuesGetMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#list-labels-for-issues-in-a-milestone + */ + "GET /repos/:owner/:repo/milestones/:milestone_number/labels": { + parameters: IssuesListLabelsForMilestoneEndpoint; + request: IssuesListLabelsForMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#list-repository-notifications-for-the-authenticated-user + */ + "GET /repos/:owner/:repo/notifications": { + parameters: ActivityListRepoNotificationsForAuthenticatedUserEndpoint; + request: ActivityListRepoNotificationsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site + */ + "GET /repos/:owner/:repo/pages": { + parameters: ReposGetPagesEndpoint; + request: ReposGetPagesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#list-pages-builds + */ + "GET /repos/:owner/:repo/pages/builds": { + parameters: ReposListPagesBuildsEndpoint; + request: ReposListPagesBuildsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#get-a-specific-pages-build + */ + "GET /repos/:owner/:repo/pages/builds/:build_id": { + parameters: ReposGetPagesBuildEndpoint; + request: ReposGetPagesBuildRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#get-latest-pages-build + */ + "GET /repos/:owner/:repo/pages/builds/latest": { + parameters: ReposGetLatestPagesBuildEndpoint; + request: ReposGetLatestPagesBuildRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#list-repository-projects + */ + "GET /repos/:owner/:repo/projects": { + parameters: ProjectsListForRepoEndpoint; + request: ProjectsListForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#list-pull-requests + */ + "GET /repos/:owner/:repo/pulls": { + parameters: PullsListEndpoint; + request: PullsListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#get-a-single-pull-request + */ + "GET /repos/:owner/:repo/pulls/:pull_number": { + parameters: PullsGetEndpoint; + request: PullsGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request + */ + "GET /repos/:owner/:repo/pulls/:pull_number/comments": { + parameters: PullsListCommentsEndpoint; + request: PullsListCommentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request + */ + "GET /repos/:owner/:repo/pulls/:pull_number/commits": { + parameters: PullsListCommitsEndpoint; + request: PullsListCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#list-pull-requests-files + */ + "GET /repos/:owner/:repo/pulls/:pull_number/files": { + parameters: PullsListFilesEndpoint; + request: PullsListFilesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged + */ + "GET /repos/:owner/:repo/pulls/:pull_number/merge": { + parameters: PullsCheckIfMergedEndpoint; + request: PullsCheckIfMergedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/review_requests/#list-review-requests + */ + "GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": { + parameters: PullsListReviewRequestsEndpoint; + request: PullsListReviewRequestsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request + */ + "GET /repos/:owner/:repo/pulls/:pull_number/reviews": { + parameters: PullsListReviewsEndpoint; + request: PullsListReviewsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#get-a-single-review + */ + "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": { + parameters: PullsGetReviewEndpoint; + request: PullsGetReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review + */ + "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments": { + parameters: PullsGetCommentsForReviewEndpoint; + request: PullsGetCommentsForReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + */ + "GET /repos/:owner/:repo/pulls/comments": { + parameters: PullsListCommentsForRepoEndpoint; + request: PullsListCommentsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#get-a-single-comment + */ + "GET /repos/:owner/:repo/pulls/comments/:comment_id": { + parameters: PullsGetCommentEndpoint; + request: PullsGetCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment + */ + "GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions": { + parameters: ReactionsListForPullRequestReviewCommentEndpoint; + request: ReactionsListForPullRequestReviewCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#get-the-readme + */ + "GET /repos/:owner/:repo/readme": { + parameters: ReposGetReadmeEndpoint; + request: ReposGetReadmeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository + */ + "GET /repos/:owner/:repo/releases": { + parameters: ReposListReleasesEndpoint; + request: ReposListReleasesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#get-a-single-release + */ + "GET /repos/:owner/:repo/releases/:release_id": { + parameters: ReposGetReleaseEndpoint; + request: ReposGetReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#list-assets-for-a-release + */ + "GET /repos/:owner/:repo/releases/:release_id/assets": { + parameters: ReposListAssetsForReleaseEndpoint; + request: ReposListAssetsForReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#get-a-single-release-asset + */ + "GET /repos/:owner/:repo/releases/assets/:asset_id": { + parameters: ReposGetReleaseAssetEndpoint; + request: ReposGetReleaseAssetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#get-the-latest-release + */ + "GET /repos/:owner/:repo/releases/latest": { + parameters: ReposGetLatestReleaseEndpoint; + request: ReposGetLatestReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name + */ + "GET /repos/:owner/:repo/releases/tags/:tag": { + parameters: ReposGetReleaseByTagEndpoint; + request: ReposGetReleaseByTagRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#list-stargazers + */ + "GET /repos/:owner/:repo/stargazers": { + parameters: ActivityListStargazersForRepoEndpoint; + request: ActivityListStargazersForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week + */ + "GET /repos/:owner/:repo/stats/code_frequency": { + parameters: ReposGetCodeFrequencyStatsEndpoint; + request: ReposGetCodeFrequencyStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data + */ + "GET /repos/:owner/:repo/stats/commit_activity": { + parameters: ReposGetCommitActivityStatsEndpoint; + request: ReposGetCommitActivityStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts + */ + "GET /repos/:owner/:repo/stats/contributors": { + parameters: ReposGetContributorsStatsEndpoint; + request: ReposGetContributorsStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else + */ + "GET /repos/:owner/:repo/stats/participation": { + parameters: ReposGetParticipationStatsEndpoint; + request: ReposGetParticipationStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day + */ + "GET /repos/:owner/:repo/stats/punch_card": { + parameters: ReposGetPunchCardStatsEndpoint; + request: ReposGetPunchCardStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#list-watchers + */ + "GET /repos/:owner/:repo/subscribers": { + parameters: ActivityListWatchersForRepoEndpoint; + request: ActivityListWatchersForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#get-a-repository-subscription + */ + "GET /repos/:owner/:repo/subscription": { + parameters: ActivityGetRepoSubscriptionEndpoint; + request: ActivityGetRepoSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-tags + */ + "GET /repos/:owner/:repo/tags": { + parameters: ReposListTagsEndpoint; + request: ReposListTagsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-teams + */ + "GET /repos/:owner/:repo/teams": { + parameters: ReposListTeamsEndpoint; + request: ReposListTeamsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#get-all-repository-topics + */ + "GET /repos/:owner/:repo/topics": { + parameters: ReposGetAllTopicsEndpoint; + request: ReposGetAllTopicsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/traffic/#clones + */ + "GET /repos/:owner/:repo/traffic/clones": { + parameters: ReposGetClonesEndpoint; + request: ReposGetClonesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/traffic/#list-paths + */ + "GET /repos/:owner/:repo/traffic/popular/paths": { + parameters: ReposGetTopPathsEndpoint; + request: ReposGetTopPathsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/traffic/#list-referrers + */ + "GET /repos/:owner/:repo/traffic/popular/referrers": { + parameters: ReposGetTopReferrersEndpoint; + request: ReposGetTopReferrersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/traffic/#views + */ + "GET /repos/:owner/:repo/traffic/views": { + parameters: ReposGetViewsEndpoint; + request: ReposGetViewsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#check-if-vulnerability-alerts-are-enabled-for-a-repository + */ + "GET /repos/:owner/:repo/vulnerability-alerts": { + parameters: ReposCheckVulnerabilityAlertsEndpoint; + request: ReposCheckVulnerabilityAlertsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-public-repositories + */ + "GET /repositories": { + parameters: ReposListPublicEndpoint; + request: ReposListPublicRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#get-a-list-of-provisioned-identities + */ + "GET /scim/v2/organizations/:org/Users": { + parameters: ScimListProvisionedIdentitiesEndpoint; + request: ScimListProvisionedIdentitiesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#get-provisioning-details-for-a-single-user + */ + "GET /scim/v2/organizations/:org/Users/:scim_user_id": { + parameters: ScimGetProvisioningDetailsForUserEndpoint; + request: ScimGetProvisioningDetailsForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-code + */ + "GET /search/code": { + parameters: SearchCodeEndpoint; + request: SearchCodeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-commits + */ + "GET /search/commits": { + parameters: SearchCommitsEndpoint; + request: SearchCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-issues-and-pull-requests + */ + "GET /search/issues": { + parameters: SearchIssuesAndPullRequestsEndpoint; + request: SearchIssuesAndPullRequestsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-labels + */ + "GET /search/labels": { + parameters: SearchLabelsEndpoint; + request: SearchLabelsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-repositories + */ + "GET /search/repositories": { + parameters: SearchReposEndpoint; + request: SearchReposRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-topics + */ + "GET /search/topics": { + parameters: SearchTopicsEndpoint; + request: SearchTopicsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-users + */ + "GET /search/users": { + parameters: SearchUsersEndpoint; + request: SearchUsersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#get-a-team-legacy + */ + "GET /teams/:team_id": { + parameters: TeamsGetLegacyEndpoint; + request: TeamsGetLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#list-discussions-legacy + */ + "GET /teams/:team_id/discussions": { + parameters: TeamsListDiscussionsLegacyEndpoint; + request: TeamsListDiscussionsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#get-a-discussion-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number": { + parameters: TeamsGetDiscussionLegacyEndpoint; + request: TeamsGetDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#list-discussion-comments-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number/comments": { + parameters: TeamsListDiscussionCommentsLegacyEndpoint; + request: TeamsListDiscussionCommentsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#get-a-discussion-comment-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsGetDiscussionCommentLegacyEndpoint; + request: TeamsGetDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": { + parameters: ReactionsListForTeamDiscussionCommentLegacyEndpoint; + request: ReactionsListForTeamDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number/reactions": { + parameters: ReactionsListForTeamDiscussionLegacyEndpoint; + request: ReactionsListForTeamDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy + */ + "GET /teams/:team_id/invitations": { + parameters: TeamsListPendingInvitationsLegacyEndpoint; + request: TeamsListPendingInvitationsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#list-team-members-legacy + */ + "GET /teams/:team_id/members": { + parameters: TeamsListMembersLegacyEndpoint; + request: TeamsListMembersLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#get-team-member-legacy + */ + "GET /teams/:team_id/members/:username": { + parameters: TeamsGetMemberLegacyEndpoint; + request: TeamsGetMemberLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#get-team-membership-for-a-user-legacy + */ + "GET /teams/:team_id/memberships/:username": { + parameters: TeamsGetMembershipForUserLegacyEndpoint; + request: TeamsGetMembershipForUserLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-team-projects-legacy + */ + "GET /teams/:team_id/projects": { + parameters: TeamsListProjectsLegacyEndpoint; + request: TeamsListProjectsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#check-team-permissions-for-a-project-legacy + */ + "GET /teams/:team_id/projects/:project_id": { + parameters: TeamsCheckPermissionsForProjectLegacyEndpoint; + request: TeamsCheckPermissionsForProjectLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-team-repositories-legacy + */ + "GET /teams/:team_id/repos": { + parameters: TeamsListReposLegacyEndpoint; + request: TeamsListReposLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#check-team-permissions-for-a-repository-legacy + */ + "GET /teams/:team_id/repos/:owner/:repo": { + parameters: TeamsCheckPermissionsForRepoLegacyEndpoint; + request: TeamsCheckPermissionsForRepoLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#list-idp-groups-for-a-team-legacy + */ + "GET /teams/:team_id/team-sync/group-mappings": { + parameters: TeamsListIdPGroupsForLegacyEndpoint; + request: TeamsListIdPGroupsForLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-child-teams-legacy + */ + "GET /teams/:team_id/teams": { + parameters: TeamsListChildLegacyEndpoint; + request: TeamsListChildLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#get-the-authenticated-user + */ + "GET /user": { + parameters: UsersGetAuthenticatedEndpoint; + request: UsersGetAuthenticatedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#list-repositories-for-a-user-migration + */ + "GET /user/:migration_id/repositories": { + parameters: MigrationsListReposForUserEndpoint; + request: MigrationsListReposForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/blocking/#list-blocked-users + */ + "GET /user/blocks": { + parameters: UsersListBlockedEndpoint; + request: UsersListBlockedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/blocking/#check-whether-youve-blocked-a-user + */ + "GET /user/blocks/:username": { + parameters: UsersCheckBlockedEndpoint; + request: UsersCheckBlockedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user + */ + "GET /user/emails": { + parameters: UsersListEmailsEndpoint; + request: UsersListEmailsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#list-followers-of-the-authenticated-user + */ + "GET /user/followers": { + parameters: UsersListFollowersForAuthenticatedUserEndpoint; + request: UsersListFollowersForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#list-users-followed-by-the-authenticated-user + */ + "GET /user/following": { + parameters: UsersListFollowedByAuthenticatedEndpoint; + request: UsersListFollowedByAuthenticatedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user + */ + "GET /user/following/:username": { + parameters: UsersCheckFollowingEndpoint; + request: UsersCheckFollowingRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#list-your-gpg-keys + */ + "GET /user/gpg_keys": { + parameters: UsersListGpgKeysEndpoint; + request: UsersListGpgKeysRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#get-a-single-gpg-key + */ + "GET /user/gpg_keys/:gpg_key_id": { + parameters: UsersGetGpgKeyEndpoint; + request: UsersGetGpgKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#list-installations-for-a-user + */ + "GET /user/installations": { + parameters: AppsListInstallationsForAuthenticatedUserEndpoint; + request: AppsListInstallationsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation + */ + "GET /user/installations/:installation_id/repositories": { + parameters: AppsListInstallationReposForAuthenticatedUserEndpoint; + request: AppsListInstallationReposForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#list-user-account-issues-assigned-to-the-authenticated-user + */ + "GET /user/issues": { + parameters: IssuesListForAuthenticatedUserEndpoint; + request: IssuesListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#list-your-public-keys + */ + "GET /user/keys": { + parameters: UsersListPublicKeysEndpoint; + request: UsersListPublicKeysRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#get-a-single-public-key + */ + "GET /user/keys/:key_id": { + parameters: UsersGetPublicKeyEndpoint; + request: UsersGetPublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-subscriptions-for-the-authenticated-user + */ + "GET /user/marketplace_purchases": { + parameters: AppsListSubscriptionsForAuthenticatedUserEndpoint; + request: AppsListSubscriptionsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-subscriptions-for-the-authenticated-user-stubbed + */ + "GET /user/marketplace_purchases/stubbed": { + parameters: AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint; + request: AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#list-your-organization-memberships + */ + "GET /user/memberships/orgs": { + parameters: OrgsListMembershipsEndpoint; + request: OrgsListMembershipsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#get-your-organization-membership + */ + "GET /user/memberships/orgs/:org": { + parameters: OrgsGetMembershipForAuthenticatedUserEndpoint; + request: OrgsGetMembershipForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#list-user-migrations + */ + "GET /user/migrations": { + parameters: MigrationsListForAuthenticatedUserEndpoint; + request: MigrationsListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#get-a-user-migration-status + */ + "GET /user/migrations/:migration_id": { + parameters: MigrationsGetStatusForAuthenticatedUserEndpoint; + request: MigrationsGetStatusForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#download-a-user-migration-archive + */ + "GET /user/migrations/:migration_id/archive": { + parameters: MigrationsGetArchiveForAuthenticatedUserEndpoint; + request: MigrationsGetArchiveForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-your-organizations + */ + "GET /user/orgs": { + parameters: OrgsListForAuthenticatedUserEndpoint; + request: OrgsListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#list-public-email-addresses-for-a-user + */ + "GET /user/public_emails": { + parameters: UsersListPublicEmailsEndpoint; + request: UsersListPublicEmailsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-repositories-for-the-authenticated-user + */ + "GET /user/repos": { + parameters: ReposListForAuthenticatedUserEndpoint; + request: ReposListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations + */ + "GET /user/repository_invitations": { + parameters: ReposListInvitationsForAuthenticatedUserEndpoint; + request: ReposListInvitationsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#list-repositories-starred-by-the-authenticated-user + */ + "GET /user/starred": { + parameters: ActivityListReposStarredByAuthenticatedUserEndpoint; + request: ActivityListReposStarredByAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#check-if-a-repository-is-starred-by-the-authenticated-user + */ + "GET /user/starred/:owner/:repo": { + parameters: ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint; + request: ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#list-repositories-watched-by-the-authenticated-user + */ + "GET /user/subscriptions": { + parameters: ActivityListWatchedReposForAuthenticatedUserEndpoint; + request: ActivityListWatchedReposForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-teams-for-the-authenticated-user + */ + "GET /user/teams": { + parameters: TeamsListForAuthenticatedUserEndpoint; + request: TeamsListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#get-all-users + */ + "GET /users": { + parameters: UsersListEndpoint; + request: UsersListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#get-a-single-user + */ + "GET /users/:username": { + parameters: UsersGetByUsernameEndpoint; + request: UsersGetByUsernameRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-events-for-the-authenticated-user + */ + "GET /users/:username/events": { + parameters: ActivityListEventsForAuthenticatedUserEndpoint; + request: ActivityListEventsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-organization-events-for-the-authenticated-user + */ + "GET /users/:username/events/orgs/:org": { + parameters: ActivityListOrgEventsForAuthenticatedUserEndpoint; + request: ActivityListOrgEventsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-events-for-a-user + */ + "GET /users/:username/events/public": { + parameters: ActivityListPublicEventsForUserEndpoint; + request: ActivityListPublicEventsForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#list-followers-of-a-user + */ + "GET /users/:username/followers": { + parameters: UsersListFollowersForUserEndpoint; + request: UsersListFollowersForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user + */ + "GET /users/:username/following": { + parameters: UsersListFollowingForUserEndpoint; + request: UsersListFollowingForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#check-if-one-user-follows-another + */ + "GET /users/:username/following/:target_user": { + parameters: UsersCheckFollowingForUserEndpoint; + request: UsersCheckFollowingForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-gists-for-a-user + */ + "GET /users/:username/gists": { + parameters: GistsListForUserEndpoint; + request: GistsListForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#list-gpg-keys-for-a-user + */ + "GET /users/:username/gpg_keys": { + parameters: UsersListGpgKeysForUserEndpoint; + request: UsersListGpgKeysForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#get-contextual-information-about-a-user + */ + "GET /users/:username/hovercard": { + parameters: UsersGetContextForUserEndpoint; + request: UsersGetContextForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-a-user-installation + */ + "GET /users/:username/installation": { + parameters: AppsGetUserInstallationEndpoint; + request: AppsGetUserInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user + */ + "GET /users/:username/keys": { + parameters: UsersListPublicKeysForUserEndpoint; + request: UsersListPublicKeysForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-user-organizations + */ + "GET /users/:username/orgs": { + parameters: OrgsListForUserEndpoint; + request: OrgsListForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#list-user-projects + */ + "GET /users/:username/projects": { + parameters: ProjectsListForUserEndpoint; + request: ProjectsListForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-events-received-by-the-authenticated-user + */ + "GET /users/:username/received_events": { + parameters: ActivityListReceivedEventsForUserEndpoint; + request: ActivityListReceivedEventsForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-events-received-by-a-user + */ + "GET /users/:username/received_events/public": { + parameters: ActivityListReceivedPublicEventsForUserEndpoint; + request: ActivityListReceivedPublicEventsForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-repositories-for-a-user + */ + "GET /users/:username/repos": { + parameters: ReposListForUserEndpoint; + request: ReposListForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#list-repositories-starred-by-a-user + */ + "GET /users/:username/starred": { + parameters: ActivityListReposStarredByUserEndpoint; + request: ActivityListReposStarredByUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#list-repositories-watched-by-a-user + */ + "GET /users/:username/subscriptions": { + parameters: ActivityListReposWatchedByUserEndpoint; + request: ActivityListReposWatchedByUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#reset-a-token + */ + "PATCH /applications/:client_id/token": { + parameters: AppsResetTokenEndpoint; + request: AppsResetTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization + */ + "PATCH /authorizations/:authorization_id": { + parameters: OauthAuthorizationsUpdateAuthorizationEndpoint; + request: OauthAuthorizationsUpdateAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#update-a-gist + */ + "PATCH /gists/:gist_id": { + parameters: GistsUpdateEndpoint; + request: GistsUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#update-a-gist-comment + */ + "PATCH /gists/:gist_id/comments/:comment_id": { + parameters: GistsUpdateCommentEndpoint; + request: GistsUpdateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read + */ + "PATCH /notifications/threads/:thread_id": { + parameters: ActivityMarkThreadAsReadEndpoint; + request: ActivityMarkThreadAsReadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#edit-an-organization + */ + "PATCH /orgs/:org": { + parameters: OrgsUpdateEndpoint; + request: OrgsUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#edit-a-hook + */ + "PATCH /orgs/:org/hooks/:hook_id": { + parameters: OrgsUpdateHookEndpoint; + request: OrgsUpdateHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#update-a-team + */ + "PATCH /orgs/:org/teams/:team_slug": { + parameters: TeamsUpdateInOrgEndpoint; + request: TeamsUpdateInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#update-a-discussion + */ + "PATCH /orgs/:org/teams/:team_slug/discussions/:discussion_number": { + parameters: TeamsUpdateDiscussionInOrgEndpoint; + request: TeamsUpdateDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#update-a-discussion-comment + */ + "PATCH /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsUpdateDiscussionCommentInOrgEndpoint; + request: TeamsUpdateDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#create-or-update-idp-group-connections + */ + "PATCH /orgs/:org/teams/:team_slug/team-sync/group-mappings": { + parameters: TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint; + request: TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#update-a-project + */ + "PATCH /projects/:project_id": { + parameters: ProjectsUpdateEndpoint; + request: ProjectsUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#update-a-project-column + */ + "PATCH /projects/columns/:column_id": { + parameters: ProjectsUpdateColumnEndpoint; + request: ProjectsUpdateColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#update-a-project-card + */ + "PATCH /projects/columns/cards/:card_id": { + parameters: ProjectsUpdateCardEndpoint; + request: ProjectsUpdateCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#update-a-repository + */ + "PATCH /repos/:owner/:repo": { + parameters: ReposUpdateEndpoint; + request: ReposUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch + */ + "PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": { + parameters: ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint; + request: ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#update-required-status-checks-of-protected-branch + */ + "PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks": { + parameters: ReposUpdateProtectedBranchRequiredStatusChecksEndpoint; + request: ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#update-a-check-run + */ + "PATCH /repos/:owner/:repo/check-runs/:check_run_id": { + parameters: ChecksUpdateEndpoint; + request: ChecksUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#update-repository-preferences-for-check-suites + */ + "PATCH /repos/:owner/:repo/check-suites/preferences": { + parameters: ChecksSetSuitesPreferencesEndpoint; + request: ChecksSetSuitesPreferencesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#update-a-commit-comment + */ + "PATCH /repos/:owner/:repo/comments/:comment_id": { + parameters: ReposUpdateCommitCommentEndpoint; + request: ReposUpdateCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#update-a-reference + */ + "PATCH /repos/:owner/:repo/git/refs/:ref": { + parameters: GitUpdateRefEndpoint; + request: GitUpdateRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#edit-a-hook + */ + "PATCH /repos/:owner/:repo/hooks/:hook_id": { + parameters: ReposUpdateHookEndpoint; + request: ReposUpdateHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#update-an-import + */ + "PATCH /repos/:owner/:repo/import": { + parameters: MigrationsUpdateImportEndpoint; + request: MigrationsUpdateImportRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#map-a-commit-author + */ + "PATCH /repos/:owner/:repo/import/authors/:author_id": { + parameters: MigrationsMapCommitAuthorEndpoint; + request: MigrationsMapCommitAuthorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#update-git-lfs-preference + */ + "PATCH /repos/:owner/:repo/import/lfs": { + parameters: MigrationsSetLfsPreferenceEndpoint; + request: MigrationsSetLfsPreferenceRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation + */ + "PATCH /repos/:owner/:repo/invitations/:invitation_id": { + parameters: ReposUpdateInvitationEndpoint; + request: ReposUpdateInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#update-an-issue + */ + "PATCH /repos/:owner/:repo/issues/:issue_number": { + parameters: IssuesUpdateEndpoint; + request: IssuesUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#update-an-issue-comment + */ + "PATCH /repos/:owner/:repo/issues/comments/:comment_id": { + parameters: IssuesUpdateCommentEndpoint; + request: IssuesUpdateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#update-a-label + */ + "PATCH /repos/:owner/:repo/labels/:name": { + parameters: IssuesUpdateLabelEndpoint; + request: IssuesUpdateLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#update-a-milestone + */ + "PATCH /repos/:owner/:repo/milestones/:milestone_number": { + parameters: IssuesUpdateMilestoneEndpoint; + request: IssuesUpdateMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#update-a-pull-request + */ + "PATCH /repos/:owner/:repo/pulls/:pull_number": { + parameters: PullsUpdateEndpoint; + request: PullsUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#edit-a-comment + */ + "PATCH /repos/:owner/:repo/pulls/comments/:comment_id": { + parameters: PullsUpdateCommentEndpoint; + request: PullsUpdateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#edit-a-release + */ + "PATCH /repos/:owner/:repo/releases/:release_id": { + parameters: ReposUpdateReleaseEndpoint; + request: ReposUpdateReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#edit-a-release-asset + */ + "PATCH /repos/:owner/:repo/releases/assets/:asset_id": { + parameters: ReposUpdateReleaseAssetEndpoint; + request: ReposUpdateReleaseAssetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#update-a-user-attribute + */ + "PATCH /scim/v2/organizations/:org/Users/:scim_user_id": { + parameters: ScimUpdateUserAttributeEndpoint; + request: ScimUpdateUserAttributeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#update-a-team-legacy + */ + "PATCH /teams/:team_id": { + parameters: TeamsUpdateLegacyEndpoint; + request: TeamsUpdateLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#update-a-discussion-legacy + */ + "PATCH /teams/:team_id/discussions/:discussion_number": { + parameters: TeamsUpdateDiscussionLegacyEndpoint; + request: TeamsUpdateDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#update-a-discussion-comment-legacy + */ + "PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsUpdateDiscussionCommentLegacyEndpoint; + request: TeamsUpdateDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#create-or-update-idp-group-connections-legacy + */ + "PATCH /teams/:team_id/team-sync/group-mappings": { + parameters: TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint; + request: TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#update-the-authenticated-user + */ + "PATCH /user": { + parameters: UsersUpdateAuthenticatedEndpoint; + request: UsersUpdateAuthenticatedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#toggle-primary-email-visibility + */ + "PATCH /user/email/visibility": { + parameters: UsersTogglePrimaryEmailVisibilityEndpoint; + request: UsersTogglePrimaryEmailVisibilityRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#edit-your-organization-membership + */ + "PATCH /user/memberships/orgs/:org": { + parameters: OrgsUpdateMembershipEndpoint; + request: OrgsUpdateMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation + */ + "PATCH /user/repository_invitations/:invitation_id": { + parameters: ReposAcceptInvitationEndpoint; + request: ReposAcceptInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#create-a-github-app-from-a-manifest + */ + "POST /app-manifests/:code/conversions": { + parameters: AppsCreateFromManifestEndpoint; + request: AppsCreateFromManifestRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#create-a-new-installation-token + */ + "POST /app/installations/:installation_id/access_tokens": { + parameters: AppsCreateInstallationTokenEndpoint; + request: AppsCreateInstallationTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#check-a-token + */ + "POST /applications/:client_id/token": { + parameters: AppsCheckTokenEndpoint; + request: AppsCheckTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization + */ + "POST /applications/:client_id/tokens/:access_token": { + parameters: AppsResetAuthorizationEndpoint; + request: AppsResetAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization + */ + "POST /authorizations": { + parameters: OauthAuthorizationsCreateAuthorizationEndpoint; + request: OauthAuthorizationsCreateAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#create-a-content-attachment + */ + "POST /content_references/:content_reference_id/attachments": { + parameters: AppsCreateContentAttachmentEndpoint; + request: AppsCreateContentAttachmentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#create-a-gist + */ + "POST /gists": { + parameters: GistsCreateEndpoint; + request: GistsCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#create-a-gist-comment + */ + "POST /gists/:gist_id/comments": { + parameters: GistsCreateCommentEndpoint; + request: GistsCreateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#fork-a-gist + */ + "POST /gists/:gist_id/forks": { + parameters: GistsForkEndpoint; + request: GistsForkRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document + */ + "POST /markdown": { + parameters: MarkdownRenderEndpoint; + request: MarkdownRenderRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode + */ + "POST /markdown/raw": { + parameters: MarkdownRenderRawEndpoint; + request: MarkdownRenderRawRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#create-a-registration-token-for-an-organization + */ + "POST /orgs/:org/actions/runners/registration-token": { + parameters: ActionsCreateRegistrationTokenForOrgEndpoint; + request: ActionsCreateRegistrationTokenForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#create-a-remove-token-for-an-organization + */ + "POST /orgs/:org/actions/runners/remove-token": { + parameters: ActionsCreateRemoveTokenForOrgEndpoint; + request: ActionsCreateRemoveTokenForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#create-a-hook + */ + "POST /orgs/:org/hooks": { + parameters: OrgsCreateHookEndpoint; + request: OrgsCreateHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#ping-a-hook + */ + "POST /orgs/:org/hooks/:hook_id/pings": { + parameters: OrgsPingHookEndpoint; + request: OrgsPingHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#create-organization-invitation + */ + "POST /orgs/:org/invitations": { + parameters: OrgsCreateInvitationEndpoint; + request: OrgsCreateInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#start-an-organization-migration + */ + "POST /orgs/:org/migrations": { + parameters: MigrationsStartForOrgEndpoint; + request: MigrationsStartForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#create-an-organization-project + */ + "POST /orgs/:org/projects": { + parameters: ProjectsCreateForOrgEndpoint; + request: ProjectsCreateForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#create-an-organization-repository + */ + "POST /orgs/:org/repos": { + parameters: ReposCreateInOrgEndpoint; + request: ReposCreateInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#create-a-team + */ + "POST /orgs/:org/teams": { + parameters: TeamsCreateEndpoint; + request: TeamsCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#create-a-discussion + */ + "POST /orgs/:org/teams/:team_slug/discussions": { + parameters: TeamsCreateDiscussionInOrgEndpoint; + request: TeamsCreateDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#create-a-discussion-comment + */ + "POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments": { + parameters: TeamsCreateDiscussionCommentInOrgEndpoint; + request: TeamsCreateDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment + */ + "POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions": { + parameters: ReactionsCreateForTeamDiscussionCommentInOrgEndpoint; + request: ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion + */ + "POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions": { + parameters: ReactionsCreateForTeamDiscussionInOrgEndpoint; + request: ReactionsCreateForTeamDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#create-a-project-column + */ + "POST /projects/:project_id/columns": { + parameters: ProjectsCreateColumnEndpoint; + request: ProjectsCreateColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#create-a-project-card + */ + "POST /projects/columns/:column_id/cards": { + parameters: ProjectsCreateCardEndpoint; + request: ProjectsCreateCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#move-a-project-column + */ + "POST /projects/columns/:column_id/moves": { + parameters: ProjectsMoveColumnEndpoint; + request: ProjectsMoveColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#move-a-project-card + */ + "POST /projects/columns/cards/:card_id/moves": { + parameters: ProjectsMoveCardEndpoint; + request: ProjectsMoveCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#create-a-registration-token-for-a-repository + */ + "POST /repos/:owner/:repo/actions/runners/registration-token": { + parameters: ActionsCreateRegistrationTokenForRepoEndpoint; + request: ActionsCreateRegistrationTokenForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#create-a-remove-token-for-a-repository + */ + "POST /repos/:owner/:repo/actions/runners/remove-token": { + parameters: ActionsCreateRemoveTokenForRepoEndpoint; + request: ActionsCreateRemoveTokenForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#cancel-a-workflow-run + */ + "POST /repos/:owner/:repo/actions/runs/:run_id/cancel": { + parameters: ActionsCancelWorkflowRunEndpoint; + request: ActionsCancelWorkflowRunRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#re-run-a-workflow + */ + "POST /repos/:owner/:repo/actions/runs/:run_id/rerun": { + parameters: ActionsReRunWorkflowEndpoint; + request: ActionsReRunWorkflowRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-admin-enforcement-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins": { + parameters: ReposAddProtectedBranchAdminEnforcementEndpoint; + request: ReposAddProtectedBranchAdminEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-required-signatures-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/required_signatures": { + parameters: ReposAddProtectedBranchRequiredSignaturesEndpoint; + request: ReposAddProtectedBranchRequiredSignaturesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-required-status-checks-contexts-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": { + parameters: ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint; + request: ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-app-restrictions-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": { + parameters: ReposAddProtectedBranchAppRestrictionsEndpoint; + request: ReposAddProtectedBranchAppRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-team-restrictions-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": { + parameters: ReposAddProtectedBranchTeamRestrictionsEndpoint; + request: ReposAddProtectedBranchTeamRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-user-restrictions-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users": { + parameters: ReposAddProtectedBranchUserRestrictionsEndpoint; + request: ReposAddProtectedBranchUserRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#create-a-check-run + */ + "POST /repos/:owner/:repo/check-runs": { + parameters: ChecksCreateEndpoint; + request: ChecksCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#create-a-check-suite + */ + "POST /repos/:owner/:repo/check-suites": { + parameters: ChecksCreateSuiteEndpoint; + request: ChecksCreateSuiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#rerequest-a-check-suite + */ + "POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest": { + parameters: ChecksRerequestSuiteEndpoint; + request: ChecksRerequestSuiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment + */ + "POST /repos/:owner/:repo/comments/:comment_id/reactions": { + parameters: ReactionsCreateForCommitCommentEndpoint; + request: ReactionsCreateForCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#create-a-commit-comment + */ + "POST /repos/:owner/:repo/commits/:commit_sha/comments": { + parameters: ReposCreateCommitCommentEndpoint; + request: ReposCreateCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#create-a-deployment + */ + "POST /repos/:owner/:repo/deployments": { + parameters: ReposCreateDeploymentEndpoint; + request: ReposCreateDeploymentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status + */ + "POST /repos/:owner/:repo/deployments/:deployment_id/statuses": { + parameters: ReposCreateDeploymentStatusEndpoint; + request: ReposCreateDeploymentStatusRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#create-a-repository-dispatch-event + */ + "POST /repos/:owner/:repo/dispatches": { + parameters: ReposCreateDispatchEventEndpoint; + request: ReposCreateDispatchEventRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/forks/#create-a-fork + */ + "POST /repos/:owner/:repo/forks": { + parameters: ReposCreateForkEndpoint; + request: ReposCreateForkRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/blobs/#create-a-blob + */ + "POST /repos/:owner/:repo/git/blobs": { + parameters: GitCreateBlobEndpoint; + request: GitCreateBlobRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/commits/#create-a-commit + */ + "POST /repos/:owner/:repo/git/commits": { + parameters: GitCreateCommitEndpoint; + request: GitCreateCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#create-a-reference + */ + "POST /repos/:owner/:repo/git/refs": { + parameters: GitCreateRefEndpoint; + request: GitCreateRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/tags/#create-a-tag-object + */ + "POST /repos/:owner/:repo/git/tags": { + parameters: GitCreateTagEndpoint; + request: GitCreateTagRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/trees/#create-a-tree + */ + "POST /repos/:owner/:repo/git/trees": { + parameters: GitCreateTreeEndpoint; + request: GitCreateTreeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#create-a-hook + */ + "POST /repos/:owner/:repo/hooks": { + parameters: ReposCreateHookEndpoint; + request: ReposCreateHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#ping-a-hook + */ + "POST /repos/:owner/:repo/hooks/:hook_id/pings": { + parameters: ReposPingHookEndpoint; + request: ReposPingHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#test-a-push-hook + */ + "POST /repos/:owner/:repo/hooks/:hook_id/tests": { + parameters: ReposTestPushHookEndpoint; + request: ReposTestPushHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#create-an-issue + */ + "POST /repos/:owner/:repo/issues": { + parameters: IssuesCreateEndpoint; + request: IssuesCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue + */ + "POST /repos/:owner/:repo/issues/:issue_number/assignees": { + parameters: IssuesAddAssigneesEndpoint; + request: IssuesAddAssigneesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#create-an-issue-comment + */ + "POST /repos/:owner/:repo/issues/:issue_number/comments": { + parameters: IssuesCreateCommentEndpoint; + request: IssuesCreateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue + */ + "POST /repos/:owner/:repo/issues/:issue_number/labels": { + parameters: IssuesAddLabelsEndpoint; + request: IssuesAddLabelsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-an-issue + */ + "POST /repos/:owner/:repo/issues/:issue_number/reactions": { + parameters: ReactionsCreateForIssueEndpoint; + request: ReactionsCreateForIssueRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment + */ + "POST /repos/:owner/:repo/issues/comments/:comment_id/reactions": { + parameters: ReactionsCreateForIssueCommentEndpoint; + request: ReactionsCreateForIssueCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key + */ + "POST /repos/:owner/:repo/keys": { + parameters: ReposAddDeployKeyEndpoint; + request: ReposAddDeployKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#create-a-label + */ + "POST /repos/:owner/:repo/labels": { + parameters: IssuesCreateLabelEndpoint; + request: IssuesCreateLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/merging/#perform-a-merge + */ + "POST /repos/:owner/:repo/merges": { + parameters: ReposMergeEndpoint; + request: ReposMergeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#create-a-milestone + */ + "POST /repos/:owner/:repo/milestones": { + parameters: IssuesCreateMilestoneEndpoint; + request: IssuesCreateMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#enable-a-pages-site + */ + "POST /repos/:owner/:repo/pages": { + parameters: ReposEnablePagesSiteEndpoint; + request: ReposEnablePagesSiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#request-a-page-build + */ + "POST /repos/:owner/:repo/pages/builds": { + parameters: ReposRequestPageBuildEndpoint; + request: ReposRequestPageBuildRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#create-a-repository-project + */ + "POST /repos/:owner/:repo/projects": { + parameters: ProjectsCreateForRepoEndpoint; + request: ProjectsCreateForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#create-a-pull-request + */ + "POST /repos/:owner/:repo/pulls": { + parameters: PullsCreateEndpoint; + request: PullsCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#create-a-comment + */ + "POST /repos/:owner/:repo/pulls/:pull_number/comments": { + parameters: PullsCreateCommentEndpoint; + request: PullsCreateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#create-a-review-comment-reply + */ + "POST /repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies": { + parameters: PullsCreateReviewCommentReplyEndpoint; + request: PullsCreateReviewCommentReplyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/review_requests/#create-a-review-request + */ + "POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": { + parameters: PullsCreateReviewRequestEndpoint; + request: PullsCreateReviewRequestRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review + */ + "POST /repos/:owner/:repo/pulls/:pull_number/reviews": { + parameters: PullsCreateReviewEndpoint; + request: PullsCreateReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review + */ + "POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events": { + parameters: PullsSubmitReviewEndpoint; + request: PullsSubmitReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment + */ + "POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions": { + parameters: ReactionsCreateForPullRequestReviewCommentEndpoint; + request: ReactionsCreateForPullRequestReviewCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#create-a-release + */ + "POST /repos/:owner/:repo/releases": { + parameters: ReposCreateReleaseEndpoint; + request: ReposCreateReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#upload-a-release-asset + */ + "POST /repos/:owner/:repo/releases/:release_id/assets{?name,label}": { + parameters: ReposUploadReleaseAssetEndpoint; + request: ReposUploadReleaseAssetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statuses/#create-a-status + */ + "POST /repos/:owner/:repo/statuses/:sha": { + parameters: ReposCreateStatusEndpoint; + request: ReposCreateStatusRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#transfer-a-repository + */ + "POST /repos/:owner/:repo/transfer": { + parameters: ReposTransferEndpoint; + request: ReposTransferRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#create-a-repository-using-a-template + */ + "POST /repos/:template_owner/:template_repo/generate": { + parameters: ReposCreateUsingTemplateEndpoint; + request: ReposCreateUsingTemplateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#provision-and-invite-users + */ + "POST /scim/v2/organizations/:org/Users": { + parameters: ScimProvisionAndInviteUsersEndpoint; + request: ScimProvisionAndInviteUsersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy + */ + "POST /teams/:team_id/discussions": { + parameters: TeamsCreateDiscussionLegacyEndpoint; + request: TeamsCreateDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#create-a-discussion-comment-legacy + */ + "POST /teams/:team_id/discussions/:discussion_number/comments": { + parameters: TeamsCreateDiscussionCommentLegacyEndpoint; + request: TeamsCreateDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy + */ + "POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": { + parameters: ReactionsCreateForTeamDiscussionCommentLegacyEndpoint; + request: ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy + */ + "POST /teams/:team_id/discussions/:discussion_number/reactions": { + parameters: ReactionsCreateForTeamDiscussionLegacyEndpoint; + request: ReactionsCreateForTeamDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#add-email-addresses + */ + "POST /user/emails": { + parameters: UsersAddEmailsEndpoint; + request: UsersAddEmailsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key + */ + "POST /user/gpg_keys": { + parameters: UsersCreateGpgKeyEndpoint; + request: UsersCreateGpgKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#create-a-public-key + */ + "POST /user/keys": { + parameters: UsersCreatePublicKeyEndpoint; + request: UsersCreatePublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#start-a-user-migration + */ + "POST /user/migrations": { + parameters: MigrationsStartForAuthenticatedUserEndpoint; + request: MigrationsStartForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#create-a-user-project + */ + "POST /user/projects": { + parameters: ProjectsCreateForAuthenticatedUserEndpoint; + request: ProjectsCreateForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#create-a-repository-for-the-authenticated-user + */ + "POST /user/repos": { + parameters: ReposCreateForAuthenticatedUserEndpoint; + request: ReposCreateForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#suspend-an-installation + */ + "PUT /app/installations/:installation_id/suspended": { + parameters: AppsSuspendInstallationEndpoint; + request: AppsSuspendInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app + */ + "PUT /authorizations/clients/:client_id": { + parameters: OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint; + request: OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint + */ + "PUT /authorizations/clients/:client_id/:fingerprint": { + parameters: OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint; + request: OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#star-a-gist + */ + "PUT /gists/:gist_id/star": { + parameters: GistsStarEndpoint; + request: GistsStarRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read + */ + "PUT /notifications": { + parameters: ActivityMarkNotificationsAsReadEndpoint; + request: ActivityMarkNotificationsAsReadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription + */ + "PUT /notifications/threads/:thread_id/subscription": { + parameters: ActivitySetThreadSubscriptionEndpoint; + request: ActivitySetThreadSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#create-or-update-an-organization-secret + */ + "PUT /orgs/:org/actions/secrets/:secret_name": { + parameters: ActionsCreateOrUpdateOrgSecretEndpoint; + request: ActionsCreateOrUpdateOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#set-selected-repositories-for-an-organization-secret + */ + "PUT /orgs/:org/actions/secrets/:secret_name/repositories": { + parameters: ActionsSetSelectedReposForOrgSecretEndpoint; + request: ActionsSetSelectedReposForOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#add-selected-repository-to-an-organization-secret + */ + "PUT /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id": { + parameters: ActionsAddSelectedRepoToOrgSecretEndpoint; + request: ActionsAddSelectedRepoToOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/blocking/#block-a-user + */ + "PUT /orgs/:org/blocks/:username": { + parameters: OrgsBlockUserEndpoint; + request: OrgsBlockUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/orgs/#add-or-update-interaction-restrictions-for-an-organization + */ + "PUT /orgs/:org/interaction-limits": { + parameters: InteractionsAddOrUpdateRestrictionsForOrgEndpoint; + request: InteractionsAddOrUpdateRestrictionsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership + */ + "PUT /orgs/:org/memberships/:username": { + parameters: OrgsAddOrUpdateMembershipEndpoint; + request: OrgsAddOrUpdateMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator + */ + "PUT /orgs/:org/outside_collaborators/:username": { + parameters: OrgsConvertMemberToOutsideCollaboratorEndpoint; + request: OrgsConvertMemberToOutsideCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#publicize-a-users-membership + */ + "PUT /orgs/:org/public_members/:username": { + parameters: OrgsPublicizeMembershipEndpoint; + request: OrgsPublicizeMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-for-a-user + */ + "PUT /orgs/:org/teams/:team_slug/memberships/:username": { + parameters: TeamsAddOrUpdateMembershipForUserInOrgEndpoint; + request: TeamsAddOrUpdateMembershipForUserInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#add-or-update-team-project-permissions + */ + "PUT /orgs/:org/teams/:team_slug/projects/:project_id": { + parameters: TeamsAddOrUpdateProjectPermissionsInOrgEndpoint; + request: TeamsAddOrUpdateProjectPermissionsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#add-or-update-team-repository-permissions + */ + "PUT /orgs/:org/teams/:team_slug/repos/:owner/:repo": { + parameters: TeamsAddOrUpdateRepoPermissionsInOrgEndpoint; + request: TeamsAddOrUpdateRepoPermissionsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator + */ + "PUT /projects/:project_id/collaborators/:username": { + parameters: ProjectsAddCollaboratorEndpoint; + request: ProjectsAddCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#create-or-update-a-repository-secret + */ + "PUT /repos/:owner/:repo/actions/secrets/:secret_name": { + parameters: ActionsCreateOrUpdateRepoSecretEndpoint; + request: ActionsCreateOrUpdateRepoSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#enable-automated-security-fixes + */ + "PUT /repos/:owner/:repo/automated-security-fixes": { + parameters: ReposEnableAutomatedSecurityFixesEndpoint; + request: ReposEnableAutomatedSecurityFixesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#update-branch-protection + */ + "PUT /repos/:owner/:repo/branches/:branch/protection": { + parameters: ReposUpdateBranchProtectionEndpoint; + request: ReposUpdateBranchProtectionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#replace-required-status-checks-contexts-of-protected-branch + */ + "PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": { + parameters: ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint; + request: ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#replace-app-restrictions-of-protected-branch + */ + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": { + parameters: ReposReplaceProtectedBranchAppRestrictionsEndpoint; + request: ReposReplaceProtectedBranchAppRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#replace-team-restrictions-of-protected-branch + */ + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": { + parameters: ReposReplaceProtectedBranchTeamRestrictionsEndpoint; + request: ReposReplaceProtectedBranchTeamRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#replace-user-restrictions-of-protected-branch + */ + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users": { + parameters: ReposReplaceProtectedBranchUserRestrictionsEndpoint; + request: ReposReplaceProtectedBranchUserRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator + */ + "PUT /repos/:owner/:repo/collaborators/:username": { + parameters: ReposAddCollaboratorEndpoint; + request: ReposAddCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#create-or-update-a-file + */ + "PUT /repos/:owner/:repo/contents/:path": { + parameters: ReposCreateOrUpdateFileEndpoint; + request: ReposCreateOrUpdateFileRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#start-an-import + */ + "PUT /repos/:owner/:repo/import": { + parameters: MigrationsStartImportEndpoint; + request: MigrationsStartImportRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/repos/#add-or-update-interaction-restrictions-for-a-repository + */ + "PUT /repos/:owner/:repo/interaction-limits": { + parameters: InteractionsAddOrUpdateRestrictionsForRepoEndpoint; + request: InteractionsAddOrUpdateRestrictionsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#set-labels-for-an-issue + */ + "PUT /repos/:owner/:repo/issues/:issue_number/labels": { + parameters: IssuesSetLabelsEndpoint; + request: IssuesSetLabelsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#lock-an-issue + */ + "PUT /repos/:owner/:repo/issues/:issue_number/lock": { + parameters: IssuesLockEndpoint; + request: IssuesLockRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#mark-repository-notifications-as-read + */ + "PUT /repos/:owner/:repo/notifications": { + parameters: ActivityMarkRepoNotificationsAsReadEndpoint; + request: ActivityMarkRepoNotificationsAsReadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#update-information-about-a-pages-site + */ + "PUT /repos/:owner/:repo/pages": { + parameters: ReposUpdateInformationAboutPagesSiteEndpoint; + request: ReposUpdateInformationAboutPagesSiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button + */ + "PUT /repos/:owner/:repo/pulls/:pull_number/merge": { + parameters: PullsMergeEndpoint; + request: PullsMergeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#update-a-pull-request-review + */ + "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": { + parameters: PullsUpdateReviewEndpoint; + request: PullsUpdateReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review + */ + "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals": { + parameters: PullsDismissReviewEndpoint; + request: PullsDismissReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#update-a-pull-request-branch + */ + "PUT /repos/:owner/:repo/pulls/:pull_number/update-branch": { + parameters: PullsUpdateBranchEndpoint; + request: PullsUpdateBranchRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#set-a-repository-subscription + */ + "PUT /repos/:owner/:repo/subscription": { + parameters: ActivitySetRepoSubscriptionEndpoint; + request: ActivitySetRepoSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#replace-all-repository-topics + */ + "PUT /repos/:owner/:repo/topics": { + parameters: ReposReplaceAllTopicsEndpoint; + request: ReposReplaceAllTopicsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#enable-vulnerability-alerts + */ + "PUT /repos/:owner/:repo/vulnerability-alerts": { + parameters: ReposEnableVulnerabilityAlertsEndpoint; + request: ReposEnableVulnerabilityAlertsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#replace-a-provisioned-users-information + */ + "PUT /scim/v2/organizations/:org/Users/:scim_user_id": { + parameters: ScimReplaceProvisionedUserInformationEndpoint; + request: ScimReplaceProvisionedUserInformationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#add-team-member-legacy + */ + "PUT /teams/:team_id/members/:username": { + parameters: TeamsAddMemberLegacyEndpoint; + request: TeamsAddMemberLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-for-a-user-legacy + */ + "PUT /teams/:team_id/memberships/:username": { + parameters: TeamsAddOrUpdateMembershipForUserLegacyEndpoint; + request: TeamsAddOrUpdateMembershipForUserLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#add-or-update-team-project-permissions-legacy + */ + "PUT /teams/:team_id/projects/:project_id": { + parameters: TeamsAddOrUpdateProjectPermissionsLegacyEndpoint; + request: TeamsAddOrUpdateProjectPermissionsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#add-or-update-team-repository-permissions-legacy + */ + "PUT /teams/:team_id/repos/:owner/:repo": { + parameters: TeamsAddOrUpdateRepoPermissionsLegacyEndpoint; + request: TeamsAddOrUpdateRepoPermissionsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/blocking/#block-a-user + */ + "PUT /user/blocks/:username": { + parameters: UsersBlockEndpoint; + request: UsersBlockRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#follow-a-user + */ + "PUT /user/following/:username": { + parameters: UsersFollowEndpoint; + request: UsersFollowRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#add-repository-to-installation + */ + "PUT /user/installations/:installation_id/repositories/:repository_id": { + parameters: AppsAddRepoToInstallationEndpoint; + request: AppsAddRepoToInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#star-a-repository-for-the-authenticated-user + */ + "PUT /user/starred/:owner/:repo": { + parameters: ActivityStarRepoForAuthenticatedUserEndpoint; + request: ActivityStarRepoForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; +} +declare type AppsGetAuthenticatedEndpoint = {} & RequiredPreview<"machine-man">; +declare type AppsGetAuthenticatedRequestOptions = { + method: "GET"; + url: "/app"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetAuthenticatedResponseData { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + installations_count: number; +} +declare type AppsCreateFromManifestEndpoint = { + code: string; +}; +declare type AppsCreateFromManifestRequestOptions = { + method: "POST"; + url: "/app-manifests/:code/conversions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsCreateFromManifestResponseData { + id: number; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + client_id: string; + client_secret: string; + webhook_secret: string; + pem: string; +} +declare type AppsListInstallationsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"machine-man">; +declare type AppsListInstallationsRequestOptions = { + method: "GET"; + url: "/app/installations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListInstallationsResponseData = { + id: number; + account: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + checks: string; + metadata: string; + contents: string; + }; + events: string[]; + single_file_name: string; + repository_selection: "all" | "selected"; +}[]; +declare type AppsGetInstallationEndpoint = { + installation_id: number; +} & RequiredPreview<"machine-man">; +declare type AppsGetInstallationRequestOptions = { + method: "GET"; + url: "/app/installations/:installation_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetInstallationResponseData { + id: number; + account: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + checks: string; + metadata: string; + contents: string; + }; + events: string[]; + single_file_name: string; + repository_selection: "all" | "selected"; +} +declare type AppsDeleteInstallationEndpoint = { + installation_id: number; +} & RequiredPreview<"machine-man">; +declare type AppsDeleteInstallationRequestOptions = { + method: "DELETE"; + url: "/app/installations/:installation_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsCreateInstallationTokenEndpoint = { + installation_id: number; + /** + * The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the "[List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token. + */ + repository_ids?: number[]; + /** + * The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see "[GitHub App permissions](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions)." + */ + permissions?: AppsCreateInstallationTokenParamsPermissions; +} & RequiredPreview<"machine-man">; +declare type AppsCreateInstallationTokenRequestOptions = { + method: "POST"; + url: "/app/installations/:installation_id/access_tokens"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsCreateInstallationTokenResponseData { + token: string; + expires_at: string; + permissions: { + issues: string; + contents: string; + }; + repository_selection: "all" | "selected"; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; +} +declare type AppsSuspendInstallationEndpoint = { + installation_id: number; +}; +declare type AppsSuspendInstallationRequestOptions = { + method: "PUT"; + url: "/app/installations/:installation_id/suspended"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsUnsuspendInstallationEndpoint = { + installation_id: number; +}; +declare type AppsUnsuspendInstallationRequestOptions = { + method: "DELETE"; + url: "/app/installations/:installation_id/suspended"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OauthAuthorizationsListGrantsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OauthAuthorizationsListGrantsRequestOptions = { + method: "GET"; + url: "/applications/grants"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OauthAuthorizationsListGrantsResponseData = { + id: number; + url: string; + app: { + url: string; + name: string; + client_id: string; + }; + created_at: string; + updated_at: string; + scopes: string[]; +}[]; +declare type OauthAuthorizationsGetGrantEndpoint = { + grant_id: number; +}; +declare type OauthAuthorizationsGetGrantRequestOptions = { + method: "GET"; + url: "/applications/grants/:grant_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OauthAuthorizationsGetGrantResponseData { + id: number; + url: string; + app: { + url: string; + name: string; + client_id: string; + }; + created_at: string; + updated_at: string; + scopes: string[]; +} +declare type OauthAuthorizationsDeleteGrantEndpoint = { + grant_id: number; +}; +declare type OauthAuthorizationsDeleteGrantRequestOptions = { + method: "DELETE"; + url: "/applications/grants/:grant_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsDeleteAuthorizationEndpoint = { + client_id: string; + /** + * The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; +}; +declare type AppsDeleteAuthorizationRequestOptions = { + method: "DELETE"; + url: "/applications/:client_id/grant"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsRevokeGrantForApplicationEndpoint = { + client_id: string; + access_token: string; +}; +declare type AppsRevokeGrantForApplicationRequestOptions = { + method: "DELETE"; + url: "/applications/:client_id/grants/:access_token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsCheckTokenEndpoint = { + client_id: string; + /** + * The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; +}; +declare type AppsCheckTokenRequestOptions = { + method: "POST"; + url: "/applications/:client_id/token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsCheckTokenResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type AppsResetTokenEndpoint = { + client_id: string; + /** + * The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; +}; +declare type AppsResetTokenRequestOptions = { + method: "PATCH"; + url: "/applications/:client_id/token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsResetTokenResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type AppsDeleteTokenEndpoint = { + client_id: string; + /** + * The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; +}; +declare type AppsDeleteTokenRequestOptions = { + method: "DELETE"; + url: "/applications/:client_id/token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsCheckAuthorizationEndpoint = { + client_id: string; + access_token: string; +}; +declare type AppsCheckAuthorizationRequestOptions = { + method: "GET"; + url: "/applications/:client_id/tokens/:access_token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsCheckAuthorizationResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type AppsResetAuthorizationEndpoint = { + client_id: string; + access_token: string; +}; +declare type AppsResetAuthorizationRequestOptions = { + method: "POST"; + url: "/applications/:client_id/tokens/:access_token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsResetAuthorizationResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type AppsRevokeAuthorizationForApplicationEndpoint = { + client_id: string; + access_token: string; +}; +declare type AppsRevokeAuthorizationForApplicationRequestOptions = { + method: "DELETE"; + url: "/applications/:client_id/tokens/:access_token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsGetBySlugEndpoint = { + app_slug: string; +} & RequiredPreview<"machine-man">; +declare type AppsGetBySlugRequestOptions = { + method: "GET"; + url: "/apps/:app_slug"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetBySlugResponseData { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; +} +declare type OauthAuthorizationsListAuthorizationsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OauthAuthorizationsListAuthorizationsRequestOptions = { + method: "GET"; + url: "/authorizations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OauthAuthorizationsListAuthorizationsResponseData = { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +}[]; +declare type OauthAuthorizationsCreateAuthorizationEndpoint = { + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. + */ + note: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * The 20 character OAuth app client key for which to create the token. + */ + client_id?: string; + /** + * The 40 character OAuth app client secret for which to create the token. + */ + client_secret?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; +}; +declare type OauthAuthorizationsCreateAuthorizationRequestOptions = { + method: "POST"; + url: "/authorizations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OauthAuthorizationsCreateAuthorizationResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +declare type OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint = { + client_id: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint). + */ + fingerprint?: string; +}; +declare type OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions = { + method: "PUT"; + url: "/authorizations/clients/:client_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OauthAuthorizationsGetOrCreateAuthorizationForAppResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +export interface OauthAuthorizationsGetOrCreateAuthorizationForAppResponse201Data { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +declare type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint = { + client_id: string; + fingerprint: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; +}; +declare type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions = { + method: "PUT"; + url: "/authorizations/clients/:client_id/:fingerprint"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +export interface OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse201Data { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +declare type OauthAuthorizationsGetAuthorizationEndpoint = { + authorization_id: number; +}; +declare type OauthAuthorizationsGetAuthorizationRequestOptions = { + method: "GET"; + url: "/authorizations/:authorization_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OauthAuthorizationsGetAuthorizationResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +declare type OauthAuthorizationsUpdateAuthorizationEndpoint = { + authorization_id: number; + /** + * Replaces the authorization scopes with these. + */ + scopes?: string[]; + /** + * A list of scopes to add to this authorization. + */ + add_scopes?: string[]; + /** + * A list of scopes to remove from this authorization. + */ + remove_scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; +}; +declare type OauthAuthorizationsUpdateAuthorizationRequestOptions = { + method: "PATCH"; + url: "/authorizations/:authorization_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OauthAuthorizationsUpdateAuthorizationResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +declare type OauthAuthorizationsDeleteAuthorizationEndpoint = { + authorization_id: number; +}; +declare type OauthAuthorizationsDeleteAuthorizationRequestOptions = { + method: "DELETE"; + url: "/authorizations/:authorization_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type CodesOfConductGetAllCodesOfConductEndpoint = {} & RequiredPreview<"scarlet-witch">; +declare type CodesOfConductGetAllCodesOfConductRequestOptions = { + method: "GET"; + url: "/codes_of_conduct"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type CodesOfConductGetAllCodesOfConductResponseData = { + key: string; + name: string; + url: string; +}[]; +declare type CodesOfConductGetConductCodeEndpoint = { + key: string; +} & RequiredPreview<"scarlet-witch">; +declare type CodesOfConductGetConductCodeRequestOptions = { + method: "GET"; + url: "/codes_of_conduct/:key"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface CodesOfConductGetConductCodeResponseData { + key: string; + name: string; + url: string; + body: string; +} +declare type AppsCreateContentAttachmentEndpoint = { + content_reference_id: number; + /** + * The title of the content attachment displayed in the body or comment of an issue or pull request. + */ + title: string; + /** + * The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown. + */ + body: string; +} & RequiredPreview<"corsair">; +declare type AppsCreateContentAttachmentRequestOptions = { + method: "POST"; + url: "/content_references/:content_reference_id/attachments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsCreateContentAttachmentResponseData { + id: number; + title: string; + body: string; +} +declare type EmojisGetEndpoint = {}; +declare type EmojisGetRequestOptions = { + method: "GET"; + url: "/emojis"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListPublicEventsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListPublicEventsRequestOptions = { + method: "GET"; + url: "/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityGetFeedsEndpoint = {}; +declare type ActivityGetFeedsRequestOptions = { + method: "GET"; + url: "/feeds"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActivityGetFeedsResponseData { + timeline_url: string; + user_url: string; + current_user_public_url: string; + current_user_url: string; + current_user_actor_url: string; + current_user_organization_url: string; + current_user_organization_urls: string[]; + security_advisories_url: string; + _links: { + timeline: { + href: string; + type: string; + }; + user: { + href: string; + type: string; + }; + current_user_public: { + href: string; + type: string; + }; + current_user: { + href: string; + type: string; + }; + current_user_actor: { + href: string; + type: string; + }; + current_user_organization: { + href: string; + type: string; + }; + current_user_organizations: { + href: string; + type: string; + }[]; + security_advisories: { + href: string; + type: string; + }; + }; +} +declare type GistsListEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListRequestOptions = { + method: "GET"; + url: "/gists"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; +}[]; +declare type GistsCreateEndpoint = { + /** + * The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`. + */ + files: GistsCreateParamsFiles; + /** + * A descriptive name for this gist. + */ + description?: string; + /** + * When `true`, the gist will be public and available for anyone to see. + */ + public?: boolean; +}; +declare type GistsCreateRequestOptions = { + method: "POST"; + url: "/gists"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsCreateResponseData { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; + forks: { + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + url: string; + id: string; + created_at: string; + updated_at: string; + }[]; + history: { + url: string; + version: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + change_status: { + deletions: number; + additions: number; + total: number; + }; + committed_at: string; + }[]; +} +declare type GistsListPublicEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListPublicRequestOptions = { + method: "GET"; + url: "/gists/public"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListPublicResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; +}[]; +declare type GistsListStarredEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListStarredRequestOptions = { + method: "GET"; + url: "/gists/starred"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListStarredResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; +}[]; +declare type GistsGetEndpoint = { + gist_id: string; +}; +declare type GistsGetRequestOptions = { + method: "GET"; + url: "/gists/:gist_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsGetResponseData { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; + forks: { + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + url: string; + id: string; + created_at: string; + updated_at: string; + }[]; + history: { + url: string; + version: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + change_status: { + deletions: number; + additions: number; + total: number; + }; + committed_at: string; + }[]; +} +declare type GistsUpdateEndpoint = { + gist_id: string; + /** + * A descriptive name for this gist. + */ + description?: string; + /** + * The filenames and content that make up this gist. + */ + files?: GistsUpdateParamsFiles; +}; +declare type GistsUpdateRequestOptions = { + method: "PATCH"; + url: "/gists/:gist_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsUpdateResponseData { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; + forks: { + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + url: string; + id: string; + created_at: string; + updated_at: string; + }[]; + history: { + url: string; + version: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + change_status: { + deletions: number; + additions: number; + total: number; + }; + committed_at: string; + }[]; +} +declare type GistsDeleteEndpoint = { + gist_id: string; +}; +declare type GistsDeleteRequestOptions = { + method: "DELETE"; + url: "/gists/:gist_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GistsListCommentsEndpoint = { + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListCommentsRequestOptions = { + method: "GET"; + url: "/gists/:gist_id/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListCommentsResponseData = { + id: number; + node_id: string; + url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type GistsCreateCommentEndpoint = { + gist_id: string; + /** + * The comment text. + */ + body: string; +}; +declare type GistsCreateCommentRequestOptions = { + method: "POST"; + url: "/gists/:gist_id/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsCreateCommentResponseData { + id: number; + node_id: string; + url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type GistsGetCommentEndpoint = { + gist_id: string; + comment_id: number; +}; +declare type GistsGetCommentRequestOptions = { + method: "GET"; + url: "/gists/:gist_id/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsGetCommentResponseData { + id: number; + node_id: string; + url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type GistsUpdateCommentEndpoint = { + gist_id: string; + comment_id: number; + /** + * The comment text. + */ + body: string; +}; +declare type GistsUpdateCommentRequestOptions = { + method: "PATCH"; + url: "/gists/:gist_id/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsUpdateCommentResponseData { + id: number; + node_id: string; + url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type GistsDeleteCommentEndpoint = { + gist_id: string; + comment_id: number; +}; +declare type GistsDeleteCommentRequestOptions = { + method: "DELETE"; + url: "/gists/:gist_id/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GistsListCommitsEndpoint = { + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListCommitsRequestOptions = { + method: "GET"; + url: "/gists/:gist_id/commits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListCommitsResponseData = { + url: string; + version: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + change_status: { + deletions: number; + additions: number; + total: number; + }; + committed_at: string; +}[]; +declare type GistsForkEndpoint = { + gist_id: string; +}; +declare type GistsForkRequestOptions = { + method: "POST"; + url: "/gists/:gist_id/forks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsForkResponseData { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; +} +declare type GistsListForksEndpoint = { + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListForksRequestOptions = { + method: "GET"; + url: "/gists/:gist_id/forks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListForksResponseData = { + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + url: string; + id: string; + created_at: string; + updated_at: string; +}[]; +declare type GistsStarEndpoint = { + gist_id: string; +}; +declare type GistsStarRequestOptions = { + method: "PUT"; + url: "/gists/:gist_id/star"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GistsUnstarEndpoint = { + gist_id: string; +}; +declare type GistsUnstarRequestOptions = { + method: "DELETE"; + url: "/gists/:gist_id/star"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GistsCheckIsStarredEndpoint = { + gist_id: string; +}; +declare type GistsCheckIsStarredRequestOptions = { + method: "GET"; + url: "/gists/:gist_id/star"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GistsGetRevisionEndpoint = { + gist_id: string; + sha: string; +}; +declare type GistsGetRevisionRequestOptions = { + method: "GET"; + url: "/gists/:gist_id/:sha"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsGetRevisionResponseData { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; + forks: { + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + url: string; + id: string; + created_at: string; + updated_at: string; + }[]; + history: { + url: string; + version: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + change_status: { + deletions: number; + additions: number; + total: number; + }; + committed_at: string; + }[]; +} +declare type GitignoreListTemplatesEndpoint = {}; +declare type GitignoreListTemplatesRequestOptions = { + method: "GET"; + url: "/gitignore/templates"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GitignoreListTemplatesResponseData = string[]; +declare type GitignoreGetTemplateEndpoint = { + name: string; +}; +declare type GitignoreGetTemplateRequestOptions = { + method: "GET"; + url: "/gitignore/templates/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitignoreGetTemplateResponseData { + name: string; + source: string; +} +declare type AppsListReposEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"machine-man">; +declare type AppsListReposRequestOptions = { + method: "GET"; + url: "/installation/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsListReposResponseData { + total_count: number; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; +} +declare type AppsRevokeInstallationTokenEndpoint = {}; +declare type AppsRevokeInstallationTokenRequestOptions = { + method: "DELETE"; + url: "/installation/token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesListEndpoint = { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListRequestOptions = { + method: "GET"; + url: "/issues"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +}[]; +declare type LicensesListCommonlyUsedEndpoint = {}; +declare type LicensesListCommonlyUsedRequestOptions = { + method: "GET"; + url: "/licenses"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type LicensesListCommonlyUsedResponseData = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; +}[]; +declare type LicensesGetEndpoint = { + license: string; +}; +declare type LicensesGetRequestOptions = { + method: "GET"; + url: "/licenses/:license"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface LicensesGetResponseData { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + html_url: string; + description: string; + implementation: string; + permissions: string[]; + conditions: string[]; + limitations: string[]; + body: string; + featured: boolean; +} +declare type MarkdownRenderEndpoint = { + /** + * The Markdown text to render in HTML. Markdown content must be 400 KB or less. + */ + text: string; + /** + * The rendering mode. Can be either: + * \* `markdown` to render a document in plain Markdown, just like README.md files are rendered. + * \* `gfm` to render a document in [GitHub Flavored Markdown](https://github.github.com/gfm/), which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests. + */ + mode?: "markdown" | "gfm"; + /** + * The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode. + */ + context?: string; +}; +declare type MarkdownRenderRequestOptions = { + method: "POST"; + url: "/markdown"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MarkdownRenderRawEndpoint = { + /** + * data parameter + */ + data: string; +} & { + headers: { + "content-type": "text/plain; charset=utf-8"; + }; +}; +declare type MarkdownRenderRawRequestOptions = { + method: "POST"; + url: "/markdown/raw"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsGetSubscriptionPlanForAccountEndpoint = { + account_id: number; +}; +declare type AppsGetSubscriptionPlanForAccountRequestOptions = { + method: "GET"; + url: "/marketplace_listing/accounts/:account_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetSubscriptionPlanForAccountResponseData { + url: string; + type: string; + id: number; + login: string; + email: string; + organization_billing_email: string; + marketplace_pending_change: { + effective_date: string; + unit_count: string; + id: number; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + state: string; + unit_name: string; + bullets: string[]; + }; + }; + marketplace_purchase: { + billing_cycle: string; + next_billing_date: string; + unit_count: string; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; + }; + }; +} +declare type AppsListPlansEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type AppsListPlansRequestOptions = { + method: "GET"; + url: "/marketplace_listing/plans"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListPlansResponseData = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; +}[]; +declare type AppsListAccountsForPlanEndpoint = { + plan_id: number; + /** + * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type AppsListAccountsForPlanRequestOptions = { + method: "GET"; + url: "/marketplace_listing/plans/:plan_id/accounts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListAccountsForPlanResponseData = { + url: string; + type: string; + id: number; + login: string; + email: string; + organization_billing_email: string; + marketplace_pending_change: { + effective_date: string; + unit_count: string; + id: number; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + state: string; + unit_name: string; + bullets: string[]; + }; + }; + marketplace_purchase: { + billing_cycle: string; + next_billing_date: string; + unit_count: string; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; + }; + }; +}[]; +declare type AppsGetSubscriptionPlanForAccountStubbedEndpoint = { + account_id: number; +}; +declare type AppsGetSubscriptionPlanForAccountStubbedRequestOptions = { + method: "GET"; + url: "/marketplace_listing/stubbed/accounts/:account_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetSubscriptionPlanForAccountStubbedResponseData { + url: string; + type: string; + id: number; + login: string; + email: string; + organization_billing_email: string; + marketplace_pending_change: { + effective_date: string; + unit_count: string; + id: number; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + state: string; + unit_name: string; + bullets: string[]; + }; + }; + marketplace_purchase: { + billing_cycle: string; + next_billing_date: string; + unit_count: string; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; + }; + }; +} +declare type AppsListPlansStubbedEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type AppsListPlansStubbedRequestOptions = { + method: "GET"; + url: "/marketplace_listing/stubbed/plans"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListPlansStubbedResponseData = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; +}[]; +declare type AppsListAccountsForPlanStubbedEndpoint = { + plan_id: number; + /** + * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type AppsListAccountsForPlanStubbedRequestOptions = { + method: "GET"; + url: "/marketplace_listing/stubbed/plans/:plan_id/accounts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListAccountsForPlanStubbedResponseData = { + url: string; + type: string; + id: number; + login: string; + email: string; + organization_billing_email: string; + marketplace_pending_change: { + effective_date: string; + unit_count: string; + id: number; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + state: string; + unit_name: string; + bullets: string[]; + }; + }; + marketplace_purchase: { + billing_cycle: string; + next_billing_date: string; + unit_count: string; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; + }; + }; +}[]; +declare type MetaGetEndpoint = {}; +declare type MetaGetRequestOptions = { + method: "GET"; + url: "/meta"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MetaGetResponseData { + verifiable_password_authentication: boolean; + ssh_key_fingerprints: { + MD5_RSA: string; + MD5_DSA: string; + SHA256_RSA: string; + SHA256_DSA: string; + }; + hooks: string[]; + web: string[]; + api: string[]; + git: string[]; + pages: string[]; + importer: string[]; +} +declare type ActivityListPublicEventsForRepoNetworkEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListPublicEventsForRepoNetworkRequestOptions = { + method: "GET"; + url: "/networks/:owner/:repo/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListNotificationsForAuthenticatedUserEndpoint = { + /** + * If `true`, show notifications marked as read. + */ + all?: boolean; + /** + * If `true`, only shows notifications in which the user is directly participating or mentioned. + */ + participating?: boolean; + /** + * Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + before?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListNotificationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/notifications"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListNotificationsForAuthenticatedUserResponseData = { + id: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + subject: { + title: string; + url: string; + latest_comment_url: string; + type: string; + }; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string; + url: string; +}[]; +declare type ActivityMarkNotificationsAsReadEndpoint = { + /** + * Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; +}; +declare type ActivityMarkNotificationsAsReadRequestOptions = { + method: "PUT"; + url: "/notifications"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityGetThreadEndpoint = { + thread_id: number; +}; +declare type ActivityGetThreadRequestOptions = { + method: "GET"; + url: "/notifications/threads/:thread_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActivityGetThreadResponseData { + id: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + subject: { + title: string; + url: string; + latest_comment_url: string; + type: string; + }; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string; + url: string; +} +declare type ActivityMarkThreadAsReadEndpoint = { + thread_id: number; +}; +declare type ActivityMarkThreadAsReadRequestOptions = { + method: "PATCH"; + url: "/notifications/threads/:thread_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint = { + thread_id: number; +}; +declare type ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/notifications/threads/:thread_id/subscription"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActivityGetThreadSubscriptionForAuthenticatedUserResponseData { + subscribed: boolean; + ignored: boolean; + reason: string; + created_at: string; + url: string; + thread_url: string; +} +declare type ActivitySetThreadSubscriptionEndpoint = { + thread_id: number; + /** + * Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread. + */ + ignored?: boolean; +}; +declare type ActivitySetThreadSubscriptionRequestOptions = { + method: "PUT"; + url: "/notifications/threads/:thread_id/subscription"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActivitySetThreadSubscriptionResponseData { + subscribed: boolean; + ignored: boolean; + reason: string; + created_at: string; + url: string; + thread_url: string; +} +declare type ActivityDeleteThreadSubscriptionEndpoint = { + thread_id: number; +}; +declare type ActivityDeleteThreadSubscriptionRequestOptions = { + method: "DELETE"; + url: "/notifications/threads/:thread_id/subscription"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsListEndpoint = { + /** + * The integer ID of the last organization that you've seen. + */ + since?: number; +}; +declare type OrgsListRequestOptions = { + method: "GET"; + url: "/organizations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListResponseData = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}[]; +declare type OrgsGetEndpoint = { + org: string; +}; +declare type OrgsGetRequestOptions = { + method: "GET"; + url: "/orgs/:org"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsGetResponseData { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + total_private_repos: number; + owned_private_repos: number; + private_gists: number; + disk_usage: number; + collaborators: number; + billing_email: string; + plan: { + name: string; + space: number; + private_repos: number; + }; + default_repository_permission: string; + members_can_create_repositories: boolean; + two_factor_requirement_enabled: boolean; + members_allowed_repository_creation_type: string; + members_can_create_public_repositories: boolean; + members_can_create_private_repositories: boolean; + members_can_create_internal_repositories: boolean; +} +declare type OrgsUpdateEndpoint = { + org: string; + /** + * Billing email address. This address is not publicized. + */ + billing_email?: string; + /** + * The company name. + */ + company?: string; + /** + * The publicly visible email address. + */ + email?: string; + /** + * The Twitter username of the company. + */ + twitter_username?: string; + /** + * The location. + */ + location?: string; + /** + * The shorthand name of the company. + */ + name?: string; + /** + * The description of the company. + */ + description?: string; + /** + * Toggles whether an organization can use organization projects. + */ + has_organization_projects?: boolean; + /** + * Toggles whether repositories that belong to the organization can use repository projects. + */ + has_repository_projects?: boolean; + /** + * Default permission level members have for organization repositories: + * \* `read` - can pull, but not push to or administer this repository. + * \* `write` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push, and administer this repository. + * \* `none` - no permissions granted by default. + */ + default_repository_permission?: "read" | "write" | "admin" | "none"; + /** + * Toggles the ability of non-admin organization members to create repositories. Can be one of: + * \* `true` - all organization members can create repositories. + * \* `false` - only organization owners can create repositories. + * Default: `true` + * **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. + */ + members_can_create_repositories?: boolean; + /** + * Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: + * \* `true` - all organization members can create internal repositories. + * \* `false` - only organization owners can create internal repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_internal_repositories?: boolean; + /** + * Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: + * \* `true` - all organization members can create private repositories. + * \* `false` - only organization owners can create private repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_private_repositories?: boolean; + /** + * Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: + * \* `true` - all organization members can create public repositories. + * \* `false` - only organization owners can create public repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_public_repositories?: boolean; + /** + * Specifies which types of repositories non-admin organization members can create. Can be one of: + * \* `all` - all organization members can create public and private repositories. + * \* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. + * \* `none` - only admin members can create repositories. + * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + */ + members_allowed_repository_creation_type?: "all" | "private" | "none"; +}; +declare type OrgsUpdateRequestOptions = { + method: "PATCH"; + url: "/orgs/:org"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsUpdateResponseData { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + total_private_repos: number; + owned_private_repos: number; + private_gists: number; + disk_usage: number; + collaborators: number; + billing_email: string; + plan: { + name: string; + space: number; + private_repos: number; + }; + default_repository_permission: string; + members_can_create_repositories: boolean; + two_factor_requirement_enabled: boolean; + members_allowed_repository_creation_type: string; + members_can_create_public_repositories: boolean; + members_can_create_private_repositories: boolean; + members_can_create_internal_repositories: boolean; +} +declare type ActionsListSelfHostedRunnersForOrgEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListSelfHostedRunnersForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/runners"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListSelfHostedRunnersForOrgResponseData { + total_count: number; + runners: { + id: number; + name: string; + os: string; + status: string; + }[]; +} +declare type ActionsListRunnerApplicationsForOrgEndpoint = { + org: string; +}; +declare type ActionsListRunnerApplicationsForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/runners/downloads"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActionsListRunnerApplicationsForOrgResponseData = { + os: string; + architecture: string; + download_url: string; + filename: string; +}[]; +declare type ActionsCreateRegistrationTokenForOrgEndpoint = { + org: string; +}; +declare type ActionsCreateRegistrationTokenForOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/actions/runners/registration-token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsCreateRegistrationTokenForOrgResponseData { + token: string; + expires_at: string; +} +declare type ActionsCreateRemoveTokenForOrgEndpoint = { + org: string; +}; +declare type ActionsCreateRemoveTokenForOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/actions/runners/remove-token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsCreateRemoveTokenForOrgResponseData { + token: string; + expires_at: string; +} +declare type ActionsGetSelfHostedRunnerForOrgEndpoint = { + org: string; + runner_id: number; +}; +declare type ActionsGetSelfHostedRunnerForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/runners/:runner_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetSelfHostedRunnerForOrgResponseData { + id: number; + name: string; + os: string; + status: string; +} +declare type ActionsDeleteSelfHostedRunnerFromOrgEndpoint = { + org: string; + runner_id: number; +}; +declare type ActionsDeleteSelfHostedRunnerFromOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/actions/runners/:runner_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsListOrgSecretsEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListOrgSecretsRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/secrets"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListOrgSecretsResponseData { + total_count: number; + secrets: { + name: string; + created_at: string; + updated_at: string; + visibility: string; + selected_repositories_url: string; + }[]; +} +declare type ActionsGetOrgPublicKeyEndpoint = { + org: string; +}; +declare type ActionsGetOrgPublicKeyRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/secrets/public-key"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetOrgPublicKeyResponseData { + key_id: string; + key: string; +} +declare type ActionsGetOrgSecretEndpoint = { + org: string; + secret_name: string; +}; +declare type ActionsGetOrgSecretRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/secrets/:secret_name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetOrgSecretResponseData { + name: string; + created_at: string; + updated_at: string; + visibility: string; + selected_repositories_url: string; +} +declare type ActionsCreateOrUpdateOrgSecretEndpoint = { + org: string; + secret_name: string; + /** + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://developer.github.com/v3/actions/secrets/#get-an-organization-public-key) endpoint. + */ + encrypted_value?: string; + /** + * ID of the key you used to encrypt the secret. + */ + key_id?: string; + /** + * Configures the access that repositories have to the organization secret. Can be one of: + * \- `all` - All repositories in an organization can access the secret. + * \- `private` - Private repositories in an organization can access the secret. + * \- `selected` - Only specific repositories can access the secret. + */ + visibility?: "all" | "private" | "selected"; + /** + * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://developer.github.com/v3/actions/secrets/#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://developer.github.com/v3/actions/secrets/#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://developer.github.com/v3/actions/secrets/#remove-selected-repository-from-an-organization-secret) endpoints. + */ + selected_repository_ids?: string[]; +}; +declare type ActionsCreateOrUpdateOrgSecretRequestOptions = { + method: "PUT"; + url: "/orgs/:org/actions/secrets/:secret_name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsDeleteOrgSecretEndpoint = { + org: string; + secret_name: string; +}; +declare type ActionsDeleteOrgSecretRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/actions/secrets/:secret_name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsListSelectedReposForOrgSecretEndpoint = { + org: string; + secret_name: string; +}; +declare type ActionsListSelectedReposForOrgSecretRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/secrets/:secret_name/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListSelectedReposForOrgSecretResponseData { + total_count: number; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }[]; +} +declare type ActionsSetSelectedReposForOrgSecretEndpoint = { + org: string; + secret_name: string; + /** + * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://developer.github.com/v3/actions/secrets/#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://developer.github.com/v3/actions/secrets/#remove-selected-repository-from-an-organization-secret) endpoints. + */ + selected_repository_ids?: number[]; +}; +declare type ActionsSetSelectedReposForOrgSecretRequestOptions = { + method: "PUT"; + url: "/orgs/:org/actions/secrets/:secret_name/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsAddSelectedRepoToOrgSecretEndpoint = { + org: string; + secret_name: string; + repository_id: number; +}; +declare type ActionsAddSelectedRepoToOrgSecretRequestOptions = { + method: "PUT"; + url: "/orgs/:org/actions/secrets/:secret_name/repositories/:repository_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsRemoveSelectedRepoFromOrgSecretEndpoint = { + org: string; + secret_name: string; + repository_id: number; +}; +declare type ActionsRemoveSelectedRepoFromOrgSecretRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/actions/secrets/:secret_name/repositories/:repository_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsListBlockedUsersEndpoint = { + org: string; +}; +declare type OrgsListBlockedUsersRequestOptions = { + method: "GET"; + url: "/orgs/:org/blocks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListBlockedUsersResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type OrgsCheckBlockedUserEndpoint = { + org: string; + username: string; +}; +declare type OrgsCheckBlockedUserRequestOptions = { + method: "GET"; + url: "/orgs/:org/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsBlockUserEndpoint = { + org: string; + username: string; +}; +declare type OrgsBlockUserRequestOptions = { + method: "PUT"; + url: "/orgs/:org/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsUnblockUserEndpoint = { + org: string; + username: string; +}; +declare type OrgsUnblockUserRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsListCredentialAuthorizationsEndpoint = { + org: string; +}; +declare type OrgsListCredentialAuthorizationsRequestOptions = { + method: "GET"; + url: "/orgs/:org/credential-authorizations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListCredentialAuthorizationsResponseData = { + login: string; + credential_id: string; + credential_type: string; + token_last_eight: string; + credential_authorized_at: string; + scopes: string[]; +}[]; +declare type OrgsRemoveCredentialAuthorizationEndpoint = { + org: string; + credential_id: number; +}; +declare type OrgsRemoveCredentialAuthorizationRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/credential-authorizations/:credential_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListPublicOrgEventsEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListPublicOrgEventsRequestOptions = { + method: "GET"; + url: "/orgs/:org/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsListHooksEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListHooksRequestOptions = { + method: "GET"; + url: "/orgs/:org/hooks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListHooksResponseData = { + id: number; + url: string; + ping_url: string; + name: string; + events: string[]; + active: boolean; + config: { + url: string; + content_type: string; + }; + updated_at: string; + created_at: string; +}[]; +declare type OrgsCreateHookEndpoint = { + org: string; + /** + * Must be passed as "web". + */ + name: string; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params). + */ + config: OrgsCreateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/webhooks/event-payloads) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +declare type OrgsCreateHookRequestOptions = { + method: "POST"; + url: "/orgs/:org/hooks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsCreateHookResponseData { + id: number; + url: string; + ping_url: string; + name: string; + events: string[]; + active: boolean; + config: { + url: string; + content_type: string; + }; + updated_at: string; + created_at: string; +} +declare type OrgsGetHookEndpoint = { + org: string; + hook_id: number; +}; +declare type OrgsGetHookRequestOptions = { + method: "GET"; + url: "/orgs/:org/hooks/:hook_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsGetHookResponseData { + id: number; + url: string; + ping_url: string; + name: string; + events: string[]; + active: boolean; + config: { + url: string; + content_type: string; + }; + updated_at: string; + created_at: string; +} +declare type OrgsUpdateHookEndpoint = { + org: string; + hook_id: number; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params). + */ + config?: OrgsUpdateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/webhooks/event-payloads) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +declare type OrgsUpdateHookRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/hooks/:hook_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsUpdateHookResponseData { + id: number; + url: string; + ping_url: string; + name: string; + events: string[]; + active: boolean; + config: { + url: string; + content_type: string; + }; + updated_at: string; + created_at: string; +} +declare type OrgsDeleteHookEndpoint = { + org: string; + hook_id: number; +}; +declare type OrgsDeleteHookRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/hooks/:hook_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsPingHookEndpoint = { + org: string; + hook_id: number; +}; +declare type OrgsPingHookRequestOptions = { + method: "POST"; + url: "/orgs/:org/hooks/:hook_id/pings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsGetOrgInstallationEndpoint = { + org: string; +} & RequiredPreview<"machine-man">; +declare type AppsGetOrgInstallationRequestOptions = { + method: "GET"; + url: "/orgs/:org/installation"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetOrgInstallationResponseData { + id: number; + account: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repository_selection: "all" | "selected"; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + checks: string; + metadata: string; + contents: string; + }; + events: string[]; + created_at: string; + updated_at: string; + single_file_name: string; +} +declare type OrgsListInstallationsEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"machine-man">; +declare type OrgsListInstallationsRequestOptions = { + method: "GET"; + url: "/orgs/:org/installations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsListInstallationsResponseData { + total_count: number; + installations: { + id: number; + account: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repository_selection: "all" | "selected"; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + deployments: string; + metadata: string; + pull_requests: string; + statuses: string; + }; + events: string[]; + created_at: string; + updated_at: string; + single_file_name: string; + }[]; +} +declare type InteractionsGetRestrictionsForOrgEndpoint = { + org: string; +} & RequiredPreview<"sombra">; +declare type InteractionsGetRestrictionsForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/interaction-limits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface InteractionsGetRestrictionsForOrgResponseData { + limit: string; + origin: string; + expires_at: string; +} +declare type InteractionsAddOrUpdateRestrictionsForOrgEndpoint = { + org: string; + /** + * Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`. + */ + limit: "existing_users" | "contributors_only" | "collaborators_only"; +} & RequiredPreview<"sombra">; +declare type InteractionsAddOrUpdateRestrictionsForOrgRequestOptions = { + method: "PUT"; + url: "/orgs/:org/interaction-limits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface InteractionsAddOrUpdateRestrictionsForOrgResponseData { + limit: string; + origin: string; + expires_at: string; +} +declare type InteractionsRemoveRestrictionsForOrgEndpoint = { + org: string; +} & RequiredPreview<"sombra">; +declare type InteractionsRemoveRestrictionsForOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/interaction-limits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsListPendingInvitationsEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListPendingInvitationsRequestOptions = { + method: "GET"; + url: "/orgs/:org/invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListPendingInvitationsResponseData = { + id: number; + login: string; + email: string; + role: string; + created_at: string; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + team_count: number; + invitation_team_url: string; +}[]; +declare type OrgsCreateInvitationEndpoint = { + org: string; + /** + * **Required unless you provide `email`**. GitHub user ID for the person you are inviting. + */ + invitee_id?: number; + /** + * **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. + */ + email?: string; + /** + * Specify role for new member. Can be one of: + * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * \* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * \* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + */ + role?: "admin" | "direct_member" | "billing_manager"; + /** + * Specify IDs for the teams you want to invite new members to. + */ + team_ids?: number[]; +}; +declare type OrgsCreateInvitationRequestOptions = { + method: "POST"; + url: "/orgs/:org/invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsCreateInvitationResponseData { + id: number; + login: string; + email: string; + role: string; + created_at: string; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + team_count: number; + invitation_team_url: string; +} +declare type OrgsListInvitationTeamsEndpoint = { + org: string; + invitation_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListInvitationTeamsRequestOptions = { + method: "GET"; + url: "/orgs/:org/invitations/:invitation_id/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListInvitationTeamsResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type IssuesListForOrgEndpoint = { + org: string; + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/issues"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListForOrgResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +}[]; +declare type OrgsListMembersEndpoint = { + org: string; + /** + * Filter members returned in the list. Can be one of: + * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. + * \* `all` - All members the authenticated user can see. + */ + filter?: "2fa_disabled" | "all"; + /** + * Filter members returned by their role. Can be one of: + * \* `all` - All members of the organization, regardless of role. + * \* `admin` - Organization owners. + * \* `member` - Non-owner organization members. + */ + role?: "all" | "admin" | "member"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListMembersRequestOptions = { + method: "GET"; + url: "/orgs/:org/members"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListMembersResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type OrgsCheckMembershipEndpoint = { + org: string; + username: string; +}; +declare type OrgsCheckMembershipRequestOptions = { + method: "GET"; + url: "/orgs/:org/members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsRemoveMemberEndpoint = { + org: string; + username: string; +}; +declare type OrgsRemoveMemberRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsGetMembershipEndpoint = { + org: string; + username: string; +}; +declare type OrgsGetMembershipRequestOptions = { + method: "GET"; + url: "/orgs/:org/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsGetMembershipResponseData { + url: string; + state: string; + role: string; + organization_url: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type OrgsAddOrUpdateMembershipEndpoint = { + org: string; + username: string; + /** + * The role to give the user in the organization. Can be one of: + * \* `admin` - The user will become an owner of the organization. + * \* `member` - The user will become a non-owner member of the organization. + */ + role?: "admin" | "member"; +}; +declare type OrgsAddOrUpdateMembershipRequestOptions = { + method: "PUT"; + url: "/orgs/:org/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsAddOrUpdateMembershipResponseData { + url: string; + state: string; + role: string; + organization_url: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type OrgsRemoveMembershipEndpoint = { + org: string; + username: string; +}; +declare type OrgsRemoveMembershipRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsStartForOrgEndpoint = { + org: string; + /** + * A list of arrays indicating which repositories should be migrated. + */ + repositories: string[]; + /** + * Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + */ + lock_repositories?: boolean; + /** + * Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + */ + exclude_attachments?: boolean; +}; +declare type MigrationsStartForOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/migrations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsStartForOrgResponseData { + id: number; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; + url: string; + created_at: string; + updated_at: string; +} +declare type MigrationsListForOrgEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsListForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/migrations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type MigrationsListForOrgResponseData = { + id: number; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; + url: string; + created_at: string; + updated_at: string; +}[]; +declare type MigrationsGetStatusForOrgEndpoint = { + org: string; + migration_id: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsGetStatusForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/migrations/:migration_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsGetStatusForOrgResponseData { + id: number; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; + url: string; + created_at: string; + updated_at: string; +} +declare type MigrationsDownloadArchiveForOrgEndpoint = { + org: string; + migration_id: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsDownloadArchiveForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/migrations/:migration_id/archive"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsDeleteArchiveForOrgEndpoint = { + org: string; + migration_id: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsDeleteArchiveForOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/migrations/:migration_id/archive"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsUnlockRepoForOrgEndpoint = { + org: string; + migration_id: number; + repo_name: string; +} & RequiredPreview<"wyandotte">; +declare type MigrationsUnlockRepoForOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/migrations/:migration_id/repos/:repo_name/lock"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsListReposForOrgEndpoint = { + org: string; + migration_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsListReposForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/migrations/:migration_id/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type MigrationsListReposForOrgResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type OrgsListOutsideCollaboratorsEndpoint = { + org: string; + /** + * Filter the list of outside collaborators. Can be one of: + * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. + * \* `all`: All outside collaborators. + */ + filter?: "2fa_disabled" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListOutsideCollaboratorsRequestOptions = { + method: "GET"; + url: "/orgs/:org/outside_collaborators"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListOutsideCollaboratorsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type OrgsRemoveOutsideCollaboratorEndpoint = { + org: string; + username: string; +}; +declare type OrgsRemoveOutsideCollaboratorRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/outside_collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsRemoveOutsideCollaboratorResponseData { + message: string; + documentation_url: string; +} +declare type OrgsConvertMemberToOutsideCollaboratorEndpoint = { + org: string; + username: string; +}; +declare type OrgsConvertMemberToOutsideCollaboratorRequestOptions = { + method: "PUT"; + url: "/orgs/:org/outside_collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsConvertMemberToOutsideCollaboratorResponseData { + message: string; + documentation_url: string; +} +declare type ProjectsListForOrgEndpoint = { + org: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsListForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ProjectsListForOrgResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type ProjectsCreateForOrgEndpoint = { + org: string; + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +} & RequiredPreview<"inertia">; +declare type ProjectsCreateForOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsCreateForOrgResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type OrgsListPublicMembersEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListPublicMembersRequestOptions = { + method: "GET"; + url: "/orgs/:org/public_members"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListPublicMembersResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type OrgsCheckPublicMembershipEndpoint = { + org: string; + username: string; +}; +declare type OrgsCheckPublicMembershipRequestOptions = { + method: "GET"; + url: "/orgs/:org/public_members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsPublicizeMembershipEndpoint = { + org: string; + username: string; +}; +declare type OrgsPublicizeMembershipRequestOptions = { + method: "PUT"; + url: "/orgs/:org/public_members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsConcealMembershipEndpoint = { + org: string; + username: string; +}; +declare type OrgsConcealMembershipRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/public_members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListForOrgEndpoint = { + org: string; + /** + * Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. + */ + type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListForOrgResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type ReposCreateInOrgEndpoint = { + org: string; + /** + * The name of the repository. + */ + name: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to create a private repository or `false` to create a public one. + */ + private?: boolean; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see "[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + */ + team_id?: number; + /** + * Pass `true` to create an initial commit with empty README. + */ + auto_init?: boolean; + /** + * Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". + */ + gitignore_template?: string; + /** + * Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". + */ + license_template?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; +}; +declare type ReposCreateInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateInOrgResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +} +declare type TeamsListIdPGroupsForOrgEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListIdPGroupsForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/team-sync/groups"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsListIdPGroupsForOrgResponseData { + groups: { + group_id: string; + group_name: string; + group_description: string; + }[]; +} +declare type TeamsListEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type TeamsCreateEndpoint = { + org: string; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * List GitHub IDs for organization members who will become team maintainers. + */ + maintainers?: string[]; + /** + * The full name (e.g., "organization-name/repository-name") of repositories to add the team to. + */ + repo_names?: string[]; + /** + * The level of privacy this team should have. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + * Default for child team: `closed` + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; +}; +declare type TeamsCreateRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + }; +} +declare type TeamsGetByNameEndpoint = { + org: string; + team_slug: string; +}; +declare type TeamsGetByNameRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetByNameResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + }; +} +declare type TeamsUpdateInOrgEndpoint = { + org: string; + team_slug: string; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; +}; +declare type TeamsUpdateInOrgRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/teams/:team_slug"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsUpdateInOrgResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + }; +} +declare type TeamsDeleteInOrgEndpoint = { + org: string; + team_slug: string; +}; +declare type TeamsDeleteInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListDiscussionsInOrgEndpoint = { + org: string; + team_slug: string; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListDiscussionsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListDiscussionsInOrgResponseData = { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +}[]; +declare type TeamsCreateDiscussionInOrgEndpoint = { + org: string; + team_slug: string; + /** + * The discussion post's title. + */ + title: string; + /** + * The discussion post's body text. + */ + body: string; + /** + * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + */ + private?: boolean; +}; +declare type TeamsCreateDiscussionInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams/:team_slug/discussions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateDiscussionInOrgResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsGetDiscussionInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; +}; +declare type TeamsGetDiscussionInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetDiscussionInOrgResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsUpdateDiscussionInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + /** + * The discussion post's title. + */ + title?: string; + /** + * The discussion post's body text. + */ + body?: string; +}; +declare type TeamsUpdateDiscussionInOrgRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsUpdateDiscussionInOrgResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsDeleteDiscussionInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; +}; +declare type TeamsDeleteDiscussionInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListDiscussionCommentsInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListDiscussionCommentsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListDiscussionCommentsInOrgResponseData = { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +}[]; +declare type TeamsCreateDiscussionCommentInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +declare type TeamsCreateDiscussionCommentInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateDiscussionCommentInOrgResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsGetDiscussionCommentInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + comment_number: number; +}; +declare type TeamsGetDiscussionCommentInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetDiscussionCommentInOrgResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsUpdateDiscussionCommentInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + comment_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +declare type TeamsUpdateDiscussionCommentInOrgRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsUpdateDiscussionCommentInOrgResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsDeleteDiscussionCommentInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + comment_number: number; +}; +declare type TeamsDeleteDiscussionCommentInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForTeamDiscussionCommentInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + comment_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForTeamDiscussionCommentInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForTeamDiscussionCommentInOrgResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForTeamDiscussionCommentInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + comment_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForTeamDiscussionCommentInOrgResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsDeleteForTeamDiscussionCommentEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + comment_number: number; + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteForTeamDiscussionCommentRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForTeamDiscussionInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForTeamDiscussionInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForTeamDiscussionInOrgResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForTeamDiscussionInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForTeamDiscussionInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForTeamDiscussionInOrgResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsDeleteForTeamDiscussionEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteForTeamDiscussionRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListPendingInvitationsInOrgEndpoint = { + org: string; + team_slug: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListPendingInvitationsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListPendingInvitationsInOrgResponseData = { + id: number; + login: string; + email: string; + role: string; + created_at: string; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + team_count: number; + invitation_team_url: string; +}[]; +declare type TeamsListMembersInOrgEndpoint = { + org: string; + team_slug: string; + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListMembersInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/members"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListMembersInOrgResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type TeamsGetMembershipForUserInOrgEndpoint = { + org: string; + team_slug: string; + username: string; +}; +declare type TeamsGetMembershipForUserInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetMembershipForUserInOrgResponseData { + url: string; + role: string; + state: string; +} +declare type TeamsAddOrUpdateMembershipForUserInOrgEndpoint = { + org: string; + team_slug: string; + username: string; + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; +}; +declare type TeamsAddOrUpdateMembershipForUserInOrgRequestOptions = { + method: "PUT"; + url: "/orgs/:org/teams/:team_slug/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsAddOrUpdateMembershipForUserInOrgResponseData { + url: string; + role: string; + state: string; +} +export interface TeamsAddOrUpdateMembershipForUserInOrgResponse422Data { + message: string; + errors: { + code: string; + field: string; + resource: string; + }[]; +} +declare type TeamsRemoveMembershipForUserInOrgEndpoint = { + org: string; + team_slug: string; + username: string; +}; +declare type TeamsRemoveMembershipForUserInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListProjectsInOrgEndpoint = { + org: string; + team_slug: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type TeamsListProjectsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListProjectsInOrgResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + organization_permission: string; + private: boolean; + permissions: { + read: boolean; + write: boolean; + admin: boolean; + }; +}[]; +declare type TeamsCheckPermissionsForProjectInOrgEndpoint = { + org: string; + team_slug: string; + project_id: number; +} & RequiredPreview<"inertia">; +declare type TeamsCheckPermissionsForProjectInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCheckPermissionsForProjectInOrgResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + organization_permission: string; + private: boolean; + permissions: { + read: boolean; + write: boolean; + admin: boolean; + }; +} +declare type TeamsAddOrUpdateProjectPermissionsInOrgEndpoint = { + org: string; + team_slug: string; + project_id: number; + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + */ + permission?: "read" | "write" | "admin"; +} & RequiredPreview<"inertia">; +declare type TeamsAddOrUpdateProjectPermissionsInOrgRequestOptions = { + method: "PUT"; + url: "/orgs/:org/teams/:team_slug/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsAddOrUpdateProjectPermissionsInOrgResponseData { + message: string; + documentation_url: string; +} +declare type TeamsRemoveProjectInOrgEndpoint = { + org: string; + team_slug: string; + project_id: number; +}; +declare type TeamsRemoveProjectInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListReposInOrgEndpoint = { + org: string; + team_slug: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListReposInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListReposInOrgResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type TeamsCheckPermissionsForRepoInOrgEndpoint = { + org: string; + team_slug: string; + owner: string; + repo: string; +}; +declare type TeamsCheckPermissionsForRepoInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCheckPermissionsForRepoInOrgResponseData { + organization: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parent: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + source: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + permissions: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; +} +declare type TeamsAddOrUpdateRepoPermissionsInOrgEndpoint = { + org: string; + team_slug: string; + owner: string; + repo: string; + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * \* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. + * \* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + */ + permission?: "pull" | "push" | "admin" | "maintain" | "triage"; +}; +declare type TeamsAddOrUpdateRepoPermissionsInOrgRequestOptions = { + method: "PUT"; + url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsRemoveRepoInOrgEndpoint = { + org: string; + team_slug: string; + owner: string; + repo: string; +}; +declare type TeamsRemoveRepoInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListIdPGroupsInOrgEndpoint = { + org: string; + team_slug: string; +}; +declare type TeamsListIdPGroupsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/team-sync/group-mappings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsListIdPGroupsInOrgResponseData { + groups: { + group_id: string; + group_name: string; + group_description: string; + }[]; +} +declare type TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint = { + org: string; + team_slug: string; + /** + * The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. + */ + groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups[]; +}; +declare type TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/teams/:team_slug/team-sync/group-mappings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseData { + groups: { + group_id: string; + group_name: string; + group_description: string; + }; +} +declare type TeamsListChildInOrgEndpoint = { + org: string; + team_slug: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListChildInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListChildInOrgResponseData = { + id: number; + node_id: string; + url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + }; +}[]; +declare type ProjectsGetCardEndpoint = { + card_id: number; +} & RequiredPreview<"inertia">; +declare type ProjectsGetCardRequestOptions = { + method: "GET"; + url: "/projects/columns/cards/:card_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsGetCardResponseData { + url: string; + id: number; + node_id: string; + note: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + archived: boolean; + column_url: string; + content_url: string; + project_url: string; +} +declare type ProjectsUpdateCardEndpoint = { + card_id: number; + /** + * The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`. + */ + note?: string; + /** + * Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card. + */ + archived?: boolean; +} & RequiredPreview<"inertia">; +declare type ProjectsUpdateCardRequestOptions = { + method: "PATCH"; + url: "/projects/columns/cards/:card_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsUpdateCardResponseData { + url: string; + id: number; + node_id: string; + note: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + archived: boolean; + column_url: string; + content_url: string; + project_url: string; +} +declare type ProjectsDeleteCardEndpoint = { + card_id: number; +} & RequiredPreview<"inertia">; +declare type ProjectsDeleteCardRequestOptions = { + method: "DELETE"; + url: "/projects/columns/cards/:card_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsMoveCardEndpoint = { + card_id: number; + /** + * Can be one of `top`, `bottom`, or `after:`, where `` is the `id` value of a card in the same column, or in the new column specified by `column_id`. + */ + position: string; + /** + * The `id` value of a column in the same project. + */ + column_id?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsMoveCardRequestOptions = { + method: "POST"; + url: "/projects/columns/cards/:card_id/moves"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsGetColumnEndpoint = { + column_id: number; +} & RequiredPreview<"inertia">; +declare type ProjectsGetColumnRequestOptions = { + method: "GET"; + url: "/projects/columns/:column_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsGetColumnResponseData { + url: string; + project_url: string; + cards_url: string; + id: number; + node_id: string; + name: string; + created_at: string; + updated_at: string; +} +declare type ProjectsUpdateColumnEndpoint = { + column_id: number; + /** + * The new name of the column. + */ + name: string; +} & RequiredPreview<"inertia">; +declare type ProjectsUpdateColumnRequestOptions = { + method: "PATCH"; + url: "/projects/columns/:column_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsUpdateColumnResponseData { + url: string; + project_url: string; + cards_url: string; + id: number; + node_id: string; + name: string; + created_at: string; + updated_at: string; +} +declare type ProjectsDeleteColumnEndpoint = { + column_id: number; +} & RequiredPreview<"inertia">; +declare type ProjectsDeleteColumnRequestOptions = { + method: "DELETE"; + url: "/projects/columns/:column_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsListCardsEndpoint = { + column_id: number; + /** + * Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. + */ + archived_state?: "all" | "archived" | "not_archived"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsListCardsRequestOptions = { + method: "GET"; + url: "/projects/columns/:column_id/cards"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ProjectsListCardsResponseData = { + url: string; + id: number; + node_id: string; + note: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + archived: boolean; + column_url: string; + content_url: string; + project_url: string; +}[]; +declare type ProjectsCreateCardEndpoint = { + column_id: number; + /** + * The card's note content. Only valid for cards without another type of content, so you must omit when specifying `content_id` and `content_type`. + */ + note?: string; + /** + * The issue or pull request id you want to associate with this card. You can use the [List repository issues](https://developer.github.com/v3/issues/#list-repository-issues) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. + * **Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`. + */ + content_id?: number; + /** + * **Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id. + */ + content_type?: string; +} & RequiredPreview<"inertia">; +declare type ProjectsCreateCardRequestOptions = { + method: "POST"; + url: "/projects/columns/:column_id/cards"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsCreateCardResponseData { + url: string; + id: number; + node_id: string; + note: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + archived: boolean; + column_url: string; + content_url: string; + project_url: string; +} +declare type ProjectsMoveColumnEndpoint = { + column_id: number; + /** + * Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project. + */ + position: string; +} & RequiredPreview<"inertia">; +declare type ProjectsMoveColumnRequestOptions = { + method: "POST"; + url: "/projects/columns/:column_id/moves"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsGetEndpoint = { + project_id: number; +} & RequiredPreview<"inertia">; +declare type ProjectsGetRequestOptions = { + method: "GET"; + url: "/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsGetResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type ProjectsUpdateEndpoint = { + project_id: number; + /** + * The name of the project. + */ + name?: string; + /** + * The description of the project. + */ + body?: string; + /** + * State of the project. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project permissions](https://developer.github.com/v3/teams/#add-or-update-team-project-permissions) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). + * + * **Note:** Updating a project's `organization_permission` requires `admin` access to the project. + * + * Can be one of: + * \* `read` - Organization members can read, but not write to or administer this project. + * \* `write` - Organization members can read and write, but not administer this project. + * \* `admin` - Organization members can read, write and administer this project. + * \* `none` - Organization members can only see this project if it is public. + */ + organization_permission?: string; + /** + * Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. + * + * Can be one of: + * \* `false` - Anyone can see the project. + * \* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account. + */ + private?: boolean; +} & RequiredPreview<"inertia">; +declare type ProjectsUpdateRequestOptions = { + method: "PATCH"; + url: "/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsUpdateResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type ProjectsDeleteEndpoint = { + project_id: number; +} & RequiredPreview<"inertia">; +declare type ProjectsDeleteRequestOptions = { + method: "DELETE"; + url: "/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsListCollaboratorsEndpoint = { + project_id: number; + /** + * Filters the collaborators by their affiliation. Can be one of: + * \* `outside`: Outside collaborators of a project that are not a member of the project's organization. + * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsListCollaboratorsRequestOptions = { + method: "GET"; + url: "/projects/:project_id/collaborators"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ProjectsListCollaboratorsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type ProjectsAddCollaboratorEndpoint = { + project_id: number; + username: string; + /** + * The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." Can be one of: + * \* `read` - can read, but not write to or administer this project. + * \* `write` - can read and write, but not administer this project. + * \* `admin` - can read, write and administer this project. + */ + permission?: "read" | "write" | "admin"; +} & RequiredPreview<"inertia">; +declare type ProjectsAddCollaboratorRequestOptions = { + method: "PUT"; + url: "/projects/:project_id/collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsRemoveCollaboratorEndpoint = { + project_id: number; + username: string; +} & RequiredPreview<"inertia">; +declare type ProjectsRemoveCollaboratorRequestOptions = { + method: "DELETE"; + url: "/projects/:project_id/collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsReviewUserPermissionLevelEndpoint = { + project_id: number; + username: string; +} & RequiredPreview<"inertia">; +declare type ProjectsReviewUserPermissionLevelRequestOptions = { + method: "GET"; + url: "/projects/:project_id/collaborators/:username/permission"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsReviewUserPermissionLevelResponseData { + permission: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type ProjectsListColumnsEndpoint = { + project_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsListColumnsRequestOptions = { + method: "GET"; + url: "/projects/:project_id/columns"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ProjectsListColumnsResponseData = { + url: string; + project_url: string; + cards_url: string; + id: number; + node_id: string; + name: string; + created_at: string; + updated_at: string; +}[]; +declare type ProjectsCreateColumnEndpoint = { + project_id: number; + /** + * The name of the column. + */ + name: string; +} & RequiredPreview<"inertia">; +declare type ProjectsCreateColumnRequestOptions = { + method: "POST"; + url: "/projects/:project_id/columns"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsCreateColumnResponseData { + url: string; + project_url: string; + cards_url: string; + id: number; + node_id: string; + name: string; + created_at: string; + updated_at: string; +} +declare type RateLimitGetEndpoint = {}; +declare type RateLimitGetRequestOptions = { + method: "GET"; + url: "/rate_limit"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface RateLimitGetResponseData { + resources: { + core: { + limit: number; + remaining: number; + reset: number; + }; + search: { + limit: number; + remaining: number; + reset: number; + }; + graphql: { + limit: number; + remaining: number; + reset: number; + }; + integration_manifest: { + limit: number; + remaining: number; + reset: number; + }; + }; + rate: { + limit: number; + remaining: number; + reset: number; + }; +} +declare type ReactionsDeleteLegacyEndpoint = { + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteLegacyRequestOptions = { + method: "DELETE"; + url: "/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; + organization: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parent: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + source: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +} +declare type ReposUpdateEndpoint = { + owner: string; + repo: string; + /** + * The name of the repository. + */ + name?: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to make the repository private or `false` to make it public. Default: `false`. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + */ + private?: boolean; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * Updates the default branch for this repository. + */ + default_branch?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; + /** + * `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. + */ + archived?: boolean; +}; +declare type ReposUpdateRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + organization: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parent: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + source: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +} +declare type ReposDeleteEndpoint = { + owner: string; + repo: string; +}; +declare type ReposDeleteRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposDeleteResponseData { + message: string; + documentation_url: string; +} +declare type ActionsListArtifactsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListArtifactsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/artifacts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListArtifactsForRepoResponseData { + total_count: number; + artifacts: { + id: number; + node_id: string; + name: string; + size_in_bytes: number; + url: string; + archive_download_url: string; + expired: boolean; + created_at: string; + expires_at: string; + }[]; +} +declare type ActionsGetArtifactEndpoint = { + owner: string; + repo: string; + artifact_id: number; +}; +declare type ActionsGetArtifactRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetArtifactResponseData { + id: number; + node_id: string; + name: string; + size_in_bytes: number; + url: string; + archive_download_url: string; + expired: boolean; + created_at: string; + expires_at: string; +} +declare type ActionsDeleteArtifactEndpoint = { + owner: string; + repo: string; + artifact_id: number; +}; +declare type ActionsDeleteArtifactRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsDownloadArtifactEndpoint = { + owner: string; + repo: string; + artifact_id: number; + archive_format: string; +}; +declare type ActionsDownloadArtifactRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsGetWorkflowJobEndpoint = { + owner: string; + repo: string; + job_id: number; +}; +declare type ActionsGetWorkflowJobRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/jobs/:job_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetWorkflowJobResponseData { + id: number; + run_id: number; + run_url: string; + node_id: string; + head_sha: string; + url: string; + html_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + name: string; + steps: { + name: string; + status: string; + conclusion: string; + number: number; + started_at: string; + completed_at: string; + }[]; + check_run_url: string; +} +declare type ActionsDownloadWorkflowJobLogsEndpoint = { + owner: string; + repo: string; + job_id: number; +}; +declare type ActionsDownloadWorkflowJobLogsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/jobs/:job_id/logs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsListSelfHostedRunnersForRepoEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListSelfHostedRunnersForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runners"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListSelfHostedRunnersForRepoResponseData { + total_count: number; + runners: { + id: number; + name: string; + os: string; + status: string; + }[]; +} +declare type ActionsListRunnerApplicationsForRepoEndpoint = { + owner: string; + repo: string; +}; +declare type ActionsListRunnerApplicationsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runners/downloads"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActionsListRunnerApplicationsForRepoResponseData = { + os: string; + architecture: string; + download_url: string; + filename: string; +}[]; +declare type ActionsCreateRegistrationTokenForRepoEndpoint = { + owner: string; + repo: string; +}; +declare type ActionsCreateRegistrationTokenForRepoRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/actions/runners/registration-token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsCreateRegistrationTokenForRepoResponseData { + token: string; + expires_at: string; +} +declare type ActionsCreateRemoveTokenForRepoEndpoint = { + owner: string; + repo: string; +}; +declare type ActionsCreateRemoveTokenForRepoRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/actions/runners/remove-token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsCreateRemoveTokenForRepoResponseData { + token: string; + expires_at: string; +} +declare type ActionsGetSelfHostedRunnerForRepoEndpoint = { + owner: string; + repo: string; + runner_id: number; +}; +declare type ActionsGetSelfHostedRunnerForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runners/:runner_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetSelfHostedRunnerForRepoResponseData { + id: number; + name: string; + os: string; + status: string; +} +declare type ActionsDeleteSelfHostedRunnerFromRepoEndpoint = { + owner: string; + repo: string; + runner_id: number; +}; +declare type ActionsDeleteSelfHostedRunnerFromRepoRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/actions/runners/:runner_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsListRepoWorkflowRunsEndpoint = { + owner: string; + repo: string; + /** + * Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. + */ + actor?: string; + /** + * Returns workflow runs associated with a branch. Use the name of the branch of the `push`. + */ + branch?: string; + /** + * Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)" in the GitHub Help documentation. + */ + event?: string; + /** + * Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in "[Create a check run](https://developer.github.com/v3/checks/runs/#create-a-check-run)." + */ + status?: "completed" | "status" | "conclusion"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListRepoWorkflowRunsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListRepoWorkflowRunsResponseData { + total_count: number; + workflow_runs: { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + run_number: number; + event: string; + status: string; + conclusion: string; + workflow_id: number; + url: string; + html_url: string; + pull_requests: unknown[]; + created_at: string; + updated_at: string; + jobs_url: string; + logs_url: string; + check_suite_url: string; + artifacts_url: string; + cancel_url: string; + rerun_url: string; + workflow_url: string; + head_commit: { + id: string; + tree_id: string; + message: string; + timestamp: string; + author: { + name: string; + email: string; + }; + committer: { + name: string; + email: string; + }; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + head_repository: { + id: number; + node_id: string; + name: string; + full_name: string; + private: boolean; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + html_url: string; + description: string; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; + }; + }[]; +} +declare type ActionsGetWorkflowRunEndpoint = { + owner: string; + repo: string; + run_id: number; +}; +declare type ActionsGetWorkflowRunRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetWorkflowRunResponseData { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + run_number: number; + event: string; + status: string; + conclusion: string; + workflow_id: number; + url: string; + html_url: string; + pull_requests: unknown[]; + created_at: string; + updated_at: string; + jobs_url: string; + logs_url: string; + check_suite_url: string; + artifacts_url: string; + cancel_url: string; + rerun_url: string; + workflow_url: string; + head_commit: { + id: string; + tree_id: string; + message: string; + timestamp: string; + author: { + name: string; + email: string; + }; + committer: { + name: string; + email: string; + }; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + head_repository: { + id: number; + node_id: string; + name: string; + full_name: string; + private: boolean; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + html_url: string; + description: string; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; + }; +} +declare type ActionsListWorkflowRunArtifactsEndpoint = { + owner: string; + repo: string; + run_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListWorkflowRunArtifactsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id/artifacts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListWorkflowRunArtifactsResponseData { + total_count: number; + artifacts: { + id: number; + node_id: string; + name: string; + size_in_bytes: number; + url: string; + archive_download_url: string; + expired: boolean; + created_at: string; + expires_at: string; + }[]; +} +declare type ActionsCancelWorkflowRunEndpoint = { + owner: string; + repo: string; + run_id: number; +}; +declare type ActionsCancelWorkflowRunRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/actions/runs/:run_id/cancel"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsListJobsForWorkflowRunEndpoint = { + owner: string; + repo: string; + run_id: number; + /** + * Filters jobs by their `completed_at` timestamp. Can be one of: + * \* `latest`: Returns jobs from the most recent execution of the workflow run. + * \* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListJobsForWorkflowRunRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id/jobs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListJobsForWorkflowRunResponseData { + total_count: number; + jobs: { + id: number; + run_id: number; + run_url: string; + node_id: string; + head_sha: string; + url: string; + html_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + name: string; + steps: { + name: string; + status: string; + conclusion: string; + number: number; + started_at: string; + completed_at: string; + }[]; + check_run_url: string; + }[]; +} +declare type ActionsDownloadWorkflowRunLogsEndpoint = { + owner: string; + repo: string; + run_id: number; +}; +declare type ActionsDownloadWorkflowRunLogsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id/logs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsDeleteWorkflowRunLogsEndpoint = { + owner: string; + repo: string; + run_id: number; +}; +declare type ActionsDeleteWorkflowRunLogsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/actions/runs/:run_id/logs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsReRunWorkflowEndpoint = { + owner: string; + repo: string; + run_id: number; +}; +declare type ActionsReRunWorkflowRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/actions/runs/:run_id/rerun"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsGetWorkflowRunUsageEndpoint = { + owner: string; + repo: string; + run_id: number; +}; +declare type ActionsGetWorkflowRunUsageRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id/timing"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetWorkflowRunUsageResponseData { + billable: { + UBUNTU: { + total_ms: number; + jobs: number; + }; + MACOS: { + total_ms: number; + jobs: number; + }; + WINDOWS: { + total_ms: number; + jobs: number; + }; + }; + run_duration_ms: number; +} +declare type ActionsListRepoSecretsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListRepoSecretsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/secrets"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListRepoSecretsResponseData { + total_count: number; + secrets: { + name: string; + created_at: string; + updated_at: string; + }[]; +} +declare type ActionsGetRepoPublicKeyEndpoint = { + owner: string; + repo: string; +}; +declare type ActionsGetRepoPublicKeyRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/secrets/public-key"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetRepoPublicKeyResponseData { + key_id: string; + key: string; +} +declare type ActionsGetRepoSecretEndpoint = { + owner: string; + repo: string; + secret_name: string; +}; +declare type ActionsGetRepoSecretRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/secrets/:secret_name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetRepoSecretResponseData { + name: string; + created_at: string; + updated_at: string; +} +declare type ActionsCreateOrUpdateRepoSecretEndpoint = { + owner: string; + repo: string; + secret_name: string; + /** + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://developer.github.com/v3/actions/secrets/#get-a-repository-public-key) endpoint. + */ + encrypted_value?: string; + /** + * ID of the key you used to encrypt the secret. + */ + key_id?: string; +}; +declare type ActionsCreateOrUpdateRepoSecretRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/actions/secrets/:secret_name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsDeleteRepoSecretEndpoint = { + owner: string; + repo: string; + secret_name: string; +}; +declare type ActionsDeleteRepoSecretRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/actions/secrets/:secret_name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsListRepoWorkflowsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListRepoWorkflowsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/workflows"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListRepoWorkflowsResponseData { + total_count: number; + workflows: { + id: number; + node_id: string; + name: string; + path: string; + state: string; + created_at: string; + updated_at: string; + url: string; + html_url: string; + badge_url: string; + }[]; +} +declare type ActionsGetWorkflowEndpoint = { + owner: string; + repo: string; + workflow_id: number; +}; +declare type ActionsGetWorkflowRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/workflows/:workflow_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetWorkflowResponseData { + id: number; + node_id: string; + name: string; + path: string; + state: string; + created_at: string; + updated_at: string; + url: string; + html_url: string; + badge_url: string; +} +declare type ActionsListWorkflowRunsEndpoint = { + owner: string; + repo: string; + workflow_id: number; + /** + * Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. + */ + actor?: string; + /** + * Returns workflow runs associated with a branch. Use the name of the branch of the `push`. + */ + branch?: string; + /** + * Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)" in the GitHub Help documentation. + */ + event?: string; + /** + * Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in "[Create a check run](https://developer.github.com/v3/checks/runs/#create-a-check-run)." + */ + status?: "completed" | "status" | "conclusion"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListWorkflowRunsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/workflows/:workflow_id/runs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListWorkflowRunsResponseData { + total_count: number; + workflow_runs: { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + run_number: number; + event: string; + status: string; + conclusion: string; + workflow_id: number; + url: string; + html_url: string; + pull_requests: unknown[]; + created_at: string; + updated_at: string; + jobs_url: string; + logs_url: string; + check_suite_url: string; + artifacts_url: string; + cancel_url: string; + rerun_url: string; + workflow_url: string; + head_commit: { + id: string; + tree_id: string; + message: string; + timestamp: string; + author: { + name: string; + email: string; + }; + committer: { + name: string; + email: string; + }; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + head_repository: { + id: number; + node_id: string; + name: string; + full_name: string; + private: boolean; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + html_url: string; + description: string; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; + }; + }[]; +} +declare type ActionsGetWorkflowUsageEndpoint = { + owner: string; + repo: string; + workflow_id: number; +}; +declare type ActionsGetWorkflowUsageRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/workflows/:workflow_id/timing"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetWorkflowUsageResponseData { + billable: { + UBUNTU: { + total_ms: number; + }; + MACOS: { + total_ms: number; + }; + WINDOWS: { + total_ms: number; + }; + }; +} +declare type IssuesListAssigneesEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListAssigneesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/assignees"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListAssigneesResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type IssuesCheckUserCanBeAssignedEndpoint = { + owner: string; + repo: string; + assignee: string; +}; +declare type IssuesCheckUserCanBeAssignedRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/assignees/:assignee"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposEnableAutomatedSecurityFixesEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"london">; +declare type ReposEnableAutomatedSecurityFixesRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/automated-security-fixes"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposDisableAutomatedSecurityFixesEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"london">; +declare type ReposDisableAutomatedSecurityFixesRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/automated-security-fixes"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListBranchesEndpoint = { + owner: string; + repo: string; + /** + * Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. + */ + protected?: boolean; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListBranchesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListBranchesResponseData = { + name: string; + commit: { + sha: string; + url: string; + }; + protected: boolean; + protection: { + enabled: boolean; + required_status_checks: { + enforcement_level: string; + contexts: string[]; + }; + }; + protection_url: string; +}[]; +declare type ReposGetBranchEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetBranchRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetBranchResponseData { + name: string; + commit: { + sha: string; + node_id: string; + commit: { + author: { + name: string; + date: string; + email: string; + }; + url: string; + message: string; + tree: { + sha: string; + url: string; + }; + committer: { + name: string; + date: string; + email: string; + }; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + gravatar_id: string; + avatar_url: string; + url: string; + id: number; + login: string; + }; + parents: { + sha: string; + url: string; + }[]; + url: string; + committer: { + gravatar_id: string; + avatar_url: string; + url: string; + id: number; + login: string; + }; + }; + _links: { + html: string; + self: string; + }; + protected: boolean; + protection: { + enabled: boolean; + required_status_checks: { + enforcement_level: string; + contexts: string[]; + }; + }; + protection_url: string; +} +declare type ReposGetBranchProtectionEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetBranchProtectionRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetBranchProtectionResponseData { + url: string; + required_status_checks: { + url: string; + strict: boolean; + contexts: string[]; + contexts_url: string; + }; + enforce_admins: { + url: string; + enabled: boolean; + }; + required_pull_request_reviews: { + url: string; + dismissal_restrictions: { + url: string; + users_url: string; + teams_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + }; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count: number; + }; + restrictions: { + url: string; + users_url: string; + teams_url: string; + apps_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + apps: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }[]; + }; + required_linear_history: { + enabled: boolean; + }; + allow_force_pushes: { + enabled: boolean; + }; + allow_deletions: { + enabled: boolean; + }; +} +declare type ReposUpdateBranchProtectionEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * Require status checks to pass before merging. Set to `null` to disable. + */ + required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null; + /** + * Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + */ + enforce_admins: boolean | null; + /** + * Require at least one approving review on a pull request, before merging. Set to `null` to disable. + */ + required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null; + /** + * Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + */ + restrictions: ReposUpdateBranchProtectionParamsRestrictions | null; + /** + * Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. + */ + required_linear_history?: boolean; + /** + * Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." + */ + allow_force_pushes?: boolean | null; + /** + * Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. + */ + allow_deletions?: boolean; +}; +declare type ReposUpdateBranchProtectionRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/branches/:branch/protection"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateBranchProtectionResponseData { + url: string; + required_status_checks: { + url: string; + strict: boolean; + contexts: string[]; + contexts_url: string; + }; + enforce_admins: { + url: string; + enabled: boolean; + }; + required_pull_request_reviews: { + url: string; + dismissal_restrictions: { + url: string; + users_url: string; + teams_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + }; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count: number; + }; + restrictions: { + url: string; + users_url: string; + teams_url: string; + apps_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + apps: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }[]; + }; + required_linear_history: { + enabled: boolean; + }; + allow_force_pushes: { + enabled: boolean; + }; + allow_deletions: { + enabled: boolean; + }; +} +declare type ReposRemoveBranchProtectionEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposRemoveBranchProtectionRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetProtectedBranchAdminEnforcementEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetProtectedBranchAdminEnforcementRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetProtectedBranchAdminEnforcementResponseData { + url: string; + enabled: boolean; +} +declare type ReposAddProtectedBranchAdminEnforcementEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposAddProtectedBranchAdminEnforcementRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposAddProtectedBranchAdminEnforcementResponseData { + url: string; + enabled: boolean; +} +declare type ReposRemoveProtectedBranchAdminEnforcementEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposRemoveProtectedBranchAdminEnforcementRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetProtectedBranchPullRequestReviewEnforcementResponseData { + url: string; + dismissal_restrictions: { + url: string; + users_url: string; + teams_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + }; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count: number; +} +declare type ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. + */ + dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions; + /** + * Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. + */ + dismiss_stale_reviews?: boolean; + /** + * Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed. + */ + require_code_owner_reviews?: boolean; + /** + * Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6. + */ + required_approving_review_count?: number; +}; +declare type ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseData { + url: string; + dismissal_restrictions: { + url: string; + users_url: string; + teams_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + }; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count: number; +} +declare type ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetProtectedBranchRequiredSignaturesEndpoint = { + owner: string; + repo: string; + branch: string; +} & RequiredPreview<"zzzax">; +declare type ReposGetProtectedBranchRequiredSignaturesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetProtectedBranchRequiredSignaturesResponseData { + url: string; + enabled: boolean; +} +declare type ReposAddProtectedBranchRequiredSignaturesEndpoint = { + owner: string; + repo: string; + branch: string; +} & RequiredPreview<"zzzax">; +declare type ReposAddProtectedBranchRequiredSignaturesRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposAddProtectedBranchRequiredSignaturesResponseData { + url: string; + enabled: boolean; +} +declare type ReposRemoveProtectedBranchRequiredSignaturesEndpoint = { + owner: string; + repo: string; + branch: string; +} & RequiredPreview<"zzzax">; +declare type ReposRemoveProtectedBranchRequiredSignaturesRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetProtectedBranchRequiredStatusChecksEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetProtectedBranchRequiredStatusChecksRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetProtectedBranchRequiredStatusChecksResponseData { + url: string; + strict: boolean; + contexts: string[]; + contexts_url: string; +} +declare type ReposUpdateProtectedBranchRequiredStatusChecksEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * Require branches to be up to date before merging. + */ + strict?: boolean; + /** + * The list of status checks to require in order to merge into this branch + */ + contexts?: string[]; +}; +declare type ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateProtectedBranchRequiredStatusChecksResponseData { + url: string; + strict: boolean; + contexts: string[]; + contexts_url: string; +} +declare type ReposRemoveProtectedBranchRequiredStatusChecksEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListProtectedBranchRequiredStatusChecksContextsEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListProtectedBranchRequiredStatusChecksContextsResponseData = string[]; +declare type ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +declare type ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposReplaceProtectedBranchRequiredStatusChecksContextsResponseData = string[]; +declare type ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +declare type ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposAddProtectedBranchRequiredStatusChecksContextsResponseData = string[]; +declare type ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +declare type ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposRemoveProtectedBranchRequiredStatusChecksContextsResponseData = string[]; +declare type ReposGetProtectedBranchRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetProtectedBranchRestrictionsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetProtectedBranchRestrictionsResponseData { + url: string; + users_url: string; + teams_url: string; + apps_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + apps: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }[]; +} +declare type ReposRemoveProtectedBranchRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposRemoveProtectedBranchRestrictionsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetAppsWithAccessToProtectedBranchEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetAppsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetAppsWithAccessToProtectedBranchResponseData = { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; +}[]; +declare type ReposReplaceProtectedBranchAppRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +declare type ReposReplaceProtectedBranchAppRestrictionsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposReplaceProtectedBranchAppRestrictionsResponseData = { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; +}[]; +declare type ReposAddProtectedBranchAppRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +declare type ReposAddProtectedBranchAppRestrictionsRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposAddProtectedBranchAppRestrictionsResponseData = { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; +}[]; +declare type ReposRemoveProtectedBranchAppRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +declare type ReposRemoveProtectedBranchAppRestrictionsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposRemoveProtectedBranchAppRestrictionsResponseData = { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; +}[]; +declare type ReposGetTeamsWithAccessToProtectedBranchEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetTeamsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetTeamsWithAccessToProtectedBranchResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type ReposReplaceProtectedBranchTeamRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +declare type ReposReplaceProtectedBranchTeamRestrictionsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposReplaceProtectedBranchTeamRestrictionsResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type ReposAddProtectedBranchTeamRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +declare type ReposAddProtectedBranchTeamRestrictionsRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposAddProtectedBranchTeamRestrictionsResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type ReposRemoveProtectedBranchTeamRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +declare type ReposRemoveProtectedBranchTeamRestrictionsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposRemoveProtectedBranchTeamRestrictionsResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type ReposGetUsersWithAccessToProtectedBranchEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetUsersWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetUsersWithAccessToProtectedBranchResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type ReposReplaceProtectedBranchUserRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * users parameter + */ + users: string[]; +}; +declare type ReposReplaceProtectedBranchUserRestrictionsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposReplaceProtectedBranchUserRestrictionsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type ReposAddProtectedBranchUserRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * users parameter + */ + users: string[]; +}; +declare type ReposAddProtectedBranchUserRestrictionsRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposAddProtectedBranchUserRestrictionsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type ReposRemoveProtectedBranchUserRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * users parameter + */ + users: string[]; +}; +declare type ReposRemoveProtectedBranchUserRestrictionsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposRemoveProtectedBranchUserRestrictionsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type ChecksCreateEndpoint = { + owner: string; + repo: string; + /** + * The name of the check. For example, "code-coverage". + */ + name: string; + /** + * The SHA of the commit. + */ + head_sha: string; + /** + * The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. + */ + details_url?: string; + /** + * A reference for the run on the integrator's system. + */ + external_id?: string; + /** + * The current status. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`. + */ + conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required"; + /** + * The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** + * Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description. + */ + output?: ChecksCreateParamsOutput; + /** + * Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + */ + actions?: ChecksCreateParamsActions[]; +} & RequiredPreview<"antiope">; +declare type ChecksCreateRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/check-runs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksCreateResponseData { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: { + title: string; + summary: string; + text: string; + }; + name: string; + check_suite: { + id: number; + }; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + pull_requests: { + url: string; + id: number; + number: number; + head: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + }[]; +} +declare type ChecksUpdateEndpoint = { + owner: string; + repo: string; + check_run_id: number; + /** + * The name of the check. For example, "code-coverage". + */ + name?: string; + /** + * The URL of the integrator's site that has the full details of the check. + */ + details_url?: string; + /** + * A reference for the run on the integrator's system. + */ + external_id?: string; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * The current status. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`. + */ + conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required"; + /** + * The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** + * Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description. + */ + output?: ChecksUpdateParamsOutput; + /** + * Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + */ + actions?: ChecksUpdateParamsActions[]; +} & RequiredPreview<"antiope">; +declare type ChecksUpdateRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/check-runs/:check_run_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksUpdateResponseData { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: { + title: string; + summary: string; + text: string; + annotations_count: number; + annotations_url: string; + }; + name: string; + check_suite: { + id: number; + }; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + pull_requests: { + url: string; + id: number; + number: number; + head: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + }[]; +} +declare type ChecksGetEndpoint = { + owner: string; + repo: string; + check_run_id: number; +} & RequiredPreview<"antiope">; +declare type ChecksGetRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/check-runs/:check_run_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksGetResponseData { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: { + title: string; + summary: string; + text: string; + annotations_count: number; + annotations_url: string; + }; + name: string; + check_suite: { + id: number; + }; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + pull_requests: { + url: string; + id: number; + number: number; + head: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + }[]; +} +declare type ChecksListAnnotationsEndpoint = { + owner: string; + repo: string; + check_run_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"antiope">; +declare type ChecksListAnnotationsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/check-runs/:check_run_id/annotations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ChecksListAnnotationsResponseData = { + path: string; + start_line: number; + end_line: number; + start_column: number; + end_column: number; + annotation_level: string; + title: string; + message: string; + raw_details: string; +}[]; +declare type ChecksCreateSuiteEndpoint = { + owner: string; + repo: string; + /** + * The sha of the head commit. + */ + head_sha: string; +} & RequiredPreview<"antiope">; +declare type ChecksCreateSuiteRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/check-suites"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksCreateSuiteResponseData { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + status: string; + conclusion: string; + url: string; + before: string; + after: string; + pull_requests: unknown[]; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +} +declare type ChecksSetSuitesPreferencesEndpoint = { + owner: string; + repo: string; + /** + * Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details. + */ + auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]; +} & RequiredPreview<"antiope">; +declare type ChecksSetSuitesPreferencesRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/check-suites/preferences"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksSetSuitesPreferencesResponseData { + preferences: { + auto_trigger_checks: { + app_id: number; + setting: boolean; + }[]; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +} +declare type ChecksGetSuiteEndpoint = { + owner: string; + repo: string; + check_suite_id: number; +} & RequiredPreview<"antiope">; +declare type ChecksGetSuiteRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/check-suites/:check_suite_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksGetSuiteResponseData { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + status: string; + conclusion: string; + url: string; + before: string; + after: string; + pull_requests: unknown[]; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +} +declare type ChecksListForSuiteEndpoint = { + owner: string; + repo: string; + check_suite_id: number; + /** + * Returns check runs with the specified `name`. + */ + check_name?: string; + /** + * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"antiope">; +declare type ChecksListForSuiteRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksListForSuiteResponseData { + total_count: number; + check_runs: { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: { + title: string; + summary: string; + text: string; + annotations_count: number; + annotations_url: string; + }; + name: string; + check_suite: { + id: number; + }; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + pull_requests: { + url: string; + id: number; + number: number; + head: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + }[]; + }[]; +} +declare type ChecksRerequestSuiteEndpoint = { + owner: string; + repo: string; + check_suite_id: number; +} & RequiredPreview<"antiope">; +declare type ChecksRerequestSuiteRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type CodeScanningListAlertsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Set to `closed` to list only closed code scanning alerts. + */ + state?: string; + /** + * Returns a list of code scanning alerts for a specific brach reference. The `ref` must be formatted as `heads/`. + */ + ref?: string; +}; +declare type CodeScanningListAlertsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/code-scanning/alerts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type CodeScanningListAlertsForRepoResponseData = { + rule_id: string; + rule_severity: string; + rule_description: string; + tool: string; + created_at: string; + open: boolean; + closed_by: string; + closed_at: string; + url: string; + html_url: string; +}[]; +declare type CodeScanningGetAlertEndpoint = { + owner: string; + repo: string; + alert_id: number; +}; +declare type CodeScanningGetAlertRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/code-scanning/alerts/:alert_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface CodeScanningGetAlertResponseData { + rule_id: string; + rule_severity: string; + rule_description: string; + tool: string; + created_at: string; + open: boolean; + closed_by: string; + closed_at: string; + url: string; + html_url: string; +} +declare type ReposListCollaboratorsEndpoint = { + owner: string; + repo: string; + /** + * Filter collaborators returned by their affiliation. Can be one of: + * \* `outside`: All outside collaborators of an organization-owned repository. + * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListCollaboratorsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/collaborators"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListCollaboratorsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + permissions: { + pull: boolean; + push: boolean; + admin: boolean; + }; +}[]; +declare type ReposCheckCollaboratorEndpoint = { + owner: string; + repo: string; + username: string; +}; +declare type ReposCheckCollaboratorRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposAddCollaboratorEndpoint = { + owner: string; + repo: string; + username: string; + /** + * The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: + * \* `pull` - can pull, but not push to or administer this repository. + * \* `push` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push and administer this repository. + * \* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. + * \* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. + */ + permission?: "pull" | "push" | "admin" | "maintain" | "triage"; +}; +declare type ReposAddCollaboratorRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposAddCollaboratorResponseData { + id: number; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + invitee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + permissions: string; + created_at: string; + url: string; + html_url: string; +} +declare type ReposRemoveCollaboratorEndpoint = { + owner: string; + repo: string; + username: string; +}; +declare type ReposRemoveCollaboratorRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetCollaboratorPermissionLevelEndpoint = { + owner: string; + repo: string; + username: string; +}; +declare type ReposGetCollaboratorPermissionLevelRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/collaborators/:username/permission"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetCollaboratorPermissionLevelResponseData { + permission: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type ReposListCommitCommentsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListCommitCommentsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListCommitCommentsResponseData = { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type ReposGetCommitCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; +}; +declare type ReposGetCommitCommentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetCommitCommentResponseData { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type ReposUpdateCommitCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * The contents of the comment + */ + body: string; +}; +declare type ReposUpdateCommitCommentRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateCommitCommentResponseData { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type ReposDeleteCommitCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; +}; +declare type ReposDeleteCommitCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForCommitCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForCommitCommentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/comments/:comment_id/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForCommitCommentResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForCommitCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForCommitCommentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/comments/:comment_id/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForCommitCommentResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsDeleteForCommitCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteForCommitCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListCommitsEndpoint = { + owner: string; + repo: string; + /** + * SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). + */ + sha?: string; + /** + * Only commits containing this file path will be returned. + */ + path?: string; + /** + * GitHub login or email address by which to filter by commit author. + */ + author?: string; + /** + * Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + until?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListCommitsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListCommitsResponseData = { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + name: string; + email: string; + date: string; + }; + committer: { + name: string; + email: string; + date: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + sha: string; + }[]; +}[]; +declare type ReposListBranchesForHeadCommitEndpoint = { + owner: string; + repo: string; + commit_sha: string; +} & RequiredPreview<"groot">; +declare type ReposListBranchesForHeadCommitRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:commit_sha/branches-where-head"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListBranchesForHeadCommitResponseData = { + name: string; + commit: { + sha: string; + url: string; + }; + protected: boolean; +}[]; +declare type ReposListCommentsForCommitEndpoint = { + owner: string; + repo: string; + commit_sha: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListCommentsForCommitRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:commit_sha/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListCommentsForCommitResponseData = { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type ReposCreateCommitCommentEndpoint = { + owner: string; + repo: string; + commit_sha: string; + /** + * The contents of the comment. + */ + body: string; + /** + * Relative path of the file to comment on. + */ + path?: string; + /** + * Line index in the diff to comment on. + */ + position?: number; + /** + * **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. + */ + line?: number; +}; +declare type ReposCreateCommitCommentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/commits/:commit_sha/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateCommitCommentResponseData { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type ReposListPullRequestsAssociatedWithCommitEndpoint = { + owner: string; + repo: string; + commit_sha: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"groot">; +declare type ReposListPullRequestsAssociatedWithCommitRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:commit_sha/pulls"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListPullRequestsAssociatedWithCommitResponseData = { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_reviewers: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + head: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + base: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + issue: { + href: string; + }; + comments: { + href: string; + }; + review_comments: { + href: string; + }; + review_comment: { + href: string; + }; + commits: { + href: string; + }; + statuses: { + href: string; + }; + }; + author_association: string; + draft: boolean; +}[]; +declare type ReposGetCommitEndpoint = { + owner: string; + repo: string; + ref: string; +}; +declare type ReposGetCommitRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:ref"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetCommitResponseData { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + name: string; + email: string; + date: string; + }; + committer: { + name: string; + email: string; + date: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + sha: string; + }[]; + stats: { + additions: number; + deletions: number; + total: number; + }; + files: { + filename: string; + additions: number; + deletions: number; + changes: number; + status: string; + raw_url: string; + blob_url: string; + patch: string; + }[]; +} +declare type ChecksListForRefEndpoint = { + owner: string; + repo: string; + ref: string; + /** + * Returns check runs with the specified `name`. + */ + check_name?: string; + /** + * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"antiope">; +declare type ChecksListForRefRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:ref/check-runs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksListForRefResponseData { + total_count: number; + check_runs: { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: { + title: string; + summary: string; + text: string; + annotations_count: number; + annotations_url: string; + }; + name: string; + check_suite: { + id: number; + }; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + pull_requests: { + url: string; + id: number; + number: number; + head: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + }[]; + }[]; +} +declare type ChecksListSuitesForRefEndpoint = { + owner: string; + repo: string; + ref: string; + /** + * Filters check suites by GitHub App `id`. + */ + app_id?: number; + /** + * Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/). + */ + check_name?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"antiope">; +declare type ChecksListSuitesForRefRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:ref/check-suites"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksListSuitesForRefResponseData { + total_count: number; + check_suites: { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + status: string; + conclusion: string; + url: string; + before: string; + after: string; + pull_requests: unknown[]; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }[]; +} +declare type ReposGetCombinedStatusForRefEndpoint = { + owner: string; + repo: string; + ref: string; +}; +declare type ReposGetCombinedStatusForRefRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:ref/status"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetCombinedStatusForRefResponseData { + state: string; + statuses: { + url: string; + avatar_url: string; + id: number; + node_id: string; + state: string; + description: string; + target_url: string; + context: string; + created_at: string; + updated_at: string; + }[]; + sha: string; + total_count: number; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + commit_url: string; + url: string; +} +declare type ReposListStatusesForRefEndpoint = { + owner: string; + repo: string; + ref: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListStatusesForRefRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:ref/statuses"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListStatusesForRefResponseData = { + url: string; + avatar_url: string; + id: number; + node_id: string; + state: string; + description: string; + target_url: string; + context: string; + created_at: string; + updated_at: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +}[]; +declare type CodesOfConductGetForRepoEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"scarlet-witch">; +declare type CodesOfConductGetForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/community/code_of_conduct"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface CodesOfConductGetForRepoResponseData { + key: string; + name: string; + url: string; + body: string; +} +declare type ReposRetrieveCommunityProfileMetricsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposRetrieveCommunityProfileMetricsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/community/profile"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposRetrieveCommunityProfileMetricsResponseData { + health_percentage: number; + description: string; + documentation: boolean; + files: { + code_of_conduct: { + name: string; + key: string; + url: string; + html_url: string; + }; + contributing: { + url: string; + html_url: string; + }; + issue_template: { + url: string; + html_url: string; + }; + pull_request_template: { + url: string; + html_url: string; + }; + license: { + name: string; + key: string; + spdx_id: string; + url: string; + html_url: string; + }; + readme: { + url: string; + html_url: string; + }; + }; + updated_at: string; +} +declare type ReposCompareCommitsEndpoint = { + owner: string; + repo: string; + base: string; + head: string; +}; +declare type ReposCompareCommitsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/compare/:base...:head"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCompareCommitsResponseData { + url: string; + html_url: string; + permalink_url: string; + diff_url: string; + patch_url: string; + base_commit: { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + name: string; + email: string; + date: string; + }; + committer: { + name: string; + email: string; + date: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + sha: string; + }[]; + }; + merge_base_commit: { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + name: string; + email: string; + date: string; + }; + committer: { + name: string; + email: string; + date: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + sha: string; + }[]; + }; + status: string; + ahead_by: number; + behind_by: number; + total_commits: number; + commits: { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + name: string; + email: string; + date: string; + }; + committer: { + name: string; + email: string; + date: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + sha: string; + }[]; + }[]; + files: { + sha: string; + filename: string; + status: string; + additions: number; + deletions: number; + changes: number; + blob_url: string; + raw_url: string; + contents_url: string; + patch: string; + }[]; +} +declare type ReposGetContentsEndpoint = { + owner: string; + repo: string; + path: string; + /** + * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) + */ + ref?: string; +}; +declare type ReposGetContentsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/contents/:path"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetContentsResponseData { + type: string; + encoding: string; + size: number; + name: string; + path: string; + content: string; + sha: string; + url: string; + git_url: string; + html_url: string; + download_url: string; + _links: { + git: string; + self: string; + html: string; + }; +} +declare type ReposCreateOrUpdateFileEndpoint = { + owner: string; + repo: string; + path: string; + /** + * The commit message. + */ + message: string; + /** + * The new file content, using Base64 encoding. + */ + content: string; + /** + * **Required if you are updating a file**. The blob SHA of the file being replaced. + */ + sha?: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * The person that committed the file. Default: the authenticated user. + */ + committer?: ReposCreateOrUpdateFileParamsCommitter; + /** + * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. + */ + author?: ReposCreateOrUpdateFileParamsAuthor; +}; +declare type ReposCreateOrUpdateFileRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/contents/:path"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateOrUpdateFileResponseData { + content: { + name: string; + path: string; + sha: string; + size: number; + url: string; + html_url: string; + git_url: string; + download_url: string; + type: string; + _links: { + self: string; + git: string; + html: string; + }; + }; + commit: { + sha: string; + node_id: string; + url: string; + html_url: string; + author: { + date: string; + name: string; + email: string; + }; + committer: { + date: string; + name: string; + email: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + parents: { + url: string; + html_url: string; + sha: string; + }[]; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; +} +export interface ReposCreateOrUpdateFileResponse201Data { + content: { + name: string; + path: string; + sha: string; + size: number; + url: string; + html_url: string; + git_url: string; + download_url: string; + type: string; + _links: { + self: string; + git: string; + html: string; + }; + }; + commit: { + sha: string; + node_id: string; + url: string; + html_url: string; + author: { + date: string; + name: string; + email: string; + }; + committer: { + date: string; + name: string; + email: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + parents: { + url: string; + html_url: string; + sha: string; + }[]; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; +} +declare type ReposDeleteFileEndpoint = { + owner: string; + repo: string; + path: string; + /** + * The commit message. + */ + message: string; + /** + * The blob SHA of the file being replaced. + */ + sha: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * object containing information about the committer. + */ + committer?: ReposDeleteFileParamsCommitter; + /** + * object containing information about the author. + */ + author?: ReposDeleteFileParamsAuthor; +}; +declare type ReposDeleteFileRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/contents/:path"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposDeleteFileResponseData { + content: string; + commit: { + sha: string; + node_id: string; + url: string; + html_url: string; + author: { + date: string; + name: string; + email: string; + }; + committer: { + date: string; + name: string; + email: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + parents: { + url: string; + html_url: string; + sha: string; + }[]; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; +} +declare type ReposListContributorsEndpoint = { + owner: string; + repo: string; + /** + * Set to `1` or `true` to include anonymous contributors in results. + */ + anon?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListContributorsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/contributors"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListContributorsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + contributions: number; +}[]; +declare type ReposListDeploymentsEndpoint = { + owner: string; + repo: string; + /** + * The SHA recorded at creation time. + */ + sha?: string; + /** + * The name of the ref. This can be a branch, tag, or SHA. + */ + ref?: string; + /** + * The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). + */ + task?: string; + /** + * The name of the environment that was deployed to (e.g., `staging` or `production`). + */ + environment?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListDeploymentsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/deployments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListDeploymentsResponseData = { + url: string; + id: number; + node_id: string; + sha: string; + ref: string; + task: string; + payload: { + deploy: string; + }; + original_environment: string; + environment: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + statuses_url: string; + repository_url: string; + transient_environment: boolean; + production_environment: boolean; +}[]; +declare type ReposCreateDeploymentEndpoint = { + owner: string; + repo: string; + /** + * The ref to deploy. This can be a branch, tag, or SHA. + */ + ref: string; + /** + * Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). + */ + task?: string; + /** + * Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. + */ + auto_merge?: boolean; + /** + * The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. + */ + required_contexts?: string[]; + /** + * JSON payload with extra information about the deployment. + */ + payload?: string; + /** + * Name for the target deployment environment (e.g., `production`, `staging`, `qa`). + */ + environment?: string; + /** + * Short description of the deployment. + */ + description?: string; + /** + * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + transient_environment?: boolean; + /** + * Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + production_environment?: boolean; +}; +declare type ReposCreateDeploymentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/deployments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateDeploymentResponseData { + url: string; + id: number; + node_id: string; + sha: string; + ref: string; + task: string; + payload: { + deploy: string; + }; + original_environment: string; + environment: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + statuses_url: string; + repository_url: string; + transient_environment: boolean; + production_environment: boolean; +} +export interface ReposCreateDeploymentResponse202Data { + message: string; +} +export interface ReposCreateDeploymentResponse409Data { + message: string; +} +declare type ReposGetDeploymentEndpoint = { + owner: string; + repo: string; + deployment_id: number; +}; +declare type ReposGetDeploymentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/deployments/:deployment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetDeploymentResponseData { + url: string; + id: number; + node_id: string; + sha: string; + ref: string; + task: string; + payload: { + deploy: string; + }; + original_environment: string; + environment: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + statuses_url: string; + repository_url: string; + transient_environment: boolean; + production_environment: boolean; +} +declare type ReposDeleteDeploymentEndpoint = { + owner: string; + repo: string; + deployment_id: number; +}; +declare type ReposDeleteDeploymentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/deployments/:deployment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListDeploymentStatusesEndpoint = { + owner: string; + repo: string; + deployment_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListDeploymentStatusesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/deployments/:deployment_id/statuses"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListDeploymentStatusesResponseData = { + url: string; + id: number; + node_id: string; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + description: string; + environment: string; + target_url: string; + created_at: string; + updated_at: string; + deployment_url: string; + repository_url: string; + environment_url: string; + log_url: string; +}[]; +declare type ReposCreateDeploymentStatusEndpoint = { + owner: string; + repo: string; + deployment_id: number; + /** + * The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. + */ + state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; + /** + * The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + */ + target_url?: string; + /** + * The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + log_url?: string; + /** + * A short description of the status. The maximum description length is 140 characters. + */ + description?: string; + /** + * Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + */ + environment?: "production" | "staging" | "qa"; + /** + * Sets the URL for accessing your environment. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + environment_url?: string; + /** + * Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` + * **Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + auto_inactive?: boolean; +}; +declare type ReposCreateDeploymentStatusRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/deployments/:deployment_id/statuses"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateDeploymentStatusResponseData { + url: string; + id: number; + node_id: string; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + description: string; + environment: string; + target_url: string; + created_at: string; + updated_at: string; + deployment_url: string; + repository_url: string; + environment_url: string; + log_url: string; +} +declare type ReposGetDeploymentStatusEndpoint = { + owner: string; + repo: string; + deployment_id: number; + status_id: number; +}; +declare type ReposGetDeploymentStatusRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetDeploymentStatusResponseData { + url: string; + id: number; + node_id: string; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + description: string; + environment: string; + target_url: string; + created_at: string; + updated_at: string; + deployment_url: string; + repository_url: string; + environment_url: string; + log_url: string; +} +declare type ReposCreateDispatchEventEndpoint = { + owner: string; + repo: string; + /** + * **Required:** A custom webhook event name. + */ + event_type?: string; + /** + * JSON payload with extra information about the webhook event that your action or worklow may use. + */ + client_payload?: ReposCreateDispatchEventParamsClientPayload; +}; +declare type ReposCreateDispatchEventRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/dispatches"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListDownloadsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListDownloadsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/downloads"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListDownloadsResponseData = { + url: string; + html_url: string; + id: number; + name: string; + description: string; + size: number; + download_count: number; + content_type: string; +}[]; +declare type ReposGetDownloadEndpoint = { + owner: string; + repo: string; + download_id: number; +}; +declare type ReposGetDownloadRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/downloads/:download_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetDownloadResponseData { + url: string; + html_url: string; + id: number; + name: string; + description: string; + size: number; + download_count: number; + content_type: string; +} +declare type ReposDeleteDownloadEndpoint = { + owner: string; + repo: string; + download_id: number; +}; +declare type ReposDeleteDownloadRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/downloads/:download_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListRepoEventsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListRepoEventsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListForksEndpoint = { + owner: string; + repo: string; + /** + * The sort order. Can be either `newest`, `oldest`, or `stargazers`. + */ + sort?: "newest" | "oldest" | "stargazers"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListForksRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/forks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListForksResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type ReposCreateForkEndpoint = { + owner: string; + repo: string; + /** + * Optional parameter to specify the organization name if forking into an organization. + */ + organization?: string; +}; +declare type ReposCreateForkRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/forks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateForkResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +} +declare type GitCreateBlobEndpoint = { + owner: string; + repo: string; + /** + * The new blob's content. + */ + content: string; + /** + * The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + */ + encoding?: string; +}; +declare type GitCreateBlobRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/git/blobs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitCreateBlobResponseData { + url: string; + sha: string; +} +declare type GitGetBlobEndpoint = { + owner: string; + repo: string; + file_sha: string; +}; +declare type GitGetBlobRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/git/blobs/:file_sha"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitGetBlobResponseData { + content: string; + encoding: string; + url: string; + sha: string; + size: number; +} +declare type GitCreateCommitEndpoint = { + owner: string; + repo: string; + /** + * The commit message + */ + message: string; + /** + * The SHA of the tree object this commit points to + */ + tree: string; + /** + * The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. + */ + parents: string[]; + /** + * Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. + */ + author?: GitCreateCommitParamsAuthor; + /** + * Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. + */ + committer?: GitCreateCommitParamsCommitter; + /** + * The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. + */ + signature?: string; +}; +declare type GitCreateCommitRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/git/commits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitCreateCommitResponseData { + sha: string; + node_id: string; + url: string; + author: { + date: string; + name: string; + email: string; + }; + committer: { + date: string; + name: string; + email: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + parents: { + url: string; + sha: string; + }[]; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; +} +declare type GitGetCommitEndpoint = { + owner: string; + repo: string; + commit_sha: string; +}; +declare type GitGetCommitRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/git/commits/:commit_sha"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitGetCommitResponseData { + sha: string; + node_id: string; + url: string; + author: { + date: string; + name: string; + email: string; + }; + committer: { + date: string; + name: string; + email: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + parents: { + url: string; + sha: string; + }[]; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; +} +declare type GitListMatchingRefsEndpoint = { + owner: string; + repo: string; + ref: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GitListMatchingRefsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/git/matching-refs/:ref"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GitListMatchingRefsResponseData = { + ref: string; + node_id: string; + url: string; + object: { + type: string; + sha: string; + url: string; + }; +}[]; +declare type GitGetRefEndpoint = { + owner: string; + repo: string; + ref: string; +}; +declare type GitGetRefRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/git/ref/:ref"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitGetRefResponseData { + ref: string; + node_id: string; + url: string; + object: { + type: string; + sha: string; + url: string; + }; +} +declare type GitCreateRefEndpoint = { + owner: string; + repo: string; + /** + * The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. + */ + ref: string; + /** + * The SHA1 value for this reference. + */ + sha: string; +}; +declare type GitCreateRefRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/git/refs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitCreateRefResponseData { + ref: string; + node_id: string; + url: string; + object: { + type: string; + sha: string; + url: string; + }; +} +declare type GitUpdateRefEndpoint = { + owner: string; + repo: string; + ref: string; + /** + * The SHA1 value to set this reference to + */ + sha: string; + /** + * Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. + */ + force?: boolean; +}; +declare type GitUpdateRefRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/git/refs/:ref"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitUpdateRefResponseData { + ref: string; + node_id: string; + url: string; + object: { + type: string; + sha: string; + url: string; + }; +} +declare type GitDeleteRefEndpoint = { + owner: string; + repo: string; + ref: string; +}; +declare type GitDeleteRefRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/git/refs/:ref"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GitCreateTagEndpoint = { + owner: string; + repo: string; + /** + * The tag's name. This is typically a version (e.g., "v0.0.1"). + */ + tag: string; + /** + * The tag message. + */ + message: string; + /** + * The SHA of the git object this is tagging. + */ + object: string; + /** + * The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. + */ + type: "commit" | "tree" | "blob"; + /** + * An object with information about the individual creating the tag. + */ + tagger?: GitCreateTagParamsTagger; +}; +declare type GitCreateTagRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/git/tags"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitCreateTagResponseData { + node_id: string; + tag: string; + sha: string; + url: string; + message: string; + tagger: { + name: string; + email: string; + date: string; + }; + object: { + type: string; + sha: string; + url: string; + }; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; +} +declare type GitGetTagEndpoint = { + owner: string; + repo: string; + tag_sha: string; +}; +declare type GitGetTagRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/git/tags/:tag_sha"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitGetTagResponseData { + node_id: string; + tag: string; + sha: string; + url: string; + message: string; + tagger: { + name: string; + email: string; + date: string; + }; + object: { + type: string; + sha: string; + url: string; + }; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; +} +declare type GitCreateTreeEndpoint = { + owner: string; + repo: string; + /** + * Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. + */ + tree: GitCreateTreeParamsTree[]; + /** + * The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted. + */ + base_tree?: string; +}; +declare type GitCreateTreeRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/git/trees"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitCreateTreeResponseData { + sha: string; + url: string; + tree: { + path: string; + mode: string; + type: string; + size: number; + sha: string; + url: string; + }[]; +} +declare type GitGetTreeEndpoint = { + owner: string; + repo: string; + tree_sha: string; + /** + * Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. + */ + recursive?: string; +}; +declare type GitGetTreeRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/git/trees/:tree_sha"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitGetTreeResponseData { + sha: string; + url: string; + tree: { + path: string; + mode: string; + type: string; + size: number; + sha: string; + url: string; + }[]; + truncated: boolean; +} +declare type ReposListHooksEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListHooksRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/hooks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListHooksResponseData = { + type: string; + id: number; + name: string; + active: boolean; + events: string[]; + config: { + content_type: string; + insecure_ssl: string; + url: string; + }; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: { + code: string; + status: string; + message: string; + }; +}[]; +declare type ReposCreateHookEndpoint = { + owner: string; + repo: string; + /** + * Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. + */ + name?: string; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). + */ + config: ReposCreateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/webhooks/event-payloads) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +declare type ReposCreateHookRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/hooks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateHookResponseData { + type: string; + id: number; + name: string; + active: boolean; + events: string[]; + config: { + content_type: string; + insecure_ssl: string; + url: string; + }; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: { + code: string; + status: string; + message: string; + }; +} +declare type ReposGetHookEndpoint = { + owner: string; + repo: string; + hook_id: number; +}; +declare type ReposGetHookRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/hooks/:hook_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetHookResponseData { + type: string; + id: number; + name: string; + active: boolean; + events: string[]; + config: { + content_type: string; + insecure_ssl: string; + url: string; + }; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: { + code: string; + status: string; + message: string; + }; +} +declare type ReposUpdateHookEndpoint = { + owner: string; + repo: string; + hook_id: number; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). + */ + config?: ReposUpdateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. + */ + events?: string[]; + /** + * Determines a list of events to be added to the list of events that the Hook triggers for. + */ + add_events?: string[]; + /** + * Determines a list of events to be removed from the list of events that the Hook triggers for. + */ + remove_events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +declare type ReposUpdateHookRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/hooks/:hook_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateHookResponseData { + type: string; + id: number; + name: string; + active: boolean; + events: string[]; + config: { + content_type: string; + insecure_ssl: string; + url: string; + }; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: { + code: string; + status: string; + message: string; + }; +} +declare type ReposDeleteHookEndpoint = { + owner: string; + repo: string; + hook_id: number; +}; +declare type ReposDeleteHookRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/hooks/:hook_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposPingHookEndpoint = { + owner: string; + repo: string; + hook_id: number; +}; +declare type ReposPingHookRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/hooks/:hook_id/pings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposTestPushHookEndpoint = { + owner: string; + repo: string; + hook_id: number; +}; +declare type ReposTestPushHookRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/hooks/:hook_id/tests"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsStartImportEndpoint = { + owner: string; + repo: string; + /** + * The URL of the originating repository. + */ + vcs_url: string; + /** + * The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. + */ + vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + /** + * If authentication is required, the username to provide to `vcs_url`. + */ + vcs_username?: string; + /** + * If authentication is required, the password to provide to `vcs_url`. + */ + vcs_password?: string; + /** + * For a tfvc import, the name of the project that is being imported. + */ + tfvc_project?: string; +}; +declare type MigrationsStartImportRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/import"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsStartImportResponseData { + vcs: string; + use_lfs: string; + vcs_url: string; + status: string; + status_text: string; + has_large_files: boolean; + large_files_size: number; + large_files_count: number; + authors_count: number; + percent: number; + commit_count: number; + url: string; + html_url: string; + authors_url: string; + repository_url: string; +} +declare type MigrationsGetImportStatusEndpoint = { + owner: string; + repo: string; +}; +declare type MigrationsGetImportStatusRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/import"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsGetImportStatusResponseData { + vcs: string; + use_lfs: string; + vcs_url: string; + status: string; + status_text: string; + has_large_files: boolean; + large_files_size: number; + large_files_count: number; + authors_count: number; + url: string; + html_url: string; + authors_url: string; + repository_url: string; +} +declare type MigrationsUpdateImportEndpoint = { + owner: string; + repo: string; + /** + * The username to provide to the originating repository. + */ + vcs_username?: string; + /** + * The password to provide to the originating repository. + */ + vcs_password?: string; +}; +declare type MigrationsUpdateImportRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/import"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsUpdateImportResponseData { + vcs: string; + use_lfs: string; + vcs_url: string; + status: string; + url: string; + html_url: string; + authors_url: string; + repository_url: string; +} +declare type MigrationsCancelImportEndpoint = { + owner: string; + repo: string; +}; +declare type MigrationsCancelImportRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/import"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsGetCommitAuthorsEndpoint = { + owner: string; + repo: string; + /** + * Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step. + */ + since?: string; +}; +declare type MigrationsGetCommitAuthorsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/import/authors"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type MigrationsGetCommitAuthorsResponseData = { + id: number; + remote_id: string; + remote_name: string; + email: string; + name: string; + url: string; + import_url: string; +}[]; +declare type MigrationsMapCommitAuthorEndpoint = { + owner: string; + repo: string; + author_id: number; + /** + * The new Git author email. + */ + email?: string; + /** + * The new Git author name. + */ + name?: string; +}; +declare type MigrationsMapCommitAuthorRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/import/authors/:author_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsMapCommitAuthorResponseData { + id: number; + remote_id: string; + remote_name: string; + email: string; + name: string; + url: string; + import_url: string; +} +declare type MigrationsGetLargeFilesEndpoint = { + owner: string; + repo: string; +}; +declare type MigrationsGetLargeFilesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/import/large_files"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type MigrationsGetLargeFilesResponseData = { + ref_name: string; + path: string; + oid: string; + size: number; +}[]; +declare type MigrationsSetLfsPreferenceEndpoint = { + owner: string; + repo: string; + /** + * Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import). + */ + use_lfs: "opt_in" | "opt_out"; +}; +declare type MigrationsSetLfsPreferenceRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/import/lfs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsSetLfsPreferenceResponseData { + vcs: string; + use_lfs: string; + vcs_url: string; + status: string; + status_text: string; + has_large_files: boolean; + large_files_size: number; + large_files_count: number; + authors_count: number; + url: string; + html_url: string; + authors_url: string; + repository_url: string; +} +declare type AppsGetRepoInstallationEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"machine-man">; +declare type AppsGetRepoInstallationRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/installation"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetRepoInstallationResponseData { + id: number; + account: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repository_selection: "all" | "selected"; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + checks: string; + metadata: string; + contents: string; + }; + events: string[]; + created_at: string; + updated_at: string; + single_file_name: string; +} +declare type InteractionsGetRestrictionsForRepoEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"sombra">; +declare type InteractionsGetRestrictionsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/interaction-limits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface InteractionsGetRestrictionsForRepoResponseData { + limit: string; + origin: string; + expires_at: string; +} +declare type InteractionsAddOrUpdateRestrictionsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`. + */ + limit: "existing_users" | "contributors_only" | "collaborators_only"; +} & RequiredPreview<"sombra">; +declare type InteractionsAddOrUpdateRestrictionsForRepoRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/interaction-limits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface InteractionsAddOrUpdateRestrictionsForRepoResponseData { + limit: string; + origin: string; + expires_at: string; +} +declare type InteractionsRemoveRestrictionsForRepoEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"sombra">; +declare type InteractionsRemoveRestrictionsForRepoRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/interaction-limits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListInvitationsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListInvitationsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListInvitationsResponseData = { + id: number; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + invitee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + permissions: string; + created_at: string; + url: string; + html_url: string; +}[]; +declare type ReposDeleteInvitationEndpoint = { + owner: string; + repo: string; + invitation_id: number; +}; +declare type ReposDeleteInvitationRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/invitations/:invitation_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposUpdateInvitationEndpoint = { + owner: string; + repo: string; + invitation_id: number; + /** + * The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. + */ + permissions?: "read" | "write" | "maintain" | "triage" | "admin"; +}; +declare type ReposUpdateInvitationRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/invitations/:invitation_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateInvitationResponseData { + id: number; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + invitee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + permissions: string; + created_at: string; + url: string; + html_url: string; +} +declare type IssuesListForRepoEndpoint = { + owner: string; + repo: string; + /** + * If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. + */ + milestone?: string; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. + */ + assignee?: string; + /** + * The user that created the issue. + */ + creator?: string; + /** + * A user that's mentioned in the issue. + */ + mentioned?: string; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListForRepoResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; +}[]; +declare type IssuesCreateEndpoint = { + owner: string; + repo: string; + /** + * The title of the issue. + */ + title: string; + /** + * The contents of the issue. + */ + body?: string; + /** + * Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ + */ + assignee?: string; + /** + * The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._ + */ + milestone?: number; + /** + * Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ + */ + labels?: string[]; + /** + * Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + */ + assignees?: string[]; +}; +declare type IssuesCreateRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/issues"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesCreateResponseData { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + closed_by: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type IssuesListCommentsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Either `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * Either `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListCommentsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListCommentsForRepoResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type IssuesGetCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; +}; +declare type IssuesGetCommentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesGetCommentResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type IssuesUpdateCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * The contents of the comment. + */ + body: string; +}; +declare type IssuesUpdateCommentRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/issues/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesUpdateCommentResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type IssuesDeleteCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; +}; +declare type IssuesDeleteCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForIssueCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForIssueCommentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForIssueCommentResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForIssueCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForIssueCommentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForIssueCommentResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsDeleteForIssueCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteForIssueCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesListEventsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListEventsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListEventsForRepoResponseData = { + id: number; + node_id: string; + url: string; + actor: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + event: string; + commit_id: string; + commit_url: string; + created_at: string; + issue: { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + }; +}[]; +declare type IssuesGetEventEndpoint = { + owner: string; + repo: string; + event_id: number; +}; +declare type IssuesGetEventRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/events/:event_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesGetEventResponseData { + id: number; + node_id: string; + url: string; + actor: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + event: string; + commit_id: string; + commit_url: string; + created_at: string; + issue: { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + }; +} +declare type IssuesGetEndpoint = { + owner: string; + repo: string; + issue_number: number; +}; +declare type IssuesGetRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/:issue_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesGetResponseData { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + closed_by: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type IssuesUpdateEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * The title of the issue. + */ + title?: string; + /** + * The contents of the issue. + */ + body?: string; + /** + * Login for the user that this issue should be assigned to. **This field is deprecated.** + */ + assignee?: string; + /** + * State of the issue. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ + */ + milestone?: number | null; + /** + * Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ + */ + labels?: string[]; + /** + * Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + */ + assignees?: string[]; +}; +declare type IssuesUpdateRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/issues/:issue_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesUpdateResponseData { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + closed_by: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type IssuesAddAssigneesEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ + */ + assignees?: string[]; +}; +declare type IssuesAddAssigneesRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/issues/:issue_number/assignees"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesAddAssigneesResponseData { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; +} +declare type IssuesRemoveAssigneesEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ + */ + assignees?: string[]; +}; +declare type IssuesRemoveAssigneesRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/:issue_number/assignees"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesRemoveAssigneesResponseData { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; +} +declare type IssuesListCommentsEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListCommentsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/:issue_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListCommentsResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type IssuesCreateCommentEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * The contents of the comment. + */ + body: string; +}; +declare type IssuesCreateCommentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/issues/:issue_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesCreateCommentResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type IssuesListEventsEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListEventsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/:issue_number/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListEventsResponseData = { + id: number; + node_id: string; + url: string; + actor: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + event: string; + commit_id: string; + commit_url: string; + created_at: string; +}[]; +declare type IssuesListLabelsOnIssueEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListLabelsOnIssueRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/:issue_number/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListLabelsOnIssueResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}[]; +declare type IssuesAddLabelsEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. + */ + labels: string[]; +}; +declare type IssuesAddLabelsRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/issues/:issue_number/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesAddLabelsResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}[]; +declare type IssuesSetLabelsEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. + */ + labels?: string[]; +}; +declare type IssuesSetLabelsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/issues/:issue_number/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesSetLabelsResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}[]; +declare type IssuesRemoveAllLabelsEndpoint = { + owner: string; + repo: string; + issue_number: number; +}; +declare type IssuesRemoveAllLabelsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/:issue_number/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesRemoveLabelEndpoint = { + owner: string; + repo: string; + issue_number: number; + name: string; +}; +declare type IssuesRemoveLabelRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/:issue_number/labels/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesRemoveLabelResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}[]; +declare type IssuesLockEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: + * \* `off-topic` + * \* `too heated` + * \* `resolved` + * \* `spam` + */ + lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; +}; +declare type IssuesLockRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/issues/:issue_number/lock"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesUnlockEndpoint = { + owner: string; + repo: string; + issue_number: number; +}; +declare type IssuesUnlockRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/:issue_number/lock"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForIssueEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForIssueRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/:issue_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForIssueResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForIssueEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForIssueRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/issues/:issue_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForIssueResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsDeleteForIssueEndpoint = { + owner: string; + repo: string; + issue_number: number; + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteForIssueRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesListEventsForTimelineEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"mockingbird">; +declare type IssuesListEventsForTimelineRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/:issue_number/timeline"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListEventsForTimelineResponseData = { + id: number; + node_id: string; + url: string; + actor: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + event: string; + commit_id: string; + commit_url: string; + created_at: string; +}[]; +declare type ReposListDeployKeysEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListDeployKeysRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListDeployKeysResponseData = { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; +}[]; +declare type ReposAddDeployKeyEndpoint = { + owner: string; + repo: string; + /** + * A name for the key. + */ + title?: string; + /** + * The contents of the key. + */ + key: string; + /** + * If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + * + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/)." + */ + read_only?: boolean; +}; +declare type ReposAddDeployKeyRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposAddDeployKeyResponseData { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; +} +declare type ReposGetDeployKeyEndpoint = { + owner: string; + repo: string; + key_id: number; +}; +declare type ReposGetDeployKeyRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/keys/:key_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetDeployKeyResponseData { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; +} +declare type ReposRemoveDeployKeyEndpoint = { + owner: string; + repo: string; + key_id: number; +}; +declare type ReposRemoveDeployKeyRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/keys/:key_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesListLabelsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListLabelsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListLabelsForRepoResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}[]; +declare type IssuesCreateLabelEndpoint = { + owner: string; + repo: string; + /** + * The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). + */ + name: string; + /** + * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + */ + color: string; + /** + * A short description of the label. + */ + description?: string; +}; +declare type IssuesCreateLabelRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesCreateLabelResponseData { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +} +declare type IssuesGetLabelEndpoint = { + owner: string; + repo: string; + name: string; +}; +declare type IssuesGetLabelRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/labels/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesGetLabelResponseData { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +} +declare type IssuesUpdateLabelEndpoint = { + owner: string; + repo: string; + name: string; + /** + * The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). + */ + new_name?: string; + /** + * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + */ + color?: string; + /** + * A short description of the label. + */ + description?: string; +}; +declare type IssuesUpdateLabelRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/labels/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesUpdateLabelResponseData { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +} +declare type IssuesDeleteLabelEndpoint = { + owner: string; + repo: string; + name: string; +}; +declare type IssuesDeleteLabelRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/labels/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListLanguagesEndpoint = { + owner: string; + repo: string; +}; +declare type ReposListLanguagesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/languages"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposListLanguagesResponseData { + C: number; + Python: number; +} +declare type LicensesGetForRepoEndpoint = { + owner: string; + repo: string; +}; +declare type LicensesGetForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/license"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface LicensesGetForRepoResponseData { + name: string; + path: string; + sha: string; + size: number; + url: string; + html_url: string; + git_url: string; + download_url: string; + type: string; + content: string; + encoding: string; + _links: { + self: string; + git: string; + html: string; + }; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +} +declare type ReposMergeEndpoint = { + owner: string; + repo: string; + /** + * The name of the base branch that the head will be merged into. + */ + base: string; + /** + * The head to merge. This can be a branch name or a commit SHA1. + */ + head: string; + /** + * Commit message to use for the merge commit. If omitted, a default message will be used. + */ + commit_message?: string; +}; +declare type ReposMergeRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/merges"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposMergeResponseData { + sha: string; + node_id: string; + commit: { + author: { + name: string; + date: string; + email: string; + }; + committer: { + name: string; + date: string; + email: string; + }; + message: string; + tree: { + sha: string; + url: string; + }; + url: string; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + url: string; + html_url: string; + comments_url: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + sha: string; + url: string; + }[]; +} +export interface ReposMergeResponse404Data { + message: string; +} +export interface ReposMergeResponse409Data { + message: string; +} +declare type IssuesListMilestonesEndpoint = { + owner: string; + repo: string; + /** + * The state of the milestone. Either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * What to sort results by. Either `due_on` or `completeness`. + */ + sort?: "due_on" | "completeness"; + /** + * The direction of the sort. Either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListMilestonesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/milestones"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListMilestonesResponseData = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}[]; +declare type IssuesCreateMilestoneEndpoint = { + owner: string; + repo: string; + /** + * The title of the milestone. + */ + title: string; + /** + * The state of the milestone. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * A description of the milestone. + */ + description?: string; + /** + * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + due_on?: string; +}; +declare type IssuesCreateMilestoneRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/milestones"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesCreateMilestoneResponseData { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +} +declare type IssuesGetMilestoneEndpoint = { + owner: string; + repo: string; + milestone_number: number; +}; +declare type IssuesGetMilestoneRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/milestones/:milestone_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesGetMilestoneResponseData { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +} +declare type IssuesUpdateMilestoneEndpoint = { + owner: string; + repo: string; + milestone_number: number; + /** + * The title of the milestone. + */ + title?: string; + /** + * The state of the milestone. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * A description of the milestone. + */ + description?: string; + /** + * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + due_on?: string; +}; +declare type IssuesUpdateMilestoneRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/milestones/:milestone_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesUpdateMilestoneResponseData { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +} +declare type IssuesDeleteMilestoneEndpoint = { + owner: string; + repo: string; + milestone_number: number; +}; +declare type IssuesDeleteMilestoneRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/milestones/:milestone_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesListLabelsForMilestoneEndpoint = { + owner: string; + repo: string; + milestone_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListLabelsForMilestoneRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/milestones/:milestone_number/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListLabelsForMilestoneResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}[]; +declare type ActivityListRepoNotificationsForAuthenticatedUserEndpoint = { + owner: string; + repo: string; + /** + * If `true`, show notifications marked as read. + */ + all?: boolean; + /** + * If `true`, only shows notifications in which the user is directly participating or mentioned. + */ + participating?: boolean; + /** + * Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + before?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListRepoNotificationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/notifications"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListRepoNotificationsForAuthenticatedUserResponseData = { + id: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + subject: { + title: string; + url: string; + latest_comment_url: string; + type: string; + }; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string; + url: string; +}[]; +declare type ActivityMarkRepoNotificationsAsReadEndpoint = { + owner: string; + repo: string; + /** + * Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; +}; +declare type ActivityMarkRepoNotificationsAsReadRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/notifications"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetPagesEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetPagesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pages"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetPagesResponseData { + url: string; + status: string; + cname: string; + custom_404: boolean; + html_url: string; + source: { + branch: string; + directory: string; + }; +} +declare type ReposEnablePagesSiteEndpoint = { + owner: string; + repo: string; + source?: ReposEnablePagesSiteParamsSource; +} & RequiredPreview<"switcheroo">; +declare type ReposEnablePagesSiteRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pages"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposEnablePagesSiteResponseData { + url: string; + status: string; + cname: string; + custom_404: boolean; + html_url: string; + source: { + branch: string; + directory: string; + }; +} +declare type ReposDisablePagesSiteEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"switcheroo">; +declare type ReposDisablePagesSiteRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/pages"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposUpdateInformationAboutPagesSiteEndpoint = { + owner: string; + repo: string; + /** + * Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/)." + */ + cname?: string; + /** + * Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `"gh-pages"`, `"master"`, and `"master /docs"`. + */ + source?: '"gh-pages"' | '"master"' | '"master /docs"'; +}; +declare type ReposUpdateInformationAboutPagesSiteRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/pages"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposRequestPageBuildEndpoint = { + owner: string; + repo: string; +}; +declare type ReposRequestPageBuildRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pages/builds"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposRequestPageBuildResponseData { + url: string; + status: string; +} +declare type ReposListPagesBuildsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListPagesBuildsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pages/builds"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListPagesBuildsResponseData = { + url: string; + status: string; + error: { + message: string; + }; + pusher: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + commit: string; + duration: number; + created_at: string; + updated_at: string; +}[]; +declare type ReposGetLatestPagesBuildEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetLatestPagesBuildRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pages/builds/latest"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetLatestPagesBuildResponseData { + url: string; + status: string; + error: { + message: string; + }; + pusher: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + commit: string; + duration: number; + created_at: string; + updated_at: string; +} +declare type ReposGetPagesBuildEndpoint = { + owner: string; + repo: string; + build_id: number; +}; +declare type ReposGetPagesBuildRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pages/builds/:build_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetPagesBuildResponseData { + url: string; + status: string; + error: { + message: string; + }; + pusher: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + commit: string; + duration: number; + created_at: string; + updated_at: string; +} +declare type ProjectsListForRepoEndpoint = { + owner: string; + repo: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsListForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ProjectsListForRepoResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type ProjectsCreateForRepoEndpoint = { + owner: string; + repo: string; + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +} & RequiredPreview<"inertia">; +declare type ProjectsCreateForRepoRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsCreateForRepoResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type PullsListEndpoint = { + owner: string; + repo: string; + /** + * Either `open`, `closed`, or `all` to filter by state. + */ + state?: "open" | "closed" | "all"; + /** + * Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. + */ + head?: string; + /** + * Filter pulls by base branch name. Example: `gh-pages`. + */ + base?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). + */ + sort?: "created" | "updated" | "popularity" | "long-running"; + /** + * The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsListResponseData = { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_reviewers: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + head: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + base: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + issue: { + href: string; + }; + comments: { + href: string; + }; + review_comments: { + href: string; + }; + review_comment: { + href: string; + }; + commits: { + href: string; + }; + statuses: { + href: string; + }; + }; + author_association: string; + draft: boolean; +}[]; +declare type PullsCreateEndpoint = { + owner: string; + repo: string; + /** + * The title of the new pull request. + */ + title: string; + /** + * The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. + */ + head: string; + /** + * The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. + */ + base: string; + /** + * The contents of the pull request. + */ + body?: string; + /** + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + */ + maintainer_can_modify?: boolean; + /** + * Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. + */ + draft?: boolean; +}; +declare type PullsCreateRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsCreateResponseData { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_reviewers: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + head: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + base: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + issue: { + href: string; + }; + comments: { + href: string; + }; + review_comments: { + href: string; + }; + review_comment: { + href: string; + }; + commits: { + href: string; + }; + statuses: { + href: string; + }; + }; + author_association: string; + draft: boolean; + merged: boolean; + mergeable: boolean; + rebaseable: boolean; + mergeable_state: string; + merged_by: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + comments: number; + review_comments: number; + maintainer_can_modify: boolean; + commits: number; + additions: number; + deletions: number; + changed_files: number; +} +declare type PullsListCommentsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Can be either `created` or `updated` comments. + */ + sort?: "created" | "updated"; + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListCommentsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsListCommentsForRepoResponseData = { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +}[]; +declare type PullsGetCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; +}; +declare type PullsGetCommentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsGetCommentResponseData { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +} +declare type PullsUpdateCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * The text of the reply to the review comment. + */ + body: string; +}; +declare type PullsUpdateCommentRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsUpdateCommentResponseData { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +} +declare type PullsDeleteCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; +}; +declare type PullsDeleteCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForPullRequestReviewCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForPullRequestReviewCommentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForPullRequestReviewCommentResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForPullRequestReviewCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForPullRequestReviewCommentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForPullRequestReviewCommentResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsDeleteForPullRequestCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteForPullRequestCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type PullsGetEndpoint = { + owner: string; + repo: string; + pull_number: number; +}; +declare type PullsGetRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsGetResponseData { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_reviewers: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + head: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + base: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + issue: { + href: string; + }; + comments: { + href: string; + }; + review_comments: { + href: string; + }; + review_comment: { + href: string; + }; + commits: { + href: string; + }; + statuses: { + href: string; + }; + }; + author_association: string; + draft: boolean; + merged: boolean; + mergeable: boolean; + rebaseable: boolean; + mergeable_state: string; + merged_by: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + comments: number; + review_comments: number; + maintainer_can_modify: boolean; + commits: number; + additions: number; + deletions: number; + changed_files: number; +} +declare type PullsUpdateEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * The title of the pull request. + */ + title?: string; + /** + * The contents of the pull request. + */ + body?: string; + /** + * State of this Pull Request. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. + */ + base?: string; + /** + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + */ + maintainer_can_modify?: boolean; +}; +declare type PullsUpdateRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/pulls/:pull_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsUpdateResponseData { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_reviewers: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + head: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + base: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + issue: { + href: string; + }; + comments: { + href: string; + }; + review_comments: { + href: string; + }; + review_comment: { + href: string; + }; + commits: { + href: string; + }; + statuses: { + href: string; + }; + }; + author_association: string; + draft: boolean; + merged: boolean; + mergeable: boolean; + rebaseable: boolean; + mergeable_state: string; + merged_by: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + comments: number; + review_comments: number; + maintainer_can_modify: boolean; + commits: number; + additions: number; + deletions: number; + changed_files: number; +} +declare type PullsListCommentsEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * Can be either `created` or `updated` comments. + */ + sort?: "created" | "updated"; + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListCommentsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsListCommentsResponseData = { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +}[]; +declare type PullsCreateCommentEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * The text of the review comment. + */ + body: string; + /** + * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. + */ + commit_id: string; + /** + * The relative path to the file that necessitates a comment. + */ + path: string; + /** + * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + */ + position?: number; + /** + * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + */ + side?: "LEFT" | "RIGHT"; + /** + * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. + */ + line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. + */ + start_line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + */ + start_side?: "LEFT" | "RIGHT" | "side"; +}; +declare type PullsCreateCommentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls/:pull_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsCreateCommentResponseData { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +} +declare type PullsCreateReviewCommentReplyEndpoint = { + owner: string; + repo: string; + pull_number: number; + comment_id: number; + /** + * The text of the review comment. + */ + body: string; +}; +declare type PullsCreateReviewCommentReplyRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsCreateReviewCommentReplyResponseData { + url: string; + pull_request_review_id: number; + id: number; + node_id: string; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; +} +declare type PullsListCommitsEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListCommitsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/commits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsListCommitsResponseData = { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + name: string; + email: string; + date: string; + }; + committer: { + name: string; + email: string; + date: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + sha: string; + }[]; +}[]; +declare type PullsListFilesEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListFilesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/files"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsListFilesResponseData = { + sha: string; + filename: string; + status: string; + additions: number; + deletions: number; + changes: number; + blob_url: string; + raw_url: string; + contents_url: string; + patch: string; +}[]; +declare type PullsCheckIfMergedEndpoint = { + owner: string; + repo: string; + pull_number: number; +}; +declare type PullsCheckIfMergedRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/merge"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type PullsMergeEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * Title for the automatic commit message. + */ + commit_title?: string; + /** + * Extra detail to append to automatic commit message. + */ + commit_message?: string; + /** + * SHA that pull request head must match to allow merge. + */ + sha?: string; + /** + * Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. + */ + merge_method?: "merge" | "squash" | "rebase"; +}; +declare type PullsMergeRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/pulls/:pull_number/merge"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsMergeResponseData { + sha: string; + merged: boolean; + message: string; +} +export interface PullsMergeResponse405Data { + message: string; + documentation_url: string; +} +export interface PullsMergeResponse409Data { + message: string; + documentation_url: string; +} +declare type PullsListReviewRequestsEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListReviewRequestsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsListReviewRequestsResponseData { + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; +} +declare type PullsCreateReviewRequestEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * An array of user `login`s that will be requested. + */ + reviewers?: string[]; + /** + * An array of team `slug`s that will be requested. + */ + team_reviewers?: string[]; +}; +declare type PullsCreateReviewRequestRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsCreateReviewRequestResponseData { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_reviewers: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + head: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + base: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + issue: { + href: string; + }; + comments: { + href: string; + }; + review_comments: { + href: string; + }; + review_comment: { + href: string; + }; + commits: { + href: string; + }; + statuses: { + href: string; + }; + }; + author_association: string; + draft: boolean; +} +declare type PullsDeleteReviewRequestEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * An array of user `login`s that will be removed. + */ + reviewers?: string[]; + /** + * An array of team `slug`s that will be removed. + */ + team_reviewers?: string[]; +}; +declare type PullsDeleteReviewRequestRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type PullsListReviewsEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListReviewsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsListReviewsResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + submitted_at: string; + commit_id: string; +}[]; +declare type PullsCreateReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. + */ + commit_id?: string; + /** + * **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. + */ + body?: string; + /** + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready. + */ + event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + /** + * Use the following table to specify the location, destination, and contents of the draft review comment. + */ + comments?: PullsCreateReviewParamsComments[]; +}; +declare type PullsCreateReviewRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsCreateReviewResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + submitted_at: string; + commit_id: string; +} +declare type PullsGetReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + review_id: number; +}; +declare type PullsGetReviewRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsGetReviewResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + submitted_at: string; + commit_id: string; +} +declare type PullsDeletePendingReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + review_id: number; +}; +declare type PullsDeletePendingReviewRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsDeletePendingReviewResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + commit_id: string; +} +declare type PullsUpdateReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + review_id: number; + /** + * The body text of the pull request review. + */ + body: string; +}; +declare type PullsUpdateReviewRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsUpdateReviewResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + submitted_at: string; + commit_id: string; +} +declare type PullsGetCommentsForReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + review_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsGetCommentsForReviewRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsGetCommentsForReviewResponseData = { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; +}[]; +declare type PullsDismissReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + review_id: number; + /** + * The message for the pull request review dismissal + */ + message: string; +}; +declare type PullsDismissReviewRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsDismissReviewResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + submitted_at: string; + commit_id: string; +} +declare type PullsSubmitReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + review_id: number; + /** + * The body text of the pull request review + */ + body?: string; + /** + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. + */ + event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; +}; +declare type PullsSubmitReviewRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsSubmitReviewResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + submitted_at: string; + commit_id: string; +} +declare type PullsUpdateBranchEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. + */ + expected_head_sha?: string; +} & RequiredPreview<"lydian">; +declare type PullsUpdateBranchRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/pulls/:pull_number/update-branch"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsUpdateBranchResponseData { + message: string; + url: string; +} +declare type ReposGetReadmeEndpoint = { + owner: string; + repo: string; + /** + * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) + */ + ref?: string; +}; +declare type ReposGetReadmeRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/readme"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetReadmeResponseData { + type: string; + encoding: string; + size: number; + name: string; + path: string; + content: string; + sha: string; + url: string; + git_url: string; + html_url: string; + download_url: string; + _links: { + git: string; + self: string; + html: string; + }; +} +declare type ReposListReleasesEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListReleasesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/releases"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListReleasesResponseData = { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assets: { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + }[]; +}[]; +declare type ReposCreateReleaseEndpoint = { + owner: string; + repo: string; + /** + * The name of the tag. + */ + tag_name: string; + /** + * Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). + */ + target_commitish?: string; + /** + * The name of the release. + */ + name?: string; + /** + * Text describing the contents of the tag. + */ + body?: string; + /** + * `true` to create a draft (unpublished) release, `false` to create a published one. + */ + draft?: boolean; + /** + * `true` to identify the release as a prerelease. `false` to identify the release as a full release. + */ + prerelease?: boolean; +}; +declare type ReposCreateReleaseRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/releases"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateReleaseResponseData { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assets: unknown[]; +} +declare type ReposGetReleaseAssetEndpoint = { + owner: string; + repo: string; + asset_id: number; +}; +declare type ReposGetReleaseAssetRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/releases/assets/:asset_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetReleaseAssetResponseData { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type ReposUpdateReleaseAssetEndpoint = { + owner: string; + repo: string; + asset_id: number; + /** + * The file name of the asset. + */ + name?: string; + /** + * An alternate short description of the asset. Used in place of the filename. + */ + label?: string; +}; +declare type ReposUpdateReleaseAssetRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/releases/assets/:asset_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateReleaseAssetResponseData { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type ReposDeleteReleaseAssetEndpoint = { + owner: string; + repo: string; + asset_id: number; +}; +declare type ReposDeleteReleaseAssetRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/releases/assets/:asset_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetLatestReleaseEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetLatestReleaseRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/releases/latest"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetLatestReleaseResponseData { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assets: { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + }[]; +} +declare type ReposGetReleaseByTagEndpoint = { + owner: string; + repo: string; + tag: string; +}; +declare type ReposGetReleaseByTagRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/releases/tags/:tag"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetReleaseByTagResponseData { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assets: { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + }[]; +} +declare type ReposGetReleaseEndpoint = { + owner: string; + repo: string; + release_id: number; +}; +declare type ReposGetReleaseRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/releases/:release_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetReleaseResponseData { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assets: { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + }[]; +} +declare type ReposUpdateReleaseEndpoint = { + owner: string; + repo: string; + release_id: number; + /** + * The name of the tag. + */ + tag_name?: string; + /** + * Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). + */ + target_commitish?: string; + /** + * The name of the release. + */ + name?: string; + /** + * Text describing the contents of the tag. + */ + body?: string; + /** + * `true` makes the release a draft, and `false` publishes the release. + */ + draft?: boolean; + /** + * `true` to identify the release as a prerelease, `false` to identify the release as a full release. + */ + prerelease?: boolean; +}; +declare type ReposUpdateReleaseRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/releases/:release_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateReleaseResponseData { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assets: { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + }[]; +} +declare type ReposDeleteReleaseEndpoint = { + owner: string; + repo: string; + release_id: number; +}; +declare type ReposDeleteReleaseRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/releases/:release_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListAssetsForReleaseEndpoint = { + owner: string; + repo: string; + release_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListAssetsForReleaseRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/releases/:release_id/assets"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListAssetsForReleaseResponseData = { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +}[]; +declare type ReposUploadReleaseAssetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; + /** + * name parameter + */ + name?: string; + /** + * label parameter + */ + label?: string; + /** + * The raw file data + */ + data: string; + /** + * The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint + */ + origin?: string; + /** + * For https://api.github.com, set `baseUrl` to `https://uploads.github.com`. For GitHub Enterprise Server, set it to `/api/uploads` + */ + baseUrl: string; +} & { + headers: { + "content-type": string; + }; +}; +declare type ReposUploadReleaseAssetRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/releases/:release_id/assets{?name,label}"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUploadReleaseAssetResponseData { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type ActivityListStargazersForRepoEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListStargazersForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/stargazers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListStargazersForRepoResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +export declare type ActivityListStargazersForRepoResponse200Data = { + starred_at: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +}[]; +declare type ReposGetCodeFrequencyStatsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetCodeFrequencyStatsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/stats/code_frequency"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetCodeFrequencyStatsResponseData = number[][]; +declare type ReposGetCommitActivityStatsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetCommitActivityStatsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/stats/commit_activity"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetCommitActivityStatsResponseData = { + days: number[]; + total: number; + week: number; +}[]; +declare type ReposGetContributorsStatsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetContributorsStatsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/stats/contributors"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetContributorsStatsResponseData = { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + total: number; + weeks: { + w: string; + a: number; + d: number; + c: number; + }[]; +}[]; +declare type ReposGetParticipationStatsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetParticipationStatsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/stats/participation"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetParticipationStatsResponseData { + all: number[]; + owner: number[]; +} +declare type ReposGetPunchCardStatsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetPunchCardStatsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/stats/punch_card"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetPunchCardStatsResponseData = number[][]; +declare type ReposCreateStatusEndpoint = { + owner: string; + repo: string; + sha: string; + /** + * The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. + */ + state: "error" | "failure" | "pending" | "success"; + /** + * The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` + */ + target_url?: string; + /** + * A short description of the status. + */ + description?: string; + /** + * A string label to differentiate this status from the status of other systems. + */ + context?: string; +}; +declare type ReposCreateStatusRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/statuses/:sha"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateStatusResponseData { + url: string; + avatar_url: string; + id: number; + node_id: string; + state: string; + description: string; + target_url: string; + context: string; + created_at: string; + updated_at: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type ActivityListWatchersForRepoEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListWatchersForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/subscribers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListWatchersForRepoResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type ActivityGetRepoSubscriptionEndpoint = { + owner: string; + repo: string; +}; +declare type ActivityGetRepoSubscriptionRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/subscription"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActivityGetRepoSubscriptionResponseData { + subscribed: boolean; + ignored: boolean; + reason: string; + created_at: string; + url: string; + repository_url: string; +} +declare type ActivitySetRepoSubscriptionEndpoint = { + owner: string; + repo: string; + /** + * Determines if notifications should be received from this repository. + */ + subscribed?: boolean; + /** + * Determines if all notifications should be blocked from this repository. + */ + ignored?: boolean; +}; +declare type ActivitySetRepoSubscriptionRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/subscription"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActivitySetRepoSubscriptionResponseData { + subscribed: boolean; + ignored: boolean; + reason: string; + created_at: string; + url: string; + repository_url: string; +} +declare type ActivityDeleteRepoSubscriptionEndpoint = { + owner: string; + repo: string; +}; +declare type ActivityDeleteRepoSubscriptionRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/subscription"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListTagsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListTagsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/tags"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListTagsResponseData = { + name: string; + commit: { + sha: string; + url: string; + }; + zipball_url: string; + tarball_url: string; +}[]; +declare type ReposListTeamsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListTeamsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListTeamsResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type ReposGetAllTopicsEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"mercy">; +declare type ReposGetAllTopicsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/topics"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetAllTopicsResponseData { + names: string[]; +} +declare type ReposReplaceAllTopicsEndpoint = { + owner: string; + repo: string; + /** + * An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. + */ + names: string[]; +} & RequiredPreview<"mercy">; +declare type ReposReplaceAllTopicsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/topics"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposReplaceAllTopicsResponseData { + names: string[]; +} +declare type ReposGetClonesEndpoint = { + owner: string; + repo: string; + /** + * Must be one of: `day`, `week`. + */ + per?: "day" | "week"; +}; +declare type ReposGetClonesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/traffic/clones"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetClonesResponseData { + count: number; + uniques: number; + clones: { + timestamp: string; + count: number; + uniques: number; + }[]; +} +declare type ReposGetTopPathsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetTopPathsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/traffic/popular/paths"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetTopPathsResponseData = { + path: string; + title: string; + count: number; + uniques: number; +}[]; +declare type ReposGetTopReferrersEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetTopReferrersRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/traffic/popular/referrers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetTopReferrersResponseData = { + referrer: string; + count: number; + uniques: number; +}[]; +declare type ReposGetViewsEndpoint = { + owner: string; + repo: string; + /** + * Must be one of: `day`, `week`. + */ + per?: "day" | "week"; +}; +declare type ReposGetViewsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/traffic/views"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetViewsResponseData { + count: number; + uniques: number; + views: { + timestamp: string; + count: number; + uniques: number; + }[]; +} +declare type ReposTransferEndpoint = { + owner: string; + repo: string; + /** + * **Required:** The username or organization name the repository will be transferred to. + */ + new_owner?: string; + /** + * ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. + */ + team_ids?: number[]; +}; +declare type ReposTransferRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/transfer"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposTransferResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +} +declare type ReposCheckVulnerabilityAlertsEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"dorian">; +declare type ReposCheckVulnerabilityAlertsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/vulnerability-alerts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposEnableVulnerabilityAlertsEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"dorian">; +declare type ReposEnableVulnerabilityAlertsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/vulnerability-alerts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposDisableVulnerabilityAlertsEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"dorian">; +declare type ReposDisableVulnerabilityAlertsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/vulnerability-alerts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetArchiveLinkEndpoint = { + owner: string; + repo: string; + archive_format: string; + ref: string; +}; +declare type ReposGetArchiveLinkRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/:archive_format/:ref"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposCreateUsingTemplateEndpoint = { + template_owner: string; + template_repo: string; + /** + * The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. + */ + owner?: string; + /** + * The name of the new repository. + */ + name: string; + /** + * A short description of the new repository. + */ + description?: string; + /** + * Either `true` to create a new private repository or `false` to create a new public one. + */ + private?: boolean; +} & RequiredPreview<"baptiste">; +declare type ReposCreateUsingTemplateRequestOptions = { + method: "POST"; + url: "/repos/:template_owner/:template_repo/generate"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateUsingTemplateResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +} +declare type ReposListPublicEndpoint = { + /** + * The integer ID of the last repository that you've seen. + */ + since?: number; +}; +declare type ReposListPublicRequestOptions = { + method: "GET"; + url: "/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListPublicResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}[]; +declare type ScimListProvisionedIdentitiesEndpoint = { + org: string; + /** + * Used for pagination: the index of the first result to return. + */ + startIndex?: number; + /** + * Used for pagination: the number of results to return. + */ + count?: number; + /** + * Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: `?filter=userName%20eq%20\"Octocat\"`. + */ + filter?: string; +}; +declare type ScimListProvisionedIdentitiesRequestOptions = { + method: "GET"; + url: "/scim/v2/organizations/:org/Users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ScimListProvisionedIdentitiesResponseData { + schemas: string[]; + totalResults: number; + itemsPerPage: number; + startIndex: number; + Resources: { + schemas: string[]; + id: string; + externalId: string; + userName: string; + name: { + givenName: string; + familyName: string; + }; + emails: { + value: string; + primary: boolean; + type: string; + }[]; + active: boolean; + meta: { + resourceType: string; + created: string; + lastModified: string; + location: string; + }; + }[]; +} +declare type ScimProvisionAndInviteUsersEndpoint = { + org: string; +}; +declare type ScimProvisionAndInviteUsersRequestOptions = { + method: "POST"; + url: "/scim/v2/organizations/:org/Users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ScimProvisionAndInviteUsersResponseData { + schemas: string[]; + id: string; + externalId: string; + userName: string; + name: { + givenName: string; + familyName: string; + }; + emails: { + value: string; + type: string; + primary: boolean; + }[]; + active: boolean; + meta: { + resourceType: string; + created: string; + lastModified: string; + location: string; + }; +} +declare type ScimGetProvisioningDetailsForUserEndpoint = { + org: string; + scim_user_id: number; +}; +declare type ScimGetProvisioningDetailsForUserRequestOptions = { + method: "GET"; + url: "/scim/v2/organizations/:org/Users/:scim_user_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ScimGetProvisioningDetailsForUserResponseData { + schemas: string[]; + id: string; + externalId: string; + userName: string; + name: { + givenName: string; + familyName: string; + }; + emails: { + value: string; + type: string; + primary: boolean; + }[]; + active: boolean; + meta: { + resourceType: string; + created: string; + lastModified: string; + location: string; + }; +} +declare type ScimReplaceProvisionedUserInformationEndpoint = { + org: string; + scim_user_id: number; +}; +declare type ScimReplaceProvisionedUserInformationRequestOptions = { + method: "PUT"; + url: "/scim/v2/organizations/:org/Users/:scim_user_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ScimReplaceProvisionedUserInformationResponseData { + schemas: string[]; + id: string; + externalId: string; + userName: string; + name: { + givenName: string; + familyName: string; + }; + emails: { + value: string; + type: string; + primary: boolean; + }[]; + active: boolean; + meta: { + resourceType: string; + created: string; + lastModified: string; + location: string; + }; +} +declare type ScimUpdateUserAttributeEndpoint = { + org: string; + scim_user_id: number; +}; +declare type ScimUpdateUserAttributeRequestOptions = { + method: "PATCH"; + url: "/scim/v2/organizations/:org/Users/:scim_user_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ScimUpdateUserAttributeResponseData { + schemas: string[]; + id: string; + externalId: string; + userName: string; + name: { + givenName: string; + familyName: string; + }; + emails: { + value: string; + type: string; + primary: boolean; + }[]; + active: boolean; + meta: { + resourceType: string; + created: string; + lastModified: string; + location: string; + }; +} +declare type ScimRemoveUserFromOrgEndpoint = { + org: string; + scim_user_id: number; +}; +declare type ScimRemoveUserFromOrgRequestOptions = { + method: "DELETE"; + url: "/scim/v2/organizations/:org/Users/:scim_user_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type SearchCodeEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching code](https://help.github.com/articles/searching-code/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "indexed"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type SearchCodeRequestOptions = { + method: "GET"; + url: "/search/code"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchCodeResponseData { + total_count: number; + incomplete_results: boolean; + items: { + name: string; + path: string; + sha: string; + url: string; + git_url: string; + html_url: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + }; + score: number; + }[]; +} +declare type SearchCommitsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching commits](https://help.github.com/articles/searching-commits/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "author-date" | "committer-date"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"cloak">; +declare type SearchCommitsRequestOptions = { + method: "GET"; + url: "/search/commits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchCommitsResponseData { + total_count: number; + incomplete_results: boolean; + items: { + url: string; + sha: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + date: string; + name: string; + email: string; + }; + committer: { + date: string; + name: string; + email: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + html_url: string; + sha: string; + }[]; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; + }; + score: number; + }[]; +} +declare type SearchIssuesAndPullRequestsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type SearchIssuesAndPullRequestsRequestOptions = { + method: "GET"; + url: "/search/issues"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchIssuesAndPullRequestsResponseData { + total_count: number; + incomplete_results: boolean; + items: { + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + id: number; + node_id: string; + number: number; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + color: string; + }[]; + state: string; + assignee: string; + milestone: string; + comments: number; + created_at: string; + updated_at: string; + closed_at: string; + pull_request: { + html_url: string; + diff_url: string; + patch_url: string; + }; + body: string; + score: number; + }[]; +} +declare type SearchLabelsEndpoint = { + /** + * The id of the repository. + */ + repository_id: number; + /** + * The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). + */ + q: string; + /** + * Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "created" | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; +}; +declare type SearchLabelsRequestOptions = { + method: "GET"; + url: "/search/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchLabelsResponseData { + total_count: number; + incomplete_results: boolean; + items: { + id: number; + node_id: string; + url: string; + name: string; + color: string; + default: boolean; + description: string; + score: number; + }[]; +} +declare type SearchReposEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type SearchReposRequestOptions = { + method: "GET"; + url: "/search/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchReposResponseData { + total_count: number; + incomplete_results: boolean; + items: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + received_events_url: string; + type: string; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + created_at: string; + updated_at: string; + pushed_at: string; + homepage: string; + size: number; + stargazers_count: number; + watchers_count: number; + language: string; + forks_count: number; + open_issues_count: number; + master_branch: string; + default_branch: string; + score: number; + }[]; +} +declare type SearchTopicsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). + */ + q: string; +}; +declare type SearchTopicsRequestOptions = { + method: "GET"; + url: "/search/topics"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchTopicsResponseData { + total_count: number; + incomplete_results: boolean; + items: { + name: string; + display_name: string; + short_description: string; + description: string; + created_by: string; + released: string; + created_at: string; + updated_at: string; + featured: boolean; + curated: boolean; + score: number; + }[]; +} +declare type SearchUsersEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching users](https://help.github.com/articles/searching-users/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "followers" | "repositories" | "joined"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type SearchUsersRequestOptions = { + method: "GET"; + url: "/search/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchUsersResponseData { + total_count: number; + incomplete_results: boolean; + items: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + received_events_url: string; + type: string; + score: number; + }[]; +} +declare type TeamsGetLegacyEndpoint = { + team_id: number; +}; +declare type TeamsGetLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetLegacyResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + }; +} +declare type TeamsUpdateLegacyEndpoint = { + team_id: number; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; +}; +declare type TeamsUpdateLegacyRequestOptions = { + method: "PATCH"; + url: "/teams/:team_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsUpdateLegacyResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + }; +} +declare type TeamsDeleteLegacyEndpoint = { + team_id: number; +}; +declare type TeamsDeleteLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListDiscussionsLegacyEndpoint = { + team_id: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListDiscussionsLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/discussions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListDiscussionsLegacyResponseData = { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +}[]; +declare type TeamsCreateDiscussionLegacyEndpoint = { + team_id: number; + /** + * The discussion post's title. + */ + title: string; + /** + * The discussion post's body text. + */ + body: string; + /** + * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + */ + private?: boolean; +}; +declare type TeamsCreateDiscussionLegacyRequestOptions = { + method: "POST"; + url: "/teams/:team_id/discussions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateDiscussionLegacyResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsGetDiscussionLegacyEndpoint = { + team_id: number; + discussion_number: number; +}; +declare type TeamsGetDiscussionLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetDiscussionLegacyResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsUpdateDiscussionLegacyEndpoint = { + team_id: number; + discussion_number: number; + /** + * The discussion post's title. + */ + title?: string; + /** + * The discussion post's body text. + */ + body?: string; +}; +declare type TeamsUpdateDiscussionLegacyRequestOptions = { + method: "PATCH"; + url: "/teams/:team_id/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsUpdateDiscussionLegacyResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsDeleteDiscussionLegacyEndpoint = { + team_id: number; + discussion_number: number; +}; +declare type TeamsDeleteDiscussionLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListDiscussionCommentsLegacyEndpoint = { + team_id: number; + discussion_number: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListDiscussionCommentsLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/discussions/:discussion_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListDiscussionCommentsLegacyResponseData = { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +}[]; +declare type TeamsCreateDiscussionCommentLegacyEndpoint = { + team_id: number; + discussion_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +declare type TeamsCreateDiscussionCommentLegacyRequestOptions = { + method: "POST"; + url: "/teams/:team_id/discussions/:discussion_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateDiscussionCommentLegacyResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsGetDiscussionCommentLegacyEndpoint = { + team_id: number; + discussion_number: number; + comment_number: number; +}; +declare type TeamsGetDiscussionCommentLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetDiscussionCommentLegacyResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsUpdateDiscussionCommentLegacyEndpoint = { + team_id: number; + discussion_number: number; + comment_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +declare type TeamsUpdateDiscussionCommentLegacyRequestOptions = { + method: "PATCH"; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsUpdateDiscussionCommentLegacyResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsDeleteDiscussionCommentLegacyEndpoint = { + team_id: number; + discussion_number: number; + comment_number: number; +}; +declare type TeamsDeleteDiscussionCommentLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForTeamDiscussionCommentLegacyEndpoint = { + team_id: number; + discussion_number: number; + comment_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForTeamDiscussionCommentLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForTeamDiscussionCommentLegacyResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForTeamDiscussionCommentLegacyEndpoint = { + team_id: number; + discussion_number: number; + comment_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions = { + method: "POST"; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForTeamDiscussionCommentLegacyResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsListForTeamDiscussionLegacyEndpoint = { + team_id: number; + discussion_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForTeamDiscussionLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/discussions/:discussion_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForTeamDiscussionLegacyResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForTeamDiscussionLegacyEndpoint = { + team_id: number; + discussion_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForTeamDiscussionLegacyRequestOptions = { + method: "POST"; + url: "/teams/:team_id/discussions/:discussion_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForTeamDiscussionLegacyResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type TeamsListPendingInvitationsLegacyEndpoint = { + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListPendingInvitationsLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListPendingInvitationsLegacyResponseData = { + id: number; + login: string; + email: string; + role: string; + created_at: string; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + team_count: number; + invitation_team_url: string; +}[]; +declare type TeamsListMembersLegacyEndpoint = { + team_id: number; + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListMembersLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/members"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListMembersLegacyResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type TeamsGetMemberLegacyEndpoint = { + team_id: number; + username: string; +}; +declare type TeamsGetMemberLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsAddMemberLegacyEndpoint = { + team_id: number; + username: string; +}; +declare type TeamsAddMemberLegacyRequestOptions = { + method: "PUT"; + url: "/teams/:team_id/members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsAddMemberLegacyResponseData { + message: string; + errors: { + code: string; + field: string; + resource: string; + }[]; +} +declare type TeamsRemoveMemberLegacyEndpoint = { + team_id: number; + username: string; +}; +declare type TeamsRemoveMemberLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id/members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsGetMembershipForUserLegacyEndpoint = { + team_id: number; + username: string; +}; +declare type TeamsGetMembershipForUserLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetMembershipForUserLegacyResponseData { + url: string; + role: string; + state: string; +} +declare type TeamsAddOrUpdateMembershipForUserLegacyEndpoint = { + team_id: number; + username: string; + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; +}; +declare type TeamsAddOrUpdateMembershipForUserLegacyRequestOptions = { + method: "PUT"; + url: "/teams/:team_id/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsAddOrUpdateMembershipForUserLegacyResponseData { + url: string; + role: string; + state: string; +} +export interface TeamsAddOrUpdateMembershipForUserLegacyResponse422Data { + message: string; + errors: { + code: string; + field: string; + resource: string; + }[]; +} +declare type TeamsRemoveMembershipForUserLegacyEndpoint = { + team_id: number; + username: string; +}; +declare type TeamsRemoveMembershipForUserLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListProjectsLegacyEndpoint = { + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type TeamsListProjectsLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListProjectsLegacyResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + organization_permission: string; + private: boolean; + permissions: { + read: boolean; + write: boolean; + admin: boolean; + }; +}[]; +declare type TeamsCheckPermissionsForProjectLegacyEndpoint = { + team_id: number; + project_id: number; +} & RequiredPreview<"inertia">; +declare type TeamsCheckPermissionsForProjectLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCheckPermissionsForProjectLegacyResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + organization_permission: string; + private: boolean; + permissions: { + read: boolean; + write: boolean; + admin: boolean; + }; +} +declare type TeamsAddOrUpdateProjectPermissionsLegacyEndpoint = { + team_id: number; + project_id: number; + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + */ + permission?: "read" | "write" | "admin"; +} & RequiredPreview<"inertia">; +declare type TeamsAddOrUpdateProjectPermissionsLegacyRequestOptions = { + method: "PUT"; + url: "/teams/:team_id/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsAddOrUpdateProjectPermissionsLegacyResponseData { + message: string; + documentation_url: string; +} +declare type TeamsRemoveProjectLegacyEndpoint = { + team_id: number; + project_id: number; +}; +declare type TeamsRemoveProjectLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListReposLegacyEndpoint = { + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListReposLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListReposLegacyResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type TeamsCheckPermissionsForRepoLegacyEndpoint = { + team_id: number; + owner: string; + repo: string; +}; +declare type TeamsCheckPermissionsForRepoLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCheckPermissionsForRepoLegacyResponseData { + organization: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parent: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + source: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + permissions: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; +} +declare type TeamsAddOrUpdateRepoPermissionsLegacyEndpoint = { + team_id: number; + owner: string; + repo: string; + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + */ + permission?: "pull" | "push" | "admin"; +}; +declare type TeamsAddOrUpdateRepoPermissionsLegacyRequestOptions = { + method: "PUT"; + url: "/teams/:team_id/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsRemoveRepoLegacyEndpoint = { + team_id: number; + owner: string; + repo: string; +}; +declare type TeamsRemoveRepoLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListIdPGroupsForLegacyEndpoint = { + team_id: number; +}; +declare type TeamsListIdPGroupsForLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/team-sync/group-mappings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsListIdPGroupsForLegacyResponseData { + groups: { + group_id: string; + group_name: string; + group_description: string; + }[]; +} +declare type TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint = { + team_id: number; + /** + * The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. + */ + groups: TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups[]; +}; +declare type TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions = { + method: "PATCH"; + url: "/teams/:team_id/team-sync/group-mappings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseData { + groups: { + group_id: string; + group_name: string; + group_description: string; + }[]; +} +declare type TeamsListChildLegacyEndpoint = { + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListChildLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListChildLegacyResponseData = { + id: number; + node_id: string; + url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + }; +}[]; +declare type UsersGetAuthenticatedEndpoint = {}; +declare type UsersGetAuthenticatedRequestOptions = { + method: "GET"; + url: "/user"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersGetAuthenticatedResponseData { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string; + company: string; + blog: string; + location: string; + email: string; + hireable: boolean; + bio: string; + twitter_username: string; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; + private_gists: number; + total_private_repos: number; + owned_private_repos: number; + disk_usage: number; + collaborators: number; + two_factor_authentication: boolean; + plan: { + name: string; + space: number; + private_repos: number; + collaborators: number; + }; +} +declare type UsersUpdateAuthenticatedEndpoint = { + /** + * The new name of the user. + */ + name?: string; + /** + * The publicly visible email address of the user. + */ + email?: string; + /** + * The new blog URL of the user. + */ + blog?: string; + /** + * The new company of the user. + */ + company?: string; + /** + * The new location of the user. + */ + location?: string; + /** + * The new hiring availability of the user. + */ + hireable?: boolean; + /** + * The new short biography of the user. + */ + bio?: string; + /** + * The new Twitter username of the user. + */ + twitter_username?: string; +}; +declare type UsersUpdateAuthenticatedRequestOptions = { + method: "PATCH"; + url: "/user"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersUpdateAuthenticatedResponseData { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string; + company: string; + blog: string; + location: string; + email: string; + hireable: boolean; + bio: string; + twitter_username: string; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; + private_gists: number; + total_private_repos: number; + owned_private_repos: number; + disk_usage: number; + collaborators: number; + two_factor_authentication: boolean; + plan: { + name: string; + space: number; + private_repos: number; + collaborators: number; + }; +} +declare type UsersListBlockedEndpoint = {}; +declare type UsersListBlockedRequestOptions = { + method: "GET"; + url: "/user/blocks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListBlockedResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type UsersCheckBlockedEndpoint = { + username: string; +}; +declare type UsersCheckBlockedRequestOptions = { + method: "GET"; + url: "/user/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersBlockEndpoint = { + username: string; +}; +declare type UsersBlockRequestOptions = { + method: "PUT"; + url: "/user/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersUnblockEndpoint = { + username: string; +}; +declare type UsersUnblockRequestOptions = { + method: "DELETE"; + url: "/user/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersTogglePrimaryEmailVisibilityEndpoint = { + /** + * Specify the _primary_ email address that needs a visibility change. + */ + email: string; + /** + * Use `public` to enable an authenticated user to view the specified email address, or use `private` so this primary email address cannot be seen publicly. + */ + visibility: string; +}; +declare type UsersTogglePrimaryEmailVisibilityRequestOptions = { + method: "PATCH"; + url: "/user/email/visibility"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersTogglePrimaryEmailVisibilityResponseData = { + email: string; + primary: boolean; + verified: boolean; + visibility: string; +}[]; +declare type UsersListEmailsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListEmailsRequestOptions = { + method: "GET"; + url: "/user/emails"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListEmailsResponseData = { + email: string; + verified: boolean; + primary: boolean; + visibility: string; +}[]; +declare type UsersAddEmailsEndpoint = { + /** + * Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. + */ + emails: string[]; +}; +declare type UsersAddEmailsRequestOptions = { + method: "POST"; + url: "/user/emails"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersAddEmailsResponseData = { + email: string; + primary: boolean; + verified: boolean; + visibility: string; +}[]; +declare type UsersDeleteEmailsEndpoint = { + /** + * Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. + */ + emails: string[]; +}; +declare type UsersDeleteEmailsRequestOptions = { + method: "DELETE"; + url: "/user/emails"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersListFollowersForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListFollowersForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/followers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListFollowersForAuthenticatedUserResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type UsersListFollowedByAuthenticatedEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListFollowedByAuthenticatedRequestOptions = { + method: "GET"; + url: "/user/following"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListFollowedByAuthenticatedResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type UsersCheckFollowingEndpoint = { + username: string; +}; +declare type UsersCheckFollowingRequestOptions = { + method: "GET"; + url: "/user/following/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersFollowEndpoint = { + username: string; +}; +declare type UsersFollowRequestOptions = { + method: "PUT"; + url: "/user/following/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersUnfollowEndpoint = { + username: string; +}; +declare type UsersUnfollowRequestOptions = { + method: "DELETE"; + url: "/user/following/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersListGpgKeysEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListGpgKeysRequestOptions = { + method: "GET"; + url: "/user/gpg_keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListGpgKeysResponseData = { + id: number; + primary_key_id: string; + key_id: string; + public_key: string; + emails: { + email: string; + verified: boolean; + }[]; + subkeys: { + id: number; + primary_key_id: number; + key_id: string; + public_key: string; + emails: unknown[]; + subkeys: unknown[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; + }[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; +}[]; +declare type UsersCreateGpgKeyEndpoint = { + /** + * Your GPG key, generated in ASCII-armored format. See "[Generating a new GPG key](https://help.github.com/articles/generating-a-new-gpg-key/)" for help creating a GPG key. + */ + armored_public_key?: string; +}; +declare type UsersCreateGpgKeyRequestOptions = { + method: "POST"; + url: "/user/gpg_keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersCreateGpgKeyResponseData { + id: number; + primary_key_id: string; + key_id: string; + public_key: string; + emails: { + email: string; + verified: boolean; + }[]; + subkeys: { + id: number; + primary_key_id: number; + key_id: string; + public_key: string; + emails: unknown[]; + subkeys: unknown[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; + }[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; +} +declare type UsersGetGpgKeyEndpoint = { + gpg_key_id: number; +}; +declare type UsersGetGpgKeyRequestOptions = { + method: "GET"; + url: "/user/gpg_keys/:gpg_key_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersGetGpgKeyResponseData { + id: number; + primary_key_id: string; + key_id: string; + public_key: string; + emails: { + email: string; + verified: boolean; + }[]; + subkeys: { + id: number; + primary_key_id: number; + key_id: string; + public_key: string; + emails: unknown[]; + subkeys: unknown[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; + }[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; +} +declare type UsersDeleteGpgKeyEndpoint = { + gpg_key_id: number; +}; +declare type UsersDeleteGpgKeyRequestOptions = { + method: "DELETE"; + url: "/user/gpg_keys/:gpg_key_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsListInstallationsForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"machine-man">; +declare type AppsListInstallationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/installations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsListInstallationsForAuthenticatedUserResponseData { + total_count: number; + installations: { + id: number; + account: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + gravatar_id: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + checks: string; + metadata: string; + contents: string; + }; + events: string[]; + single_file_name: string; + }[]; +} +declare type AppsListInstallationReposForAuthenticatedUserEndpoint = { + installation_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"machine-man">; +declare type AppsListInstallationReposForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/installations/:installation_id/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsListInstallationReposForAuthenticatedUserResponseData { + total_count: number; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; +} +declare type AppsAddRepoToInstallationEndpoint = { + installation_id: number; + repository_id: number; +} & RequiredPreview<"machine-man">; +declare type AppsAddRepoToInstallationRequestOptions = { + method: "PUT"; + url: "/user/installations/:installation_id/repositories/:repository_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsRemoveRepoFromInstallationEndpoint = { + installation_id: number; + repository_id: number; +} & RequiredPreview<"machine-man">; +declare type AppsRemoveRepoFromInstallationRequestOptions = { + method: "DELETE"; + url: "/user/installations/:installation_id/repositories/:repository_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesListForAuthenticatedUserEndpoint = { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/issues"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListForAuthenticatedUserResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +}[]; +declare type UsersListPublicKeysEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListPublicKeysRequestOptions = { + method: "GET"; + url: "/user/keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListPublicKeysResponseData = { + key_id: string; + key: string; +}[]; +declare type UsersCreatePublicKeyEndpoint = { + /** + * A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air". + */ + title?: string; + /** + * The public SSH key to add to your GitHub account. See "[Generating a new SSH key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)" for guidance on how to create a public SSH key. + */ + key?: string; +}; +declare type UsersCreatePublicKeyRequestOptions = { + method: "POST"; + url: "/user/keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersCreatePublicKeyResponseData { + key_id: string; + key: string; +} +declare type UsersGetPublicKeyEndpoint = { + key_id: number; +}; +declare type UsersGetPublicKeyRequestOptions = { + method: "GET"; + url: "/user/keys/:key_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersGetPublicKeyResponseData { + key_id: string; + key: string; +} +declare type UsersDeletePublicKeyEndpoint = { + key_id: number; +}; +declare type UsersDeletePublicKeyRequestOptions = { + method: "DELETE"; + url: "/user/keys/:key_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsListSubscriptionsForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type AppsListSubscriptionsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/marketplace_purchases"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListSubscriptionsForAuthenticatedUserResponseData = { + billing_cycle: string; + next_billing_date: string; + unit_count: string; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + account: { + login: string; + id: number; + url: string; + email: string; + organization_billing_email: string; + type: string; + }; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; + }; +}[]; +declare type AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions = { + method: "GET"; + url: "/user/marketplace_purchases/stubbed"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListSubscriptionsForAuthenticatedUserStubbedResponseData = { + billing_cycle: string; + next_billing_date: string; + unit_count: string; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + account: { + login: string; + id: number; + url: string; + email: string; + organization_billing_email: string; + type: string; + }; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; + }; +}[]; +declare type OrgsListMembershipsEndpoint = { + /** + * Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. + */ + state?: "active" | "pending"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListMembershipsRequestOptions = { + method: "GET"; + url: "/user/memberships/orgs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListMembershipsResponseData = { + url: string; + state: string; + role: string; + organization_url: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +}[]; +declare type OrgsGetMembershipForAuthenticatedUserEndpoint = { + org: string; +}; +declare type OrgsGetMembershipForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/memberships/orgs/:org"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsGetMembershipForAuthenticatedUserResponseData { + url: string; + state: string; + role: string; + organization_url: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type OrgsUpdateMembershipEndpoint = { + org: string; + /** + * The state that the membership should be in. Only `"active"` will be accepted. + */ + state: "active"; +}; +declare type OrgsUpdateMembershipRequestOptions = { + method: "PATCH"; + url: "/user/memberships/orgs/:org"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsUpdateMembershipResponseData { + url: string; + state: string; + role: string; + organization_url: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type MigrationsStartForAuthenticatedUserEndpoint = { + /** + * An array of repositories to include in the migration. + */ + repositories: string[]; + /** + * Locks the `repositories` to prevent changes during the migration when set to `true`. + */ + lock_repositories?: boolean; + /** + * Does not include attachments uploaded to GitHub.com in the migration data when set to `true`. Excluding attachments will reduce the migration archive file size. + */ + exclude_attachments?: boolean; +}; +declare type MigrationsStartForAuthenticatedUserRequestOptions = { + method: "POST"; + url: "/user/migrations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsStartForAuthenticatedUserResponseData { + id: number; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; + url: string; + created_at: string; + updated_at: string; +} +declare type MigrationsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/migrations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type MigrationsListForAuthenticatedUserResponseData = { + id: number; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; + url: string; + created_at: string; + updated_at: string; +}[]; +declare type MigrationsGetStatusForAuthenticatedUserEndpoint = { + migration_id: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsGetStatusForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/migrations/:migration_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsGetStatusForAuthenticatedUserResponseData { + id: number; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; + url: string; + created_at: string; + updated_at: string; +} +declare type MigrationsGetArchiveForAuthenticatedUserEndpoint = { + migration_id: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsGetArchiveForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/migrations/:migration_id/archive"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsDeleteArchiveForAuthenticatedUserEndpoint = { + migration_id: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsDeleteArchiveForAuthenticatedUserRequestOptions = { + method: "DELETE"; + url: "/user/migrations/:migration_id/archive"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsUnlockRepoForAuthenticatedUserEndpoint = { + migration_id: number; + repo_name: string; +} & RequiredPreview<"wyandotte">; +declare type MigrationsUnlockRepoForAuthenticatedUserRequestOptions = { + method: "DELETE"; + url: "/user/migrations/:migration_id/repos/:repo_name/lock"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/orgs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListForAuthenticatedUserResponseData = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}[]; +declare type ProjectsCreateForAuthenticatedUserEndpoint = { + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +} & RequiredPreview<"inertia">; +declare type ProjectsCreateForAuthenticatedUserRequestOptions = { + method: "POST"; + url: "/user/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsCreateForAuthenticatedUserResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type UsersListPublicEmailsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListPublicEmailsRequestOptions = { + method: "GET"; + url: "/user/public_emails"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListPublicEmailsResponseData = { + email: string; + verified: boolean; + primary: boolean; + visibility: string; +}[]; +declare type ReposListForAuthenticatedUserEndpoint = { + /** + * Can be one of `all`, `public`, or `private`. + */ + visibility?: "all" | "public" | "private"; + /** + * Comma-separated list of values. Can include: + * \* `owner`: Repositories that are owned by the authenticated user. + * \* `collaborator`: Repositories that the user has been added to as a collaborator. + * \* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. + */ + affiliation?: string; + /** + * Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` + * + * Will cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. + */ + type?: "all" | "owner" | "public" | "private" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposCreateForAuthenticatedUserEndpoint = { + /** + * The name of the repository. + */ + name: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to create a private repository or `false` to create a public one. + */ + private?: boolean; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see "[Creating an internal repository](https://help.github.com/github/creating-cloning-and-archiving-repositories/creating-an-internal-repository)" in the GitHub Help documentation. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + */ + team_id?: number; + /** + * Pass `true` to create an initial commit with empty README. + */ + auto_init?: boolean; + /** + * Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". + */ + gitignore_template?: string; + /** + * Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". + */ + license_template?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; +}; +declare type ReposCreateForAuthenticatedUserRequestOptions = { + method: "POST"; + url: "/user/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateForAuthenticatedUserResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +} +declare type ReposListInvitationsForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListInvitationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/repository_invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListInvitationsForAuthenticatedUserResponseData = { + id: number; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + invitee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + permissions: string; + created_at: string; + url: string; + html_url: string; +}[]; +declare type ReposAcceptInvitationEndpoint = { + invitation_id: number; +}; +declare type ReposAcceptInvitationRequestOptions = { + method: "PATCH"; + url: "/user/repository_invitations/:invitation_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposDeclineInvitationEndpoint = { + invitation_id: number; +}; +declare type ReposDeclineInvitationRequestOptions = { + method: "DELETE"; + url: "/user/repository_invitations/:invitation_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListReposStarredByAuthenticatedUserEndpoint = { + /** + * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). + */ + sort?: "created" | "updated"; + /** + * One of `asc` (ascending) or `desc` (descending). + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListReposStarredByAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/starred"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListReposStarredByAuthenticatedUserResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}[]; +export declare type ActivityListReposStarredByAuthenticatedUserResponse200Data = { + starred_at: string; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +}[]; +declare type ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint = { + owner: string; + repo: string; +}; +declare type ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/starred/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityStarRepoForAuthenticatedUserEndpoint = { + owner: string; + repo: string; +}; +declare type ActivityStarRepoForAuthenticatedUserRequestOptions = { + method: "PUT"; + url: "/user/starred/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityUnstarRepoForAuthenticatedUserEndpoint = { + owner: string; + repo: string; +}; +declare type ActivityUnstarRepoForAuthenticatedUserRequestOptions = { + method: "DELETE"; + url: "/user/starred/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListWatchedReposForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListWatchedReposForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/subscriptions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListWatchedReposForAuthenticatedUserResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type TeamsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListForAuthenticatedUserResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + }; +}[]; +declare type MigrationsListReposForUserEndpoint = { + migration_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsListReposForUserRequestOptions = { + method: "GET"; + url: "/user/:migration_id/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type MigrationsListReposForUserResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type UsersListEndpoint = { + /** + * The integer ID of the last User that you've seen. + */ + since?: string; +}; +declare type UsersListRequestOptions = { + method: "GET"; + url: "/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type UsersGetByUsernameEndpoint = { + username: string; +}; +declare type UsersGetByUsernameRequestOptions = { + method: "GET"; + url: "/users/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersGetByUsernameResponseData { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string; + company: string; + blog: string; + location: string; + email: string; + hireable: boolean; + bio: string; + twitter_username: string; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; +} +declare type ActivityListEventsForAuthenticatedUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListEventsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/users/:username/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListOrgEventsForAuthenticatedUserEndpoint = { + username: string; + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListOrgEventsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/users/:username/events/orgs/:org"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListPublicEventsForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListPublicEventsForUserRequestOptions = { + method: "GET"; + url: "/users/:username/events/public"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersListFollowersForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListFollowersForUserRequestOptions = { + method: "GET"; + url: "/users/:username/followers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListFollowersForUserResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type UsersListFollowingForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListFollowingForUserRequestOptions = { + method: "GET"; + url: "/users/:username/following"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListFollowingForUserResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type UsersCheckFollowingForUserEndpoint = { + username: string; + target_user: string; +}; +declare type UsersCheckFollowingForUserRequestOptions = { + method: "GET"; + url: "/users/:username/following/:target_user"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GistsListForUserEndpoint = { + username: string; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListForUserRequestOptions = { + method: "GET"; + url: "/users/:username/gists"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListForUserResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; +}[]; +declare type UsersListGpgKeysForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListGpgKeysForUserRequestOptions = { + method: "GET"; + url: "/users/:username/gpg_keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListGpgKeysForUserResponseData = { + id: number; + primary_key_id: string; + key_id: string; + public_key: string; + emails: { + email: string; + verified: boolean; + }[]; + subkeys: { + id: number; + primary_key_id: number; + key_id: string; + public_key: string; + emails: unknown[]; + subkeys: unknown[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; + }[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; +}[]; +declare type UsersGetContextForUserEndpoint = { + username: string; + /** + * Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. + */ + subject_type?: "organization" | "repository" | "issue" | "pull_request"; + /** + * Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. + */ + subject_id?: string; +}; +declare type UsersGetContextForUserRequestOptions = { + method: "GET"; + url: "/users/:username/hovercard"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersGetContextForUserResponseData { + contexts: { + message: string; + octicon: string; + }[]; +} +declare type AppsGetUserInstallationEndpoint = { + username: string; +} & RequiredPreview<"machine-man">; +declare type AppsGetUserInstallationRequestOptions = { + method: "GET"; + url: "/users/:username/installation"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetUserInstallationResponseData { + id: number; + account: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repository_selection: "all" | "selected"; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + checks: string; + metadata: string; + contents: string; + }; + events: string[]; + created_at: string; + updated_at: string; + single_file_name: string; +} +declare type UsersListPublicKeysForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListPublicKeysForUserRequestOptions = { + method: "GET"; + url: "/users/:username/keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListPublicKeysForUserResponseData = { + id: number; + key: string; +}[]; +declare type OrgsListForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListForUserRequestOptions = { + method: "GET"; + url: "/users/:username/orgs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListForUserResponseData = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}[]; +declare type ProjectsListForUserEndpoint = { + username: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsListForUserRequestOptions = { + method: "GET"; + url: "/users/:username/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ProjectsListForUserResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type ActivityListReceivedEventsForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListReceivedEventsForUserRequestOptions = { + method: "GET"; + url: "/users/:username/received_events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListReceivedPublicEventsForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListReceivedPublicEventsForUserRequestOptions = { + method: "GET"; + url: "/users/:username/received_events/public"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListForUserEndpoint = { + username: string; + /** + * Can be one of `all`, `owner`, `member`. + */ + type?: "all" | "owner" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListForUserRequestOptions = { + method: "GET"; + url: "/users/:username/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListReposStarredByUserEndpoint = { + username: string; + /** + * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). + */ + sort?: "created" | "updated"; + /** + * One of `asc` (ascending) or `desc` (descending). + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListReposStarredByUserRequestOptions = { + method: "GET"; + url: "/users/:username/starred"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListReposStarredByUserResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}[]; +export declare type ActivityListReposStarredByUserResponse200Data = { + starred_at: string; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +}[]; +declare type ActivityListReposWatchedByUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListReposWatchedByUserRequestOptions = { + method: "GET"; + url: "/users/:username/subscriptions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListReposWatchedByUserResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type AppsCreateInstallationTokenParamsPermissions = {}; +declare type GistsCreateParamsFiles = { + [key: string]: GistsCreateParamsFilesKeyString; +}; +declare type GistsCreateParamsFilesKeyString = { + content: string; +}; +declare type GistsUpdateParamsFiles = { + [key: string]: GistsUpdateParamsFilesKeyString; +}; +declare type GistsUpdateParamsFilesKeyString = { + content: string; + filename: string; +}; +declare type OrgsCreateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +declare type OrgsUpdateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +declare type TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups = { + group_id: string; + group_name: string; + group_description: string; +}; +declare type ReposUpdateBranchProtectionParamsRequiredStatusChecks = { + strict: boolean; + contexts: string[]; +}; +declare type ReposUpdateBranchProtectionParamsRequiredPullRequestReviews = { + dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions; + dismiss_stale_reviews?: boolean; + require_code_owner_reviews?: boolean; + required_approving_review_count?: number; +}; +declare type ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions = { + users?: string[]; + teams?: string[]; +}; +declare type ReposUpdateBranchProtectionParamsRestrictions = { + users: string[]; + teams: string[]; + apps?: string[]; +}; +declare type ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions = { + users?: string[]; + teams?: string[]; +}; +declare type ChecksCreateParamsOutput = { + title: string; + summary: string; + text?: string; + annotations?: ChecksCreateParamsOutputAnnotations[]; + images?: ChecksCreateParamsOutputImages[]; +}; +declare type ChecksCreateParamsOutputAnnotations = { + path: string; + start_line: number; + end_line: number; + start_column?: number; + end_column?: number; + annotation_level: "notice" | "warning" | "failure"; + message: string; + title?: string; + raw_details?: string; +}; +declare type ChecksCreateParamsOutputImages = { + alt: string; + image_url: string; + caption?: string; +}; +declare type ChecksCreateParamsActions = { + label: string; + description: string; + identifier: string; +}; +declare type ChecksUpdateParamsOutput = { + title?: string; + summary: string; + text?: string; + annotations?: ChecksUpdateParamsOutputAnnotations[]; + images?: ChecksUpdateParamsOutputImages[]; +}; +declare type ChecksUpdateParamsOutputAnnotations = { + path: string; + start_line: number; + end_line: number; + start_column?: number; + end_column?: number; + annotation_level: "notice" | "warning" | "failure"; + message: string; + title?: string; + raw_details?: string; +}; +declare type ChecksUpdateParamsOutputImages = { + alt: string; + image_url: string; + caption?: string; +}; +declare type ChecksUpdateParamsActions = { + label: string; + description: string; + identifier: string; +}; +declare type ChecksSetSuitesPreferencesParamsAutoTriggerChecks = { + app_id: number; + setting: boolean; +}; +declare type ReposCreateOrUpdateFileParamsCommitter = { + name: string; + email: string; +}; +declare type ReposCreateOrUpdateFileParamsAuthor = { + name: string; + email: string; +}; +declare type ReposDeleteFileParamsCommitter = { + name?: string; + email?: string; +}; +declare type ReposDeleteFileParamsAuthor = { + name?: string; + email?: string; +}; +declare type ReposCreateDispatchEventParamsClientPayload = {}; +declare type GitCreateCommitParamsAuthor = { + name?: string; + email?: string; + date?: string; +}; +declare type GitCreateCommitParamsCommitter = { + name?: string; + email?: string; + date?: string; +}; +declare type GitCreateTagParamsTagger = { + name?: string; + email?: string; + date?: string; +}; +declare type GitCreateTreeParamsTree = { + path?: string; + mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + type?: "blob" | "tree" | "commit"; + sha?: string | null; + content?: string; +}; +declare type ReposCreateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +declare type ReposUpdateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +declare type ReposEnablePagesSiteParamsSource = { + branch?: "master" | "gh-pages"; + path?: string; +}; +declare type PullsCreateReviewParamsComments = { + path: string; + position: number; + body: string; +}; +declare type TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups = { + group_id: string; + group_name: string; + group_description: string; +}; +export {}; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/index.d.ts b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/index.d.ts new file mode 100644 index 00000000..5d2d5ae0 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-types/index.d.ts @@ -0,0 +1,20 @@ +export * from "./AuthInterface"; +export * from "./EndpointDefaults"; +export * from "./EndpointInterface"; +export * from "./EndpointOptions"; +export * from "./Fetch"; +export * from "./OctokitResponse"; +export * from "./RequestHeaders"; +export * from "./RequestInterface"; +export * from "./RequestMethod"; +export * from "./RequestOptions"; +export * from "./RequestParameters"; +export * from "./RequestRequestOptions"; +export * from "./ResponseHeaders"; +export * from "./Route"; +export * from "./Signal"; +export * from "./StrategyInterface"; +export * from "./Url"; +export * from "./VERSION"; +export * from "./GetResponseTypeFromEndpointMethod"; +export * from "./generated/Endpoints"; diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-web/index.js b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-web/index.js new file mode 100644 index 00000000..1e76cdfc --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-web/index.js @@ -0,0 +1,4 @@ +const VERSION = "4.1.6"; + +export { VERSION }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-web/index.js.map b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-web/index.js.map new file mode 100644 index 00000000..cd0e254a --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/VERSION.js"],"sourcesContent":["export const VERSION = \"0.0.0-development\";\n"],"names":[],"mappings":"AAAY,MAAC,OAAO,GAAG;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/node_modules/@octokit/types/package.json b/node_modules/@octokit/endpoint/node_modules/@octokit/types/package.json new file mode 100644 index 00000000..bd8d8964 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/@octokit/types/package.json @@ -0,0 +1,49 @@ +{ + "name": "@octokit/types", + "description": "Shared TypeScript definitions for Octokit projects", + "version": "4.1.6", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "github", + "api", + "sdk", + "toolkit", + "typescript" + ], + "repository": "https://github.com/octokit/types.ts", + "dependencies": { + "@types/node": ">= 8" + }, + "devDependencies": { + "@octokit/graphql": "^4.2.2", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "handlebars": "^4.7.6", + "json-schema-to-typescript": "^9.1.0", + "lodash.set": "^4.3.2", + "npm-run-all": "^4.1.5", + "pascal-case": "^3.1.1", + "prettier": "^2.0.0", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "sort-keys": "^4.0.0", + "string-to-jsdoc-comment": "^1.0.0", + "typedoc": "^0.17.0", + "typescript": "^3.6.4" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/LICENSE.md b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/LICENSE.md new file mode 100644 index 00000000..f105ab0c --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/LICENSE.md @@ -0,0 +1,7 @@ +# [ISC License](https://spdx.org/licenses/ISC) + +Copyright (c) 2018, Gregor Martynus (https://github.com/gr2m) + +Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/README.md b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/README.md new file mode 100644 index 00000000..d00d14c1 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/README.md @@ -0,0 +1,25 @@ +# universal-user-agent + +> Get a user agent string in both browser and node + +[![@latest](https://img.shields.io/npm/v/universal-user-agent.svg)](https://www.npmjs.com/package/universal-user-agent) +[![Build Status](https://travis-ci.com/gr2m/universal-user-agent.svg?branch=master)](https://travis-ci.com/gr2m/universal-user-agent) +[![Greenkeeper](https://badges.greenkeeper.io/gr2m/universal-user-agent.svg)](https://greenkeeper.io/) + +```js +const { getUserAgent } = require("universal-user-agent"); +// or import { getUserAgent } from "universal-user-agent"; + +const userAgent = getUserAgent(); +// userAgent will look like this +// in browser: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:61.0) Gecko/20100101 Firefox/61.0" +// in node: Node.js/v8.9.4 (macOS High Sierra; x64) +``` + +## Credits + +The Node implementation was originally inspired by [default-user-agent](https://www.npmjs.com/package/default-user-agent). + +## License + +[ISC](LICENSE.md) diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js new file mode 100644 index 00000000..c2534ce2 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js @@ -0,0 +1,22 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } + +var osName = _interopDefault(require('os-name')); + +function getUserAgent() { + try { + return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; + } catch (error) { + if (/wmic os get Caption/.test(error.message)) { + return "Windows "; + } + + return ""; + } +} + +exports.getUserAgent = getUserAgent; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map new file mode 100644 index 00000000..6f15e8db --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/node.js"],"sourcesContent":["import osName from \"os-name\";\nexport function getUserAgent() {\n try {\n return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`;\n }\n catch (error) {\n if (/wmic os get Caption/.test(error.message)) {\n return \"Windows \";\n }\n return \"\";\n }\n}\n"],"names":["getUserAgent","process","version","substr","osName","arch","error","test","message"],"mappings":";;;;;;;;AACO,SAASA,YAAT,GAAwB;MACvB;WACQ,WAAUC,OAAO,CAACC,OAAR,CAAgBC,MAAhB,CAAuB,CAAvB,CAA0B,KAAIC,MAAM,EAAG,KAAIH,OAAO,CAACI,IAAK,GAA1E;GADJ,CAGA,OAAOC,KAAP,EAAc;QACN,sBAAsBC,IAAtB,CAA2BD,KAAK,CAACE,OAAjC,CAAJ,EAA+C;aACpC,gCAAP;;;WAEG,4BAAP;;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js new file mode 100644 index 00000000..8903ac92 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js @@ -0,0 +1,8 @@ +export function getUserAgent() { + try { + return navigator.userAgent; + } + catch (e) { + return ""; + } +} diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/index.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/index.js new file mode 100644 index 00000000..c6253f5a --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/index.js @@ -0,0 +1 @@ +export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js new file mode 100644 index 00000000..ba148f05 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js @@ -0,0 +1,12 @@ +import osName from "os-name"; +export function getUserAgent() { + try { + return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; + } + catch (error) { + if (/wmic os get Caption/.test(error.message)) { + return "Windows "; + } + return ""; + } +} diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/browser.d.ts b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/browser.d.ts new file mode 100644 index 00000000..a7bb1c44 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/browser.d.ts @@ -0,0 +1 @@ +export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/index.d.ts b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/index.d.ts new file mode 100644 index 00000000..c6253f5a --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/index.d.ts @@ -0,0 +1 @@ +export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/node.d.ts b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/node.d.ts new file mode 100644 index 00000000..a7bb1c44 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/node.d.ts @@ -0,0 +1 @@ +export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js new file mode 100644 index 00000000..c76d6e58 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js @@ -0,0 +1,11 @@ +function getUserAgent() { + try { + return navigator.userAgent; + } + catch (e) { + return ""; + } +} + +export { getUserAgent }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map new file mode 100644 index 00000000..f4b20c36 --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/browser.js"],"sourcesContent":["export function getUserAgent() {\n try {\n return navigator.userAgent;\n }\n catch (e) {\n return \"\";\n }\n}\n"],"names":[],"mappings":"AAAO,SAAS,YAAY,GAAG;IAC3B,IAAI;QACA,OAAO,SAAS,CAAC,SAAS,CAAC;KAC9B;IACD,OAAO,CAAC,EAAE;QACN,OAAO,4BAA4B,CAAC;KACvC;CACJ;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json new file mode 100644 index 00000000..d661faac --- /dev/null +++ b/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json @@ -0,0 +1,33 @@ +{ + "name": "universal-user-agent", + "description": "Get a user agent string in both browser and node", + "version": "5.0.0", + "license": "ISC", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [], + "repository": "https://github.com/gr2m/universal-user-agent.git", + "dependencies": { + "os-name": "^3.1.0" + }, + "devDependencies": { + "@gr2m/pika-plugin-build-web": "^0.6.0-issue-84.1", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.1", + "@pika/plugin-ts-standard-pkg": "^0.9.1", + "@types/jest": "^25.1.0", + "jest": "^24.9.0", + "prettier": "^1.18.2", + "semantic-release": "^17.0.0", + "ts-jest": "^25.1.0", + "typescript": "^3.6.2" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/endpoint/package.json b/node_modules/@octokit/endpoint/package.json new file mode 100644 index 00000000..ca7c7803 --- /dev/null +++ b/node_modules/@octokit/endpoint/package.json @@ -0,0 +1,51 @@ +{ + "name": "@octokit/endpoint", + "description": "Turns REST API endpoints into generic request options", + "version": "6.0.2", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "octokit", + "github", + "api", + "rest" + ], + "homepage": "https://github.com/octokit/endpoint.js#readme", + "bugs": { + "url": "https://github.com/octokit/endpoint.js/issues" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/octokit/endpoint.js.git" + }, + "dependencies": { + "@octokit/types": "^4.0.1", + "is-plain-object": "^3.0.0", + "universal-user-agent": "^5.0.0" + }, + "devDependencies": { + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/jest": "^25.1.0", + "jest": "^26.0.1", + "prettier": "2.0.5", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "ts-jest": "^26.0.0", + "typescript": "^3.4.5" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/graphql/LICENSE b/node_modules/@octokit/graphql/LICENSE new file mode 100644 index 00000000..af5366d0 --- /dev/null +++ b/node_modules/@octokit/graphql/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2018 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/@octokit/graphql/README.md b/node_modules/@octokit/graphql/README.md new file mode 100644 index 00000000..7ba46fbd --- /dev/null +++ b/node_modules/@octokit/graphql/README.md @@ -0,0 +1,398 @@ +# graphql.js + +> GitHub GraphQL API client for browsers and Node + +[![@latest](https://img.shields.io/npm/v/@octokit/graphql.svg)](https://www.npmjs.com/package/@octokit/graphql) +[![Build Status](https://github.com/octokit/graphql.js/workflows/Test/badge.svg)](https://github.com/octokit/graphql.js/actions?query=workflow%3ATest+branch%3Amaster) + + + +- [Usage](#usage) + - [Send a simple query](#send-a-simple-query) + - [Authentication](#authentication) + - [Variables](#variables) + - [Pass query together with headers and variables](#pass-query-together-with-headers-and-variables) + - [Use with GitHub Enterprise](#use-with-github-enterprise) + - [Use custom `@octokit/request` instance](#use-custom-octokitrequest-instance) +- [TypeScript](#typescript) + - [Additional Types](#additional-types) +- [Errors](#errors) +- [Partial responses](#partial-responses) +- [Writing tests](#writing-tests) +- [License](#license) + + + +## Usage + + + + + + +
+Browsers + + +Load `@octokit/graphql` directly from [cdn.skypack.dev](https://cdn.skypack.dev) + +```html + +``` + +
+Node + + +Install with npm install @octokit/graphql + +```js +const { graphql } = require("@octokit/graphql"); +// or: import { graphql } from "@octokit/graphql"; +``` + +
+ +### Send a simple query + +```js +const { repository } = await graphql( + ` + { + repository(owner: "octokit", name: "graphql.js") { + issues(last: 3) { + edges { + node { + title + } + } + } + } + } + `, + { + headers: { + authorization: `token secret123`, + }, + } +); +``` + +### Authentication + +The simplest way to authenticate a request is to set the `Authorization` header, e.g. to a [personal access token](https://github.com/settings/tokens/). + +```js +const graphqlWithAuth = graphql.defaults({ + headers: { + authorization: `token secret123`, + }, +}); +const { repository } = await graphqlWithAuth(` + { + repository(owner: "octokit", name: "graphql.js") { + issues(last: 3) { + edges { + node { + title + } + } + } + } + } +`); +``` + +For more complex authentication strategies such as GitHub Apps or Basic, we recommend the according authentication library exported by [`@octokit/auth`](https://github.com/octokit/auth.js). + +```js +const { createAppAuth } = require("@octokit/auth-app"); +const auth = createAppAuth({ + id: process.env.APP_ID, + privateKey: process.env.PRIVATE_KEY, + installationId: 123, +}); +const graphqlWithAuth = graphql.defaults({ + request: { + hook: auth.hook, + }, +}); + +const { repository } = await graphqlWithAuth( + `{ + repository(owner: "octokit", name: "graphql.js") { + issues(last: 3) { + edges { + node { + title + } + } + } + } + }` +); +``` + +### Variables + +⚠️ Do not use [template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) in the query strings as they make your code vulnerable to query injection attacks (see [#2](https://github.com/octokit/graphql.js/issues/2)). Use variables instead: + +```js +const { lastIssues } = await graphql( + ` + query lastIssues($owner: String!, $repo: String!, $num: Int = 3) { + repository(owner: $owner, name: $repo) { + issues(last: $num) { + edges { + node { + title + } + } + } + } + } + `, + { + owner: "octokit", + repo: "graphql.js", + headers: { + authorization: `token secret123`, + }, + } +); +``` + +### Pass query together with headers and variables + +```js +const { graphql } = require("@octokit/graphql"); +const { lastIssues } = await graphql({ + query: `query lastIssues($owner: String!, $repo: String!, $num: Int = 3) { + repository(owner:$owner, name:$repo) { + issues(last:$num) { + edges { + node { + title + } + } + } + } + }`, + owner: "octokit", + repo: "graphql.js", + headers: { + authorization: `token secret123`, + }, +}); +``` + +### Use with GitHub Enterprise + +```js +let { graphql } = require("@octokit/graphql"); +graphql = graphql.defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api", + headers: { + authorization: `token secret123`, + }, +}); +const { repository } = await graphql(` + { + repository(owner: "acme-project", name: "acme-repo") { + issues(last: 3) { + edges { + node { + title + } + } + } + } + } +`); +``` + +### Use custom `@octokit/request` instance + +```js +const { request } = require("@octokit/request"); +const { withCustomRequest } = require("@octokit/graphql"); + +let requestCounter = 0; +const myRequest = request.defaults({ + headers: { + authentication: "token secret123", + }, + request: { + hook(request, options) { + requestCounter++; + return request(options); + }, + }, +}); +const myGraphql = withCustomRequest(myRequest); +await request("/"); +await myGraphql(` + { + repository(owner: "acme-project", name: "acme-repo") { + issues(last: 3) { + edges { + node { + title + } + } + } + } + } +`); +// requestCounter is now 2 +``` + +## TypeScript + +`@octokit/graphql` is exposing proper types for its usage with TypeScript projects. + +### Additional Types + +Additionally, `GraphQlQueryResponseData` has been exposed to users: + +```ts +import type { GraphQlQueryResponseData } from "@octokit/graphql"; +``` + +## Errors + +In case of a GraphQL error, `error.message` is set to the first error from the response’s `errors` array. All errors can be accessed at `error.errors`. `error.request` has the request options such as query, variables and headers set for easier debugging. + +```js +let { graphql } = require("@octokit/graphql"); +graphqlt = graphql.defaults({ + headers: { + authorization: `token secret123`, + }, +}); +const query = `{ + viewer { + bioHtml + } +}`; + +try { + const result = await graphql(query); +} catch (error) { + // server responds with + // { + // "data": null, + // "errors": [{ + // "message": "Field 'bioHtml' doesn't exist on type 'User'", + // "locations": [{ + // "line": 3, + // "column": 5 + // }] + // }] + // } + + console.log("Request failed:", error.request); // { query, variables: {}, headers: { authorization: 'token secret123' } } + console.log(error.message); // Field 'bioHtml' doesn't exist on type 'User' +} +``` + +## Partial responses + +A GraphQL query may respond with partial data accompanied by errors. In this case we will throw an error but the partial data will still be accessible through `error.data` + +```js +let { graphql } = require("@octokit/graphql"); +graphql = graphql.defaults({ + headers: { + authorization: `token secret123`, + }, +}); +const query = `{ + repository(name: "probot", owner: "probot") { + name + ref(qualifiedName: "master") { + target { + ... on Commit { + history(first: 25, after: "invalid cursor") { + nodes { + message + } + } + } + } + } + } +}`; + +try { + const result = await graphql(query); +} catch (error) { + // server responds with + // { + // "data": { + // "repository": { + // "name": "probot", + // "ref": null + // } + // }, + // "errors": [ + // { + // "type": "INVALID_CURSOR_ARGUMENTS", + // "path": [ + // "repository", + // "ref", + // "target", + // "history" + // ], + // "locations": [ + // { + // "line": 7, + // "column": 11 + // } + // ], + // "message": "`invalid cursor` does not appear to be a valid cursor." + // } + // ] + // } + + console.log("Request failed:", error.request); // { query, variables: {}, headers: { authorization: 'token secret123' } } + console.log(error.message); // `invalid cursor` does not appear to be a valid cursor. + console.log(error.data); // { repository: { name: 'probot', ref: null } } +} +``` + +## Writing tests + +You can pass a replacement for [the built-in fetch implementation](https://github.com/bitinn/node-fetch) as `request.fetch` option. For example, using [fetch-mock](http://www.wheresrhys.co.uk/fetch-mock/) works great to write tests + +```js +const assert = require("assert"); +const fetchMock = require("fetch-mock/es5/server"); + +const { graphql } = require("@octokit/graphql"); + +graphql("{ viewer { login } }", { + headers: { + authorization: "token secret123", + }, + request: { + fetch: fetchMock + .sandbox() + .post("https://api.github.com/graphql", (url, options) => { + assert.strictEqual(options.headers.authorization, "token secret123"); + assert.strictEqual( + options.body, + '{"query":"{ viewer { login } }"}', + "Sends correct query" + ); + return { data: {} }; + }), + }, +}); +``` + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/graphql/dist-node/index.js b/node_modules/@octokit/graphql/dist-node/index.js new file mode 100644 index 00000000..9e43db29 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-node/index.js @@ -0,0 +1,116 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +var request = require('@octokit/request'); +var universalUserAgent = require('universal-user-agent'); + +const VERSION = "4.6.2"; + +class GraphqlError extends Error { + constructor(request, response) { + const message = response.data.errors[0].message; + super(message); + Object.assign(this, response.data); + Object.assign(this, { + headers: response.headers + }); + this.name = "GraphqlError"; + this.request = request; // Maintains proper stack trace (only available on V8) + + /* istanbul ignore next */ + + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + } + +} + +const NON_VARIABLE_OPTIONS = ["method", "baseUrl", "url", "headers", "request", "query", "mediaType"]; +const FORBIDDEN_VARIABLE_OPTIONS = ["query", "method", "url"]; +const GHES_V3_SUFFIX_REGEX = /\/api\/v3\/?$/; +function graphql(request, query, options) { + if (options) { + if (typeof query === "string" && "query" in options) { + return Promise.reject(new Error(`[@octokit/graphql] "query" cannot be used as variable name`)); + } + + for (const key in options) { + if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key)) continue; + return Promise.reject(new Error(`[@octokit/graphql] "${key}" cannot be used as variable name`)); + } + } + + const parsedOptions = typeof query === "string" ? Object.assign({ + query + }, options) : query; + const requestOptions = Object.keys(parsedOptions).reduce((result, key) => { + if (NON_VARIABLE_OPTIONS.includes(key)) { + result[key] = parsedOptions[key]; + return result; + } + + if (!result.variables) { + result.variables = {}; + } + + result.variables[key] = parsedOptions[key]; + return result; + }, {}); // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix + // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451 + + const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl; + + if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) { + requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, "/api/graphql"); + } + + return request(requestOptions).then(response => { + if (response.data.errors) { + const headers = {}; + + for (const key of Object.keys(response.headers)) { + headers[key] = response.headers[key]; + } + + throw new GraphqlError(requestOptions, { + headers, + data: response.data + }); + } + + return response.data.data; + }); +} + +function withDefaults(request$1, newDefaults) { + const newRequest = request$1.defaults(newDefaults); + + const newApi = (query, options) => { + return graphql(newRequest, query, options); + }; + + return Object.assign(newApi, { + defaults: withDefaults.bind(null, newRequest), + endpoint: request.request.endpoint + }); +} + +const graphql$1 = withDefaults(request.request, { + headers: { + "user-agent": `octokit-graphql.js/${VERSION} ${universalUserAgent.getUserAgent()}` + }, + method: "POST", + url: "/graphql" +}); +function withCustomRequest(customRequest) { + return withDefaults(customRequest, { + method: "POST", + url: "/graphql" + }); +} + +exports.graphql = graphql$1; +exports.withCustomRequest = withCustomRequest; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/dist-node/index.js.map b/node_modules/@octokit/graphql/dist-node/index.js.map new file mode 100644 index 00000000..df398e98 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/error.js","../dist-src/graphql.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"4.6.2\";\n","export class GraphqlError extends Error {\n constructor(request, response) {\n const message = response.data.errors[0].message;\n super(message);\n Object.assign(this, response.data);\n Object.assign(this, { headers: response.headers });\n this.name = \"GraphqlError\";\n this.request = request;\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n }\n}\n","import { GraphqlError } from \"./error\";\nconst NON_VARIABLE_OPTIONS = [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"query\",\n \"mediaType\",\n];\nconst FORBIDDEN_VARIABLE_OPTIONS = [\"query\", \"method\", \"url\"];\nconst GHES_V3_SUFFIX_REGEX = /\\/api\\/v3\\/?$/;\nexport function graphql(request, query, options) {\n if (options) {\n if (typeof query === \"string\" && \"query\" in options) {\n return Promise.reject(new Error(`[@octokit/graphql] \"query\" cannot be used as variable name`));\n }\n for (const key in options) {\n if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key))\n continue;\n return Promise.reject(new Error(`[@octokit/graphql] \"${key}\" cannot be used as variable name`));\n }\n }\n const parsedOptions = typeof query === \"string\" ? Object.assign({ query }, options) : query;\n const requestOptions = Object.keys(parsedOptions).reduce((result, key) => {\n if (NON_VARIABLE_OPTIONS.includes(key)) {\n result[key] = parsedOptions[key];\n return result;\n }\n if (!result.variables) {\n result.variables = {};\n }\n result.variables[key] = parsedOptions[key];\n return result;\n }, {});\n // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix\n // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451\n const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl;\n if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {\n requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, \"/api/graphql\");\n }\n return request(requestOptions).then((response) => {\n if (response.data.errors) {\n const headers = {};\n for (const key of Object.keys(response.headers)) {\n headers[key] = response.headers[key];\n }\n throw new GraphqlError(requestOptions, {\n headers,\n data: response.data,\n });\n }\n return response.data.data;\n });\n}\n","import { request as Request } from \"@octokit/request\";\nimport { graphql } from \"./graphql\";\nexport function withDefaults(request, newDefaults) {\n const newRequest = request.defaults(newDefaults);\n const newApi = (query, options) => {\n return graphql(newRequest, query, options);\n };\n return Object.assign(newApi, {\n defaults: withDefaults.bind(null, newRequest),\n endpoint: Request.endpoint,\n });\n}\n","import { request } from \"@octokit/request\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport { withDefaults } from \"./with-defaults\";\nexport const graphql = withDefaults(request, {\n headers: {\n \"user-agent\": `octokit-graphql.js/${VERSION} ${getUserAgent()}`,\n },\n method: \"POST\",\n url: \"/graphql\",\n});\nexport function withCustomRequest(customRequest) {\n return withDefaults(customRequest, {\n method: \"POST\",\n url: \"/graphql\",\n });\n}\n"],"names":["VERSION","GraphqlError","Error","constructor","request","response","message","data","errors","Object","assign","headers","name","captureStackTrace","NON_VARIABLE_OPTIONS","FORBIDDEN_VARIABLE_OPTIONS","GHES_V3_SUFFIX_REGEX","graphql","query","options","Promise","reject","key","includes","parsedOptions","requestOptions","keys","reduce","result","variables","baseUrl","endpoint","DEFAULTS","test","url","replace","then","withDefaults","newDefaults","newRequest","defaults","newApi","bind","Request","getUserAgent","method","withCustomRequest","customRequest"],"mappings":";;;;;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACAA,MAAMC,YAAN,SAA2BC,KAA3B,CAAiC;AACpCC,EAAAA,WAAW,CAACC,OAAD,EAAUC,QAAV,EAAoB;AAC3B,UAAMC,OAAO,GAAGD,QAAQ,CAACE,IAAT,CAAcC,MAAd,CAAqB,CAArB,EAAwBF,OAAxC;AACA,UAAMA,OAAN;AACAG,IAAAA,MAAM,CAACC,MAAP,CAAc,IAAd,EAAoBL,QAAQ,CAACE,IAA7B;AACAE,IAAAA,MAAM,CAACC,MAAP,CAAc,IAAd,EAAoB;AAAEC,MAAAA,OAAO,EAAEN,QAAQ,CAACM;AAApB,KAApB;AACA,SAAKC,IAAL,GAAY,cAAZ;AACA,SAAKR,OAAL,GAAeA,OAAf,CAN2B;;AAQ3B;;AACA,QAAIF,KAAK,CAACW,iBAAV,EAA6B;AACzBX,MAAAA,KAAK,CAACW,iBAAN,CAAwB,IAAxB,EAA8B,KAAKV,WAAnC;AACH;AACJ;;AAbmC;;ACCxC,MAAMW,oBAAoB,GAAG,CACzB,QADyB,EAEzB,SAFyB,EAGzB,KAHyB,EAIzB,SAJyB,EAKzB,SALyB,EAMzB,OANyB,EAOzB,WAPyB,CAA7B;AASA,MAAMC,0BAA0B,GAAG,CAAC,OAAD,EAAU,QAAV,EAAoB,KAApB,CAAnC;AACA,MAAMC,oBAAoB,GAAG,eAA7B;AACA,AAAO,SAASC,OAAT,CAAiBb,OAAjB,EAA0Bc,KAA1B,EAAiCC,OAAjC,EAA0C;AAC7C,MAAIA,OAAJ,EAAa;AACT,QAAI,OAAOD,KAAP,KAAiB,QAAjB,IAA6B,WAAWC,OAA5C,EAAqD;AACjD,aAAOC,OAAO,CAACC,MAAR,CAAe,IAAInB,KAAJ,CAAW,4DAAX,CAAf,CAAP;AACH;;AACD,SAAK,MAAMoB,GAAX,IAAkBH,OAAlB,EAA2B;AACvB,UAAI,CAACJ,0BAA0B,CAACQ,QAA3B,CAAoCD,GAApC,CAAL,EACI;AACJ,aAAOF,OAAO,CAACC,MAAR,CAAe,IAAInB,KAAJ,CAAW,uBAAsBoB,GAAI,mCAArC,CAAf,CAAP;AACH;AACJ;;AACD,QAAME,aAAa,GAAG,OAAON,KAAP,KAAiB,QAAjB,GAA4BT,MAAM,CAACC,MAAP,CAAc;AAAEQ,IAAAA;AAAF,GAAd,EAAyBC,OAAzB,CAA5B,GAAgED,KAAtF;AACA,QAAMO,cAAc,GAAGhB,MAAM,CAACiB,IAAP,CAAYF,aAAZ,EAA2BG,MAA3B,CAAkC,CAACC,MAAD,EAASN,GAAT,KAAiB;AACtE,QAAIR,oBAAoB,CAACS,QAArB,CAA8BD,GAA9B,CAAJ,EAAwC;AACpCM,MAAAA,MAAM,CAACN,GAAD,CAAN,GAAcE,aAAa,CAACF,GAAD,CAA3B;AACA,aAAOM,MAAP;AACH;;AACD,QAAI,CAACA,MAAM,CAACC,SAAZ,EAAuB;AACnBD,MAAAA,MAAM,CAACC,SAAP,GAAmB,EAAnB;AACH;;AACDD,IAAAA,MAAM,CAACC,SAAP,CAAiBP,GAAjB,IAAwBE,aAAa,CAACF,GAAD,CAArC;AACA,WAAOM,MAAP;AACH,GAVsB,EAUpB,EAVoB,CAAvB,CAZ6C;AAwB7C;;AACA,QAAME,OAAO,GAAGN,aAAa,CAACM,OAAd,IAAyB1B,OAAO,CAAC2B,QAAR,CAAiBC,QAAjB,CAA0BF,OAAnE;;AACA,MAAId,oBAAoB,CAACiB,IAArB,CAA0BH,OAA1B,CAAJ,EAAwC;AACpCL,IAAAA,cAAc,CAACS,GAAf,GAAqBJ,OAAO,CAACK,OAAR,CAAgBnB,oBAAhB,EAAsC,cAAtC,CAArB;AACH;;AACD,SAAOZ,OAAO,CAACqB,cAAD,CAAP,CAAwBW,IAAxB,CAA8B/B,QAAD,IAAc;AAC9C,QAAIA,QAAQ,CAACE,IAAT,CAAcC,MAAlB,EAA0B;AACtB,YAAMG,OAAO,GAAG,EAAhB;;AACA,WAAK,MAAMW,GAAX,IAAkBb,MAAM,CAACiB,IAAP,CAAYrB,QAAQ,CAACM,OAArB,CAAlB,EAAiD;AAC7CA,QAAAA,OAAO,CAACW,GAAD,CAAP,GAAejB,QAAQ,CAACM,OAAT,CAAiBW,GAAjB,CAAf;AACH;;AACD,YAAM,IAAIrB,YAAJ,CAAiBwB,cAAjB,EAAiC;AACnCd,QAAAA,OADmC;AAEnCJ,QAAAA,IAAI,EAAEF,QAAQ,CAACE;AAFoB,OAAjC,CAAN;AAIH;;AACD,WAAOF,QAAQ,CAACE,IAAT,CAAcA,IAArB;AACH,GAZM,CAAP;AAaH;;ACpDM,SAAS8B,YAAT,CAAsBjC,SAAtB,EAA+BkC,WAA/B,EAA4C;AAC/C,QAAMC,UAAU,GAAGnC,SAAO,CAACoC,QAAR,CAAiBF,WAAjB,CAAnB;;AACA,QAAMG,MAAM,GAAG,CAACvB,KAAD,EAAQC,OAAR,KAAoB;AAC/B,WAAOF,OAAO,CAACsB,UAAD,EAAarB,KAAb,EAAoBC,OAApB,CAAd;AACH,GAFD;;AAGA,SAAOV,MAAM,CAACC,MAAP,CAAc+B,MAAd,EAAsB;AACzBD,IAAAA,QAAQ,EAAEH,YAAY,CAACK,IAAb,CAAkB,IAAlB,EAAwBH,UAAxB,CADe;AAEzBR,IAAAA,QAAQ,EAAEY,eAAO,CAACZ;AAFO,GAAtB,CAAP;AAIH;;MCPYd,SAAO,GAAGoB,YAAY,CAACjC,eAAD,EAAU;AACzCO,EAAAA,OAAO,EAAE;AACL,kBAAe,sBAAqBX,OAAQ,IAAG4C,+BAAY,EAAG;AADzD,GADgC;AAIzCC,EAAAA,MAAM,EAAE,MAJiC;AAKzCX,EAAAA,GAAG,EAAE;AALoC,CAAV,CAA5B;AAOP,AAAO,SAASY,iBAAT,CAA2BC,aAA3B,EAA0C;AAC7C,SAAOV,YAAY,CAACU,aAAD,EAAgB;AAC/BF,IAAAA,MAAM,EAAE,MADuB;AAE/BX,IAAAA,GAAG,EAAE;AAF0B,GAAhB,CAAnB;AAIH;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/dist-src/error.js b/node_modules/@octokit/graphql/dist-src/error.js new file mode 100644 index 00000000..37942ba1 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-src/error.js @@ -0,0 +1,15 @@ +export class GraphqlError extends Error { + constructor(request, response) { + const message = response.data.errors[0].message; + super(message); + Object.assign(this, response.data); + Object.assign(this, { headers: response.headers }); + this.name = "GraphqlError"; + this.request = request; + // Maintains proper stack trace (only available on V8) + /* istanbul ignore next */ + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + } +} diff --git a/node_modules/@octokit/graphql/dist-src/graphql.js b/node_modules/@octokit/graphql/dist-src/graphql.js new file mode 100644 index 00000000..4fef9b1c --- /dev/null +++ b/node_modules/@octokit/graphql/dist-src/graphql.js @@ -0,0 +1,55 @@ +import { GraphqlError } from "./error"; +const NON_VARIABLE_OPTIONS = [ + "method", + "baseUrl", + "url", + "headers", + "request", + "query", + "mediaType", +]; +const FORBIDDEN_VARIABLE_OPTIONS = ["query", "method", "url"]; +const GHES_V3_SUFFIX_REGEX = /\/api\/v3\/?$/; +export function graphql(request, query, options) { + if (options) { + if (typeof query === "string" && "query" in options) { + return Promise.reject(new Error(`[@octokit/graphql] "query" cannot be used as variable name`)); + } + for (const key in options) { + if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key)) + continue; + return Promise.reject(new Error(`[@octokit/graphql] "${key}" cannot be used as variable name`)); + } + } + const parsedOptions = typeof query === "string" ? Object.assign({ query }, options) : query; + const requestOptions = Object.keys(parsedOptions).reduce((result, key) => { + if (NON_VARIABLE_OPTIONS.includes(key)) { + result[key] = parsedOptions[key]; + return result; + } + if (!result.variables) { + result.variables = {}; + } + result.variables[key] = parsedOptions[key]; + return result; + }, {}); + // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix + // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451 + const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl; + if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) { + requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, "/api/graphql"); + } + return request(requestOptions).then((response) => { + if (response.data.errors) { + const headers = {}; + for (const key of Object.keys(response.headers)) { + headers[key] = response.headers[key]; + } + throw new GraphqlError(requestOptions, { + headers, + data: response.data, + }); + } + return response.data.data; + }); +} diff --git a/node_modules/@octokit/graphql/dist-src/index.js b/node_modules/@octokit/graphql/dist-src/index.js new file mode 100644 index 00000000..b2023784 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-src/index.js @@ -0,0 +1,17 @@ +import { request } from "@octokit/request"; +import { getUserAgent } from "universal-user-agent"; +import { VERSION } from "./version"; +import { withDefaults } from "./with-defaults"; +export const graphql = withDefaults(request, { + headers: { + "user-agent": `octokit-graphql.js/${VERSION} ${getUserAgent()}`, + }, + method: "POST", + url: "/graphql", +}); +export function withCustomRequest(customRequest) { + return withDefaults(customRequest, { + method: "POST", + url: "/graphql", + }); +} diff --git a/node_modules/@octokit/graphql/dist-src/types.js b/node_modules/@octokit/graphql/dist-src/types.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-src/types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/graphql/dist-src/version.js b/node_modules/@octokit/graphql/dist-src/version.js new file mode 100644 index 00000000..d3ab9be4 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "4.6.2"; diff --git a/node_modules/@octokit/graphql/dist-src/with-defaults.js b/node_modules/@octokit/graphql/dist-src/with-defaults.js new file mode 100644 index 00000000..6ea309e3 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-src/with-defaults.js @@ -0,0 +1,12 @@ +import { request as Request } from "@octokit/request"; +import { graphql } from "./graphql"; +export function withDefaults(request, newDefaults) { + const newRequest = request.defaults(newDefaults); + const newApi = (query, options) => { + return graphql(newRequest, query, options); + }; + return Object.assign(newApi, { + defaults: withDefaults.bind(null, newRequest), + endpoint: Request.endpoint, + }); +} diff --git a/node_modules/@octokit/graphql/dist-types/error.d.ts b/node_modules/@octokit/graphql/dist-types/error.d.ts new file mode 100644 index 00000000..81b31a43 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-types/error.d.ts @@ -0,0 +1,9 @@ +import { ResponseHeaders } from "@octokit/types"; +import { GraphQlEndpointOptions, GraphQlQueryResponse } from "./types"; +export declare class GraphqlError extends Error { + request: GraphQlEndpointOptions; + constructor(request: GraphQlEndpointOptions, response: { + headers: ResponseHeaders; + data: Required>; + }); +} diff --git a/node_modules/@octokit/graphql/dist-types/graphql.d.ts b/node_modules/@octokit/graphql/dist-types/graphql.d.ts new file mode 100644 index 00000000..2942b8b6 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-types/graphql.d.ts @@ -0,0 +1,3 @@ +import { request as Request } from "@octokit/request"; +import { RequestParameters, GraphQlQueryResponseData } from "./types"; +export declare function graphql(request: typeof Request, query: string | RequestParameters, options?: RequestParameters): Promise; diff --git a/node_modules/@octokit/graphql/dist-types/index.d.ts b/node_modules/@octokit/graphql/dist-types/index.d.ts new file mode 100644 index 00000000..a0d263b4 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-types/index.d.ts @@ -0,0 +1,4 @@ +import { request } from "@octokit/request"; +export declare const graphql: import("./types").graphql; +export { GraphQlQueryResponseData } from "./types"; +export declare function withCustomRequest(customRequest: typeof request): import("./types").graphql; diff --git a/node_modules/@octokit/graphql/dist-types/types.d.ts b/node_modules/@octokit/graphql/dist-types/types.d.ts new file mode 100644 index 00000000..a3cf6eb6 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-types/types.d.ts @@ -0,0 +1,54 @@ +import { EndpointOptions, RequestParameters as RequestParametersType, EndpointInterface } from "@octokit/types"; +export declare type GraphQlEndpointOptions = EndpointOptions & { + variables?: { + [key: string]: unknown; + }; +}; +export declare type RequestParameters = RequestParametersType; +export declare type Query = string; +export interface graphql { + /** + * Sends a GraphQL query request based on endpoint options + * The GraphQL query must be specified in `options`. + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: RequestParameters): GraphQlResponse; + /** + * Sends a GraphQL query request based on endpoint options + * + * @param {string} query GraphQL query. Example: `'query { viewer { login } }'`. + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (query: Query, parameters?: RequestParameters): GraphQlResponse; + /** + * Returns a new `endpoint` with updated route and parameters + */ + defaults: (newDefaults: RequestParameters) => graphql; + /** + * Octokit endpoint API, see {@link https://github.com/octokit/endpoint.js|@octokit/endpoint} + */ + endpoint: EndpointInterface; +} +export declare type GraphQlResponse = Promise; +export declare type GraphQlQueryResponseData = { + [key: string]: any; +}; +export declare type GraphQlQueryResponse = { + data: ResponseData; + errors?: [ + { + message: string; + path: [string]; + extensions: { + [key: string]: any; + }; + locations: [ + { + line: number; + column: number; + } + ]; + } + ]; +}; diff --git a/node_modules/@octokit/graphql/dist-types/version.d.ts b/node_modules/@octokit/graphql/dist-types/version.d.ts new file mode 100644 index 00000000..134f5671 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "4.6.2"; diff --git a/node_modules/@octokit/graphql/dist-types/with-defaults.d.ts b/node_modules/@octokit/graphql/dist-types/with-defaults.d.ts new file mode 100644 index 00000000..03edc320 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-types/with-defaults.d.ts @@ -0,0 +1,3 @@ +import { request as Request } from "@octokit/request"; +import { graphql as ApiInterface, RequestParameters } from "./types"; +export declare function withDefaults(request: typeof Request, newDefaults: RequestParameters): ApiInterface; diff --git a/node_modules/@octokit/graphql/dist-web/index.js b/node_modules/@octokit/graphql/dist-web/index.js new file mode 100644 index 00000000..e78d237a --- /dev/null +++ b/node_modules/@octokit/graphql/dist-web/index.js @@ -0,0 +1,103 @@ +import { request } from '@octokit/request'; +import { getUserAgent } from 'universal-user-agent'; + +const VERSION = "4.6.2"; + +class GraphqlError extends Error { + constructor(request, response) { + const message = response.data.errors[0].message; + super(message); + Object.assign(this, response.data); + Object.assign(this, { headers: response.headers }); + this.name = "GraphqlError"; + this.request = request; + // Maintains proper stack trace (only available on V8) + /* istanbul ignore next */ + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + } +} + +const NON_VARIABLE_OPTIONS = [ + "method", + "baseUrl", + "url", + "headers", + "request", + "query", + "mediaType", +]; +const FORBIDDEN_VARIABLE_OPTIONS = ["query", "method", "url"]; +const GHES_V3_SUFFIX_REGEX = /\/api\/v3\/?$/; +function graphql(request, query, options) { + if (options) { + if (typeof query === "string" && "query" in options) { + return Promise.reject(new Error(`[@octokit/graphql] "query" cannot be used as variable name`)); + } + for (const key in options) { + if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key)) + continue; + return Promise.reject(new Error(`[@octokit/graphql] "${key}" cannot be used as variable name`)); + } + } + const parsedOptions = typeof query === "string" ? Object.assign({ query }, options) : query; + const requestOptions = Object.keys(parsedOptions).reduce((result, key) => { + if (NON_VARIABLE_OPTIONS.includes(key)) { + result[key] = parsedOptions[key]; + return result; + } + if (!result.variables) { + result.variables = {}; + } + result.variables[key] = parsedOptions[key]; + return result; + }, {}); + // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix + // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451 + const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl; + if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) { + requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, "/api/graphql"); + } + return request(requestOptions).then((response) => { + if (response.data.errors) { + const headers = {}; + for (const key of Object.keys(response.headers)) { + headers[key] = response.headers[key]; + } + throw new GraphqlError(requestOptions, { + headers, + data: response.data, + }); + } + return response.data.data; + }); +} + +function withDefaults(request$1, newDefaults) { + const newRequest = request$1.defaults(newDefaults); + const newApi = (query, options) => { + return graphql(newRequest, query, options); + }; + return Object.assign(newApi, { + defaults: withDefaults.bind(null, newRequest), + endpoint: request.endpoint, + }); +} + +const graphql$1 = withDefaults(request, { + headers: { + "user-agent": `octokit-graphql.js/${VERSION} ${getUserAgent()}`, + }, + method: "POST", + url: "/graphql", +}); +function withCustomRequest(customRequest) { + return withDefaults(customRequest, { + method: "POST", + url: "/graphql", + }); +} + +export { graphql$1 as graphql, withCustomRequest }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/dist-web/index.js.map b/node_modules/@octokit/graphql/dist-web/index.js.map new file mode 100644 index 00000000..492d4303 --- /dev/null +++ b/node_modules/@octokit/graphql/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/error.js","../dist-src/graphql.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"4.6.2\";\n","export class GraphqlError extends Error {\n constructor(request, response) {\n const message = response.data.errors[0].message;\n super(message);\n Object.assign(this, response.data);\n Object.assign(this, { headers: response.headers });\n this.name = \"GraphqlError\";\n this.request = request;\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n }\n}\n","import { GraphqlError } from \"./error\";\nconst NON_VARIABLE_OPTIONS = [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"query\",\n \"mediaType\",\n];\nconst FORBIDDEN_VARIABLE_OPTIONS = [\"query\", \"method\", \"url\"];\nconst GHES_V3_SUFFIX_REGEX = /\\/api\\/v3\\/?$/;\nexport function graphql(request, query, options) {\n if (options) {\n if (typeof query === \"string\" && \"query\" in options) {\n return Promise.reject(new Error(`[@octokit/graphql] \"query\" cannot be used as variable name`));\n }\n for (const key in options) {\n if (!FORBIDDEN_VARIABLE_OPTIONS.includes(key))\n continue;\n return Promise.reject(new Error(`[@octokit/graphql] \"${key}\" cannot be used as variable name`));\n }\n }\n const parsedOptions = typeof query === \"string\" ? Object.assign({ query }, options) : query;\n const requestOptions = Object.keys(parsedOptions).reduce((result, key) => {\n if (NON_VARIABLE_OPTIONS.includes(key)) {\n result[key] = parsedOptions[key];\n return result;\n }\n if (!result.variables) {\n result.variables = {};\n }\n result.variables[key] = parsedOptions[key];\n return result;\n }, {});\n // workaround for GitHub Enterprise baseUrl set with /api/v3 suffix\n // https://github.com/octokit/auth-app.js/issues/111#issuecomment-657610451\n const baseUrl = parsedOptions.baseUrl || request.endpoint.DEFAULTS.baseUrl;\n if (GHES_V3_SUFFIX_REGEX.test(baseUrl)) {\n requestOptions.url = baseUrl.replace(GHES_V3_SUFFIX_REGEX, \"/api/graphql\");\n }\n return request(requestOptions).then((response) => {\n if (response.data.errors) {\n const headers = {};\n for (const key of Object.keys(response.headers)) {\n headers[key] = response.headers[key];\n }\n throw new GraphqlError(requestOptions, {\n headers,\n data: response.data,\n });\n }\n return response.data.data;\n });\n}\n","import { request as Request } from \"@octokit/request\";\nimport { graphql } from \"./graphql\";\nexport function withDefaults(request, newDefaults) {\n const newRequest = request.defaults(newDefaults);\n const newApi = (query, options) => {\n return graphql(newRequest, query, options);\n };\n return Object.assign(newApi, {\n defaults: withDefaults.bind(null, newRequest),\n endpoint: Request.endpoint,\n });\n}\n","import { request } from \"@octokit/request\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport { withDefaults } from \"./with-defaults\";\nexport const graphql = withDefaults(request, {\n headers: {\n \"user-agent\": `octokit-graphql.js/${VERSION} ${getUserAgent()}`,\n },\n method: \"POST\",\n url: \"/graphql\",\n});\nexport function withCustomRequest(customRequest) {\n return withDefaults(customRequest, {\n method: \"POST\",\n url: \"/graphql\",\n });\n}\n"],"names":["request","Request","graphql"],"mappings":";;;AAAO,MAAM,OAAO,GAAG,mBAAmB;;ACAnC,MAAM,YAAY,SAAS,KAAK,CAAC;AACxC,IAAI,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE;AACnC,QAAQ,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;AACxD,QAAQ,KAAK,CAAC,OAAO,CAAC,CAAC;AACvB,QAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC3C,QAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;AAC3D,QAAQ,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;AACnC,QAAQ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;AAC/B;AACA;AACA,QAAQ,IAAI,KAAK,CAAC,iBAAiB,EAAE;AACrC,YAAY,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;AAC5D,SAAS;AACT,KAAK;AACL,CAAC;;ACbD,MAAM,oBAAoB,GAAG;AAC7B,IAAI,QAAQ;AACZ,IAAI,SAAS;AACb,IAAI,KAAK;AACT,IAAI,SAAS;AACb,IAAI,SAAS;AACb,IAAI,OAAO;AACX,IAAI,WAAW;AACf,CAAC,CAAC;AACF,MAAM,0BAA0B,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAC9D,MAAM,oBAAoB,GAAG,eAAe,CAAC;AAC7C,AAAO,SAAS,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;AACjD,IAAI,IAAI,OAAO,EAAE;AACjB,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,IAAI,OAAO,EAAE;AAC7D,YAAY,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,0DAA0D,CAAC,CAAC,CAAC,CAAC;AAC3G,SAAS;AACT,QAAQ,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;AACnC,YAAY,IAAI,CAAC,0BAA0B,CAAC,QAAQ,CAAC,GAAG,CAAC;AACzD,gBAAgB,SAAS;AACzB,YAAY,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,oBAAoB,EAAE,GAAG,CAAC,iCAAiC,CAAC,CAAC,CAAC,CAAC;AAC5G,SAAS;AACT,KAAK;AACL,IAAI,MAAM,aAAa,GAAG,OAAO,KAAK,KAAK,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC;AAChG,IAAI,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK;AAC9E,QAAQ,IAAI,oBAAoB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AAChD,YAAY,MAAM,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;AAC7C,YAAY,OAAO,MAAM,CAAC;AAC1B,SAAS;AACT,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;AAC/B,YAAY,MAAM,CAAC,SAAS,GAAG,EAAE,CAAC;AAClC,SAAS;AACT,QAAQ,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;AACnD,QAAQ,OAAO,MAAM,CAAC;AACtB,KAAK,EAAE,EAAE,CAAC,CAAC;AACX;AACA;AACA,IAAI,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;AAC/E,IAAI,IAAI,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;AAC5C,QAAQ,cAAc,CAAC,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE,cAAc,CAAC,CAAC;AACnF,KAAK;AACL,IAAI,OAAO,OAAO,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK;AACtD,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE;AAClC,YAAY,MAAM,OAAO,GAAG,EAAE,CAAC;AAC/B,YAAY,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;AAC7D,gBAAgB,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AACrD,aAAa;AACb,YAAY,MAAM,IAAI,YAAY,CAAC,cAAc,EAAE;AACnD,gBAAgB,OAAO;AACvB,gBAAgB,IAAI,EAAE,QAAQ,CAAC,IAAI;AACnC,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;AAClC,KAAK,CAAC,CAAC;AACP,CAAC;;ACpDM,SAAS,YAAY,CAACA,SAAO,EAAE,WAAW,EAAE;AACnD,IAAI,MAAM,UAAU,GAAGA,SAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AACrD,IAAI,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK;AACvC,QAAQ,OAAO,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACnD,KAAK,CAAC;AACN,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;AACjC,QAAQ,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC;AACrD,QAAQ,QAAQ,EAAEC,OAAO,CAAC,QAAQ;AAClC,KAAK,CAAC,CAAC;AACP,CAAC;;ACPW,MAACC,SAAO,GAAG,YAAY,CAAC,OAAO,EAAE;AAC7C,IAAI,OAAO,EAAE;AACb,QAAQ,YAAY,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AACvE,KAAK;AACL,IAAI,MAAM,EAAE,MAAM;AAClB,IAAI,GAAG,EAAE,UAAU;AACnB,CAAC,CAAC,CAAC;AACH,AAAO,SAAS,iBAAiB,CAAC,aAAa,EAAE;AACjD,IAAI,OAAO,YAAY,CAAC,aAAa,EAAE;AACvC,QAAQ,MAAM,EAAE,MAAM;AACtB,QAAQ,GAAG,EAAE,UAAU;AACvB,KAAK,CAAC,CAAC;AACP,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/LICENSE b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/LICENSE new file mode 100644 index 00000000..af5366d0 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2018 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/README.md new file mode 100644 index 00000000..5ac84297 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/README.md @@ -0,0 +1,421 @@ +# endpoint.js + +> Turns GitHub REST API endpoints into generic request options + +[![@latest](https://img.shields.io/npm/v/@octokit/endpoint.svg)](https://www.npmjs.com/package/@octokit/endpoint) +![Build Status](https://github.com/octokit/endpoint.js/workflows/Test/badge.svg) +[![Greenkeeper](https://badges.greenkeeper.io/octokit/endpoint.js.svg)](https://greenkeeper.io/) + +`@octokit/endpoint` combines [GitHub REST API routes](https://developer.github.com/v3/) with your parameters and turns them into generic request options that can be used in any request library. + + + + +- [Usage](#usage) +- [API](#api) + - [endpoint()](#endpointroute-options-or-endpointoptions) + - [endpoint.defaults()](#endpointdefaults) + - [endpoint.DEFAULTS](#endpointdefaults-1) + - [endpoint.merge()](#endpointmergeroute-options-or-endpointmergeoptions) + - [endpoint.parse()](#endpointparse) +- [Special cases](#special-cases) + - [The `data` parameter – set request body directly](#the-data-parameter--set-request-body-directly) + - [Set parameters for both the URL/query and the request body](#set-parameters-for-both-the-urlquery-and-the-request-body) +- [LICENSE](#license) + + + +## Usage + + + + + + +
+Browsers + +Load @octokit/endpoint directly from cdn.pika.dev + +```html + +``` + +
+Node + + +Install with npm install @octokit/endpoint + +```js +const { endpoint } = require("@octokit/endpoint"); +// or: import { endpoint } from "@octokit/endpoint"; +``` + +
+ +Example for [List organization repositories](https://developer.github.com/v3/repos/#list-organization-repositories) + +```js +const requestOptions = endpoint("GET /orgs/:org/repos", { + headers: { + authorization: "token 0000000000000000000000000000000000000001" + }, + org: "octokit", + type: "private" +}); +``` + +The resulting `requestOptions` looks as follows + +```json +{ + "method": "GET", + "url": "https://api.github.com/orgs/octokit/repos?type=private", + "headers": { + "accept": "application/vnd.github.v3+json", + "authorization": "token 0000000000000000000000000000000000000001", + "user-agent": "octokit/endpoint.js v1.2.3" + } +} +``` + +You can pass `requestOptions` to common request libraries + +```js +const { url, ...options } = requestOptions; +// using with fetch (https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) +fetch(url, options); +// using with request (https://github.com/request/request) +request(requestOptions); +// using with got (https://github.com/sindresorhus/got) +got[options.method](url, options); +// using with axios +axios(requestOptions); +``` + +## API + +### `endpoint(route, options)` or `endpoint(options)` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ name + + type + + description +
+ route + + String + + If set, it has to be a string consisting of URL and the request method, e.g., GET /orgs/:org. If it’s set to a URL, only the method defaults to GET. +
+ options.method + + String + + Required unless route is set. Any supported http verb. Defaults to GET. +
+ options.url + + String + + Required unless route is set. A path or full URL which may contain :variable or {variable} placeholders, + e.g., /orgs/:org/repos. The url is parsed using url-template. +
+ options.baseUrl + + String + + Defaults to https://api.github.com. +
+ options.headers + + Object + + Custom headers. Passed headers are merged with defaults:
+ headers['user-agent'] defaults to octokit-endpoint.js/1.2.3 (where 1.2.3 is the released version).
+ headers['accept'] defaults to application/vnd.github.v3+json.
+
+ options.mediaType.format + + String + + Media type param, such as raw, diff, or text+json. See Media Types. Setting options.mediaType.format will amend the headers.accept value. +
+ options.mediaType.previews + + Array of Strings + + Name of previews, such as mercy, symmetra, or scarlet-witch. See API Previews. If options.mediaType.previews was set as default, the new previews will be merged into the default ones. Setting options.mediaType.previews will amend the headers.accept value. options.mediaType.previews will be merged with an existing array set using .defaults(). +
+ options.data + + Any + + Set request body directly instead of setting it to JSON based on additional parameters. See "The data parameter" below. +
+ options.request + + Object + + Pass custom meta information for the request. The request object will be returned as is. +
+ +All other options will be passed depending on the `method` and `url` options. + +1. If the option key has a placeholder in the `url`, it will be used as the replacement. For example, if the passed options are `{url: '/orgs/:org/repos', org: 'foo'}` the returned `options.url` is `https://api.github.com/orgs/foo/repos`. +2. If the `method` is `GET` or `HEAD`, the option is passed as a query parameter. +3. Otherwise, the parameter is passed in the request body as a JSON key. + +**Result** + +`endpoint()` is a synchronous method and returns an object with the following keys: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ key + + type + + description +
methodStringThe http method. Always lowercase.
urlStringThe url with placeholders replaced with passed parameters.
headersObjectAll header names are lowercased.
bodyAnyThe request body if one is present. Only for PATCH, POST, PUT, DELETE requests.
requestObjectRequest meta option, it will be returned as it was passed into endpoint()
+ +### `endpoint.defaults()` + +Override or set default options. Example: + +```js +const request = require("request"); +const myEndpoint = require("@octokit/endpoint").defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", + headers: { + "user-agent": "myApp/1.2.3", + authorization: `token 0000000000000000000000000000000000000001` + }, + org: "my-project", + per_page: 100 +}); + +request(myEndpoint(`GET /orgs/:org/repos`)); +``` + +You can call `.defaults()` again on the returned method, the defaults will cascade. + +```js +const myProjectEndpoint = endpoint.defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", + headers: { + "user-agent": "myApp/1.2.3" + }, + org: "my-project" +}); +const myProjectEndpointWithAuth = myProjectEndpoint.defaults({ + headers: { + authorization: `token 0000000000000000000000000000000000000001` + } +}); +``` + +`myProjectEndpointWithAuth` now defaults the `baseUrl`, `headers['user-agent']`, +`org` and `headers['authorization']` on top of `headers['accept']` that is set +by the global default. + +### `endpoint.DEFAULTS` + +The current default options. + +```js +endpoint.DEFAULTS.baseUrl; // https://api.github.com +const myEndpoint = endpoint.defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api/v3" +}); +myEndpoint.DEFAULTS.baseUrl; // https://github-enterprise.acme-inc.com/api/v3 +``` + +### `endpoint.merge(route, options)` or `endpoint.merge(options)` + +Get the defaulted endpoint options, but without parsing them into request options: + +```js +const myProjectEndpoint = endpoint.defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", + headers: { + "user-agent": "myApp/1.2.3" + }, + org: "my-project" +}); +myProjectEndpoint.merge("GET /orgs/:org/repos", { + headers: { + authorization: `token 0000000000000000000000000000000000000001` + }, + org: "my-secret-project", + type: "private" +}); + +// { +// baseUrl: 'https://github-enterprise.acme-inc.com/api/v3', +// method: 'GET', +// url: '/orgs/:org/repos', +// headers: { +// accept: 'application/vnd.github.v3+json', +// authorization: `token 0000000000000000000000000000000000000001`, +// 'user-agent': 'myApp/1.2.3' +// }, +// org: 'my-secret-project', +// type: 'private' +// } +``` + +### `endpoint.parse()` + +Stateless method to turn endpoint options into request options. Calling +`endpoint(options)` is the same as calling `endpoint.parse(endpoint.merge(options))`. + +## Special cases + + + +### The `data` parameter – set request body directly + +Some endpoints such as [Render a Markdown document in raw mode](https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode) don’t have parameters that are sent as request body keys, instead, the request body needs to be set directly. In these cases, set the `data` parameter. + +```js +const options = endpoint("POST /markdown/raw", { + data: "Hello world github/linguist#1 **cool**, and #1!", + headers: { + accept: "text/html;charset=utf-8", + "content-type": "text/plain" + } +}); + +// options is +// { +// method: 'post', +// url: 'https://api.github.com/markdown/raw', +// headers: { +// accept: 'text/html;charset=utf-8', +// 'content-type': 'text/plain', +// 'user-agent': userAgent +// }, +// body: 'Hello world github/linguist#1 **cool**, and #1!' +// } +``` + +### Set parameters for both the URL/query and the request body + +There are API endpoints that accept both query parameters as well as a body. In that case, you need to add the query parameters as templates to `options.url`, as defined in the [RFC 6570 URI Template specification](https://tools.ietf.org/html/rfc6570). + +Example + +```js +endpoint( + "POST https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", + { + name: "example.zip", + label: "short description", + headers: { + "content-type": "text/plain", + "content-length": 14, + authorization: `token 0000000000000000000000000000000000000001` + }, + data: "Hello, world!" + } +); +``` + +## LICENSE + +[MIT](LICENSE) diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-node/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-node/index.js new file mode 100644 index 00000000..9218ced3 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-node/index.js @@ -0,0 +1,379 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } + +var isPlainObject = _interopDefault(require('is-plain-object')); +var universalUserAgent = require('universal-user-agent'); + +function lowercaseKeys(object) { + if (!object) { + return {}; + } + + return Object.keys(object).reduce((newObj, key) => { + newObj[key.toLowerCase()] = object[key]; + return newObj; + }, {}); +} + +function mergeDeep(defaults, options) { + const result = Object.assign({}, defaults); + Object.keys(options).forEach(key => { + if (isPlainObject(options[key])) { + if (!(key in defaults)) Object.assign(result, { + [key]: options[key] + });else result[key] = mergeDeep(defaults[key], options[key]); + } else { + Object.assign(result, { + [key]: options[key] + }); + } + }); + return result; +} + +function merge(defaults, route, options) { + if (typeof route === "string") { + let [method, url] = route.split(" "); + options = Object.assign(url ? { + method, + url + } : { + url: method + }, options); + } else { + options = Object.assign({}, route); + } // lowercase header names before merging with defaults to avoid duplicates + + + options.headers = lowercaseKeys(options.headers); + const mergedOptions = mergeDeep(defaults || {}, options); // mediaType.previews arrays are merged, instead of overwritten + + if (defaults && defaults.mediaType.previews.length) { + mergedOptions.mediaType.previews = defaults.mediaType.previews.filter(preview => !mergedOptions.mediaType.previews.includes(preview)).concat(mergedOptions.mediaType.previews); + } + + mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map(preview => preview.replace(/-preview/, "")); + return mergedOptions; +} + +function addQueryParameters(url, parameters) { + const separator = /\?/.test(url) ? "&" : "?"; + const names = Object.keys(parameters); + + if (names.length === 0) { + return url; + } + + return url + separator + names.map(name => { + if (name === "q") { + return "q=" + parameters.q.split("+").map(encodeURIComponent).join("+"); + } + + return `${name}=${encodeURIComponent(parameters[name])}`; + }).join("&"); +} + +const urlVariableRegex = /\{[^}]+\}/g; + +function removeNonChars(variableName) { + return variableName.replace(/^\W+|\W+$/g, "").split(/,/); +} + +function extractUrlVariableNames(url) { + const matches = url.match(urlVariableRegex); + + if (!matches) { + return []; + } + + return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []); +} + +function omit(object, keysToOmit) { + return Object.keys(object).filter(option => !keysToOmit.includes(option)).reduce((obj, key) => { + obj[key] = object[key]; + return obj; + }, {}); +} + +// Based on https://github.com/bramstein/url-template, licensed under BSD +// TODO: create separate package. +// +// Copyright (c) 2012-2014, Bram Stein +// All rights reserved. +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions +// are met: +// 1. Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// 2. Redistributions in binary form must reproduce the above copyright +// notice, this list of conditions and the following disclaimer in the +// documentation and/or other materials provided with the distribution. +// 3. The name of the author may not be used to endorse or promote products +// derived from this software without specific prior written permission. +// THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED +// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO +// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY +// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +/* istanbul ignore file */ +function encodeReserved(str) { + return str.split(/(%[0-9A-Fa-f]{2})/g).map(function (part) { + if (!/%[0-9A-Fa-f]/.test(part)) { + part = encodeURI(part).replace(/%5B/g, "[").replace(/%5D/g, "]"); + } + + return part; + }).join(""); +} + +function encodeUnreserved(str) { + return encodeURIComponent(str).replace(/[!'()*]/g, function (c) { + return "%" + c.charCodeAt(0).toString(16).toUpperCase(); + }); +} + +function encodeValue(operator, value, key) { + value = operator === "+" || operator === "#" ? encodeReserved(value) : encodeUnreserved(value); + + if (key) { + return encodeUnreserved(key) + "=" + value; + } else { + return value; + } +} + +function isDefined(value) { + return value !== undefined && value !== null; +} + +function isKeyOperator(operator) { + return operator === ";" || operator === "&" || operator === "?"; +} + +function getValues(context, operator, key, modifier) { + var value = context[key], + result = []; + + if (isDefined(value) && value !== "") { + if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") { + value = value.toString(); + + if (modifier && modifier !== "*") { + value = value.substring(0, parseInt(modifier, 10)); + } + + result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : "")); + } else { + if (modifier === "*") { + if (Array.isArray(value)) { + value.filter(isDefined).forEach(function (value) { + result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : "")); + }); + } else { + Object.keys(value).forEach(function (k) { + if (isDefined(value[k])) { + result.push(encodeValue(operator, value[k], k)); + } + }); + } + } else { + const tmp = []; + + if (Array.isArray(value)) { + value.filter(isDefined).forEach(function (value) { + tmp.push(encodeValue(operator, value)); + }); + } else { + Object.keys(value).forEach(function (k) { + if (isDefined(value[k])) { + tmp.push(encodeUnreserved(k)); + tmp.push(encodeValue(operator, value[k].toString())); + } + }); + } + + if (isKeyOperator(operator)) { + result.push(encodeUnreserved(key) + "=" + tmp.join(",")); + } else if (tmp.length !== 0) { + result.push(tmp.join(",")); + } + } + } + } else { + if (operator === ";") { + if (isDefined(value)) { + result.push(encodeUnreserved(key)); + } + } else if (value === "" && (operator === "&" || operator === "?")) { + result.push(encodeUnreserved(key) + "="); + } else if (value === "") { + result.push(""); + } + } + + return result; +} + +function parseUrl(template) { + return { + expand: expand.bind(null, template) + }; +} + +function expand(template, context) { + var operators = ["+", "#", ".", "/", ";", "?", "&"]; + return template.replace(/\{([^\{\}]+)\}|([^\{\}]+)/g, function (_, expression, literal) { + if (expression) { + let operator = ""; + const values = []; + + if (operators.indexOf(expression.charAt(0)) !== -1) { + operator = expression.charAt(0); + expression = expression.substr(1); + } + + expression.split(/,/g).forEach(function (variable) { + var tmp = /([^:\*]*)(?::(\d+)|(\*))?/.exec(variable); + values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3])); + }); + + if (operator && operator !== "+") { + var separator = ","; + + if (operator === "?") { + separator = "&"; + } else if (operator !== "#") { + separator = operator; + } + + return (values.length !== 0 ? operator : "") + values.join(separator); + } else { + return values.join(","); + } + } else { + return encodeReserved(literal); + } + }); +} + +function parse(options) { + // https://fetch.spec.whatwg.org/#methods + let method = options.method.toUpperCase(); // replace :varname with {varname} to make it RFC 6570 compatible + + let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{+$1}"); + let headers = Object.assign({}, options.headers); + let body; + let parameters = omit(options, ["method", "baseUrl", "url", "headers", "request", "mediaType"]); // extract variable names from URL to calculate remaining variables later + + const urlVariableNames = extractUrlVariableNames(url); + url = parseUrl(url).expand(parameters); + + if (!/^http/.test(url)) { + url = options.baseUrl + url; + } + + const omittedParameters = Object.keys(options).filter(option => urlVariableNames.includes(option)).concat("baseUrl"); + const remainingParameters = omit(parameters, omittedParameters); + const isBinaryRequset = /application\/octet-stream/i.test(headers.accept); + + if (!isBinaryRequset) { + if (options.mediaType.format) { + // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw + headers.accept = headers.accept.split(/,/).map(preview => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)).join(","); + } + + if (options.mediaType.previews.length) { + const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || []; + headers.accept = previewsFromAcceptHeader.concat(options.mediaType.previews).map(preview => { + const format = options.mediaType.format ? `.${options.mediaType.format}` : "+json"; + return `application/vnd.github.${preview}-preview${format}`; + }).join(","); + } + } // for GET/HEAD requests, set URL query parameters from remaining parameters + // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters + + + if (["GET", "HEAD"].includes(method)) { + url = addQueryParameters(url, remainingParameters); + } else { + if ("data" in remainingParameters) { + body = remainingParameters.data; + } else { + if (Object.keys(remainingParameters).length) { + body = remainingParameters; + } else { + headers["content-length"] = 0; + } + } + } // default content-type for JSON if body is set + + + if (!headers["content-type"] && typeof body !== "undefined") { + headers["content-type"] = "application/json; charset=utf-8"; + } // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body. + // fetch does not allow to set `content-length` header, but we can set body to an empty string + + + if (["PATCH", "PUT"].includes(method) && typeof body === "undefined") { + body = ""; + } // Only return body/request keys if present + + + return Object.assign({ + method, + url, + headers + }, typeof body !== "undefined" ? { + body + } : null, options.request ? { + request: options.request + } : null); +} + +function endpointWithDefaults(defaults, route, options) { + return parse(merge(defaults, route, options)); +} + +function withDefaults(oldDefaults, newDefaults) { + const DEFAULTS = merge(oldDefaults, newDefaults); + const endpoint = endpointWithDefaults.bind(null, DEFAULTS); + return Object.assign(endpoint, { + DEFAULTS, + defaults: withDefaults.bind(null, DEFAULTS), + merge: merge.bind(null, DEFAULTS), + parse + }); +} + +const VERSION = "5.5.1"; + +const userAgent = `octokit-endpoint.js/${VERSION} ${universalUserAgent.getUserAgent()}`; // DEFAULTS has all properties set that EndpointOptions has, except url. +// So we use RequestParameters and add method as additional required property. + +const DEFAULTS = { + method: "GET", + baseUrl: "https://api.github.com", + headers: { + accept: "application/vnd.github.v3+json", + "user-agent": userAgent + }, + mediaType: { + format: "", + previews: [] + } +}; + +const endpoint = withDefaults(null, DEFAULTS); + +exports.endpoint = endpoint; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-node/index.js.map b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-node/index.js.map new file mode 100644 index 00000000..d84c1b7c --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import isPlainObject from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach(key => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter(preview => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map(name => {\n if (name === \"q\") {\n return (\"q=\" +\n parameters\n .q.split(\"+\")\n .map(encodeURIComponent)\n .join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter(option => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part)\n .replace(/%5B/g, \"[\")\n .replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return (\"%\" +\n c\n .charCodeAt(0)\n .toString(16)\n .toUpperCase());\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template)\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{+$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\"\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter(option => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequset = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequset) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map(preview => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map(preview => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n else {\n headers[\"content-length\"] = 0;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse\n });\n}\n","export const VERSION = \"5.5.1\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent\n },\n mediaType: {\n format: \"\",\n previews: []\n }\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":["lowercaseKeys","object","Object","keys","reduce","newObj","key","toLowerCase","mergeDeep","defaults","options","result","assign","forEach","isPlainObject","merge","route","method","url","split","headers","mergedOptions","mediaType","previews","length","filter","preview","includes","concat","map","replace","addQueryParameters","parameters","separator","test","names","name","q","encodeURIComponent","join","urlVariableRegex","removeNonChars","variableName","extractUrlVariableNames","matches","match","a","b","omit","keysToOmit","option","obj","encodeReserved","str","part","encodeURI","encodeUnreserved","c","charCodeAt","toString","toUpperCase","encodeValue","operator","value","isDefined","undefined","isKeyOperator","getValues","context","modifier","substring","parseInt","push","Array","isArray","k","tmp","parseUrl","template","expand","bind","operators","_","expression","literal","values","indexOf","charAt","substr","variable","exec","parse","body","urlVariableNames","baseUrl","omittedParameters","remainingParameters","isBinaryRequset","accept","format","previewsFromAcceptHeader","data","request","endpointWithDefaults","withDefaults","oldDefaults","newDefaults","DEFAULTS","endpoint","VERSION","userAgent","getUserAgent"],"mappings":";;;;;;;;;AAAO,SAASA,aAAT,CAAuBC,MAAvB,EAA+B;MAC9B,CAACA,MAAL,EAAa;WACF,EAAP;;;SAEGC,MAAM,CAACC,IAAP,CAAYF,MAAZ,EAAoBG,MAApB,CAA2B,CAACC,MAAD,EAASC,GAAT,KAAiB;IAC/CD,MAAM,CAACC,GAAG,CAACC,WAAJ,EAAD,CAAN,GAA4BN,MAAM,CAACK,GAAD,CAAlC;WACOD,MAAP;GAFG,EAGJ,EAHI,CAAP;;;ACHG,SAASG,SAAT,CAAmBC,QAAnB,EAA6BC,OAA7B,EAAsC;QACnCC,MAAM,GAAGT,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBH,QAAlB,CAAf;EACAP,MAAM,CAACC,IAAP,CAAYO,OAAZ,EAAqBG,OAArB,CAA6BP,GAAG,IAAI;QAC5BQ,aAAa,CAACJ,OAAO,CAACJ,GAAD,CAAR,CAAjB,EAAiC;UACzB,EAAEA,GAAG,IAAIG,QAAT,CAAJ,EACIP,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;SAAGL,GAAD,GAAOI,OAAO,CAACJ,GAAD;OAAtC,EADJ,KAGIK,MAAM,CAACL,GAAD,CAAN,GAAcE,SAAS,CAACC,QAAQ,CAACH,GAAD,CAAT,EAAgBI,OAAO,CAACJ,GAAD,CAAvB,CAAvB;KAJR,MAMK;MACDJ,MAAM,CAACU,MAAP,CAAcD,MAAd,EAAsB;SAAGL,GAAD,GAAOI,OAAO,CAACJ,GAAD;OAAtC;;GARR;SAWOK,MAAP;;;ACZG,SAASI,KAAT,CAAeN,QAAf,EAAyBO,KAAzB,EAAgCN,OAAhC,EAAyC;MACxC,OAAOM,KAAP,KAAiB,QAArB,EAA+B;QACvB,CAACC,MAAD,EAASC,GAAT,IAAgBF,KAAK,CAACG,KAAN,CAAY,GAAZ,CAApB;IACAT,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAcM,GAAG,GAAG;MAAED,MAAF;MAAUC;KAAb,GAAqB;MAAEA,GAAG,EAAED;KAA7C,EAAuDP,OAAvD,CAAV;GAFJ,MAIK;IACDA,OAAO,GAAGR,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBI,KAAlB,CAAV;GANwC;;;EAS5CN,OAAO,CAACU,OAAR,GAAkBpB,aAAa,CAACU,OAAO,CAACU,OAAT,CAA/B;QACMC,aAAa,GAAGb,SAAS,CAACC,QAAQ,IAAI,EAAb,EAAiBC,OAAjB,CAA/B,CAV4C;;MAYxCD,QAAQ,IAAIA,QAAQ,CAACa,SAAT,CAAmBC,QAAnB,CAA4BC,MAA5C,EAAoD;IAChDH,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCd,QAAQ,CAACa,SAAT,CAAmBC,QAAnB,CAC9BE,MAD8B,CACvBC,OAAO,IAAI,CAACL,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCI,QAAjC,CAA0CD,OAA1C,CADW,EAE9BE,MAF8B,CAEvBP,aAAa,CAACC,SAAd,CAAwBC,QAFD,CAAnC;;;EAIJF,aAAa,CAACC,SAAd,CAAwBC,QAAxB,GAAmCF,aAAa,CAACC,SAAd,CAAwBC,QAAxB,CAAiCM,GAAjC,CAAsCH,OAAD,IAAaA,OAAO,CAACI,OAAR,CAAgB,UAAhB,EAA4B,EAA5B,CAAlD,CAAnC;SACOT,aAAP;;;ACpBG,SAASU,kBAAT,CAA4Bb,GAA5B,EAAiCc,UAAjC,EAA6C;QAC1CC,SAAS,GAAG,KAAKC,IAAL,CAAUhB,GAAV,IAAiB,GAAjB,GAAuB,GAAzC;QACMiB,KAAK,GAAGjC,MAAM,CAACC,IAAP,CAAY6B,UAAZ,CAAd;;MACIG,KAAK,CAACX,MAAN,KAAiB,CAArB,EAAwB;WACbN,GAAP;;;SAEIA,GAAG,GACPe,SADI,GAEJE,KAAK,CACAN,GADL,CACSO,IAAI,IAAI;QACTA,IAAI,KAAK,GAAb,EAAkB;aACN,OACJJ,UAAU,CACLK,CADL,CACOlB,KADP,CACa,GADb,EAEKU,GAFL,CAESS,kBAFT,EAGKC,IAHL,CAGU,GAHV,CADJ;;;WAMI,GAAEH,IAAK,IAAGE,kBAAkB,CAACN,UAAU,CAACI,IAAD,CAAX,CAAmB,EAAvD;GATJ,EAWKG,IAXL,CAWU,GAXV,CAFJ;;;ACNJ,MAAMC,gBAAgB,GAAG,YAAzB;;AACA,SAASC,cAAT,CAAwBC,YAAxB,EAAsC;SAC3BA,YAAY,CAACZ,OAAb,CAAqB,YAArB,EAAmC,EAAnC,EAAuCX,KAAvC,CAA6C,GAA7C,CAAP;;;AAEJ,AAAO,SAASwB,uBAAT,CAAiCzB,GAAjC,EAAsC;QACnC0B,OAAO,GAAG1B,GAAG,CAAC2B,KAAJ,CAAUL,gBAAV,CAAhB;;MACI,CAACI,OAAL,EAAc;WACH,EAAP;;;SAEGA,OAAO,CAACf,GAAR,CAAYY,cAAZ,EAA4BrC,MAA5B,CAAmC,CAAC0C,CAAD,EAAIC,CAAJ,KAAUD,CAAC,CAAClB,MAAF,CAASmB,CAAT,CAA7C,EAA0D,EAA1D,CAAP;;;ACTG,SAASC,IAAT,CAAc/C,MAAd,EAAsBgD,UAAtB,EAAkC;SAC9B/C,MAAM,CAACC,IAAP,CAAYF,MAAZ,EACFwB,MADE,CACKyB,MAAM,IAAI,CAACD,UAAU,CAACtB,QAAX,CAAoBuB,MAApB,CADhB,EAEF9C,MAFE,CAEK,CAAC+C,GAAD,EAAM7C,GAAN,KAAc;IACtB6C,GAAG,CAAC7C,GAAD,CAAH,GAAWL,MAAM,CAACK,GAAD,CAAjB;WACO6C,GAAP;GAJG,EAKJ,EALI,CAAP;;;ACDJ;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,SAASC,cAAT,CAAwBC,GAAxB,EAA6B;SAClBA,GAAG,CACLlC,KADE,CACI,oBADJ,EAEFU,GAFE,CAEE,UAAUyB,IAAV,EAAgB;QACjB,CAAC,eAAepB,IAAf,CAAoBoB,IAApB,CAAL,EAAgC;MAC5BA,IAAI,GAAGC,SAAS,CAACD,IAAD,CAAT,CACFxB,OADE,CACM,MADN,EACc,GADd,EAEFA,OAFE,CAEM,MAFN,EAEc,GAFd,CAAP;;;WAIGwB,IAAP;GARG,EAUFf,IAVE,CAUG,EAVH,CAAP;;;AAYJ,SAASiB,gBAAT,CAA0BH,GAA1B,EAA+B;SACpBf,kBAAkB,CAACe,GAAD,CAAlB,CAAwBvB,OAAxB,CAAgC,UAAhC,EAA4C,UAAU2B,CAAV,EAAa;WACpD,MACJA,CAAC,CACIC,UADL,CACgB,CADhB,EAEKC,QAFL,CAEc,EAFd,EAGKC,WAHL,EADJ;GADG,CAAP;;;AAQJ,SAASC,WAAT,CAAqBC,QAArB,EAA+BC,KAA/B,EAAsCzD,GAAtC,EAA2C;EACvCyD,KAAK,GACDD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,GACMV,cAAc,CAACW,KAAD,CADpB,GAEMP,gBAAgB,CAACO,KAAD,CAH1B;;MAIIzD,GAAJ,EAAS;WACEkD,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAAxB,GAA8ByD,KAArC;GADJ,MAGK;WACMA,KAAP;;;;AAGR,SAASC,SAAT,CAAmBD,KAAnB,EAA0B;SACfA,KAAK,KAAKE,SAAV,IAAuBF,KAAK,KAAK,IAAxC;;;AAEJ,SAASG,aAAT,CAAuBJ,QAAvB,EAAiC;SACtBA,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAjC,IAAwCA,QAAQ,KAAK,GAA5D;;;AAEJ,SAASK,SAAT,CAAmBC,OAAnB,EAA4BN,QAA5B,EAAsCxD,GAAtC,EAA2C+D,QAA3C,EAAqD;MAC7CN,KAAK,GAAGK,OAAO,CAAC9D,GAAD,CAAnB;MAA0BK,MAAM,GAAG,EAAnC;;MACIqD,SAAS,CAACD,KAAD,CAAT,IAAoBA,KAAK,KAAK,EAAlC,EAAsC;QAC9B,OAAOA,KAAP,KAAiB,QAAjB,IACA,OAAOA,KAAP,KAAiB,QADjB,IAEA,OAAOA,KAAP,KAAiB,SAFrB,EAEgC;MAC5BA,KAAK,GAAGA,KAAK,CAACJ,QAAN,EAAR;;UACIU,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;QAC9BN,KAAK,GAAGA,KAAK,CAACO,SAAN,CAAgB,CAAhB,EAAmBC,QAAQ,CAACF,QAAD,EAAW,EAAX,CAA3B,CAAR;;;MAEJ1D,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBG,aAAa,CAACJ,QAAD,CAAb,GAA0BxD,GAA1B,GAAgC,EAAlD,CAAvB;KAPJ,MASK;UACG+D,QAAQ,KAAK,GAAjB,EAAsB;YACdI,KAAK,CAACC,OAAN,CAAcX,KAAd,CAAJ,EAA0B;UACtBA,KAAK,CAACtC,MAAN,CAAauC,SAAb,EAAwBnD,OAAxB,CAAgC,UAAUkD,KAAV,EAAiB;YAC7CpD,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAX,EAAkBG,aAAa,CAACJ,QAAD,CAAb,GAA0BxD,GAA1B,GAAgC,EAAlD,CAAvB;WADJ;SADJ,MAKK;UACDJ,MAAM,CAACC,IAAP,CAAY4D,KAAZ,EAAmBlD,OAAnB,CAA2B,UAAU8D,CAAV,EAAa;gBAChCX,SAAS,CAACD,KAAK,CAACY,CAAD,CAAN,CAAb,EAAyB;cACrBhE,MAAM,CAAC6D,IAAP,CAAYX,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACY,CAAD,CAAhB,EAAqBA,CAArB,CAAvB;;WAFR;;OAPR,MAcK;cACKC,GAAG,GAAG,EAAZ;;YACIH,KAAK,CAACC,OAAN,CAAcX,KAAd,CAAJ,EAA0B;UACtBA,KAAK,CAACtC,MAAN,CAAauC,SAAb,EAAwBnD,OAAxB,CAAgC,UAAUkD,KAAV,EAAiB;YAC7Ca,GAAG,CAACJ,IAAJ,CAASX,WAAW,CAACC,QAAD,EAAWC,KAAX,CAApB;WADJ;SADJ,MAKK;UACD7D,MAAM,CAACC,IAAP,CAAY4D,KAAZ,EAAmBlD,OAAnB,CAA2B,UAAU8D,CAAV,EAAa;gBAChCX,SAAS,CAACD,KAAK,CAACY,CAAD,CAAN,CAAb,EAAyB;cACrBC,GAAG,CAACJ,IAAJ,CAAShB,gBAAgB,CAACmB,CAAD,CAAzB;cACAC,GAAG,CAACJ,IAAJ,CAASX,WAAW,CAACC,QAAD,EAAWC,KAAK,CAACY,CAAD,CAAL,CAAShB,QAAT,EAAX,CAApB;;WAHR;;;YAOAO,aAAa,CAACJ,QAAD,CAAjB,EAA6B;UACzBnD,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAAxB,GAA8BsE,GAAG,CAACrC,IAAJ,CAAS,GAAT,CAA1C;SADJ,MAGK,IAAIqC,GAAG,CAACpD,MAAJ,KAAe,CAAnB,EAAsB;UACvBb,MAAM,CAAC6D,IAAP,CAAYI,GAAG,CAACrC,IAAJ,CAAS,GAAT,CAAZ;;;;GA5ChB,MAiDK;QACGuB,QAAQ,KAAK,GAAjB,EAAsB;UACdE,SAAS,CAACD,KAAD,CAAb,EAAsB;QAClBpD,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAA5B;;KAFR,MAKK,IAAIyD,KAAK,KAAK,EAAV,KAAiBD,QAAQ,KAAK,GAAb,IAAoBA,QAAQ,KAAK,GAAlD,CAAJ,EAA4D;MAC7DnD,MAAM,CAAC6D,IAAP,CAAYhB,gBAAgB,CAAClD,GAAD,CAAhB,GAAwB,GAApC;KADC,MAGA,IAAIyD,KAAK,KAAK,EAAd,EAAkB;MACnBpD,MAAM,CAAC6D,IAAP,CAAY,EAAZ;;;;SAGD7D,MAAP;;;AAEJ,AAAO,SAASkE,QAAT,CAAkBC,QAAlB,EAA4B;SACxB;IACHC,MAAM,EAAEA,MAAM,CAACC,IAAP,CAAY,IAAZ,EAAkBF,QAAlB;GADZ;;;AAIJ,SAASC,MAAT,CAAgBD,QAAhB,EAA0BV,OAA1B,EAAmC;MAC3Ba,SAAS,GAAG,CAAC,GAAD,EAAM,GAAN,EAAW,GAAX,EAAgB,GAAhB,EAAqB,GAArB,EAA0B,GAA1B,EAA+B,GAA/B,CAAhB;SACOH,QAAQ,CAAChD,OAAT,CAAiB,4BAAjB,EAA+C,UAAUoD,CAAV,EAAaC,UAAb,EAAyBC,OAAzB,EAAkC;QAChFD,UAAJ,EAAgB;UACRrB,QAAQ,GAAG,EAAf;YACMuB,MAAM,GAAG,EAAf;;UACIJ,SAAS,CAACK,OAAV,CAAkBH,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAlB,MAA4C,CAAC,CAAjD,EAAoD;QAChDzB,QAAQ,GAAGqB,UAAU,CAACI,MAAX,CAAkB,CAAlB,CAAX;QACAJ,UAAU,GAAGA,UAAU,CAACK,MAAX,CAAkB,CAAlB,CAAb;;;MAEJL,UAAU,CAAChE,KAAX,CAAiB,IAAjB,EAAuBN,OAAvB,CAA+B,UAAU4E,QAAV,EAAoB;YAC3Cb,GAAG,GAAG,4BAA4Bc,IAA5B,CAAiCD,QAAjC,CAAV;QACAJ,MAAM,CAACb,IAAP,CAAYL,SAAS,CAACC,OAAD,EAAUN,QAAV,EAAoBc,GAAG,CAAC,CAAD,CAAvB,EAA4BA,GAAG,CAAC,CAAD,CAAH,IAAUA,GAAG,CAAC,CAAD,CAAzC,CAArB;OAFJ;;UAIId,QAAQ,IAAIA,QAAQ,KAAK,GAA7B,EAAkC;YAC1B7B,SAAS,GAAG,GAAhB;;YACI6B,QAAQ,KAAK,GAAjB,EAAsB;UAClB7B,SAAS,GAAG,GAAZ;SADJ,MAGK,IAAI6B,QAAQ,KAAK,GAAjB,EAAsB;UACvB7B,SAAS,GAAG6B,QAAZ;;;eAEG,CAACuB,MAAM,CAAC7D,MAAP,KAAkB,CAAlB,GAAsBsC,QAAtB,GAAiC,EAAlC,IAAwCuB,MAAM,CAAC9C,IAAP,CAAYN,SAAZ,CAA/C;OARJ,MAUK;eACMoD,MAAM,CAAC9C,IAAP,CAAY,GAAZ,CAAP;;KAtBR,MAyBK;aACMa,cAAc,CAACgC,OAAD,CAArB;;GA3BD,CAAP;;;ACvIG,SAASO,KAAT,CAAejF,OAAf,EAAwB;;MAEvBO,MAAM,GAAGP,OAAO,CAACO,MAAR,CAAe2C,WAAf,EAAb,CAF2B;;MAIvB1C,GAAG,GAAG,CAACR,OAAO,CAACQ,GAAR,IAAe,GAAhB,EAAqBY,OAArB,CAA6B,cAA7B,EAA6C,OAA7C,CAAV;MACIV,OAAO,GAAGlB,MAAM,CAACU,MAAP,CAAc,EAAd,EAAkBF,OAAO,CAACU,OAA1B,CAAd;MACIwE,IAAJ;MACI5D,UAAU,GAAGgB,IAAI,CAACtC,OAAD,EAAU,CAC3B,QAD2B,EAE3B,SAF2B,EAG3B,KAH2B,EAI3B,SAJ2B,EAK3B,SAL2B,EAM3B,WAN2B,CAAV,CAArB,CAP2B;;QAgBrBmF,gBAAgB,GAAGlD,uBAAuB,CAACzB,GAAD,CAAhD;EACAA,GAAG,GAAG2D,QAAQ,CAAC3D,GAAD,CAAR,CAAc6D,MAAd,CAAqB/C,UAArB,CAAN;;MACI,CAAC,QAAQE,IAAR,CAAahB,GAAb,CAAL,EAAwB;IACpBA,GAAG,GAAGR,OAAO,CAACoF,OAAR,GAAkB5E,GAAxB;;;QAEE6E,iBAAiB,GAAG7F,MAAM,CAACC,IAAP,CAAYO,OAAZ,EACrBe,MADqB,CACdyB,MAAM,IAAI2C,gBAAgB,CAAClE,QAAjB,CAA0BuB,MAA1B,CADI,EAErBtB,MAFqB,CAEd,SAFc,CAA1B;QAGMoE,mBAAmB,GAAGhD,IAAI,CAAChB,UAAD,EAAa+D,iBAAb,CAAhC;QACME,eAAe,GAAG,6BAA6B/D,IAA7B,CAAkCd,OAAO,CAAC8E,MAA1C,CAAxB;;MACI,CAACD,eAAL,EAAsB;QACdvF,OAAO,CAACY,SAAR,CAAkB6E,MAAtB,EAA8B;;MAE1B/E,OAAO,CAAC8E,MAAR,GAAiB9E,OAAO,CAAC8E,MAAR,CACZ/E,KADY,CACN,GADM,EAEZU,GAFY,CAERH,OAAO,IAAIA,OAAO,CAACI,OAAR,CAAgB,kDAAhB,EAAqE,uBAAsBpB,OAAO,CAACY,SAAR,CAAkB6E,MAAO,EAApH,CAFH,EAGZ5D,IAHY,CAGP,GAHO,CAAjB;;;QAKA7B,OAAO,CAACY,SAAR,CAAkBC,QAAlB,CAA2BC,MAA/B,EAAuC;YAC7B4E,wBAAwB,GAAGhF,OAAO,CAAC8E,MAAR,CAAerD,KAAf,CAAqB,qBAArB,KAA+C,EAAhF;MACAzB,OAAO,CAAC8E,MAAR,GAAiBE,wBAAwB,CACpCxE,MADY,CACLlB,OAAO,CAACY,SAAR,CAAkBC,QADb,EAEZM,GAFY,CAERH,OAAO,IAAI;cACVyE,MAAM,GAAGzF,OAAO,CAACY,SAAR,CAAkB6E,MAAlB,GACR,IAAGzF,OAAO,CAACY,SAAR,CAAkB6E,MAAO,EADpB,GAET,OAFN;eAGQ,0BAAyBzE,OAAQ,WAAUyE,MAAO,EAA1D;OANa,EAQZ5D,IARY,CAQP,GARO,CAAjB;;GApCmB;;;;MAiDvB,CAAC,KAAD,EAAQ,MAAR,EAAgBZ,QAAhB,CAAyBV,MAAzB,CAAJ,EAAsC;IAClCC,GAAG,GAAGa,kBAAkB,CAACb,GAAD,EAAM8E,mBAAN,CAAxB;GADJ,MAGK;QACG,UAAUA,mBAAd,EAAmC;MAC/BJ,IAAI,GAAGI,mBAAmB,CAACK,IAA3B;KADJ,MAGK;UACGnG,MAAM,CAACC,IAAP,CAAY6F,mBAAZ,EAAiCxE,MAArC,EAA6C;QACzCoE,IAAI,GAAGI,mBAAP;OADJ,MAGK;QACD5E,OAAO,CAAC,gBAAD,CAAP,GAA4B,CAA5B;;;GA7De;;;MAkEvB,CAACA,OAAO,CAAC,cAAD,CAAR,IAA4B,OAAOwE,IAAP,KAAgB,WAAhD,EAA6D;IACzDxE,OAAO,CAAC,cAAD,CAAP,GAA0B,iCAA1B;GAnEuB;;;;MAuEvB,CAAC,OAAD,EAAU,KAAV,EAAiBO,QAAjB,CAA0BV,MAA1B,KAAqC,OAAO2E,IAAP,KAAgB,WAAzD,EAAsE;IAClEA,IAAI,GAAG,EAAP;GAxEuB;;;SA2EpB1F,MAAM,CAACU,MAAP,CAAc;IAAEK,MAAF;IAAUC,GAAV;IAAeE;GAA7B,EAAwC,OAAOwE,IAAP,KAAgB,WAAhB,GAA8B;IAAEA;GAAhC,GAAyC,IAAjF,EAAuFlF,OAAO,CAAC4F,OAAR,GAAkB;IAAEA,OAAO,EAAE5F,OAAO,CAAC4F;GAArC,GAAiD,IAAxI,CAAP;;;AC7EG,SAASC,oBAAT,CAA8B9F,QAA9B,EAAwCO,KAAxC,EAA+CN,OAA/C,EAAwD;SACpDiF,KAAK,CAAC5E,KAAK,CAACN,QAAD,EAAWO,KAAX,EAAkBN,OAAlB,CAAN,CAAZ;;;ACAG,SAAS8F,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;QAC7CC,QAAQ,GAAG5F,KAAK,CAAC0F,WAAD,EAAcC,WAAd,CAAtB;QACME,QAAQ,GAAGL,oBAAoB,CAACvB,IAArB,CAA0B,IAA1B,EAAgC2B,QAAhC,CAAjB;SACOzG,MAAM,CAACU,MAAP,CAAcgG,QAAd,EAAwB;IAC3BD,QAD2B;IAE3BlG,QAAQ,EAAE+F,YAAY,CAACxB,IAAb,CAAkB,IAAlB,EAAwB2B,QAAxB,CAFiB;IAG3B5F,KAAK,EAAEA,KAAK,CAACiE,IAAN,CAAW,IAAX,EAAiB2B,QAAjB,CAHoB;IAI3BhB;GAJG,CAAP;;;ACNG,MAAMkB,OAAO,GAAG,mBAAhB;;ACEP,MAAMC,SAAS,GAAI,uBAAsBD,OAAQ,IAAGE,+BAAY,EAAG,EAAnE;;;AAGA,AAAO,MAAMJ,QAAQ,GAAG;EACpB1F,MAAM,EAAE,KADY;EAEpB6E,OAAO,EAAE,wBAFW;EAGpB1E,OAAO,EAAE;IACL8E,MAAM,EAAE,gCADH;kBAESY;GALE;EAOpBxF,SAAS,EAAE;IACP6E,MAAM,EAAE,EADD;IAEP5E,QAAQ,EAAE;;CATX;;MCHMqF,QAAQ,GAAGJ,YAAY,CAAC,IAAD,EAAOG,QAAP,CAA7B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/defaults.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/defaults.js new file mode 100644 index 00000000..e1e53fbc --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/defaults.js @@ -0,0 +1,17 @@ +import { getUserAgent } from "universal-user-agent"; +import { VERSION } from "./version"; +const userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`; +// DEFAULTS has all properties set that EndpointOptions has, except url. +// So we use RequestParameters and add method as additional required property. +export const DEFAULTS = { + method: "GET", + baseUrl: "https://api.github.com", + headers: { + accept: "application/vnd.github.v3+json", + "user-agent": userAgent + }, + mediaType: { + format: "", + previews: [] + } +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/endpoint-with-defaults.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/endpoint-with-defaults.js new file mode 100644 index 00000000..5763758f --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/endpoint-with-defaults.js @@ -0,0 +1,5 @@ +import { merge } from "./merge"; +import { parse } from "./parse"; +export function endpointWithDefaults(defaults, route, options) { + return parse(merge(defaults, route, options)); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/index.js new file mode 100644 index 00000000..599917f9 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/index.js @@ -0,0 +1,3 @@ +import { withDefaults } from "./with-defaults"; +import { DEFAULTS } from "./defaults"; +export const endpoint = withDefaults(null, DEFAULTS); diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/merge.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/merge.js new file mode 100644 index 00000000..a209ffa1 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/merge.js @@ -0,0 +1,22 @@ +import { lowercaseKeys } from "./util/lowercase-keys"; +import { mergeDeep } from "./util/merge-deep"; +export function merge(defaults, route, options) { + if (typeof route === "string") { + let [method, url] = route.split(" "); + options = Object.assign(url ? { method, url } : { url: method }, options); + } + else { + options = Object.assign({}, route); + } + // lowercase header names before merging with defaults to avoid duplicates + options.headers = lowercaseKeys(options.headers); + const mergedOptions = mergeDeep(defaults || {}, options); + // mediaType.previews arrays are merged, instead of overwritten + if (defaults && defaults.mediaType.previews.length) { + mergedOptions.mediaType.previews = defaults.mediaType.previews + .filter(preview => !mergedOptions.mediaType.previews.includes(preview)) + .concat(mergedOptions.mediaType.previews); + } + mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, "")); + return mergedOptions; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/parse.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/parse.js new file mode 100644 index 00000000..ca68ca9f --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/parse.js @@ -0,0 +1,81 @@ +import { addQueryParameters } from "./util/add-query-parameters"; +import { extractUrlVariableNames } from "./util/extract-url-variable-names"; +import { omit } from "./util/omit"; +import { parseUrl } from "./util/url-template"; +export function parse(options) { + // https://fetch.spec.whatwg.org/#methods + let method = options.method.toUpperCase(); + // replace :varname with {varname} to make it RFC 6570 compatible + let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{+$1}"); + let headers = Object.assign({}, options.headers); + let body; + let parameters = omit(options, [ + "method", + "baseUrl", + "url", + "headers", + "request", + "mediaType" + ]); + // extract variable names from URL to calculate remaining variables later + const urlVariableNames = extractUrlVariableNames(url); + url = parseUrl(url).expand(parameters); + if (!/^http/.test(url)) { + url = options.baseUrl + url; + } + const omittedParameters = Object.keys(options) + .filter(option => urlVariableNames.includes(option)) + .concat("baseUrl"); + const remainingParameters = omit(parameters, omittedParameters); + const isBinaryRequset = /application\/octet-stream/i.test(headers.accept); + if (!isBinaryRequset) { + if (options.mediaType.format) { + // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw + headers.accept = headers.accept + .split(/,/) + .map(preview => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)) + .join(","); + } + if (options.mediaType.previews.length) { + const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || []; + headers.accept = previewsFromAcceptHeader + .concat(options.mediaType.previews) + .map(preview => { + const format = options.mediaType.format + ? `.${options.mediaType.format}` + : "+json"; + return `application/vnd.github.${preview}-preview${format}`; + }) + .join(","); + } + } + // for GET/HEAD requests, set URL query parameters from remaining parameters + // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters + if (["GET", "HEAD"].includes(method)) { + url = addQueryParameters(url, remainingParameters); + } + else { + if ("data" in remainingParameters) { + body = remainingParameters.data; + } + else { + if (Object.keys(remainingParameters).length) { + body = remainingParameters; + } + else { + headers["content-length"] = 0; + } + } + } + // default content-type for JSON if body is set + if (!headers["content-type"] && typeof body !== "undefined") { + headers["content-type"] = "application/json; charset=utf-8"; + } + // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body. + // fetch does not allow to set `content-length` header, but we can set body to an empty string + if (["PATCH", "PUT"].includes(method) && typeof body === "undefined") { + body = ""; + } + // Only return body/request keys if present + return Object.assign({ method, url, headers }, typeof body !== "undefined" ? { body } : null, options.request ? { request: options.request } : null); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js new file mode 100644 index 00000000..a78812f7 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/add-query-parameters.js @@ -0,0 +1,21 @@ +export function addQueryParameters(url, parameters) { + const separator = /\?/.test(url) ? "&" : "?"; + const names = Object.keys(parameters); + if (names.length === 0) { + return url; + } + return (url + + separator + + names + .map(name => { + if (name === "q") { + return ("q=" + + parameters + .q.split("+") + .map(encodeURIComponent) + .join("+")); + } + return `${name}=${encodeURIComponent(parameters[name])}`; + }) + .join("&")); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/extract-url-variable-names.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/extract-url-variable-names.js new file mode 100644 index 00000000..3e75db28 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/extract-url-variable-names.js @@ -0,0 +1,11 @@ +const urlVariableRegex = /\{[^}]+\}/g; +function removeNonChars(variableName) { + return variableName.replace(/^\W+|\W+$/g, "").split(/,/); +} +export function extractUrlVariableNames(url) { + const matches = url.match(urlVariableRegex); + if (!matches) { + return []; + } + return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/lowercase-keys.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/lowercase-keys.js new file mode 100644 index 00000000..07806425 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/lowercase-keys.js @@ -0,0 +1,9 @@ +export function lowercaseKeys(object) { + if (!object) { + return {}; + } + return Object.keys(object).reduce((newObj, key) => { + newObj[key.toLowerCase()] = object[key]; + return newObj; + }, {}); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js new file mode 100644 index 00000000..d1c5402d --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/merge-deep.js @@ -0,0 +1,16 @@ +import isPlainObject from "is-plain-object"; +export function mergeDeep(defaults, options) { + const result = Object.assign({}, defaults); + Object.keys(options).forEach(key => { + if (isPlainObject(options[key])) { + if (!(key in defaults)) + Object.assign(result, { [key]: options[key] }); + else + result[key] = mergeDeep(defaults[key], options[key]); + } + else { + Object.assign(result, { [key]: options[key] }); + } + }); + return result; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/omit.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/omit.js new file mode 100644 index 00000000..7e1aa6b4 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/omit.js @@ -0,0 +1,8 @@ +export function omit(object, keysToOmit) { + return Object.keys(object) + .filter(option => !keysToOmit.includes(option)) + .reduce((obj, key) => { + obj[key] = object[key]; + return obj; + }, {}); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/url-template.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/url-template.js new file mode 100644 index 00000000..f6d9885e --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/util/url-template.js @@ -0,0 +1,170 @@ +// Based on https://github.com/bramstein/url-template, licensed under BSD +// TODO: create separate package. +// +// Copyright (c) 2012-2014, Bram Stein +// All rights reserved. +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions +// are met: +// 1. Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// 2. Redistributions in binary form must reproduce the above copyright +// notice, this list of conditions and the following disclaimer in the +// documentation and/or other materials provided with the distribution. +// 3. The name of the author may not be used to endorse or promote products +// derived from this software without specific prior written permission. +// THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED +// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO +// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY +// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +/* istanbul ignore file */ +function encodeReserved(str) { + return str + .split(/(%[0-9A-Fa-f]{2})/g) + .map(function (part) { + if (!/%[0-9A-Fa-f]/.test(part)) { + part = encodeURI(part) + .replace(/%5B/g, "[") + .replace(/%5D/g, "]"); + } + return part; + }) + .join(""); +} +function encodeUnreserved(str) { + return encodeURIComponent(str).replace(/[!'()*]/g, function (c) { + return ("%" + + c + .charCodeAt(0) + .toString(16) + .toUpperCase()); + }); +} +function encodeValue(operator, value, key) { + value = + operator === "+" || operator === "#" + ? encodeReserved(value) + : encodeUnreserved(value); + if (key) { + return encodeUnreserved(key) + "=" + value; + } + else { + return value; + } +} +function isDefined(value) { + return value !== undefined && value !== null; +} +function isKeyOperator(operator) { + return operator === ";" || operator === "&" || operator === "?"; +} +function getValues(context, operator, key, modifier) { + var value = context[key], result = []; + if (isDefined(value) && value !== "") { + if (typeof value === "string" || + typeof value === "number" || + typeof value === "boolean") { + value = value.toString(); + if (modifier && modifier !== "*") { + value = value.substring(0, parseInt(modifier, 10)); + } + result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : "")); + } + else { + if (modifier === "*") { + if (Array.isArray(value)) { + value.filter(isDefined).forEach(function (value) { + result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : "")); + }); + } + else { + Object.keys(value).forEach(function (k) { + if (isDefined(value[k])) { + result.push(encodeValue(operator, value[k], k)); + } + }); + } + } + else { + const tmp = []; + if (Array.isArray(value)) { + value.filter(isDefined).forEach(function (value) { + tmp.push(encodeValue(operator, value)); + }); + } + else { + Object.keys(value).forEach(function (k) { + if (isDefined(value[k])) { + tmp.push(encodeUnreserved(k)); + tmp.push(encodeValue(operator, value[k].toString())); + } + }); + } + if (isKeyOperator(operator)) { + result.push(encodeUnreserved(key) + "=" + tmp.join(",")); + } + else if (tmp.length !== 0) { + result.push(tmp.join(",")); + } + } + } + } + else { + if (operator === ";") { + if (isDefined(value)) { + result.push(encodeUnreserved(key)); + } + } + else if (value === "" && (operator === "&" || operator === "?")) { + result.push(encodeUnreserved(key) + "="); + } + else if (value === "") { + result.push(""); + } + } + return result; +} +export function parseUrl(template) { + return { + expand: expand.bind(null, template) + }; +} +function expand(template, context) { + var operators = ["+", "#", ".", "/", ";", "?", "&"]; + return template.replace(/\{([^\{\}]+)\}|([^\{\}]+)/g, function (_, expression, literal) { + if (expression) { + let operator = ""; + const values = []; + if (operators.indexOf(expression.charAt(0)) !== -1) { + operator = expression.charAt(0); + expression = expression.substr(1); + } + expression.split(/,/g).forEach(function (variable) { + var tmp = /([^:\*]*)(?::(\d+)|(\*))?/.exec(variable); + values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3])); + }); + if (operator && operator !== "+") { + var separator = ","; + if (operator === "?") { + separator = "&"; + } + else if (operator !== "#") { + separator = operator; + } + return (values.length !== 0 ? operator : "") + values.join(separator); + } + else { + return values.join(","); + } + } + else { + return encodeReserved(literal); + } + }); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/version.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/version.js new file mode 100644 index 00000000..ef913979 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "5.5.1"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/with-defaults.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/with-defaults.js new file mode 100644 index 00000000..9a1c886a --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-src/with-defaults.js @@ -0,0 +1,13 @@ +import { endpointWithDefaults } from "./endpoint-with-defaults"; +import { merge } from "./merge"; +import { parse } from "./parse"; +export function withDefaults(oldDefaults, newDefaults) { + const DEFAULTS = merge(oldDefaults, newDefaults); + const endpoint = endpointWithDefaults.bind(null, DEFAULTS); + return Object.assign(endpoint, { + DEFAULTS, + defaults: withDefaults.bind(null, DEFAULTS), + merge: merge.bind(null, DEFAULTS), + parse + }); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/defaults.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/defaults.d.ts new file mode 100644 index 00000000..30fcd203 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/defaults.d.ts @@ -0,0 +1,2 @@ +import { EndpointDefaults } from "@octokit/types"; +export declare const DEFAULTS: EndpointDefaults; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/endpoint-with-defaults.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/endpoint-with-defaults.d.ts new file mode 100644 index 00000000..ff39e5e7 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/endpoint-with-defaults.d.ts @@ -0,0 +1,3 @@ +import { EndpointOptions, RequestParameters, Route } from "@octokit/types"; +import { DEFAULTS } from "./defaults"; +export declare function endpointWithDefaults(defaults: typeof DEFAULTS, route: Route | EndpointOptions, options?: RequestParameters): import("@octokit/types").RequestOptions; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/index.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/index.d.ts new file mode 100644 index 00000000..17be8553 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/index.d.ts @@ -0,0 +1 @@ +export declare const endpoint: import("@octokit/types").EndpointInterface; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/merge.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/merge.d.ts new file mode 100644 index 00000000..b75a15ec --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/merge.d.ts @@ -0,0 +1,2 @@ +import { EndpointDefaults, RequestParameters, Route } from "@octokit/types"; +export declare function merge(defaults: EndpointDefaults | null, route?: Route | RequestParameters, options?: RequestParameters): EndpointDefaults; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/parse.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/parse.d.ts new file mode 100644 index 00000000..fbe21440 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/parse.d.ts @@ -0,0 +1,2 @@ +import { EndpointDefaults, RequestOptions } from "@octokit/types"; +export declare function parse(options: EndpointDefaults): RequestOptions; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/add-query-parameters.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/add-query-parameters.d.ts new file mode 100644 index 00000000..4b192ac4 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/add-query-parameters.d.ts @@ -0,0 +1,4 @@ +export declare function addQueryParameters(url: string, parameters: { + [x: string]: string | undefined; + q?: string; +}): string; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/extract-url-variable-names.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/extract-url-variable-names.d.ts new file mode 100644 index 00000000..93586d4d --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/extract-url-variable-names.d.ts @@ -0,0 +1 @@ +export declare function extractUrlVariableNames(url: string): string[]; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/lowercase-keys.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/lowercase-keys.d.ts new file mode 100644 index 00000000..1daf3073 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/lowercase-keys.d.ts @@ -0,0 +1,5 @@ +export declare function lowercaseKeys(object?: { + [key: string]: any; +}): { + [key: string]: any; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/merge-deep.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/merge-deep.d.ts new file mode 100644 index 00000000..914411cf --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/merge-deep.d.ts @@ -0,0 +1 @@ +export declare function mergeDeep(defaults: any, options: any): object; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/omit.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/omit.d.ts new file mode 100644 index 00000000..06927d6b --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/omit.d.ts @@ -0,0 +1,5 @@ +export declare function omit(object: { + [key: string]: any; +}, keysToOmit: string[]): { + [key: string]: any; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/url-template.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/url-template.d.ts new file mode 100644 index 00000000..5d967cab --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/util/url-template.d.ts @@ -0,0 +1,3 @@ +export declare function parseUrl(template: string): { + expand: (context: object) => string; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/version.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/version.d.ts new file mode 100644 index 00000000..809d28a7 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "5.5.1"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/with-defaults.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/with-defaults.d.ts new file mode 100644 index 00000000..6f5afd1e --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-types/with-defaults.d.ts @@ -0,0 +1,2 @@ +import { EndpointInterface, RequestParameters, EndpointDefaults } from "@octokit/types"; +export declare function withDefaults(oldDefaults: EndpointDefaults | null, newDefaults: RequestParameters): EndpointInterface; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-web/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-web/index.js new file mode 100644 index 00000000..a327238b --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-web/index.js @@ -0,0 +1,379 @@ +import isPlainObject from 'is-plain-object'; +import { getUserAgent } from 'universal-user-agent'; + +function lowercaseKeys(object) { + if (!object) { + return {}; + } + return Object.keys(object).reduce((newObj, key) => { + newObj[key.toLowerCase()] = object[key]; + return newObj; + }, {}); +} + +function mergeDeep(defaults, options) { + const result = Object.assign({}, defaults); + Object.keys(options).forEach(key => { + if (isPlainObject(options[key])) { + if (!(key in defaults)) + Object.assign(result, { [key]: options[key] }); + else + result[key] = mergeDeep(defaults[key], options[key]); + } + else { + Object.assign(result, { [key]: options[key] }); + } + }); + return result; +} + +function merge(defaults, route, options) { + if (typeof route === "string") { + let [method, url] = route.split(" "); + options = Object.assign(url ? { method, url } : { url: method }, options); + } + else { + options = Object.assign({}, route); + } + // lowercase header names before merging with defaults to avoid duplicates + options.headers = lowercaseKeys(options.headers); + const mergedOptions = mergeDeep(defaults || {}, options); + // mediaType.previews arrays are merged, instead of overwritten + if (defaults && defaults.mediaType.previews.length) { + mergedOptions.mediaType.previews = defaults.mediaType.previews + .filter(preview => !mergedOptions.mediaType.previews.includes(preview)) + .concat(mergedOptions.mediaType.previews); + } + mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, "")); + return mergedOptions; +} + +function addQueryParameters(url, parameters) { + const separator = /\?/.test(url) ? "&" : "?"; + const names = Object.keys(parameters); + if (names.length === 0) { + return url; + } + return (url + + separator + + names + .map(name => { + if (name === "q") { + return ("q=" + + parameters + .q.split("+") + .map(encodeURIComponent) + .join("+")); + } + return `${name}=${encodeURIComponent(parameters[name])}`; + }) + .join("&")); +} + +const urlVariableRegex = /\{[^}]+\}/g; +function removeNonChars(variableName) { + return variableName.replace(/^\W+|\W+$/g, "").split(/,/); +} +function extractUrlVariableNames(url) { + const matches = url.match(urlVariableRegex); + if (!matches) { + return []; + } + return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []); +} + +function omit(object, keysToOmit) { + return Object.keys(object) + .filter(option => !keysToOmit.includes(option)) + .reduce((obj, key) => { + obj[key] = object[key]; + return obj; + }, {}); +} + +// Based on https://github.com/bramstein/url-template, licensed under BSD +// TODO: create separate package. +// +// Copyright (c) 2012-2014, Bram Stein +// All rights reserved. +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions +// are met: +// 1. Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// 2. Redistributions in binary form must reproduce the above copyright +// notice, this list of conditions and the following disclaimer in the +// documentation and/or other materials provided with the distribution. +// 3. The name of the author may not be used to endorse or promote products +// derived from this software without specific prior written permission. +// THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED +// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO +// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY +// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +/* istanbul ignore file */ +function encodeReserved(str) { + return str + .split(/(%[0-9A-Fa-f]{2})/g) + .map(function (part) { + if (!/%[0-9A-Fa-f]/.test(part)) { + part = encodeURI(part) + .replace(/%5B/g, "[") + .replace(/%5D/g, "]"); + } + return part; + }) + .join(""); +} +function encodeUnreserved(str) { + return encodeURIComponent(str).replace(/[!'()*]/g, function (c) { + return ("%" + + c + .charCodeAt(0) + .toString(16) + .toUpperCase()); + }); +} +function encodeValue(operator, value, key) { + value = + operator === "+" || operator === "#" + ? encodeReserved(value) + : encodeUnreserved(value); + if (key) { + return encodeUnreserved(key) + "=" + value; + } + else { + return value; + } +} +function isDefined(value) { + return value !== undefined && value !== null; +} +function isKeyOperator(operator) { + return operator === ";" || operator === "&" || operator === "?"; +} +function getValues(context, operator, key, modifier) { + var value = context[key], result = []; + if (isDefined(value) && value !== "") { + if (typeof value === "string" || + typeof value === "number" || + typeof value === "boolean") { + value = value.toString(); + if (modifier && modifier !== "*") { + value = value.substring(0, parseInt(modifier, 10)); + } + result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : "")); + } + else { + if (modifier === "*") { + if (Array.isArray(value)) { + value.filter(isDefined).forEach(function (value) { + result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : "")); + }); + } + else { + Object.keys(value).forEach(function (k) { + if (isDefined(value[k])) { + result.push(encodeValue(operator, value[k], k)); + } + }); + } + } + else { + const tmp = []; + if (Array.isArray(value)) { + value.filter(isDefined).forEach(function (value) { + tmp.push(encodeValue(operator, value)); + }); + } + else { + Object.keys(value).forEach(function (k) { + if (isDefined(value[k])) { + tmp.push(encodeUnreserved(k)); + tmp.push(encodeValue(operator, value[k].toString())); + } + }); + } + if (isKeyOperator(operator)) { + result.push(encodeUnreserved(key) + "=" + tmp.join(",")); + } + else if (tmp.length !== 0) { + result.push(tmp.join(",")); + } + } + } + } + else { + if (operator === ";") { + if (isDefined(value)) { + result.push(encodeUnreserved(key)); + } + } + else if (value === "" && (operator === "&" || operator === "?")) { + result.push(encodeUnreserved(key) + "="); + } + else if (value === "") { + result.push(""); + } + } + return result; +} +function parseUrl(template) { + return { + expand: expand.bind(null, template) + }; +} +function expand(template, context) { + var operators = ["+", "#", ".", "/", ";", "?", "&"]; + return template.replace(/\{([^\{\}]+)\}|([^\{\}]+)/g, function (_, expression, literal) { + if (expression) { + let operator = ""; + const values = []; + if (operators.indexOf(expression.charAt(0)) !== -1) { + operator = expression.charAt(0); + expression = expression.substr(1); + } + expression.split(/,/g).forEach(function (variable) { + var tmp = /([^:\*]*)(?::(\d+)|(\*))?/.exec(variable); + values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3])); + }); + if (operator && operator !== "+") { + var separator = ","; + if (operator === "?") { + separator = "&"; + } + else if (operator !== "#") { + separator = operator; + } + return (values.length !== 0 ? operator : "") + values.join(separator); + } + else { + return values.join(","); + } + } + else { + return encodeReserved(literal); + } + }); +} + +function parse(options) { + // https://fetch.spec.whatwg.org/#methods + let method = options.method.toUpperCase(); + // replace :varname with {varname} to make it RFC 6570 compatible + let url = (options.url || "/").replace(/:([a-z]\w+)/g, "{+$1}"); + let headers = Object.assign({}, options.headers); + let body; + let parameters = omit(options, [ + "method", + "baseUrl", + "url", + "headers", + "request", + "mediaType" + ]); + // extract variable names from URL to calculate remaining variables later + const urlVariableNames = extractUrlVariableNames(url); + url = parseUrl(url).expand(parameters); + if (!/^http/.test(url)) { + url = options.baseUrl + url; + } + const omittedParameters = Object.keys(options) + .filter(option => urlVariableNames.includes(option)) + .concat("baseUrl"); + const remainingParameters = omit(parameters, omittedParameters); + const isBinaryRequset = /application\/octet-stream/i.test(headers.accept); + if (!isBinaryRequset) { + if (options.mediaType.format) { + // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw + headers.accept = headers.accept + .split(/,/) + .map(preview => preview.replace(/application\/vnd(\.\w+)(\.v3)?(\.\w+)?(\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`)) + .join(","); + } + if (options.mediaType.previews.length) { + const previewsFromAcceptHeader = headers.accept.match(/[\w-]+(?=-preview)/g) || []; + headers.accept = previewsFromAcceptHeader + .concat(options.mediaType.previews) + .map(preview => { + const format = options.mediaType.format + ? `.${options.mediaType.format}` + : "+json"; + return `application/vnd.github.${preview}-preview${format}`; + }) + .join(","); + } + } + // for GET/HEAD requests, set URL query parameters from remaining parameters + // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters + if (["GET", "HEAD"].includes(method)) { + url = addQueryParameters(url, remainingParameters); + } + else { + if ("data" in remainingParameters) { + body = remainingParameters.data; + } + else { + if (Object.keys(remainingParameters).length) { + body = remainingParameters; + } + else { + headers["content-length"] = 0; + } + } + } + // default content-type for JSON if body is set + if (!headers["content-type"] && typeof body !== "undefined") { + headers["content-type"] = "application/json; charset=utf-8"; + } + // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body. + // fetch does not allow to set `content-length` header, but we can set body to an empty string + if (["PATCH", "PUT"].includes(method) && typeof body === "undefined") { + body = ""; + } + // Only return body/request keys if present + return Object.assign({ method, url, headers }, typeof body !== "undefined" ? { body } : null, options.request ? { request: options.request } : null); +} + +function endpointWithDefaults(defaults, route, options) { + return parse(merge(defaults, route, options)); +} + +function withDefaults(oldDefaults, newDefaults) { + const DEFAULTS = merge(oldDefaults, newDefaults); + const endpoint = endpointWithDefaults.bind(null, DEFAULTS); + return Object.assign(endpoint, { + DEFAULTS, + defaults: withDefaults.bind(null, DEFAULTS), + merge: merge.bind(null, DEFAULTS), + parse + }); +} + +const VERSION = "5.5.1"; + +const userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`; +// DEFAULTS has all properties set that EndpointOptions has, except url. +// So we use RequestParameters and add method as additional required property. +const DEFAULTS = { + method: "GET", + baseUrl: "https://api.github.com", + headers: { + accept: "application/vnd.github.v3+json", + "user-agent": userAgent + }, + mediaType: { + format: "", + previews: [] + } +}; + +const endpoint = withDefaults(null, DEFAULTS); + +export { endpoint }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-web/index.js.map b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-web/index.js.map new file mode 100644 index 00000000..68900096 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/util/lowercase-keys.js","../dist-src/util/merge-deep.js","../dist-src/merge.js","../dist-src/util/add-query-parameters.js","../dist-src/util/extract-url-variable-names.js","../dist-src/util/omit.js","../dist-src/util/url-template.js","../dist-src/parse.js","../dist-src/endpoint-with-defaults.js","../dist-src/with-defaults.js","../dist-src/version.js","../dist-src/defaults.js","../dist-src/index.js"],"sourcesContent":["export function lowercaseKeys(object) {\n if (!object) {\n return {};\n }\n return Object.keys(object).reduce((newObj, key) => {\n newObj[key.toLowerCase()] = object[key];\n return newObj;\n }, {});\n}\n","import isPlainObject from \"is-plain-object\";\nexport function mergeDeep(defaults, options) {\n const result = Object.assign({}, defaults);\n Object.keys(options).forEach(key => {\n if (isPlainObject(options[key])) {\n if (!(key in defaults))\n Object.assign(result, { [key]: options[key] });\n else\n result[key] = mergeDeep(defaults[key], options[key]);\n }\n else {\n Object.assign(result, { [key]: options[key] });\n }\n });\n return result;\n}\n","import { lowercaseKeys } from \"./util/lowercase-keys\";\nimport { mergeDeep } from \"./util/merge-deep\";\nexport function merge(defaults, route, options) {\n if (typeof route === \"string\") {\n let [method, url] = route.split(\" \");\n options = Object.assign(url ? { method, url } : { url: method }, options);\n }\n else {\n options = Object.assign({}, route);\n }\n // lowercase header names before merging with defaults to avoid duplicates\n options.headers = lowercaseKeys(options.headers);\n const mergedOptions = mergeDeep(defaults || {}, options);\n // mediaType.previews arrays are merged, instead of overwritten\n if (defaults && defaults.mediaType.previews.length) {\n mergedOptions.mediaType.previews = defaults.mediaType.previews\n .filter(preview => !mergedOptions.mediaType.previews.includes(preview))\n .concat(mergedOptions.mediaType.previews);\n }\n mergedOptions.mediaType.previews = mergedOptions.mediaType.previews.map((preview) => preview.replace(/-preview/, \"\"));\n return mergedOptions;\n}\n","export function addQueryParameters(url, parameters) {\n const separator = /\\?/.test(url) ? \"&\" : \"?\";\n const names = Object.keys(parameters);\n if (names.length === 0) {\n return url;\n }\n return (url +\n separator +\n names\n .map(name => {\n if (name === \"q\") {\n return (\"q=\" +\n parameters\n .q.split(\"+\")\n .map(encodeURIComponent)\n .join(\"+\"));\n }\n return `${name}=${encodeURIComponent(parameters[name])}`;\n })\n .join(\"&\"));\n}\n","const urlVariableRegex = /\\{[^}]+\\}/g;\nfunction removeNonChars(variableName) {\n return variableName.replace(/^\\W+|\\W+$/g, \"\").split(/,/);\n}\nexport function extractUrlVariableNames(url) {\n const matches = url.match(urlVariableRegex);\n if (!matches) {\n return [];\n }\n return matches.map(removeNonChars).reduce((a, b) => a.concat(b), []);\n}\n","export function omit(object, keysToOmit) {\n return Object.keys(object)\n .filter(option => !keysToOmit.includes(option))\n .reduce((obj, key) => {\n obj[key] = object[key];\n return obj;\n }, {});\n}\n","// Based on https://github.com/bramstein/url-template, licensed under BSD\n// TODO: create separate package.\n//\n// Copyright (c) 2012-2014, Bram Stein\n// All rights reserved.\n// Redistribution and use in source and binary forms, with or without\n// modification, are permitted provided that the following conditions\n// are met:\n// 1. Redistributions of source code must retain the above copyright\n// notice, this list of conditions and the following disclaimer.\n// 2. Redistributions in binary form must reproduce the above copyright\n// notice, this list of conditions and the following disclaimer in the\n// documentation and/or other materials provided with the distribution.\n// 3. The name of the author may not be used to endorse or promote products\n// derived from this software without specific prior written permission.\n// THIS SOFTWARE IS PROVIDED BY THE AUTHOR \"AS IS\" AND ANY EXPRESS OR IMPLIED\n// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO\n// EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\n// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\n// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\n// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\n// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n/* istanbul ignore file */\nfunction encodeReserved(str) {\n return str\n .split(/(%[0-9A-Fa-f]{2})/g)\n .map(function (part) {\n if (!/%[0-9A-Fa-f]/.test(part)) {\n part = encodeURI(part)\n .replace(/%5B/g, \"[\")\n .replace(/%5D/g, \"]\");\n }\n return part;\n })\n .join(\"\");\n}\nfunction encodeUnreserved(str) {\n return encodeURIComponent(str).replace(/[!'()*]/g, function (c) {\n return (\"%\" +\n c\n .charCodeAt(0)\n .toString(16)\n .toUpperCase());\n });\n}\nfunction encodeValue(operator, value, key) {\n value =\n operator === \"+\" || operator === \"#\"\n ? encodeReserved(value)\n : encodeUnreserved(value);\n if (key) {\n return encodeUnreserved(key) + \"=\" + value;\n }\n else {\n return value;\n }\n}\nfunction isDefined(value) {\n return value !== undefined && value !== null;\n}\nfunction isKeyOperator(operator) {\n return operator === \";\" || operator === \"&\" || operator === \"?\";\n}\nfunction getValues(context, operator, key, modifier) {\n var value = context[key], result = [];\n if (isDefined(value) && value !== \"\") {\n if (typeof value === \"string\" ||\n typeof value === \"number\" ||\n typeof value === \"boolean\") {\n value = value.toString();\n if (modifier && modifier !== \"*\") {\n value = value.substring(0, parseInt(modifier, 10));\n }\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n }\n else {\n if (modifier === \"*\") {\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n result.push(encodeValue(operator, value, isKeyOperator(operator) ? key : \"\"));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n result.push(encodeValue(operator, value[k], k));\n }\n });\n }\n }\n else {\n const tmp = [];\n if (Array.isArray(value)) {\n value.filter(isDefined).forEach(function (value) {\n tmp.push(encodeValue(operator, value));\n });\n }\n else {\n Object.keys(value).forEach(function (k) {\n if (isDefined(value[k])) {\n tmp.push(encodeUnreserved(k));\n tmp.push(encodeValue(operator, value[k].toString()));\n }\n });\n }\n if (isKeyOperator(operator)) {\n result.push(encodeUnreserved(key) + \"=\" + tmp.join(\",\"));\n }\n else if (tmp.length !== 0) {\n result.push(tmp.join(\",\"));\n }\n }\n }\n }\n else {\n if (operator === \";\") {\n if (isDefined(value)) {\n result.push(encodeUnreserved(key));\n }\n }\n else if (value === \"\" && (operator === \"&\" || operator === \"?\")) {\n result.push(encodeUnreserved(key) + \"=\");\n }\n else if (value === \"\") {\n result.push(\"\");\n }\n }\n return result;\n}\nexport function parseUrl(template) {\n return {\n expand: expand.bind(null, template)\n };\n}\nfunction expand(template, context) {\n var operators = [\"+\", \"#\", \".\", \"/\", \";\", \"?\", \"&\"];\n return template.replace(/\\{([^\\{\\}]+)\\}|([^\\{\\}]+)/g, function (_, expression, literal) {\n if (expression) {\n let operator = \"\";\n const values = [];\n if (operators.indexOf(expression.charAt(0)) !== -1) {\n operator = expression.charAt(0);\n expression = expression.substr(1);\n }\n expression.split(/,/g).forEach(function (variable) {\n var tmp = /([^:\\*]*)(?::(\\d+)|(\\*))?/.exec(variable);\n values.push(getValues(context, operator, tmp[1], tmp[2] || tmp[3]));\n });\n if (operator && operator !== \"+\") {\n var separator = \",\";\n if (operator === \"?\") {\n separator = \"&\";\n }\n else if (operator !== \"#\") {\n separator = operator;\n }\n return (values.length !== 0 ? operator : \"\") + values.join(separator);\n }\n else {\n return values.join(\",\");\n }\n }\n else {\n return encodeReserved(literal);\n }\n });\n}\n","import { addQueryParameters } from \"./util/add-query-parameters\";\nimport { extractUrlVariableNames } from \"./util/extract-url-variable-names\";\nimport { omit } from \"./util/omit\";\nimport { parseUrl } from \"./util/url-template\";\nexport function parse(options) {\n // https://fetch.spec.whatwg.org/#methods\n let method = options.method.toUpperCase();\n // replace :varname with {varname} to make it RFC 6570 compatible\n let url = (options.url || \"/\").replace(/:([a-z]\\w+)/g, \"{+$1}\");\n let headers = Object.assign({}, options.headers);\n let body;\n let parameters = omit(options, [\n \"method\",\n \"baseUrl\",\n \"url\",\n \"headers\",\n \"request\",\n \"mediaType\"\n ]);\n // extract variable names from URL to calculate remaining variables later\n const urlVariableNames = extractUrlVariableNames(url);\n url = parseUrl(url).expand(parameters);\n if (!/^http/.test(url)) {\n url = options.baseUrl + url;\n }\n const omittedParameters = Object.keys(options)\n .filter(option => urlVariableNames.includes(option))\n .concat(\"baseUrl\");\n const remainingParameters = omit(parameters, omittedParameters);\n const isBinaryRequset = /application\\/octet-stream/i.test(headers.accept);\n if (!isBinaryRequset) {\n if (options.mediaType.format) {\n // e.g. application/vnd.github.v3+json => application/vnd.github.v3.raw\n headers.accept = headers.accept\n .split(/,/)\n .map(preview => preview.replace(/application\\/vnd(\\.\\w+)(\\.v3)?(\\.\\w+)?(\\+json)?$/, `application/vnd$1$2.${options.mediaType.format}`))\n .join(\",\");\n }\n if (options.mediaType.previews.length) {\n const previewsFromAcceptHeader = headers.accept.match(/[\\w-]+(?=-preview)/g) || [];\n headers.accept = previewsFromAcceptHeader\n .concat(options.mediaType.previews)\n .map(preview => {\n const format = options.mediaType.format\n ? `.${options.mediaType.format}`\n : \"+json\";\n return `application/vnd.github.${preview}-preview${format}`;\n })\n .join(\",\");\n }\n }\n // for GET/HEAD requests, set URL query parameters from remaining parameters\n // for PATCH/POST/PUT/DELETE requests, set request body from remaining parameters\n if ([\"GET\", \"HEAD\"].includes(method)) {\n url = addQueryParameters(url, remainingParameters);\n }\n else {\n if (\"data\" in remainingParameters) {\n body = remainingParameters.data;\n }\n else {\n if (Object.keys(remainingParameters).length) {\n body = remainingParameters;\n }\n else {\n headers[\"content-length\"] = 0;\n }\n }\n }\n // default content-type for JSON if body is set\n if (!headers[\"content-type\"] && typeof body !== \"undefined\") {\n headers[\"content-type\"] = \"application/json; charset=utf-8\";\n }\n // GitHub expects 'content-length: 0' header for PUT/PATCH requests without body.\n // fetch does not allow to set `content-length` header, but we can set body to an empty string\n if ([\"PATCH\", \"PUT\"].includes(method) && typeof body === \"undefined\") {\n body = \"\";\n }\n // Only return body/request keys if present\n return Object.assign({ method, url, headers }, typeof body !== \"undefined\" ? { body } : null, options.request ? { request: options.request } : null);\n}\n","import { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function endpointWithDefaults(defaults, route, options) {\n return parse(merge(defaults, route, options));\n}\n","import { endpointWithDefaults } from \"./endpoint-with-defaults\";\nimport { merge } from \"./merge\";\nimport { parse } from \"./parse\";\nexport function withDefaults(oldDefaults, newDefaults) {\n const DEFAULTS = merge(oldDefaults, newDefaults);\n const endpoint = endpointWithDefaults.bind(null, DEFAULTS);\n return Object.assign(endpoint, {\n DEFAULTS,\n defaults: withDefaults.bind(null, DEFAULTS),\n merge: merge.bind(null, DEFAULTS),\n parse\n });\n}\n","export const VERSION = \"5.5.1\";\n","import { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nconst userAgent = `octokit-endpoint.js/${VERSION} ${getUserAgent()}`;\n// DEFAULTS has all properties set that EndpointOptions has, except url.\n// So we use RequestParameters and add method as additional required property.\nexport const DEFAULTS = {\n method: \"GET\",\n baseUrl: \"https://api.github.com\",\n headers: {\n accept: \"application/vnd.github.v3+json\",\n \"user-agent\": userAgent\n },\n mediaType: {\n format: \"\",\n previews: []\n }\n};\n","import { withDefaults } from \"./with-defaults\";\nimport { DEFAULTS } from \"./defaults\";\nexport const endpoint = withDefaults(null, DEFAULTS);\n"],"names":[],"mappings":";;;AAAO,SAAS,aAAa,CAAC,MAAM,EAAE;IAClC,IAAI,CAAC,MAAM,EAAE;QACT,OAAO,EAAE,CAAC;KACb;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK;QAC/C,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACxC,OAAO,MAAM,CAAC;KACjB,EAAE,EAAE,CAAC,CAAC;CACV;;ACPM,SAAS,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE;IACzC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC3C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI;QAChC,IAAI,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE;YAC7B,IAAI,EAAE,GAAG,IAAI,QAAQ,CAAC;gBAClB,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;;gBAE/C,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SAC5D;aACI;YACD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SAClD;KACJ,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;CACjB;;ACbM,SAAS,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;IAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC3B,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;KAC7E;SACI;QACD,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;KACtC;;IAED,OAAO,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACjD,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;;IAEzD,IAAI,QAAQ,IAAI,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;QAChD,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ;aACzD,MAAM,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;aACtE,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;KACjD;IACD,aAAa,CAAC,SAAS,CAAC,QAAQ,GAAG,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC;IACtH,OAAO,aAAa,CAAC;CACxB;;ACrBM,SAAS,kBAAkB,CAAC,GAAG,EAAE,UAAU,EAAE;IAChD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC;IAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACpB,OAAO,GAAG,CAAC;KACd;IACD,QAAQ,GAAG;QACP,SAAS;QACT,KAAK;aACA,GAAG,CAAC,IAAI,IAAI;YACb,IAAI,IAAI,KAAK,GAAG,EAAE;gBACd,QAAQ,IAAI;oBACR,UAAU;yBACL,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;yBACZ,GAAG,CAAC,kBAAkB,CAAC;yBACvB,IAAI,CAAC,GAAG,CAAC,EAAE;aACvB;YACD,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SAC5D,CAAC;aACG,IAAI,CAAC,GAAG,CAAC,EAAE;CACvB;;ACpBD,MAAM,gBAAgB,GAAG,YAAY,CAAC;AACtC,SAAS,cAAc,CAAC,YAAY,EAAE;IAClC,OAAO,YAAY,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;CAC5D;AACD,AAAO,SAAS,uBAAuB,CAAC,GAAG,EAAE;IACzC,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC5C,IAAI,CAAC,OAAO,EAAE;QACV,OAAO,EAAE,CAAC;KACb;IACD,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CACxE;;ACVM,SAAS,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACrB,MAAM,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC9C,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK;QACtB,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACvB,OAAO,GAAG,CAAC;KACd,EAAE,EAAE,CAAC,CAAC;CACV;;ACPD;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,SAAS,cAAc,CAAC,GAAG,EAAE;IACzB,OAAO,GAAG;SACL,KAAK,CAAC,oBAAoB,CAAC;SAC3B,GAAG,CAAC,UAAU,IAAI,EAAE;QACrB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC5B,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC;iBACjB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;iBACpB,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC;KACf,CAAC;SACG,IAAI,CAAC,EAAE,CAAC,CAAC;CACjB;AACD,SAAS,gBAAgB,CAAC,GAAG,EAAE;IAC3B,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE;QAC5D,QAAQ,GAAG;YACP,CAAC;iBACI,UAAU,CAAC,CAAC,CAAC;iBACb,QAAQ,CAAC,EAAE,CAAC;iBACZ,WAAW,EAAE,EAAE;KAC3B,CAAC,CAAC;CACN;AACD,SAAS,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE;IACvC,KAAK;QACD,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG;cAC9B,cAAc,CAAC,KAAK,CAAC;cACrB,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAClC,IAAI,GAAG,EAAE;QACL,OAAO,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC;KAC9C;SACI;QACD,OAAO,KAAK,CAAC;KAChB;CACJ;AACD,SAAS,SAAS,CAAC,KAAK,EAAE;IACtB,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC;CAChD;AACD,SAAS,aAAa,CAAC,QAAQ,EAAE;IAC7B,OAAO,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC;CACnE;AACD,SAAS,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE;IACjD,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;IACtC,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE,EAAE;QAClC,IAAI,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,QAAQ;YACzB,OAAO,KAAK,KAAK,SAAS,EAAE;YAC5B,KAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YACzB,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;gBAC9B,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;aACtD;YACD,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;SACjF;aACI;YACD,IAAI,QAAQ,KAAK,GAAG,EAAE;gBAClB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBACtB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;wBAC7C,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;qBACjF,CAAC,CAAC;iBACN;qBACI;oBACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;wBACpC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;4BACrB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;yBACnD;qBACJ,CAAC,CAAC;iBACN;aACJ;iBACI;gBACD,MAAM,GAAG,GAAG,EAAE,CAAC;gBACf,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBACtB,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,EAAE;wBAC7C,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;qBAC1C,CAAC,CAAC;iBACN;qBACI;oBACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;wBACpC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;4BACrB,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;4BAC9B,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;yBACxD;qBACJ,CAAC,CAAC;iBACN;gBACD,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE;oBACzB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;iBAC5D;qBACI,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;oBACvB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;iBAC9B;aACJ;SACJ;KACJ;SACI;QACD,IAAI,QAAQ,KAAK,GAAG,EAAE;YAClB,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;gBAClB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;aACtC;SACJ;aACI,IAAI,KAAK,KAAK,EAAE,KAAK,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,CAAC,EAAE;YAC7D,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;SAC5C;aACI,IAAI,KAAK,KAAK,EAAE,EAAE;YACnB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACnB;KACJ;IACD,OAAO,MAAM,CAAC;CACjB;AACD,AAAO,SAAS,QAAQ,CAAC,QAAQ,EAAE;IAC/B,OAAO;QACH,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;KACtC,CAAC;CACL;AACD,SAAS,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE;IAC/B,IAAI,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACpD,OAAO,QAAQ,CAAC,OAAO,CAAC,4BAA4B,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE;QACpF,IAAI,UAAU,EAAE;YACZ,IAAI,QAAQ,GAAG,EAAE,CAAC;YAClB,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE;gBAChD,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAChC,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;aACrC;YACD,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,QAAQ,EAAE;gBAC/C,IAAI,GAAG,GAAG,2BAA2B,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACrD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACvE,CAAC,CAAC;YACH,IAAI,QAAQ,IAAI,QAAQ,KAAK,GAAG,EAAE;gBAC9B,IAAI,SAAS,GAAG,GAAG,CAAC;gBACpB,IAAI,QAAQ,KAAK,GAAG,EAAE;oBAClB,SAAS,GAAG,GAAG,CAAC;iBACnB;qBACI,IAAI,QAAQ,KAAK,GAAG,EAAE;oBACvB,SAAS,GAAG,QAAQ,CAAC;iBACxB;gBACD,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,QAAQ,GAAG,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aACzE;iBACI;gBACD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAC3B;SACJ;aACI;YACD,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC;SAClC;KACJ,CAAC,CAAC;CACN;;ACrKM,SAAS,KAAK,CAAC,OAAO,EAAE;;IAE3B,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;;IAE1C,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,EAAE,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAChE,IAAI,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACjD,IAAI,IAAI,CAAC;IACT,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE;QAC3B,QAAQ;QACR,SAAS;QACT,KAAK;QACL,SAAS;QACT,SAAS;QACT,WAAW;KACd,CAAC,CAAC;;IAEH,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC;IACtD,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACvC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QACpB,GAAG,GAAG,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;KAC/B;IACD,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;SACzC,MAAM,CAAC,MAAM,IAAI,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACnD,MAAM,CAAC,SAAS,CAAC,CAAC;IACvB,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;IAChE,MAAM,eAAe,GAAG,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1E,IAAI,CAAC,eAAe,EAAE;QAClB,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE;;YAE1B,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM;iBAC1B,KAAK,CAAC,GAAG,CAAC;iBACV,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,kDAAkD,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;iBACtI,IAAI,CAAC,GAAG,CAAC,CAAC;SAClB;QACD,IAAI,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;YACnC,MAAM,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;YACnF,OAAO,CAAC,MAAM,GAAG,wBAAwB;iBACpC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC;iBAClC,GAAG,CAAC,OAAO,IAAI;gBAChB,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM;sBACjC,CAAC,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;sBAC9B,OAAO,CAAC;gBACd,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;aAC/D,CAAC;iBACG,IAAI,CAAC,GAAG,CAAC,CAAC;SAClB;KACJ;;;IAGD,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QAClC,GAAG,GAAG,kBAAkB,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;KACtD;SACI;QACD,IAAI,MAAM,IAAI,mBAAmB,EAAE;YAC/B,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;SACnC;aACI;YACD,IAAI,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,EAAE;gBACzC,IAAI,GAAG,mBAAmB,CAAC;aAC9B;iBACI;gBACD,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;aACjC;SACJ;KACJ;;IAED,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;QACzD,OAAO,CAAC,cAAc,CAAC,GAAG,iCAAiC,CAAC;KAC/D;;;IAGD,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;QAClE,IAAI,GAAG,EAAE,CAAC;KACb;;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,OAAO,IAAI,KAAK,WAAW,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,OAAO,CAAC,OAAO,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;CACxJ;;AC9EM,SAAS,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE;IAC3D,OAAO,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;CACjD;;ACDM,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;IACnD,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC3D,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;QAC3B,QAAQ;QACR,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;QAC3C,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;QACjC,KAAK;KACR,CAAC,CAAC;CACN;;ACZM,MAAM,OAAO,GAAG,mBAAmB,CAAC;;ACE3C,MAAM,SAAS,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;;;AAGrE,AAAO,MAAM,QAAQ,GAAG;IACpB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,wBAAwB;IACjC,OAAO,EAAE;QACL,MAAM,EAAE,gCAAgC;QACxC,YAAY,EAAE,SAAS;KAC1B;IACD,SAAS,EAAE;QACP,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE,EAAE;KACf;CACJ,CAAC;;ACdU,MAAC,QAAQ,GAAG,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md new file mode 100644 index 00000000..b5185152 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md @@ -0,0 +1,5 @@ +--- +name: "🆘 Help" +about: "How does this even work 🤷‍♂️" +labels: support +--- diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md new file mode 100644 index 00000000..d7e83250 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md @@ -0,0 +1,19 @@ +--- +name: "🐛 Bug Report" +about: "If something isn't working as expected 🤔" +labels: bug +--- + + + +**What happened?** + + + +**What did you expect to happen?** + + + +**What the problem might be** + + diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md new file mode 100644 index 00000000..89a54819 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md @@ -0,0 +1,19 @@ +--- +name: "🧚‍♂️ Feature Request" +about: "Wouldn’t it be nice if 💭" +labels: feature +--- + + + +**What’s missing?** + + + +**Why?** + + + +**Alternatives you tried** + + diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md new file mode 100644 index 00000000..c67ce83b --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md @@ -0,0 +1,19 @@ +--- +name: "💝 Thank you" +about: "@octokit/types is awesome 🙌" +labels: thanks +--- + + + +**How do you use @octokit/types?** + + + +**What do you love about it?** + + + +**How did you learn about it?** + + diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/workflows/release.yml b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/workflows/release.yml new file mode 100644 index 00000000..e47f42cb --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/workflows/release.yml @@ -0,0 +1,25 @@ +name: Release +on: + push: + branches: + - master + +jobs: + release: + name: release + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: actions/setup-node@v1 + with: + node-version: "12.x" + - run: npm ci + - run: npx semantic-release + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + - run: npm run docs + - uses: maxheld83/ghpages@master + env: + BUILD_DIR: docs/ + GH_PAT: ${{ secrets.OCTOKIT_PAT }} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/workflows/routes-update.yml b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/workflows/routes-update.yml new file mode 100644 index 00000000..f1639d90 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/workflows/routes-update.yml @@ -0,0 +1,37 @@ +name: octokit/routes update +on: + repository_dispatch: + types: [octokit-routes-release] + +jobs: + update_routes: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: actions/setup-node@v1 + with: + node-version: "12.x" + # try checking out routes-update branch. Ignore error if it does not exist + - run: git checkout routes-update || true + - run: npm ci + - run: npm run update-endpoints + - name: Create Pull Request + uses: gr2m/create-or-update-pull-request-action@v1.x + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + title: "🚧 GitHub REST Endpoints changed" + body: | + See what changed at https://github.com/octokit/routes/releases/latest. + + Make sure to update the commits so that the merge results in helpful release notes, see [Merging the Pull Request & releasing a new version](https://github.com/octokit/rest.js/blob/master/CONTRIBUTING.md#merging-the-pull-request--releasing-a-new-version). + + In general + + - Avoid breaking changes at all costs + - If there are no typescript or code changes, use a `docs` prefix + - If there are typescript changes but no code changes, use `fix(typescript)` prefix + - If there are code changes, use `fix` if a problem was resolved, `feat` if new endpoints / parameters were added, and `feat(deprecation)` if a method was deprecated. + branch: "routes-update" + commit-message: "WIP octokit/routes updated" + author: "Octokit Bot <33075676+octokitbot@users.noreply.github.com>" diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/workflows/test.yml b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/workflows/test.yml new file mode 100644 index 00000000..702220fd --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/.github/workflows/test.yml @@ -0,0 +1,19 @@ +name: Test +on: + push: + branches: + - master + - "greenkeeper/*" + pull_request: + types: [opened, synchronize] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: actions/setup-node@v1 + with: + node-version: 12 + - run: npm ci + - run: npm test diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/CODE_OF_CONDUCT.md b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..8392e63e --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/CODE_OF_CONDUCT.md @@ -0,0 +1,75 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at opensource+octokit@github.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [https://contributor-covenant.org/version/1/4][version] + +[homepage]: https://contributor-covenant.org +[version]: https://contributor-covenant.org/version/1/4/ + diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/CONTRIBUTING.md b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/CONTRIBUTING.md new file mode 100644 index 00000000..6b275990 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/CONTRIBUTING.md @@ -0,0 +1,59 @@ +# How to contribute + +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). +By participating in this project you agree to abide by its terms. + +## Creating an Issue + +Before you create a new Issue: + +1. Please make sure there is no [open issue](https://github.com/octokit/plugin-paginate-rest/issues?utf8=%E2%9C%93&q=is%3Aissue) yet. +2. If it is a bug report, include the steps to reproduce the issue and please create a reproducible test case on [runkit.com](https://runkit.com/). Example: https://runkit.com/gr2m/5aa034f1440b420012a6eebf +3. If it is a feature request, please share the motivation for the new feature, what alternatives you tried, and how you would implement it. +4. Please include links to the corresponding github documentation. + +## Setup the repository locally + +First, fork the repository. + +Setup the repository locally. Replace `` with the name of the account you forked to. + +```shell +git clone https://github.com//plugin-paginate-rest.js.git +cd plugin-paginate-rest.js +npm install +``` + +Run the tests before making changes to make sure the local setup is working as expected + +```shell +npm test +``` + +## Submitting the Pull Request + +- Create a new branch locally. +- Make your changes in that branch to your fork repository +- Submit a pull request from your topic branch to the master branch on the `octokit/plugin-paginate-rest.js` repository. +- Be sure to tag any issues your pull request is taking care of / contributing to. Adding "Closes #123" to a pull request description will automatically close the issue once the pull request is merged in. + +## Testing a pull request from github repo locally: + +You can install `@octokit/plugin-paginate-rest` from each pull request. Replace `[PULL REQUEST NUMBER]` + +Once you are done testing, you can revert back to the default module `@octokit/plugin-paginate-rest` from npm with `npm install @octokit/plugin-paginate-rest` + +## Merging the Pull Request & releasing a new version + +Releases are automated using [semantic-release](https://github.com/semantic-release/semantic-release). +The following commit message conventions determine which version is released: + +1. `fix: ...` or `fix(scope name): ...` prefix in subject: bumps fix version, e.g. `1.2.3` → `1.2.4` +2. `feat: ...` or `feat(scope name): ...` prefix in subject: bumps feature version, e.g. `1.2.3` → `1.3.0` +3. `BREAKING CHANGE:` in body: bumps breaking version, e.g. `1.2.3` → `2.0.0` + +Only one version number is bumped at a time, the highest version change trumps the others. +Besides publishing a new version to npm, semantic-release also creates a git tag and release +on GitHub, generates changelogs from the commit messages and puts them into the release notes. +s +If the pull request looks good but does not follow the commit conventions, use the Squash & merge button. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/LICENSE b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/LICENSE new file mode 100644 index 00000000..57bee5f1 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/LICENSE @@ -0,0 +1,7 @@ +MIT License Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/README.md new file mode 100644 index 00000000..482dae00 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/README.md @@ -0,0 +1,19 @@ +# types.ts + +> Shared TypeScript definitions for Octokit projects + +[![@latest](https://img.shields.io/npm/v/@octokit/types.svg)](https://www.npmjs.com/package/@octokit/types) +[![Build Status](https://github.com/octokit/types.ts/workflows/Test/badge.svg)](https://github.com/octokit/types.ts/actions?workflow=Test) +[![Greenkeeper](https://badges.greenkeeper.io/octokit/types.ts.svg)](https://greenkeeper.io/) + +## Usage + +See https://octokit.github.io/types.ts for all exported types + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/package.json b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/package.json new file mode 100644 index 00000000..7f014514 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/package.json @@ -0,0 +1,62 @@ +{ + "name": "@octokit/types", + "version": "2.0.1", + "publishConfig": { + "access": "public" + }, + "description": "Shared TypeScript definitions for Octokit projects", + "main": "src/index.ts", + "scripts": { + "docs": "typedoc --module commonjs --readme none --out docs src/", + "lint": "prettier --check '{src,test}/**/*' README.md package.json !src/generated/*", + "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json !src/generated/*", + "pretest": "npm run -s lint", + "test": "./node_modules/.bin/tsc --noEmit --declaration src/index.ts", + "update-endpoints": "npm-run-all update-endpoints:*", + "update-endpoints:fetch-json": "node scripts/update-endpoints/fetch-json", + "update-endpoints:typescript": "node scripts/update-endpoints/typescript" + }, + "repository": "https://github.com/octokit/types.ts", + "keywords": [ + "github", + "api", + "sdk", + "toolkit", + "typescript" + ], + "author": "Gregor Martynus (https://twitter.com/gr2m)", + "license": "MIT", + "devDependencies": { + "@octokit/graphql": "^4.2.2", + "handlebars": "^4.4.5", + "lodash.set": "^4.3.2", + "npm-run-all": "^4.1.5", + "pascal-case": "^2.0.1", + "prettier": "^1.18.2", + "semantic-release": "^15.13.24", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "sort-keys": "^4.0.0", + "string-to-jsdoc-comment": "^1.0.0", + "typedoc": "^0.15.0", + "typescript": "^3.6.4" + }, + "release": { + "plugins": [ + "@semantic-release/commit-analyzer", + "@semantic-release/release-notes-generator", + "@semantic-release/github", + "@semantic-release/npm", + [ + "semantic-release-plugin-update-version-in-files", + { + "files": [ + "src/VERSION.ts" + ] + } + ] + ] + }, + "dependencies": { + "@types/node": ">= 8" + } +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js new file mode 100644 index 00000000..6bca9300 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js @@ -0,0 +1,41 @@ +const { writeFileSync } = require("fs"); +const path = require("path"); + +const { graphql } = require("@octokit/graphql"); +const prettier = require("prettier"); + +const QUERY = ` + { + endpoints { + name + scope(format: CAMELCASE) + id(format: CAMELCASE) + method + url + parameters { + alias + allowNull + deprecated + description + enum + name + type + required + } + } + }`; + +main(); + +async function main() { + const { endpoints } = await graphql(QUERY, { + url: "https://octokit-routes-graphql-server.now.sh/" + }); + + writeFileSync( + path.resolve(__dirname, "generated", "endpoints.json"), + prettier.format(JSON.stringify(endpoints), { + parser: "json" + }) + ); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md new file mode 100644 index 00000000..6beaf58e --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md @@ -0,0 +1,3 @@ +# DO NOT EDIT FILES IN THIS DIRECTORY + +All files are generated automatically and will be overwritten next time [octokit/routes](https://github.com/octokit/routes/) has a new release. If you find a problem, please file an issue. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json new file mode 100644 index 00000000..6c3d62a3 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json @@ -0,0 +1,25258 @@ +[ + { + "name": "Get the authenticated GitHub App", + "scope": "apps", + "id": "getAuthenticated", + "method": "GET", + "url": "/app", + "parameters": [] + }, + { + "name": "Create a GitHub App from a manifest", + "scope": "apps", + "id": "createFromManifest", + "method": "POST", + "url": "/app-manifests/{code}/conversions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "code parameter", + "enum": null, + "name": "code", + "type": "string", + "required": true + } + ] + }, + { + "name": "List installations", + "scope": "apps", + "id": "listInstallations", + "method": "GET", + "url": "/app/installations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get an installation", + "scope": "apps", + "id": "getInstallation", + "method": "GET", + "url": "/app/installations/{installation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete an installation", + "scope": "apps", + "id": "deleteInstallation", + "method": "DELETE", + "url": "/app/installations/{installation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Create a new installation token", + "scope": "apps", + "id": "createInstallationToken", + "method": "POST", + "url": "/app/installations/{installation_id}/access_tokens", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the \"[List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)\" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.", + "enum": null, + "name": "repository_ids", + "type": "integer[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see \"[GitHub App permissions](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions).\"", + "enum": null, + "name": "permissions", + "type": "object", + "required": false + } + ] + }, + { + "name": "List your grants", + "scope": "oauthAuthorizations", + "id": "listGrants", + "method": "GET", + "url": "/applications/grants", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single grant", + "scope": "oauthAuthorizations", + "id": "getGrant", + "method": "GET", + "url": "/applications/grants/{grant_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "grant_id parameter", + "enum": null, + "name": "grant_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a grant", + "scope": "oauthAuthorizations", + "id": "deleteGrant", + "method": "DELETE", + "url": "/applications/grants/{grant_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "grant_id parameter", + "enum": null, + "name": "grant_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Revoke a grant for an application", + "scope": "oauthAuthorizations", + "id": "revokeGrantForApplication", + "method": "DELETE", + "url": "/applications/{client_id}/grants/{access_token}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "access_token parameter", + "enum": null, + "name": "access_token", + "type": "string", + "required": true + } + ] + }, + { + "name": "Check an authorization", + "scope": "oauthAuthorizations", + "id": "checkAuthorization", + "method": "GET", + "url": "/applications/{client_id}/tokens/{access_token}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "access_token parameter", + "enum": null, + "name": "access_token", + "type": "string", + "required": true + } + ] + }, + { + "name": "Reset an authorization", + "scope": "oauthAuthorizations", + "id": "resetAuthorization", + "method": "POST", + "url": "/applications/{client_id}/tokens/{access_token}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "access_token parameter", + "enum": null, + "name": "access_token", + "type": "string", + "required": true + } + ] + }, + { + "name": "Revoke an authorization for an application", + "scope": "oauthAuthorizations", + "id": "revokeAuthorizationForApplication", + "method": "DELETE", + "url": "/applications/{client_id}/tokens/{access_token}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "access_token parameter", + "enum": null, + "name": "access_token", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single GitHub App", + "scope": "apps", + "id": "getBySlug", + "method": "GET", + "url": "/apps/{app_slug}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "app_slug parameter", + "enum": null, + "name": "app_slug", + "type": "string", + "required": true + } + ] + }, + { + "name": "List your authorizations", + "scope": "oauthAuthorizations", + "id": "listAuthorizations", + "method": "GET", + "url": "/authorizations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a new authorization", + "scope": "oauthAuthorizations", + "id": "createAuthorization", + "method": "POST", + "url": "/authorizations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes that this authorization is in.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.", + "enum": null, + "name": "note", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 20 character OAuth app client key for which to create the token.", + "enum": null, + "name": "client_id", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 40 character OAuth app client secret for which to create the token.", + "enum": null, + "name": "client_secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get-or-create an authorization for a specific app", + "scope": "oauthAuthorizations", + "id": "getOrCreateAuthorizationForApp", + "method": "PUT", + "url": "/authorizations/clients/{client_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", + "enum": null, + "name": "client_secret", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes that this authorization is in.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get-or-create an authorization for a specific app and fingerprint", + "scope": "oauthAuthorizations", + "id": "getOrCreateAuthorizationForAppAndFingerprint", + "method": "PUT", + "url": "/authorizations/clients/{client_id}/{fingerprint}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "fingerprint parameter", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", + "enum": null, + "name": "client_secret", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes that this authorization is in.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get-or-create an authorization for a specific app and fingerprint", + "scope": "oauthAuthorizations", + "id": "getOrCreateAuthorizationForAppFingerprint", + "method": "PUT", + "url": "/authorizations/clients/{client_id}/{fingerprint}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "fingerprint parameter", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", + "enum": null, + "name": "client_secret", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes that this authorization is in.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single authorization", + "scope": "oauthAuthorizations", + "id": "getAuthorization", + "method": "GET", + "url": "/authorizations/{authorization_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "authorization_id parameter", + "enum": null, + "name": "authorization_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update an existing authorization", + "scope": "oauthAuthorizations", + "id": "updateAuthorization", + "method": "PATCH", + "url": "/authorizations/{authorization_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "authorization_id parameter", + "enum": null, + "name": "authorization_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Replaces the authorization scopes with these.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes to add to this authorization.", + "enum": null, + "name": "add_scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes to remove from this authorization.", + "enum": null, + "name": "remove_scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete an authorization", + "scope": "oauthAuthorizations", + "id": "deleteAuthorization", + "method": "DELETE", + "url": "/authorizations/{authorization_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "authorization_id parameter", + "enum": null, + "name": "authorization_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List all codes of conduct", + "scope": "codesOfConduct", + "id": "listConductCodes", + "method": "GET", + "url": "/codes_of_conduct", + "parameters": [] + }, + { + "name": "Get an individual code of conduct", + "scope": "codesOfConduct", + "id": "getConductCode", + "method": "GET", + "url": "/codes_of_conduct/{key}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key parameter", + "enum": null, + "name": "key", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a content attachment", + "scope": "apps", + "id": "createContentAttachment", + "method": "POST", + "url": "/content_references/{content_reference_id}/attachments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "content_reference_id parameter", + "enum": null, + "name": "content_reference_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the content attachment displayed in the body or comment of an issue or pull request.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get", + "scope": "emojis", + "id": "get", + "method": "GET", + "url": "/emojis", + "parameters": [] + }, + { + "name": "List public events", + "scope": "activity", + "id": "listPublicEvents", + "method": "GET", + "url": "/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List feeds", + "scope": "activity", + "id": "listFeeds", + "method": "GET", + "url": "/feeds", + "parameters": [] + }, + { + "name": "List the authenticated user's gists or if called anonymously, this will return all public gists", + "scope": "gists", + "id": "list", + "method": "GET", + "url": "/gists", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a gist", + "scope": "gists", + "id": "create", + "method": "POST", + "url": "/gists", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`.", + "enum": null, + "name": "files", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The content of the file.", + "enum": null, + "name": "files.content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A descriptive name for this gist.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "When `true`, the gist will be public and available for anyone to see.", + "enum": null, + "name": "public", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List all public gists", + "scope": "gists", + "id": "listPublic", + "method": "GET", + "url": "/gists/public", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List starred gists", + "scope": "gists", + "id": "listStarred", + "method": "GET", + "url": "/gists/starred", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single gist", + "scope": "gists", + "id": "get", + "method": "GET", + "url": "/gists/{gist_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "Edit a gist", + "scope": "gists", + "id": "update", + "method": "PATCH", + "url": "/gists/{gist_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A descriptive name for this gist.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The filenames and content that make up this gist.", + "enum": null, + "name": "files", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The updated content of the file.", + "enum": null, + "name": "files.content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new name for this file. To delete a file, set the value of the filename to `null`.", + "enum": null, + "name": "files.filename", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete a gist", + "scope": "gists", + "id": "delete", + "method": "DELETE", + "url": "/gists/{gist_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "List comments on a gist", + "scope": "gists", + "id": "listComments", + "method": "GET", + "url": "/gists/{gist_id}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a comment", + "scope": "gists", + "id": "createComment", + "method": "POST", + "url": "/gists/{gist_id}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The comment text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single comment", + "scope": "gists", + "id": "getComment", + "method": "GET", + "url": "/gists/{gist_id}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a comment", + "scope": "gists", + "id": "updateComment", + "method": "PATCH", + "url": "/gists/{gist_id}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The comment text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a comment", + "scope": "gists", + "id": "deleteComment", + "method": "DELETE", + "url": "/gists/{gist_id}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List gist commits", + "scope": "gists", + "id": "listCommits", + "method": "GET", + "url": "/gists/{gist_id}/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Fork a gist", + "scope": "gists", + "id": "fork", + "method": "POST", + "url": "/gists/{gist_id}/forks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "List gist forks", + "scope": "gists", + "id": "listForks", + "method": "GET", + "url": "/gists/{gist_id}/forks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Star a gist", + "scope": "gists", + "id": "star", + "method": "PUT", + "url": "/gists/{gist_id}/star", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unstar a gist", + "scope": "gists", + "id": "unstar", + "method": "DELETE", + "url": "/gists/{gist_id}/star", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "Check if a gist is starred", + "scope": "gists", + "id": "checkIsStarred", + "method": "GET", + "url": "/gists/{gist_id}/star", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a specific revision of a gist", + "scope": "gists", + "id": "getRevision", + "method": "GET", + "url": "/gists/{gist_id}/{sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "sha parameter", + "enum": null, + "name": "sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Listing available templates", + "scope": "gitignore", + "id": "listTemplates", + "method": "GET", + "url": "/gitignore/templates", + "parameters": [] + }, + { + "name": "Get a single template", + "scope": "gitignore", + "id": "getTemplate", + "method": "GET", + "url": "/gitignore/templates/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "List repositories", + "scope": "apps", + "id": "listRepos", + "method": "GET", + "url": "/installation/repositories", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories", + "scope": "issues", + "id": "list", + "method": "GET", + "url": "/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "enum": null, + "name": "labels", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "enum": ["created", "updated", "comments"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search issues", + "scope": "search", + "id": "issuesLegacy", + "method": "GET", + "url": "/legacy/issues/search/{owner}/{repository}/{state}/{keyword}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repository parameter", + "enum": null, + "name": "repository", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The search term.", + "enum": null, + "name": "keyword", + "type": "string", + "required": true + } + ] + }, + { + "name": "Search repositories", + "scope": "search", + "id": "reposLegacy", + "method": "GET", + "url": "/legacy/repos/search/{keyword}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The search term.", + "enum": null, + "name": "keyword", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter results by language.", + "enum": null, + "name": "language", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The page number to fetch.", + "enum": null, + "name": "start_page", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", + "enum": ["stars", "forks", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "order", + "type": "string", + "required": false + } + ] + }, + { + "name": "Email search", + "scope": "search", + "id": "emailLegacy", + "method": "GET", + "url": "/legacy/user/email/{email}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email address.", + "enum": null, + "name": "email", + "type": "string", + "required": true + } + ] + }, + { + "name": "Search users", + "scope": "search", + "id": "usersLegacy", + "method": "GET", + "url": "/legacy/user/search/{keyword}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The search term.", + "enum": null, + "name": "keyword", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The page number to fetch.", + "enum": null, + "name": "start_page", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", + "enum": ["stars", "forks", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "order", + "type": "string", + "required": false + } + ] + }, + { + "name": "List commonly used licenses", + "scope": "licenses", + "id": "listCommonlyUsed", + "method": "GET", + "url": "/licenses", + "parameters": [] + }, + { + "name": "List commonly used licenses", + "scope": "licenses", + "id": "list", + "method": "GET", + "url": "/licenses", + "parameters": [] + }, + { + "name": "Get an individual license", + "scope": "licenses", + "id": "get", + "method": "GET", + "url": "/licenses/{license}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "license parameter", + "enum": null, + "name": "license", + "type": "string", + "required": true + } + ] + }, + { + "name": "Render an arbitrary Markdown document", + "scope": "markdown", + "id": "render", + "method": "POST", + "url": "/markdown", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.", + "enum": null, + "name": "text", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The rendering mode. Can be either: \n\\* `markdown` to render a document in plain Markdown, just like README.md files are rendered. \n\\* `gfm` to render a document in [GitHub Flavored Markdown](https://github.github.com/gfm/), which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.", + "enum": ["markdown", "gfm"], + "name": "mode", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.", + "enum": null, + "name": "context", + "type": "string", + "required": false + } + ] + }, + { + "name": "Render a Markdown document in raw mode", + "scope": "markdown", + "id": "renderRaw", + "method": "POST", + "url": "/markdown/raw", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "data parameter", + "enum": null, + "name": "data", + "type": "string", + "required": true + } + ] + }, + { + "name": "Check if a GitHub account is associated with any Marketplace listing", + "scope": "apps", + "id": "checkAccountIsAssociatedWithAny", + "method": "GET", + "url": "/marketplace_listing/accounts/{account_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "account_id parameter", + "enum": null, + "name": "account_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all plans for your Marketplace listing", + "scope": "apps", + "id": "listPlans", + "method": "GET", + "url": "/marketplace_listing/plans", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all GitHub accounts (user or organization) on a specific plan", + "scope": "apps", + "id": "listAccountsUserOrOrgOnPlan", + "method": "GET", + "url": "/marketplace_listing/plans/{plan_id}/accounts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "plan_id parameter", + "enum": null, + "name": "plan_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if a GitHub account is associated with any Marketplace listing (stubbed)", + "scope": "apps", + "id": "checkAccountIsAssociatedWithAnyStubbed", + "method": "GET", + "url": "/marketplace_listing/stubbed/accounts/{account_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "account_id parameter", + "enum": null, + "name": "account_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all plans for your Marketplace listing (stubbed)", + "scope": "apps", + "id": "listPlansStubbed", + "method": "GET", + "url": "/marketplace_listing/stubbed/plans", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all GitHub accounts (user or organization) on a specific plan (stubbed)", + "scope": "apps", + "id": "listAccountsUserOrOrgOnPlanStubbed", + "method": "GET", + "url": "/marketplace_listing/stubbed/plans/{plan_id}/accounts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "plan_id parameter", + "enum": null, + "name": "plan_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get", + "scope": "meta", + "id": "get", + "method": "GET", + "url": "/meta", + "parameters": [] + }, + { + "name": "List public events for a network of repositories", + "scope": "activity", + "id": "listPublicEventsForRepoNetwork", + "method": "GET", + "url": "/networks/{owner}/{repo}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List your notifications", + "scope": "activity", + "id": "listNotifications", + "method": "GET", + "url": "/notifications", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, show notifications marked as read.", + "enum": null, + "name": "all", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", + "enum": null, + "name": "participating", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "before", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Mark as read", + "scope": "activity", + "id": "markAsRead", + "method": "PUT", + "url": "/notifications", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", + "enum": null, + "name": "last_read_at", + "type": "string", + "required": false + } + ] + }, + { + "name": "View a single thread", + "scope": "activity", + "id": "getThread", + "method": "GET", + "url": "/notifications/threads/{thread_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Mark a thread as read", + "scope": "activity", + "id": "markThreadAsRead", + "method": "PATCH", + "url": "/notifications/threads/{thread_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get a thread subscription", + "scope": "activity", + "id": "getThreadSubscription", + "method": "GET", + "url": "/notifications/threads/{thread_id}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Set a thread subscription", + "scope": "activity", + "id": "setThreadSubscription", + "method": "PUT", + "url": "/notifications/threads/{thread_id}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.", + "enum": null, + "name": "ignored", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a thread subscription", + "scope": "activity", + "id": "deleteThreadSubscription", + "method": "DELETE", + "url": "/notifications/threads/{thread_id}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List all organizations", + "scope": "orgs", + "id": "list", + "method": "GET", + "url": "/organizations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The integer ID of the last Organization that you've seen.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get an organization", + "scope": "orgs", + "id": "get", + "method": "GET", + "url": "/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Edit an organization", + "scope": "orgs", + "id": "update", + "method": "PATCH", + "url": "/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Billing email address. This address is not publicized.", + "enum": null, + "name": "billing_email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The company name.", + "enum": null, + "name": "company", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The publicly visible email address.", + "enum": null, + "name": "email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The location.", + "enum": null, + "name": "location", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The shorthand name of the company.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the company.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Toggles whether organization projects are enabled for the organization.", + "enum": null, + "name": "has_organization_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Toggles whether repository projects are enabled for repositories that belong to the organization.", + "enum": null, + "name": "has_repository_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.", + "enum": ["read", "write", "admin", "none"], + "name": "default_repository_permission", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only admin members can create repositories. \nDefault: `true` \n**Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", + "enum": null, + "name": "members_can_create_repositories", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). \n\\* `none` - only admin members can create repositories. \n**Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", + "enum": ["all", "private", "none"], + "name": "members_allowed_repository_creation_type", + "type": "string", + "required": false + } + ] + }, + { + "name": "List blocked users", + "scope": "orgs", + "id": "listBlockedUsers", + "method": "GET", + "url": "/orgs/{org}/blocks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Check whether a user is blocked from an organization", + "scope": "orgs", + "id": "checkBlockedUser", + "method": "GET", + "url": "/orgs/{org}/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Block a user", + "scope": "orgs", + "id": "blockUser", + "method": "PUT", + "url": "/orgs/{org}/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unblock a user", + "scope": "orgs", + "id": "unblockUser", + "method": "DELETE", + "url": "/orgs/{org}/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List credential authorizations for an organization", + "scope": "orgs", + "id": "listCredentialAuthorizations", + "method": "GET", + "url": "/orgs/{org}/credential-authorizations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove a credential authorization for an organization", + "scope": "orgs", + "id": "removeCredentialAuthorization", + "method": "DELETE", + "url": "/orgs/{org}/credential-authorizations/{credential_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "credential_id parameter", + "enum": null, + "name": "credential_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List public events for an organization", + "scope": "activity", + "id": "listPublicEventsForOrg", + "method": "GET", + "url": "/orgs/{org}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List hooks", + "scope": "orgs", + "id": "listHooks", + "method": "GET", + "url": "/orgs/{org}/hooks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a hook", + "scope": "orgs", + "id": "createHook", + "method": "POST", + "url": "/orgs/{org}/hooks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Must be passed as \"web\".", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params).", + "enum": null, + "name": "config", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL to which the payloads will be delivered.", + "enum": null, + "name": "config.url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "enum": null, + "name": "config.content_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "enum": null, + "name": "config.secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "enum": null, + "name": "config.insecure_ssl", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", + "enum": null, + "name": "events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "enum": null, + "name": "active", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get single hook", + "scope": "orgs", + "id": "getHook", + "method": "GET", + "url": "/orgs/{org}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a hook", + "scope": "orgs", + "id": "updateHook", + "method": "PATCH", + "url": "/orgs/{org}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params).", + "enum": null, + "name": "config", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL to which the payloads will be delivered.", + "enum": null, + "name": "config.url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "enum": null, + "name": "config.content_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "enum": null, + "name": "config.secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "enum": null, + "name": "config.insecure_ssl", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", + "enum": null, + "name": "events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "enum": null, + "name": "active", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a hook", + "scope": "orgs", + "id": "deleteHook", + "method": "DELETE", + "url": "/orgs/{org}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Ping a hook", + "scope": "orgs", + "id": "pingHook", + "method": "POST", + "url": "/orgs/{org}/hooks/{hook_id}/pings", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get an organization installation", + "scope": "apps", + "id": "getOrgInstallation", + "method": "GET", + "url": "/orgs/{org}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get an organization installation", + "scope": "apps", + "id": "findOrgInstallation", + "method": "GET", + "url": "/orgs/{org}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get interaction restrictions for an organization", + "scope": "interactions", + "id": "getRestrictionsForOrg", + "method": "GET", + "url": "/orgs/{org}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update interaction restrictions for an organization", + "scope": "interactions", + "id": "addOrUpdateRestrictionsForOrg", + "method": "PUT", + "url": "/orgs/{org}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", + "enum": ["existing_users", "contributors_only", "collaborators_only"], + "name": "limit", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove interaction restrictions for an organization", + "scope": "interactions", + "id": "removeRestrictionsForOrg", + "method": "DELETE", + "url": "/orgs/{org}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "List pending organization invitations", + "scope": "orgs", + "id": "listPendingInvitations", + "method": "GET", + "url": "/orgs/{org}/invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create organization invitation", + "scope": "orgs", + "id": "createInvitation", + "method": "POST", + "url": "/orgs/{org}/invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting.", + "enum": null, + "name": "invitee_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.", + "enum": null, + "name": "email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify role for new member. Can be one of: \n\\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n\\* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n\\* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.", + "enum": ["admin", "direct_member", "billing_manager"], + "name": "role", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify IDs for the teams you want to invite new members to.", + "enum": null, + "name": "team_ids", + "type": "integer[]", + "required": false + } + ] + }, + { + "name": "List organization invitation teams", + "scope": "orgs", + "id": "listInvitationTeams", + "method": "GET", + "url": "/orgs/{org}/invitations/{invitation_id}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all issues for a given organization assigned to the authenticated user", + "scope": "issues", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "enum": null, + "name": "labels", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "enum": ["created", "updated", "comments"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Members list", + "scope": "orgs", + "id": "listMembers", + "method": "GET", + "url": "/orgs/{org}/members", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", + "enum": ["2fa_disabled", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", + "enum": ["all", "admin", "member"], + "name": "role", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check membership", + "scope": "orgs", + "id": "checkMembership", + "method": "GET", + "url": "/orgs/{org}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove a member", + "scope": "orgs", + "id": "removeMember", + "method": "DELETE", + "url": "/orgs/{org}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get organization membership", + "scope": "orgs", + "id": "getMembership", + "method": "GET", + "url": "/orgs/{org}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update organization membership", + "scope": "orgs", + "id": "addOrUpdateMembership", + "method": "PUT", + "url": "/orgs/{org}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", + "enum": ["admin", "member"], + "name": "role", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove organization membership", + "scope": "orgs", + "id": "removeMembership", + "method": "DELETE", + "url": "/orgs/{org}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Start an organization migration", + "scope": "migrations", + "id": "startForOrg", + "method": "POST", + "url": "/orgs/{org}/migrations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of arrays indicating which repositories should be migrated.", + "enum": null, + "name": "repositories", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", + "enum": null, + "name": "lock_repositories", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", + "enum": null, + "name": "exclude_attachments", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a list of organization migrations", + "scope": "migrations", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/migrations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the status of an organization migration", + "scope": "migrations", + "id": "getStatusForOrg", + "method": "GET", + "url": "/orgs/{org}/migrations/{migration_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Download an organization migration archive", + "scope": "migrations", + "id": "getArchiveForOrg", + "method": "GET", + "url": "/orgs/{org}/migrations/{migration_id}/archive", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete an organization migration archive", + "scope": "migrations", + "id": "deleteArchiveForOrg", + "method": "DELETE", + "url": "/orgs/{org}/migrations/{migration_id}/archive", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Unlock an organization repository", + "scope": "migrations", + "id": "unlockRepoForOrg", + "method": "DELETE", + "url": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo_name parameter", + "enum": null, + "name": "repo_name", + "type": "string", + "required": true + } + ] + }, + { + "name": "List outside collaborators", + "scope": "orgs", + "id": "listOutsideCollaborators", + "method": "GET", + "url": "/orgs/{org}/outside_collaborators", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", + "enum": ["2fa_disabled", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Remove outside collaborator", + "scope": "orgs", + "id": "removeOutsideCollaborator", + "method": "DELETE", + "url": "/orgs/{org}/outside_collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Convert member to outside collaborator", + "scope": "orgs", + "id": "convertMemberToOutsideCollaborator", + "method": "PUT", + "url": "/orgs/{org}/outside_collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List organization projects", + "scope": "projects", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create an organization project", + "scope": "projects", + "id": "createForOrg", + "method": "POST", + "url": "/orgs/{org}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the project.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the project.", + "enum": null, + "name": "body", + "type": "string", + "required": false + } + ] + }, + { + "name": "Public members list", + "scope": "orgs", + "id": "listPublicMembers", + "method": "GET", + "url": "/orgs/{org}/public_members", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check public membership", + "scope": "orgs", + "id": "checkPublicMembership", + "method": "GET", + "url": "/orgs/{org}/public_members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Publicize a user's membership", + "scope": "orgs", + "id": "publicizeMembership", + "method": "PUT", + "url": "/orgs/{org}/public_members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Conceal a user's membership", + "scope": "orgs", + "id": "concealMembership", + "method": "DELETE", + "url": "/orgs/{org}/public_members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List organization repositories", + "scope": "repos", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`.", + "enum": ["all", "public", "private", "forks", "sources", "member"], + "name": "type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "enum": ["created", "updated", "pushed", "full_name"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Creates a new repository in the specified organization", + "scope": "repos", + "id": "createInOrg", + "method": "POST", + "url": "/orgs/{org}/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the repository.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the repository.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL with more information about the repository.", + "enum": null, + "name": "homepage", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "enum": null, + "name": "has_issues", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "enum": null, + "name": "has_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "enum": null, + "name": "has_wiki", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "enum": null, + "name": "is_template", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", + "enum": null, + "name": "team_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Pass `true` to create an initial commit with empty README.", + "enum": null, + "name": "auto_init", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", + "enum": null, + "name": "gitignore_template", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", + "enum": null, + "name": "license_template", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "enum": null, + "name": "allow_squash_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "enum": null, + "name": "allow_merge_commit", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "enum": null, + "name": "allow_rebase_merge", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List IdP groups in an organization", + "scope": "teams", + "id": "listIdPGroupsForOrg", + "method": "GET", + "url": "/orgs/{org}/team-sync/groups", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List teams", + "scope": "teams", + "id": "list", + "method": "GET", + "url": "/orgs/{org}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create team", + "scope": "teams", + "id": "create", + "method": "POST", + "url": "/orgs/{org}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the team.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the team.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The logins of organization members to add as maintainers of the team.", + "enum": null, + "name": "maintainers", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", + "enum": null, + "name": "repo_names", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed` \n**Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams.", + "enum": ["secret", "closed"], + "name": "privacy", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "enum": ["pull", "push", "admin"], + "name": "permission", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.", + "enum": null, + "name": "parent_team_id", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get team by name", + "scope": "teams", + "id": "getByName", + "method": "GET", + "url": "/orgs/{org}/teams/{team_slug}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_slug parameter", + "enum": null, + "name": "team_slug", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a project card", + "scope": "projects", + "id": "getCard", + "method": "GET", + "url": "/projects/columns/cards/{card_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "card_id parameter", + "enum": null, + "name": "card_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update a project card", + "scope": "projects", + "id": "updateCard", + "method": "PATCH", + "url": "/projects/columns/cards/{card_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "card_id parameter", + "enum": null, + "name": "card_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card.", + "enum": null, + "name": "archived", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a project card", + "scope": "projects", + "id": "deleteCard", + "method": "DELETE", + "url": "/projects/columns/cards/{card_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "card_id parameter", + "enum": null, + "name": "card_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Move a project card", + "scope": "projects", + "id": "moveCard", + "method": "POST", + "url": "/projects/columns/cards/{card_id}/moves", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "card_id parameter", + "enum": null, + "name": "card_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `top`, `bottom`, or `after:`, where `` is the `id` value of a card in the same column, or in the new column specified by `column_id`.", + "enum": null, + "name": "position", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The `id` value of a column in the same project.", + "enum": null, + "name": "column_id", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a project column", + "scope": "projects", + "id": "getColumn", + "method": "GET", + "url": "/projects/columns/{column_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update a project column", + "scope": "projects", + "id": "updateColumn", + "method": "PATCH", + "url": "/projects/columns/{column_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new name of the column.", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a project column", + "scope": "projects", + "id": "deleteColumn", + "method": "DELETE", + "url": "/projects/columns/{column_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List project cards", + "scope": "projects", + "id": "listCards", + "method": "GET", + "url": "/projects/columns/{column_id}/cards", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", + "enum": ["all", "archived", "not_archived"], + "name": "archived_state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a project card", + "scope": "projects", + "id": "createCard", + "method": "POST", + "url": "/projects/columns/{column_id}/cards", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The card's note content. Only valid for cards without another type of content, so you must omit when specifying `content_id` and `content_type`.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. \n**Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`.", + "enum": null, + "name": "content_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id.", + "enum": null, + "name": "content_type", + "type": "string", + "required": false + } + ] + }, + { + "name": "Move a project column", + "scope": "projects", + "id": "moveColumn", + "method": "POST", + "url": "/projects/columns/{column_id}/moves", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project.", + "enum": null, + "name": "position", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a project", + "scope": "projects", + "id": "get", + "method": "GET", + "url": "/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Update a project", + "scope": "projects", + "id": "update", + "method": "PATCH", + "url": "/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the project.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the project.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "State of the project. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project](https://developer.github.com/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). \n \n**Note:** Updating a project's `organization_permission` requires `admin` access to the project. \n \nCan be one of: \n\\* `read` - Organization members can read, but not write to or administer this project. \n\\* `write` - Organization members can read and write, but not administer this project. \n\\* `admin` - Organization members can read, write and administer this project. \n\\* `none` - Organization members can only see this project if it is public.", + "enum": null, + "name": "organization_permission", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. \n \nCan be one of: \n\\* `false` - Anyone can see the project. \n\\* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a project", + "scope": "projects", + "id": "delete", + "method": "DELETE", + "url": "/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List collaborators", + "scope": "projects", + "id": "listCollaborators", + "method": "GET", + "url": "/projects/{project_id}/collaborators", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", + "enum": ["outside", "direct", "all"], + "name": "affiliation", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Add user as a collaborator", + "scope": "projects", + "id": "addCollaborator", + "method": "PUT", + "url": "/projects/{project_id}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\" Can be one of: \n\\* `read` - can read, but not write to or administer this project. \n\\* `write` - can read and write, but not administer this project. \n\\* `admin` - can read, write and administer this project.", + "enum": ["read", "write", "admin"], + "name": "permission", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove user as a collaborator", + "scope": "projects", + "id": "removeCollaborator", + "method": "DELETE", + "url": "/projects/{project_id}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Review a user's permission level", + "scope": "projects", + "id": "reviewUserPermissionLevel", + "method": "GET", + "url": "/projects/{project_id}/collaborators/{username}/permission", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List project columns", + "scope": "projects", + "id": "listColumns", + "method": "GET", + "url": "/projects/{project_id}/columns", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a project column", + "scope": "projects", + "id": "createColumn", + "method": "POST", + "url": "/projects/{project_id}/columns", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the column.", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get your current rate limit status", + "scope": "rateLimit", + "id": "get", + "method": "GET", + "url": "/rate_limit", + "parameters": [] + }, + { + "name": "Delete a reaction", + "scope": "reactions", + "id": "delete", + "method": "DELETE", + "url": "/reactions/{reaction_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "reaction_id parameter", + "enum": null, + "name": "reaction_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get", + "scope": "repos", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Edit", + "scope": "repos", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the repository.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the repository.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL with more information about the repository.", + "enum": null, + "name": "homepage", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "enum": null, + "name": "has_issues", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "enum": null, + "name": "has_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "enum": null, + "name": "has_wiki", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "enum": null, + "name": "is_template", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Updates the default branch for this repository.", + "enum": null, + "name": "default_branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "enum": null, + "name": "allow_squash_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "enum": null, + "name": "allow_merge_commit", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "enum": null, + "name": "allow_rebase_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "enum": null, + "name": "archived", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a repository", + "scope": "repos", + "id": "delete", + "method": "DELETE", + "url": "/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List assignees", + "scope": "issues", + "id": "listAssignees", + "method": "GET", + "url": "/repos/{owner}/{repo}/assignees", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check assignee", + "scope": "issues", + "id": "checkAssignee", + "method": "GET", + "url": "/repos/{owner}/{repo}/assignees/{assignee}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "assignee parameter", + "enum": null, + "name": "assignee", + "type": "string", + "required": true + } + ] + }, + { + "name": "Enable automated security fixes", + "scope": "repos", + "id": "enableAutomatedSecurityFixes", + "method": "PUT", + "url": "/repos/{owner}/{repo}/automated-security-fixes", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Disable automated security fixes", + "scope": "repos", + "id": "disableAutomatedSecurityFixes", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/automated-security-fixes", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List branches", + "scope": "repos", + "id": "listBranches", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", + "enum": null, + "name": "protected", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get branch", + "scope": "repos", + "id": "getBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get branch protection", + "scope": "repos", + "id": "getBranchProtection", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update branch protection", + "scope": "repos", + "id": "updateBranchProtection", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "Require status checks to pass before merging. Set to `null` to disable.", + "enum": null, + "name": "required_status_checks", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Require branches to be up to date before merging.", + "enum": null, + "name": "required_status_checks.strict", + "type": "boolean", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of status checks to require in order to merge into this branch", + "enum": null, + "name": "required_status_checks.contexts", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", + "enum": null, + "name": "enforce_admins", + "type": "boolean", + "required": true + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", + "enum": null, + "name": "required_pull_request_reviews", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "enum": null, + "name": "required_pull_request_reviews.dismissal_restrictions", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of user `login`s with dismissal access", + "enum": null, + "name": "required_pull_request_reviews.dismissal_restrictions.users", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of team `slug`s with dismissal access", + "enum": null, + "name": "required_pull_request_reviews.dismissal_restrictions.teams", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "enum": null, + "name": "required_pull_request_reviews.dismiss_stale_reviews", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", + "enum": null, + "name": "required_pull_request_reviews.require_code_owner_reviews", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "enum": null, + "name": "required_pull_request_reviews.required_approving_review_count", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "Restrict who can push to this branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", + "enum": null, + "name": "restrictions", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of user `login`s with push access", + "enum": null, + "name": "restrictions.users", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of team `slug`s with push access", + "enum": null, + "name": "restrictions.teams", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of app `slug`s with push access", + "enum": null, + "name": "restrictions.apps", + "type": "string[]", + "required": false + } + ] + }, + { + "name": "Remove branch protection", + "scope": "repos", + "id": "removeBranchProtection", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get admin enforcement of protected branch", + "scope": "repos", + "id": "getProtectedBranchAdminEnforcement", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add admin enforcement of protected branch", + "scope": "repos", + "id": "addProtectedBranchAdminEnforcement", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove admin enforcement of protected branch", + "scope": "repos", + "id": "removeProtectedBranchAdminEnforcement", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get pull request review enforcement of protected branch", + "scope": "repos", + "id": "getProtectedBranchPullRequestReviewEnforcement", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update pull request review enforcement of protected branch", + "scope": "repos", + "id": "updateProtectedBranchPullRequestReviewEnforcement", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "enum": null, + "name": "dismissal_restrictions", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of user `login`s with dismissal access", + "enum": null, + "name": "dismissal_restrictions.users", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of team `slug`s with dismissal access", + "enum": null, + "name": "dismissal_restrictions.teams", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "enum": null, + "name": "dismiss_stale_reviews", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", + "enum": null, + "name": "require_code_owner_reviews", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "enum": null, + "name": "required_approving_review_count", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Remove pull request review enforcement of protected branch", + "scope": "repos", + "id": "removeProtectedBranchPullRequestReviewEnforcement", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get required signatures of protected branch", + "scope": "repos", + "id": "getProtectedBranchRequiredSignatures", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add required signatures of protected branch", + "scope": "repos", + "id": "addProtectedBranchRequiredSignatures", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove required signatures of protected branch", + "scope": "repos", + "id": "removeProtectedBranchRequiredSignatures", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get required status checks of protected branch", + "scope": "repos", + "id": "getProtectedBranchRequiredStatusChecks", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update required status checks of protected branch", + "scope": "repos", + "id": "updateProtectedBranchRequiredStatusChecks", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Require branches to be up to date before merging.", + "enum": null, + "name": "strict", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of status checks to require in order to merge into this branch", + "enum": null, + "name": "contexts", + "type": "string[]", + "required": false + } + ] + }, + { + "name": "Remove required status checks of protected branch", + "scope": "repos", + "id": "removeProtectedBranchRequiredStatusChecks", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "List required status checks contexts of protected branch", + "scope": "repos", + "id": "listProtectedBranchRequiredStatusChecksContexts", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace required status checks contexts of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchRequiredStatusChecksContexts", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "contexts parameter", + "enum": null, + "name": "contexts", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Add required status checks contexts of protected branch", + "scope": "repos", + "id": "addProtectedBranchRequiredStatusChecksContexts", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "contexts parameter", + "enum": null, + "name": "contexts", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Remove required status checks contexts of protected branch", + "scope": "repos", + "id": "removeProtectedBranchRequiredStatusChecksContexts", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "contexts parameter", + "enum": null, + "name": "contexts", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Get restrictions of protected branch", + "scope": "repos", + "id": "getProtectedBranchRestrictions", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get apps with access to protected branch", + "scope": "repos", + "id": "getAppsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get apps with access to protected branch", + "scope": "repos", + "id": "listAppsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace app restrictions of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchAppRestrictions", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "apps parameter", + "enum": null, + "name": "apps", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Add app restrictions of protected branch", + "scope": "repos", + "id": "addProtectedBranchAppRestrictions", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "apps parameter", + "enum": null, + "name": "apps", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Remove app restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchAppRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "apps parameter", + "enum": null, + "name": "apps", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Get teams with access to protected branch", + "scope": "repos", + "id": "getTeamsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get teams with access to protected branch", + "scope": "repos", + "id": "listProtectedBranchTeamRestrictions", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get teams with access to protected branch", + "scope": "repos", + "id": "listTeamsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace team restrictions of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchTeamRestrictions", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "teams parameter", + "enum": null, + "name": "teams", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Add team restrictions of protected branch", + "scope": "repos", + "id": "addProtectedBranchTeamRestrictions", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "teams parameter", + "enum": null, + "name": "teams", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Remove team restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchTeamRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "teams parameter", + "enum": null, + "name": "teams", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Get users with access to protected branch", + "scope": "repos", + "id": "getUsersWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get users with access to protected branch", + "scope": "repos", + "id": "listProtectedBranchUserRestrictions", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get users with access to protected branch", + "scope": "repos", + "id": "listUsersWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace user restrictions of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchUserRestrictions", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "users parameter", + "enum": null, + "name": "users", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Add user restrictions of protected branch", + "scope": "repos", + "id": "addProtectedBranchUserRestrictions", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "users parameter", + "enum": null, + "name": "users", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Remove user restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchUserRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "users parameter", + "enum": null, + "name": "users", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Create a check run", + "scope": "checks", + "id": "create", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-runs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the check. For example, \"code-coverage\".", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the commit.", + "enum": null, + "name": "head_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL of the integrator's site that has the full details of the check.", + "enum": null, + "name": "details_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A reference for the run on the integrator's system.", + "enum": null, + "name": "external_id", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "name": "status", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "started_at", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`.", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required" + ], + "name": "conclusion", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "completed_at", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description.", + "enum": null, + "name": "output", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the check run.", + "enum": null, + "name": "output.title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The summary of the check run. This parameter supports Markdown.", + "enum": null, + "name": "output.summary", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The details of the check run. This parameter supports Markdown.", + "enum": null, + "name": "output.text", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", + "enum": null, + "name": "output.annotations", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", + "enum": null, + "name": "output.annotations[].path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The start line of the annotation.", + "enum": null, + "name": "output.annotations[].start_line", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The end line of the annotation.", + "enum": null, + "name": "output.annotations[].end_line", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "enum": null, + "name": "output.annotations[].start_column", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "enum": null, + "name": "output.annotations[].end_column", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", + "enum": ["notice", "warning", "failure"], + "name": "output.annotations[].annotation_level", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", + "enum": null, + "name": "output.annotations[].message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title that represents the annotation. The maximum size is 255 characters.", + "enum": null, + "name": "output.annotations[].title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Details about this annotation. The maximum size is 64 KB.", + "enum": null, + "name": "output.annotations[].raw_details", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#images-object) description for details.", + "enum": null, + "name": "output.images", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The alternative text for the image.", + "enum": null, + "name": "output.images[].alt", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The full URL of the image.", + "enum": null, + "name": "output.images[].image_url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short image description.", + "enum": null, + "name": "output.images[].caption", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", + "enum": null, + "name": "actions", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", + "enum": null, + "name": "actions[].label", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short explanation of what this action would do. The maximum size is 40 characters.", + "enum": null, + "name": "actions[].description", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", + "enum": null, + "name": "actions[].identifier", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update a check run", + "scope": "checks", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_run_id parameter", + "enum": null, + "name": "check_run_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the check. For example, \"code-coverage\".", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL of the integrator's site that has the full details of the check.", + "enum": null, + "name": "details_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A reference for the run on the integrator's system.", + "enum": null, + "name": "external_id", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "started_at", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "name": "status", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`.", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required" + ], + "name": "conclusion", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "completed_at", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description.", + "enum": null, + "name": "output", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required**.", + "enum": null, + "name": "output.title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can contain Markdown.", + "enum": null, + "name": "output.summary", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can contain Markdown.", + "enum": null, + "name": "output.text", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", + "enum": null, + "name": "output.annotations", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", + "enum": null, + "name": "output.annotations[].path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The start line of the annotation.", + "enum": null, + "name": "output.annotations[].start_line", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The end line of the annotation.", + "enum": null, + "name": "output.annotations[].end_line", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "enum": null, + "name": "output.annotations[].start_column", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "enum": null, + "name": "output.annotations[].end_column", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", + "enum": ["notice", "warning", "failure"], + "name": "output.annotations[].annotation_level", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", + "enum": null, + "name": "output.annotations[].message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title that represents the annotation. The maximum size is 255 characters.", + "enum": null, + "name": "output.annotations[].title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Details about this annotation. The maximum size is 64 KB.", + "enum": null, + "name": "output.annotations[].raw_details", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", + "enum": null, + "name": "output.images", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The alternative text for the image.", + "enum": null, + "name": "output.images[].alt", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The full URL of the image.", + "enum": null, + "name": "output.images[].image_url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short image description.", + "enum": null, + "name": "output.images[].caption", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", + "enum": null, + "name": "actions", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", + "enum": null, + "name": "actions[].label", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short explanation of what this action would do. The maximum size is 40 characters.", + "enum": null, + "name": "actions[].description", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", + "enum": null, + "name": "actions[].identifier", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single check run", + "scope": "checks", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_run_id parameter", + "enum": null, + "name": "check_run_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List annotations for a check run", + "scope": "checks", + "id": "listAnnotations", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_run_id parameter", + "enum": null, + "name": "check_run_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a check suite", + "scope": "checks", + "id": "createSuite", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-suites", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sha of the head commit.", + "enum": null, + "name": "head_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Set preferences for check suites on a repository", + "scope": "checks", + "id": "setSuitesPreferences", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/check-suites/preferences", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details.", + "enum": null, + "name": "auto_trigger_checks", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The `id` of the GitHub App.", + "enum": null, + "name": "auto_trigger_checks[].app_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", + "enum": null, + "name": "auto_trigger_checks[].setting", + "type": "boolean", + "required": true + } + ] + }, + { + "name": "Get a single check suite", + "scope": "checks", + "id": "getSuite", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_suite_id parameter", + "enum": null, + "name": "check_suite_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List check runs in a check suite", + "scope": "checks", + "id": "listForSuite", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_suite_id parameter", + "enum": null, + "name": "check_suite_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns check runs with the specified `name`.", + "enum": null, + "name": "check_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "name": "status", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", + "enum": ["latest", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Rerequest check suite", + "scope": "checks", + "id": "rerequestSuite", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_suite_id parameter", + "enum": null, + "name": "check_suite_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List collaborators", + "scope": "repos", + "id": "listCollaborators", + "method": "GET", + "url": "/repos/{owner}/{repo}/collaborators", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", + "enum": ["outside", "direct", "all"], + "name": "affiliation", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if a user is a collaborator", + "scope": "repos", + "id": "checkCollaborator", + "method": "GET", + "url": "/repos/{owner}/{repo}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add user as a collaborator", + "scope": "repos", + "id": "addCollaborator", + "method": "PUT", + "url": "/repos/{owner}/{repo}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository.", + "enum": ["pull", "push", "admin"], + "name": "permission", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove user as a collaborator", + "scope": "repos", + "id": "removeCollaborator", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Review a user's permission level", + "scope": "repos", + "id": "getCollaboratorPermissionLevel", + "method": "GET", + "url": "/repos/{owner}/{repo}/collaborators/{username}/permission", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List commit comments for a repository", + "scope": "repos", + "id": "listCommitComments", + "method": "GET", + "url": "/repos/{owner}/{repo}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single commit comment", + "scope": "repos", + "id": "getCommitComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update a commit comment", + "scope": "repos", + "id": "updateCommitComment", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the comment", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a commit comment", + "scope": "repos", + "id": "deleteCommitComment", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List reactions for a commit comment", + "scope": "reactions", + "id": "listForCommitComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for a commit comment", + "scope": "reactions", + "id": "createForCommitComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "List commits on a repository", + "scope": "repos", + "id": "listCommits", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only commits containing this file path will be returned.", + "enum": null, + "name": "path", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "GitHub login or email address by which to filter by commit author.", + "enum": null, + "name": "author", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "until", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List branches for HEAD commit", + "scope": "repos", + "id": "listBranchesForHeadCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "List comments for a single commit", + "scope": "repos", + "id": "listCommentsForCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "commit_sha", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "ref", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a commit comment", + "scope": "repos", + "id": "createCommitComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Relative path of the file to comment on.", + "enum": null, + "name": "path", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Line index in the diff to comment on.", + "enum": null, + "name": "position", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", + "enum": null, + "name": "line", + "type": "integer", + "required": false + }, + { + "alias": "commit_sha", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "sha", + "type": null, + "required": null + } + ] + }, + { + "name": "List pull requests associated with commit", + "scope": "repos", + "id": "listPullRequestsAssociatedWithCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single commit", + "scope": "repos", + "id": "getCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": "ref", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "sha", + "type": null, + "required": null + }, + { + "alias": "ref", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "commit_sha", + "type": null, + "required": null + } + ] + }, + { + "name": "List check runs for a specific ref", + "scope": "checks", + "id": "listForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns check runs with the specified `name`.", + "enum": null, + "name": "check_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "name": "status", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", + "enum": ["latest", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List check suites for a specific ref", + "scope": "checks", + "id": "listSuitesForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters check suites by GitHub App `id`.", + "enum": null, + "name": "app_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/).", + "enum": null, + "name": "check_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the combined status for a specific ref", + "scope": "repos", + "id": "getCombinedStatusForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/status", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + } + ] + }, + { + "name": "List statuses for a specific ref", + "scope": "repos", + "id": "listStatusesForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/statuses", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the contents of a repository's code of conduct", + "scope": "codesOfConduct", + "id": "getForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/community/code_of_conduct", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Retrieve community profile metrics", + "scope": "repos", + "id": "retrieveCommunityProfileMetrics", + "method": "GET", + "url": "/repos/{owner}/{repo}/community/profile", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Compare two commits", + "scope": "repos", + "id": "compareCommits", + "method": "GET", + "url": "/repos/{owner}/{repo}/compare/{base}...{head}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "base parameter", + "enum": null, + "name": "base", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "head parameter", + "enum": null, + "name": "head", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get contents", + "scope": "repos", + "id": "getContents", + "method": "GET", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "ref", + "type": "string", + "required": false + } + ] + }, + { + "name": "Create or update a file", + "scope": "repos", + "id": "createOrUpdateFile", + "method": "PUT", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new file content, using Base64 encoding.", + "enum": null, + "name": "content", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The person that committed the file. Default: the authenticated user.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.email", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.email", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create or update a file", + "scope": "repos", + "id": "createFile", + "method": "PUT", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new file content, using Base64 encoding.", + "enum": null, + "name": "content", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The person that committed the file. Default: the authenticated user.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.email", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.email", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create or update a file", + "scope": "repos", + "id": "updateFile", + "method": "PUT", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new file content, using Base64 encoding.", + "enum": null, + "name": "content", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The person that committed the file. Default: the authenticated user.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.email", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.email", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a file", + "scope": "repos", + "id": "deleteFile", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The blob SHA of the file being replaced.", + "enum": null, + "name": "sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "object containing information about the committer.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author (or committer) of the commit", + "enum": null, + "name": "committer.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author (or committer) of the commit", + "enum": null, + "name": "committer.email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "object containing information about the author.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author (or committer) of the commit", + "enum": null, + "name": "author.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author (or committer) of the commit", + "enum": null, + "name": "author.email", + "type": "string", + "required": false + } + ] + }, + { + "name": "List contributors", + "scope": "repos", + "id": "listContributors", + "method": "GET", + "url": "/repos/{owner}/{repo}/contributors", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Set to `1` or `true` to include anonymous contributors in results.", + "enum": null, + "name": "anon", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List deployments", + "scope": "repos", + "id": "listDeployments", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA recorded at creation time.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the ref. This can be a branch, tag, or SHA.", + "enum": null, + "name": "ref", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", + "enum": null, + "name": "task", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", + "enum": null, + "name": "environment", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a deployment", + "scope": "repos", + "id": "createDeployment", + "method": "POST", + "url": "/repos/{owner}/{repo}/deployments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The ref to deploy. This can be a branch, tag, or SHA.", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", + "enum": null, + "name": "task", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", + "enum": null, + "name": "auto_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", + "enum": null, + "name": "required_contexts", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "JSON payload with extra information about the deployment.", + "enum": null, + "name": "payload", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", + "enum": null, + "name": "environment", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Short description of the deployment.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "transient_environment", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "production_environment", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a single deployment", + "scope": "repos", + "id": "getDeployment", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "deployment_id parameter", + "enum": null, + "name": "deployment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List deployment statuses", + "scope": "repos", + "id": "listDeploymentStatuses", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "deployment_id parameter", + "enum": null, + "name": "deployment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a deployment status", + "scope": "repos", + "id": "createDeploymentStatus", + "method": "POST", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "deployment_id parameter", + "enum": null, + "name": "deployment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", + "enum": [ + "error", + "failure", + "inactive", + "in_progress", + "queued", + "pending", + "success" + ], + "name": "state", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", + "enum": null, + "name": "target_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "log_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the status. The maximum description length is 140 characters.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", + "enum": ["production", "staging", "qa"], + "name": "environment", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "environment_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "auto_inactive", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a single deployment status", + "scope": "repos", + "id": "getDeploymentStatus", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "deployment_id parameter", + "enum": null, + "name": "deployment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "status_id parameter", + "enum": null, + "name": "status_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Create a repository dispatch event", + "scope": "repos", + "id": "createDispatchEvent", + "method": "POST", + "url": "/repos/{owner}/{repo}/dispatches", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required:** A custom webhook event name.", + "enum": null, + "name": "event_type", + "type": "string", + "required": false + } + ] + }, + { + "name": "List downloads for a repository", + "scope": "repos", + "id": "listDownloads", + "method": "GET", + "url": "/repos/{owner}/{repo}/downloads", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single download", + "scope": "repos", + "id": "getDownload", + "method": "GET", + "url": "/repos/{owner}/{repo}/downloads/{download_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "download_id parameter", + "enum": null, + "name": "download_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a download", + "scope": "repos", + "id": "deleteDownload", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/downloads/{download_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "download_id parameter", + "enum": null, + "name": "download_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List repository events", + "scope": "activity", + "id": "listRepoEvents", + "method": "GET", + "url": "/repos/{owner}/{repo}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List forks", + "scope": "repos", + "id": "listForks", + "method": "GET", + "url": "/repos/{owner}/{repo}/forks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", + "enum": ["newest", "oldest", "stargazers"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a fork", + "scope": "repos", + "id": "createFork", + "method": "POST", + "url": "/repos/{owner}/{repo}/forks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Optional parameter to specify the organization name if forking into an organization.", + "enum": null, + "name": "organization", + "type": "string", + "required": false + } + ] + }, + { + "name": "Create a blob", + "scope": "git", + "id": "createBlob", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/blobs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new blob's content.", + "enum": null, + "name": "content", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "enum": null, + "name": "encoding", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a blob", + "scope": "git", + "id": "getBlob", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/blobs/{file_sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "file_sha parameter", + "enum": null, + "name": "file_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a commit", + "scope": "git", + "id": "createCommit", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the tree object this commit points to", + "enum": null, + "name": "tree", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "enum": null, + "name": "parents", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author (or committer) of the commit", + "enum": null, + "name": "author.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author (or committer) of the commit", + "enum": null, + "name": "author.email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "author.date", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author (or committer) of the commit", + "enum": null, + "name": "committer.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author (or committer) of the commit", + "enum": null, + "name": "committer.email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "committer.date", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", + "enum": null, + "name": "signature", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a commit", + "scope": "git", + "id": "getCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/commits/{commit_sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "List matching references", + "scope": "git", + "id": "listMatchingRefs", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/matching-refs/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single reference", + "scope": "git", + "id": "getRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/ref/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a reference", + "scope": "git", + "id": "createRef", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/refs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA1 value for this reference.", + "enum": null, + "name": "sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update a reference", + "scope": "git", + "id": "updateRef", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/git/refs/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA1 value to set this reference to", + "enum": null, + "name": "sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", + "enum": null, + "name": "force", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a reference", + "scope": "git", + "id": "deleteRef", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/git/refs/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a tag object", + "scope": "git", + "id": "createTag", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/tags", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", + "enum": null, + "name": "tag", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The tag message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the git object this is tagging.", + "enum": null, + "name": "object", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", + "enum": ["commit", "tree", "blob"], + "name": "type", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An object with information about the individual creating the tag.", + "enum": null, + "name": "tagger", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author of the tag", + "enum": null, + "name": "tagger.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author of the tag", + "enum": null, + "name": "tagger.email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "tagger.date", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a tag", + "scope": "git", + "id": "getTag", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/tags/{tag_sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "tag_sha parameter", + "enum": null, + "name": "tag_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a tree", + "scope": "git", + "id": "createTree", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/trees", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", + "enum": null, + "name": "tree", + "type": "object[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The file referenced in the tree.", + "enum": null, + "name": "tree[].path", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", + "enum": ["100644", "100755", "040000", "160000", "120000"], + "name": "tree[].mode", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `blob`, `tree`, or `commit`.", + "enum": ["blob", "tree", "commit"], + "name": "tree[].type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", + "enum": null, + "name": "tree[].sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", + "enum": null, + "name": "tree[].content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.", + "enum": null, + "name": "base_tree", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a tree", + "scope": "git", + "id": "getTree", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/trees/{tree_sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "tree_sha parameter", + "enum": null, + "name": "tree_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "recursive parameter", + "enum": ["1"], + "name": "recursive", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List hooks", + "scope": "repos", + "id": "listHooks", + "method": "GET", + "url": "/repos/{owner}/{repo}/hooks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a hook", + "scope": "repos", + "id": "createHook", + "method": "POST", + "url": "/repos/{owner}/{repo}/hooks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", + "enum": null, + "name": "config", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL to which the payloads will be delivered.", + "enum": null, + "name": "config.url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "enum": null, + "name": "config.content_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "enum": null, + "name": "config.secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "enum": null, + "name": "config.insecure_ssl", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", + "enum": null, + "name": "events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "enum": null, + "name": "active", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get single hook", + "scope": "repos", + "id": "getHook", + "method": "GET", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a hook", + "scope": "repos", + "id": "updateHook", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", + "enum": null, + "name": "config", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL to which the payloads will be delivered.", + "enum": null, + "name": "config.url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "enum": null, + "name": "config.content_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "enum": null, + "name": "config.secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "enum": null, + "name": "config.insecure_ssl", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", + "enum": null, + "name": "events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", + "enum": null, + "name": "add_events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", + "enum": null, + "name": "remove_events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "enum": null, + "name": "active", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a hook", + "scope": "repos", + "id": "deleteHook", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Ping a hook", + "scope": "repos", + "id": "pingHook", + "method": "POST", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Test a push hook", + "scope": "repos", + "id": "testPushHook", + "method": "POST", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Start an import", + "scope": "migrations", + "id": "startImport", + "method": "PUT", + "url": "/repos/{owner}/{repo}/import", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL of the originating repository.", + "enum": null, + "name": "vcs_url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", + "enum": ["subversion", "git", "mercurial", "tfvc"], + "name": "vcs", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If authentication is required, the username to provide to `vcs_url`.", + "enum": null, + "name": "vcs_username", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If authentication is required, the password to provide to `vcs_url`.", + "enum": null, + "name": "vcs_password", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "For a tfvc import, the name of the project that is being imported.", + "enum": null, + "name": "tfvc_project", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get import progress", + "scope": "migrations", + "id": "getImportProgress", + "method": "GET", + "url": "/repos/{owner}/{repo}/import", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update existing import", + "scope": "migrations", + "id": "updateImport", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/import", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The username to provide to the originating repository.", + "enum": null, + "name": "vcs_username", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The password to provide to the originating repository.", + "enum": null, + "name": "vcs_password", + "type": "string", + "required": false + } + ] + }, + { + "name": "Cancel an import", + "scope": "migrations", + "id": "cancelImport", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/import", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get commit authors", + "scope": "migrations", + "id": "getCommitAuthors", + "method": "GET", + "url": "/repos/{owner}/{repo}/import/authors", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step.", + "enum": null, + "name": "since", + "type": "string", + "required": false + } + ] + }, + { + "name": "Map a commit author", + "scope": "migrations", + "id": "mapCommitAuthor", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/import/authors/{author_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "author_id parameter", + "enum": null, + "name": "author_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new Git author email.", + "enum": null, + "name": "email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new Git author name.", + "enum": null, + "name": "name", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get large files", + "scope": "migrations", + "id": "getLargeFiles", + "method": "GET", + "url": "/repos/{owner}/{repo}/import/large_files", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Set Git LFS preference", + "scope": "migrations", + "id": "setLfsPreference", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/import/lfs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import).", + "enum": ["opt_in", "opt_out"], + "name": "use_lfs", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a repository installation", + "scope": "apps", + "id": "getRepoInstallation", + "method": "GET", + "url": "/repos/{owner}/{repo}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a repository installation", + "scope": "apps", + "id": "findRepoInstallation", + "method": "GET", + "url": "/repos/{owner}/{repo}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get interaction restrictions for a repository", + "scope": "interactions", + "id": "getRestrictionsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update interaction restrictions for a repository", + "scope": "interactions", + "id": "addOrUpdateRestrictionsForRepo", + "method": "PUT", + "url": "/repos/{owner}/{repo}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", + "enum": ["existing_users", "contributors_only", "collaborators_only"], + "name": "limit", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove interaction restrictions for a repository", + "scope": "interactions", + "id": "removeRestrictionsForRepo", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List invitations for a repository", + "scope": "repos", + "id": "listInvitations", + "method": "GET", + "url": "/repos/{owner}/{repo}/invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Delete a repository invitation", + "scope": "repos", + "id": "deleteInvitation", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update a repository invitation", + "scope": "repos", + "id": "updateInvitation", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.", + "enum": ["read", "write", "admin"], + "name": "permissions", + "type": "string", + "required": false + } + ] + }, + { + "name": "List issues for a repository", + "scope": "issues", + "id": "listForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", + "enum": null, + "name": "milestone", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", + "enum": null, + "name": "assignee", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The user that created the issue.", + "enum": null, + "name": "creator", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A user that's mentioned in the issue.", + "enum": null, + "name": "mentioned", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "enum": null, + "name": "labels", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "enum": ["created", "updated", "comments"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create an issue", + "scope": "issues", + "id": "create", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the issue.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the issue.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", + "enum": null, + "name": "assignee", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._", + "enum": null, + "name": "milestone", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", + "enum": null, + "name": "labels", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", + "enum": null, + "name": "assignees", + "type": "string[]", + "required": false + } + ] + }, + { + "name": "List comments in a repository", + "scope": "issues", + "id": "listCommentsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `created` or `updated`.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single comment", + "scope": "issues", + "id": "getComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Edit a comment", + "scope": "issues", + "id": "updateComment", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a comment", + "scope": "issues", + "id": "deleteComment", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List reactions for an issue comment", + "scope": "reactions", + "id": "listForIssueComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for an issue comment", + "scope": "reactions", + "id": "createForIssueComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "List events for a repository", + "scope": "issues", + "id": "listEventsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single event", + "scope": "issues", + "id": "getEvent", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/events/{event_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "event_id parameter", + "enum": null, + "name": "event_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get a single issue", + "scope": "issues", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Edit an issue", + "scope": "issues", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/issues/{issue_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the issue.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the issue.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", + "enum": null, + "name": "assignee", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "State of the issue. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._", + "enum": null, + "name": "milestone", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", + "enum": null, + "name": "labels", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", + "enum": null, + "name": "assignees", + "type": "string[]", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Add assignees to an issue", + "scope": "issues", + "id": "addAssignees", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", + "enum": null, + "name": "assignees", + "type": "string[]", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Remove assignees from an issue", + "scope": "issues", + "id": "removeAssignees", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", + "enum": null, + "name": "assignees", + "type": "string[]", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List comments on an issue", + "scope": "issues", + "id": "listComments", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a comment", + "scope": "issues", + "id": "createComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List events for an issue", + "scope": "issues", + "id": "listEvents", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List labels on an issue", + "scope": "issues", + "id": "listLabelsOnIssue", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Add labels to an issue", + "scope": "issues", + "id": "addLabels", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "enum": null, + "name": "labels", + "type": "string[]", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Replace all labels for an issue", + "scope": "issues", + "id": "replaceLabels", + "method": "PUT", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "enum": null, + "name": "labels", + "type": "string[]", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Remove all labels from an issue", + "scope": "issues", + "id": "removeLabels", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Remove a label from an issue", + "scope": "issues", + "id": "removeLabel", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Lock an issue", + "scope": "issues", + "id": "lock", + "method": "PUT", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", + "enum": ["off-topic", "too heated", "resolved", "spam"], + "name": "lock_reason", + "type": "string", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Unlock an issue", + "scope": "issues", + "id": "unlock", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List reactions for an issue", + "scope": "reactions", + "id": "listForIssue", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create reaction for an issue", + "scope": "reactions", + "id": "createForIssue", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List events for an issue", + "scope": "issues", + "id": "listEventsForTimeline", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List deploy keys", + "scope": "repos", + "id": "listDeployKeys", + "method": "GET", + "url": "/repos/{owner}/{repo}/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Add a new deploy key", + "scope": "repos", + "id": "addDeployKey", + "method": "POST", + "url": "/repos/{owner}/{repo}/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A name for the key.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the key.", + "enum": null, + "name": "key", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/).\"", + "enum": null, + "name": "read_only", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a deploy key", + "scope": "repos", + "id": "getDeployKey", + "method": "GET", + "url": "/repos/{owner}/{repo}/keys/{key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key_id parameter", + "enum": null, + "name": "key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Remove a deploy key", + "scope": "repos", + "id": "removeDeployKey", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/keys/{key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key_id parameter", + "enum": null, + "name": "key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List all labels for this repository", + "scope": "issues", + "id": "listLabelsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a label", + "scope": "issues", + "id": "createLabel", + "method": "POST", + "url": "/repos/{owner}/{repo}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", + "enum": null, + "name": "color", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the label.", + "enum": null, + "name": "description", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single label", + "scope": "issues", + "id": "getLabel", + "method": "GET", + "url": "/repos/{owner}/{repo}/labels/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update a label", + "scope": "issues", + "id": "updateLabel", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/labels/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", + "enum": null, + "name": "new_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", + "enum": null, + "name": "color", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the label.", + "enum": null, + "name": "description", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete a label", + "scope": "issues", + "id": "deleteLabel", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/labels/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "List languages", + "scope": "repos", + "id": "listLanguages", + "method": "GET", + "url": "/repos/{owner}/{repo}/languages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get the contents of a repository's license", + "scope": "licenses", + "id": "getForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/license", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Perform a merge", + "scope": "repos", + "id": "merge", + "method": "POST", + "url": "/repos/{owner}/{repo}/merges", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the base branch that the head will be merged into.", + "enum": null, + "name": "base", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The head to merge. This can be a branch name or a commit SHA1.", + "enum": null, + "name": "head", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", + "enum": null, + "name": "commit_message", + "type": "string", + "required": false + } + ] + }, + { + "name": "List milestones for a repository", + "scope": "issues", + "id": "listMilestonesForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/milestones", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the milestone. Either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Either `due_on` or `completeness`.", + "enum": ["due_on", "completeness"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a milestone", + "scope": "issues", + "id": "createMilestone", + "method": "POST", + "url": "/repos/{owner}/{repo}/milestones", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the milestone.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the milestone. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A description of the milestone.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "due_on", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single milestone", + "scope": "issues", + "id": "getMilestone", + "method": "GET", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "milestone_number parameter", + "enum": null, + "name": "milestone_number", + "type": "integer", + "required": true + }, + { + "alias": "milestone_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a milestone", + "scope": "issues", + "id": "updateMilestone", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "milestone_number parameter", + "enum": null, + "name": "milestone_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the milestone.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the milestone. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A description of the milestone.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "due_on", + "type": "string", + "required": false + }, + { + "alias": "milestone_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Delete a milestone", + "scope": "issues", + "id": "deleteMilestone", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "milestone_number parameter", + "enum": null, + "name": "milestone_number", + "type": "integer", + "required": true + }, + { + "alias": "milestone_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Get labels for every issue in a milestone", + "scope": "issues", + "id": "listLabelsForMilestone", + "method": "GET", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "milestone_number parameter", + "enum": null, + "name": "milestone_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "milestone_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List your notifications in a repository", + "scope": "activity", + "id": "listNotificationsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/notifications", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, show notifications marked as read.", + "enum": null, + "name": "all", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", + "enum": null, + "name": "participating", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "before", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Mark notifications as read in a repository", + "scope": "activity", + "id": "markNotificationsAsReadForRepo", + "method": "PUT", + "url": "/repos/{owner}/{repo}/notifications", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", + "enum": null, + "name": "last_read_at", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get information about a Pages site", + "scope": "repos", + "id": "getPages", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Enable a Pages site", + "scope": "repos", + "id": "enablePagesSite", + "method": "POST", + "url": "/repos/{owner}/{repo}/pages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "source parameter", + "enum": null, + "name": "source", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The repository branch used to publish your [site's source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.", + "enum": ["master", "gh-pages"], + "name": "source.branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.", + "enum": null, + "name": "source.path", + "type": "string", + "required": false + } + ] + }, + { + "name": "Disable a Pages site", + "scope": "repos", + "id": "disablePagesSite", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update information about a Pages site", + "scope": "repos", + "id": "updateInformationAboutPagesSite", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"", + "enum": null, + "name": "cname", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", + "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""], + "name": "source", + "type": "string", + "required": false + } + ] + }, + { + "name": "Request a page build", + "scope": "repos", + "id": "requestPageBuild", + "method": "POST", + "url": "/repos/{owner}/{repo}/pages/builds", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List Pages builds", + "scope": "repos", + "id": "listPagesBuilds", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages/builds", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get latest Pages build", + "scope": "repos", + "id": "getLatestPagesBuild", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages/builds/latest", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a specific Pages build", + "scope": "repos", + "id": "getPagesBuild", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages/builds/{build_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "build_id parameter", + "enum": null, + "name": "build_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List repository projects", + "scope": "projects", + "id": "listForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a repository project", + "scope": "projects", + "id": "createForRepo", + "method": "POST", + "url": "/repos/{owner}/{repo}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the project.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the project.", + "enum": null, + "name": "body", + "type": "string", + "required": false + } + ] + }, + { + "name": "List pull requests", + "scope": "pulls", + "id": "list", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `open`, `closed`, or `all` to filter by state.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", + "enum": null, + "name": "head", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter pulls by base branch name. Example: `gh-pages`.", + "enum": null, + "name": "base", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", + "enum": ["created", "updated", "popularity", "long-running"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a pull request", + "scope": "pulls", + "id": "create", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the new pull request.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", + "enum": null, + "name": "head", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", + "enum": null, + "name": "base", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the pull request.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "enum": null, + "name": "maintainer_can_modify", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", + "enum": null, + "name": "draft", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List comments in a repository", + "scope": "pulls", + "id": "listCommentsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be either `created` or `updated` comments.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single comment", + "scope": "pulls", + "id": "getComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a comment", + "scope": "pulls", + "id": "updateComment", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text of the reply to the review comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a comment", + "scope": "pulls", + "id": "deleteComment", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List reactions for a pull request review comment", + "scope": "reactions", + "id": "listForPullRequestReviewComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for a pull request review comment", + "scope": "reactions", + "id": "createForPullRequestReviewComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single pull request", + "scope": "pulls", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a pull request", + "scope": "pulls", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the pull request.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the pull request.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "State of this Pull Request. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", + "enum": null, + "name": "base", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "enum": null, + "name": "maintainer_can_modify", + "type": "boolean", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List comments on a pull request", + "scope": "pulls", + "id": "listComments", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be either `created` or `updated` comments.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a comment", + "scope": "pulls", + "id": "createComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text of the review comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", + "enum": null, + "name": "commit_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The relative path to the file that necessitates a comment.", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "enum": null, + "name": "position", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "enum": ["LEFT", "RIGHT"], + "name": "side", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "enum": null, + "name": "line", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "enum": null, + "name": "start_line", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "enum": ["LEFT", "RIGHT", "side"], + "name": "start_side", + "type": "string", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + }, + { + "alias": null, + "allowNull": null, + "deprecated": true, + "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", + "enum": null, + "name": "in_reply_to", + "type": "integer", + "required": null + } + ] + }, + { + "name": "Create a comment", + "scope": "pulls", + "id": "createCommentReply", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text of the review comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", + "enum": null, + "name": "commit_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The relative path to the file that necessitates a comment.", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "enum": null, + "name": "position", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "enum": ["LEFT", "RIGHT"], + "name": "side", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "enum": null, + "name": "line", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "enum": null, + "name": "start_line", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "enum": ["LEFT", "RIGHT", "side"], + "name": "start_side", + "type": "string", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + }, + { + "alias": null, + "allowNull": null, + "deprecated": true, + "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", + "enum": null, + "name": "in_reply_to", + "type": "integer", + "required": null + } + ] + }, + { + "name": "Create a review comment reply", + "scope": "pulls", + "id": "createReviewCommentReply", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text of the review comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "List commits on a pull request", + "scope": "pulls", + "id": "listCommits", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List pull requests files", + "scope": "pulls", + "id": "listFiles", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Get if a pull request has been merged", + "scope": "pulls", + "id": "checkIfMerged", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Merge a pull request (Merge Button)", + "scope": "pulls", + "id": "merge", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Title for the automatic commit message.", + "enum": null, + "name": "commit_title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Extra detail to append to automatic commit message.", + "enum": null, + "name": "commit_message", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "SHA that pull request head must match to allow merge.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", + "enum": ["merge", "squash", "rebase"], + "name": "merge_method", + "type": "string", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List review requests", + "scope": "pulls", + "id": "listReviewRequests", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a review request", + "scope": "pulls", + "id": "createReviewRequest", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of user `login`s that will be requested.", + "enum": null, + "name": "reviewers", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of team `slug`s that will be requested.", + "enum": null, + "name": "team_reviewers", + "type": "string[]", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Delete a review request", + "scope": "pulls", + "id": "deleteReviewRequest", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of user `login`s that will be removed.", + "enum": null, + "name": "reviewers", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of team `slug`s that will be removed.", + "enum": null, + "name": "team_reviewers", + "type": "string[]", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List reviews on a pull request", + "scope": "pulls", + "id": "listReviews", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a pull request review", + "scope": "pulls", + "id": "createReview", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", + "enum": null, + "name": "commit_id", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", + "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], + "name": "event", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", + "enum": null, + "name": "comments", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The relative path to the file that necessitates a review comment.", + "enum": null, + "name": "comments[].path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", + "enum": null, + "name": "comments[].position", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Text of the review comment.", + "enum": null, + "name": "comments[].body", + "type": "string", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Get a single review", + "scope": "pulls", + "id": "getReview", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Delete a pending review", + "scope": "pulls", + "id": "deletePendingReview", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a pull request review", + "scope": "pulls", + "id": "updateReview", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The body text of the pull request review.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Get comments for a single review", + "scope": "pulls", + "id": "getCommentsForReview", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Dismiss a pull request review", + "scope": "pulls", + "id": "dismissReview", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The message for the pull request review dismissal", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Submit a pull request review", + "scope": "pulls", + "id": "submitReview", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The body text of the pull request review", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", + "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], + "name": "event", + "type": "string", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a pull request branch", + "scope": "pulls", + "id": "updateBranch", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", + "enum": null, + "name": "expected_head_sha", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get the README", + "scope": "repos", + "id": "getReadme", + "method": "GET", + "url": "/repos/{owner}/{repo}/readme", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "ref", + "type": "string", + "required": false + } + ] + }, + { + "name": "List releases for a repository", + "scope": "repos", + "id": "listReleases", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a release", + "scope": "repos", + "id": "createRelease", + "method": "POST", + "url": "/repos/{owner}/{repo}/releases", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the tag.", + "enum": null, + "name": "tag_name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", + "enum": null, + "name": "target_commitish", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the release.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Text describing the contents of the tag.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", + "enum": null, + "name": "draft", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", + "enum": null, + "name": "prerelease", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a single release asset", + "scope": "repos", + "id": "getReleaseAsset", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "asset_id parameter", + "enum": null, + "name": "asset_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a release asset", + "scope": "repos", + "id": "updateReleaseAsset", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "asset_id parameter", + "enum": null, + "name": "asset_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The file name of the asset.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An alternate short description of the asset. Used in place of the filename.", + "enum": null, + "name": "label", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete a release asset", + "scope": "repos", + "id": "deleteReleaseAsset", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "asset_id parameter", + "enum": null, + "name": "asset_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get the latest release", + "scope": "repos", + "id": "getLatestRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/latest", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a release by tag name", + "scope": "repos", + "id": "getReleaseByTag", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/tags/{tag}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "tag parameter", + "enum": null, + "name": "tag", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single release", + "scope": "repos", + "id": "getRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "release_id parameter", + "enum": null, + "name": "release_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a release", + "scope": "repos", + "id": "updateRelease", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "release_id parameter", + "enum": null, + "name": "release_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the tag.", + "enum": null, + "name": "tag_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", + "enum": null, + "name": "target_commitish", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the release.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Text describing the contents of the tag.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` makes the release a draft, and `false` publishes the release.", + "enum": null, + "name": "draft", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", + "enum": null, + "name": "prerelease", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a release", + "scope": "repos", + "id": "deleteRelease", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "release_id parameter", + "enum": null, + "name": "release_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List assets for a release", + "scope": "repos", + "id": "listAssetsForRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/{release_id}/assets", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "release_id parameter", + "enum": null, + "name": "release_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List Stargazers", + "scope": "activity", + "id": "listStargazersForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/stargazers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the number of additions and deletions per week", + "scope": "repos", + "id": "getCodeFrequencyStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/code_frequency", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get the last year of commit activity data", + "scope": "repos", + "id": "getCommitActivityStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/commit_activity", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get contributors list with additions, deletions, and commit counts", + "scope": "repos", + "id": "getContributorsStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/contributors", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get the weekly commit count for the repository owner and everyone else", + "scope": "repos", + "id": "getParticipationStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/participation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get the number of commits per hour in each day", + "scope": "repos", + "id": "getPunchCardStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/punch_card", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a status", + "scope": "repos", + "id": "createStatus", + "method": "POST", + "url": "/repos/{owner}/{repo}/statuses/{sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "sha parameter", + "enum": null, + "name": "sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", + "enum": ["error", "failure", "pending", "success"], + "name": "state", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", + "enum": null, + "name": "target_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the status.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A string label to differentiate this status from the status of other systems.", + "enum": null, + "name": "context", + "type": "string", + "required": false + } + ] + }, + { + "name": "List watchers", + "scope": "activity", + "id": "listWatchersForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/subscribers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a Repository Subscription", + "scope": "activity", + "id": "getRepoSubscription", + "method": "GET", + "url": "/repos/{owner}/{repo}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Set a Repository Subscription", + "scope": "activity", + "id": "setRepoSubscription", + "method": "PUT", + "url": "/repos/{owner}/{repo}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications should be received from this repository.", + "enum": null, + "name": "subscribed", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if all notifications should be blocked from this repository.", + "enum": null, + "name": "ignored", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a Repository Subscription", + "scope": "activity", + "id": "deleteRepoSubscription", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List tags", + "scope": "repos", + "id": "listTags", + "method": "GET", + "url": "/repos/{owner}/{repo}/tags", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List teams", + "scope": "repos", + "id": "listTeams", + "method": "GET", + "url": "/repos/{owner}/{repo}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all topics for a repository", + "scope": "repos", + "id": "listTopics", + "method": "GET", + "url": "/repos/{owner}/{repo}/topics", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace all topics for a repository", + "scope": "repos", + "id": "replaceTopics", + "method": "PUT", + "url": "/repos/{owner}/{repo}/topics", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", + "enum": null, + "name": "names", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Clones", + "scope": "repos", + "id": "getClones", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/clones", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Must be one of: `day`, `week`.", + "enum": ["day", "week"], + "name": "per", + "type": "string", + "required": false + } + ] + }, + { + "name": "List paths", + "scope": "repos", + "id": "getTopPaths", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/popular/paths", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List referrers", + "scope": "repos", + "id": "getTopReferrers", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/popular/referrers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Views", + "scope": "repos", + "id": "getViews", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/views", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Must be one of: `day`, `week`.", + "enum": ["day", "week"], + "name": "per", + "type": "string", + "required": false + } + ] + }, + { + "name": "Transfer a repository", + "scope": "repos", + "id": "transfer", + "method": "POST", + "url": "/repos/{owner}/{repo}/transfer", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required:** The username or organization name the repository will be transferred to.", + "enum": null, + "name": "new_owner", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", + "enum": null, + "name": "team_ids", + "type": "integer[]", + "required": false + } + ] + }, + { + "name": "Check if vulnerability alerts are enabled for a repository", + "scope": "repos", + "id": "checkVulnerabilityAlerts", + "method": "GET", + "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Enable vulnerability alerts", + "scope": "repos", + "id": "enableVulnerabilityAlerts", + "method": "PUT", + "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Disable vulnerability alerts", + "scope": "repos", + "id": "disableVulnerabilityAlerts", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get archive link", + "scope": "repos", + "id": "getArchiveLink", + "method": "GET", + "url": "/repos/{owner}/{repo}/{archive_format}/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "archive_format parameter", + "enum": null, + "name": "archive_format", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create repository using a repository template", + "scope": "repos", + "id": "createUsingTemplate", + "method": "POST", + "url": "/repos/{template_owner}/{template_repo}/generate", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "template_owner parameter", + "enum": null, + "name": "template_owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "template_repo parameter", + "enum": null, + "name": "template_repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", + "enum": null, + "name": "owner", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the new repository.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the new repository.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to create a new private repository or `false` to create a new public one.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List all public repositories", + "scope": "repos", + "id": "listPublic", + "method": "GET", + "url": "/repositories", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The integer ID of the last Repository that you've seen.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a list of provisioned identities", + "scope": "scim", + "id": "listProvisionedIdentities", + "method": "GET", + "url": "/scim/v2/organizations/{org}/Users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Used for pagination: the index of the first result to return.", + "enum": null, + "name": "startIndex", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Used for pagination: the number of results to return.", + "enum": null, + "name": "count", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: `?filter=userName%20eq%20\\\"Octocat\\\"`.", + "enum": null, + "name": "filter", + "type": "string", + "required": false + } + ] + }, + { + "name": "Provision and invite users", + "scope": "scim", + "id": "provisionAndInviteUsers", + "method": "POST", + "url": "/scim/v2/organizations/{org}/Users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Provision and invite users", + "scope": "scim", + "id": "provisionInviteUsers", + "method": "POST", + "url": "/scim/v2/organizations/{org}/Users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get provisioning details for a single user", + "scope": "scim", + "id": "getProvisioningDetailsForUser", + "method": "GET", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Replace a provisioned user's information", + "scope": "scim", + "id": "replaceProvisionedUserInformation", + "method": "PUT", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Replace a provisioned user's information", + "scope": "scim", + "id": "updateProvisionedOrgMembership", + "method": "PUT", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a user attribute", + "scope": "scim", + "id": "updateUserAttribute", + "method": "PATCH", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Remove a user from the organization", + "scope": "scim", + "id": "removeUserFromOrg", + "method": "DELETE", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Search code", + "scope": "search", + "id": "code", + "method": "GET", + "url": "/search/code", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["indexed"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search commits", + "scope": "search", + "id": "commits", + "method": "GET", + "url": "/search/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["author-date", "committer-date"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search issues and pull requests", + "scope": "search", + "id": "issuesAndPullRequests", + "method": "GET", + "url": "/search/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": [ + "comments", + "reactions", + "reactions-+1", + "reactions--1", + "reactions-smile", + "reactions-thinking_face", + "reactions-heart", + "reactions-tada", + "interactions", + "created", + "updated" + ], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search issues and pull requests", + "scope": "search", + "id": "issues", + "method": "GET", + "url": "/search/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": [ + "comments", + "reactions", + "reactions-+1", + "reactions--1", + "reactions-smile", + "reactions-thinking_face", + "reactions-heart", + "reactions-tada", + "interactions", + "created", + "updated" + ], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search labels", + "scope": "search", + "id": "labels", + "method": "GET", + "url": "/search/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The id of the repository.", + "enum": null, + "name": "repository_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + } + ] + }, + { + "name": "Search repositories", + "scope": "search", + "id": "repos", + "method": "GET", + "url": "/search/repositories", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["stars", "forks", "help-wanted-issues", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search topics", + "scope": "search", + "id": "topics", + "method": "GET", + "url": "/search/topics", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", + "enum": null, + "name": "q", + "type": "string", + "required": true + } + ] + }, + { + "name": "Search users", + "scope": "search", + "id": "users", + "method": "GET", + "url": "/search/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["followers", "repositories", "joined"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get team", + "scope": "teams", + "id": "get", + "method": "GET", + "url": "/teams/{team_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit team", + "scope": "teams", + "id": "update", + "method": "PATCH", + "url": "/teams/{team_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the team.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the team.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "enum": ["secret", "closed"], + "name": "privacy", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "enum": ["pull", "push", "admin"], + "name": "permission", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.", + "enum": null, + "name": "parent_team_id", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Delete team", + "scope": "teams", + "id": "delete", + "method": "DELETE", + "url": "/teams/{team_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List discussions", + "scope": "teams", + "id": "listDiscussions", + "method": "GET", + "url": "/teams/{team_id}/discussions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a discussion", + "scope": "teams", + "id": "createDiscussion", + "method": "POST", + "url": "/teams/{team_id}/discussions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion post's title.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion post's body text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a single discussion", + "scope": "teams", + "id": "getDiscussion", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a discussion", + "scope": "teams", + "id": "updateDiscussion", + "method": "PATCH", + "url": "/teams/{team_id}/discussions/{discussion_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion post's title.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion post's body text.", + "enum": null, + "name": "body", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete a discussion", + "scope": "teams", + "id": "deleteDiscussion", + "method": "DELETE", + "url": "/teams/{team_id}/discussions/{discussion_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List comments", + "scope": "teams", + "id": "listDiscussionComments", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a comment", + "scope": "teams", + "id": "createDiscussionComment", + "method": "POST", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion comment's body text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single comment", + "scope": "teams", + "id": "getDiscussionComment", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a comment", + "scope": "teams", + "id": "updateDiscussionComment", + "method": "PATCH", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion comment's body text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a comment", + "scope": "teams", + "id": "deleteDiscussionComment", + "method": "DELETE", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List reactions for a team discussion comment", + "scope": "reactions", + "id": "listForTeamDiscussionComment", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for a team discussion comment", + "scope": "reactions", + "id": "createForTeamDiscussionComment", + "method": "POST", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "List reactions for a team discussion", + "scope": "reactions", + "id": "listForTeamDiscussion", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for a team discussion", + "scope": "reactions", + "id": "createForTeamDiscussion", + "method": "POST", + "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "List pending team invitations", + "scope": "teams", + "id": "listPendingInvitations", + "method": "GET", + "url": "/teams/{team_id}/invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List team members", + "scope": "teams", + "id": "listMembers", + "method": "GET", + "url": "/teams/{team_id}/members", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", + "enum": ["member", "maintainer", "all"], + "name": "role", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get team member", + "scope": "teams", + "id": "getMember", + "method": "GET", + "url": "/teams/{team_id}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add team member", + "scope": "teams", + "id": "addMember", + "method": "PUT", + "url": "/teams/{team_id}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove team member", + "scope": "teams", + "id": "removeMember", + "method": "DELETE", + "url": "/teams/{team_id}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get team membership", + "scope": "teams", + "id": "getMembership", + "method": "GET", + "url": "/teams/{team_id}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update team membership", + "scope": "teams", + "id": "addOrUpdateMembership", + "method": "PUT", + "url": "/teams/{team_id}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", + "enum": ["member", "maintainer"], + "name": "role", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove team membership", + "scope": "teams", + "id": "removeMembership", + "method": "DELETE", + "url": "/teams/{team_id}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List team projects", + "scope": "teams", + "id": "listProjects", + "method": "GET", + "url": "/teams/{team_id}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Review a team project", + "scope": "teams", + "id": "reviewProject", + "method": "GET", + "url": "/teams/{team_id}/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Add or update team project", + "scope": "teams", + "id": "addOrUpdateProject", + "method": "PUT", + "url": "/teams/{team_id}/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.", + "enum": ["read", "write", "admin"], + "name": "permission", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove team project", + "scope": "teams", + "id": "removeProject", + "method": "DELETE", + "url": "/teams/{team_id}/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List team repos", + "scope": "teams", + "id": "listRepos", + "method": "GET", + "url": "/teams/{team_id}/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if a team manages a repository", + "scope": "teams", + "id": "checkManagesRepo", + "method": "GET", + "url": "/teams/{team_id}/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update team repository", + "scope": "teams", + "id": "addOrUpdateRepo", + "method": "PUT", + "url": "/teams/{team_id}/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team.", + "enum": ["pull", "push", "admin"], + "name": "permission", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove team repository", + "scope": "teams", + "id": "removeRepo", + "method": "DELETE", + "url": "/teams/{team_id}/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List IdP groups for a team", + "scope": "teams", + "id": "listIdPGroups", + "method": "GET", + "url": "/teams/{team_id}/team-sync/group-mappings", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Create or update IdP group connections", + "scope": "teams", + "id": "createOrUpdateIdPGroupConnections", + "method": "PATCH", + "url": "/teams/{team_id}/team-sync/group-mappings", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", + "enum": null, + "name": "groups", + "type": "object[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ID of the IdP group.", + "enum": null, + "name": "groups[].group_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Name of the IdP group.", + "enum": null, + "name": "groups[].group_name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Description of the IdP group.", + "enum": null, + "name": "groups[].group_description", + "type": "string", + "required": true + } + ] + }, + { + "name": "List child teams", + "scope": "teams", + "id": "listChild", + "method": "GET", + "url": "/teams/{team_id}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the authenticated user", + "scope": "users", + "id": "getAuthenticated", + "method": "GET", + "url": "/user", + "parameters": [] + }, + { + "name": "Update the authenticated user", + "scope": "users", + "id": "updateAuthenticated", + "method": "PATCH", + "url": "/user", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new name of the user.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The publicly visible email address of the user.", + "enum": null, + "name": "email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new blog URL of the user.", + "enum": null, + "name": "blog", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new company of the user.", + "enum": null, + "name": "company", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new location of the user.", + "enum": null, + "name": "location", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new hiring availability of the user.", + "enum": null, + "name": "hireable", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new short biography of the user.", + "enum": null, + "name": "bio", + "type": "string", + "required": false + } + ] + }, + { + "name": "List blocked users", + "scope": "users", + "id": "listBlocked", + "method": "GET", + "url": "/user/blocks", + "parameters": [] + }, + { + "name": "Check whether you've blocked a user", + "scope": "users", + "id": "checkBlocked", + "method": "GET", + "url": "/user/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Block a user", + "scope": "users", + "id": "block", + "method": "PUT", + "url": "/user/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unblock a user", + "scope": "users", + "id": "unblock", + "method": "DELETE", + "url": "/user/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Toggle primary email visibility", + "scope": "users", + "id": "togglePrimaryEmailVisibility", + "method": "PATCH", + "url": "/user/email/visibility", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify the _primary_ email address that needs a visibility change.", + "enum": null, + "name": "email", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Use `public` to enable an authenticated user to view the specified email address, or use `private` so this primary email address cannot be seen publicly.", + "enum": null, + "name": "visibility", + "type": "string", + "required": true + } + ] + }, + { + "name": "List email addresses for a user", + "scope": "users", + "id": "listEmails", + "method": "GET", + "url": "/user/emails", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Add email address(es)", + "scope": "users", + "id": "addEmails", + "method": "POST", + "url": "/user/emails", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "enum": null, + "name": "emails", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Delete email address(es)", + "scope": "users", + "id": "deleteEmails", + "method": "DELETE", + "url": "/user/emails", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "enum": null, + "name": "emails", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "List the authenticated user's followers", + "scope": "users", + "id": "listFollowersForAuthenticatedUser", + "method": "GET", + "url": "/user/followers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List who the authenticated user is following", + "scope": "users", + "id": "listFollowingForAuthenticatedUser", + "method": "GET", + "url": "/user/following", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if you are following a user", + "scope": "users", + "id": "checkFollowing", + "method": "GET", + "url": "/user/following/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Follow a user", + "scope": "users", + "id": "follow", + "method": "PUT", + "url": "/user/following/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unfollow a user", + "scope": "users", + "id": "unfollow", + "method": "DELETE", + "url": "/user/following/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List your GPG keys", + "scope": "users", + "id": "listGpgKeys", + "method": "GET", + "url": "/user/gpg_keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a GPG key", + "scope": "users", + "id": "createGpgKey", + "method": "POST", + "url": "/user/gpg_keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Your GPG key, generated in ASCII-armored format. See \"[Generating a new GPG key](https://help.github.com/articles/generating-a-new-gpg-key/)\" for help creating a GPG key.", + "enum": null, + "name": "armored_public_key", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single GPG key", + "scope": "users", + "id": "getGpgKey", + "method": "GET", + "url": "/user/gpg_keys/{gpg_key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gpg_key_id parameter", + "enum": null, + "name": "gpg_key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a GPG key", + "scope": "users", + "id": "deleteGpgKey", + "method": "DELETE", + "url": "/user/gpg_keys/{gpg_key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gpg_key_id parameter", + "enum": null, + "name": "gpg_key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List installations for a user", + "scope": "apps", + "id": "listInstallationsForAuthenticatedUser", + "method": "GET", + "url": "/user/installations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List repositories accessible to the user for an installation", + "scope": "apps", + "id": "listInstallationReposForAuthenticatedUser", + "method": "GET", + "url": "/user/installations/{installation_id}/repositories", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Add repository to installation", + "scope": "apps", + "id": "addRepoToInstallation", + "method": "PUT", + "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repository_id parameter", + "enum": null, + "name": "repository_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Remove repository from installation", + "scope": "apps", + "id": "removeRepoFromInstallation", + "method": "DELETE", + "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repository_id parameter", + "enum": null, + "name": "repository_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List all issues across owned and member repositories assigned to the authenticated user", + "scope": "issues", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "enum": null, + "name": "labels", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "enum": ["created", "updated", "comments"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List your public keys", + "scope": "users", + "id": "listPublicKeys", + "method": "GET", + "url": "/user/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a public key", + "scope": "users", + "id": "createPublicKey", + "method": "POST", + "url": "/user/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key \"Personal MacBook Air\".", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The public SSH key to add to your GitHub account. See \"[Generating a new SSH key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)\" for guidance on how to create a public SSH key.", + "enum": null, + "name": "key", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single public key", + "scope": "users", + "id": "getPublicKey", + "method": "GET", + "url": "/user/keys/{key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key_id parameter", + "enum": null, + "name": "key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a public key", + "scope": "users", + "id": "deletePublicKey", + "method": "DELETE", + "url": "/user/keys/{key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key_id parameter", + "enum": null, + "name": "key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get a user's Marketplace purchases", + "scope": "apps", + "id": "listMarketplacePurchasesForAuthenticatedUser", + "method": "GET", + "url": "/user/marketplace_purchases", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a user's Marketplace purchases (stubbed)", + "scope": "apps", + "id": "listMarketplacePurchasesForAuthenticatedUserStubbed", + "method": "GET", + "url": "/user/marketplace_purchases/stubbed", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List your organization memberships", + "scope": "orgs", + "id": "listMemberships", + "method": "GET", + "url": "/user/memberships/orgs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.", + "enum": ["active", "pending"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get your organization membership", + "scope": "orgs", + "id": "getMembershipForAuthenticatedUser", + "method": "GET", + "url": "/user/memberships/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Edit your organization membership", + "scope": "orgs", + "id": "updateMembership", + "method": "PATCH", + "url": "/user/memberships/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", + "enum": ["active"], + "name": "state", + "type": "string", + "required": true + } + ] + }, + { + "name": "Start a user migration", + "scope": "migrations", + "id": "startForAuthenticatedUser", + "method": "POST", + "url": "/user/migrations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of repositories to include in the migration.", + "enum": null, + "name": "repositories", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Locks the `repositories` to prevent changes during the migration when set to `true`.", + "enum": null, + "name": "lock_repositories", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Does not include attachments uploaded to GitHub.com in the migration data when set to `true`. Excluding attachments will reduce the migration archive file size.", + "enum": null, + "name": "exclude_attachments", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a list of user migrations", + "scope": "migrations", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/migrations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the status of a user migration", + "scope": "migrations", + "id": "getStatusForAuthenticatedUser", + "method": "GET", + "url": "/user/migrations/{migration_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Download a user migration archive", + "scope": "migrations", + "id": "getArchiveForAuthenticatedUser", + "method": "GET", + "url": "/user/migrations/{migration_id}/archive", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a user migration archive", + "scope": "migrations", + "id": "deleteArchiveForAuthenticatedUser", + "method": "DELETE", + "url": "/user/migrations/{migration_id}/archive", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Unlock a user repository", + "scope": "migrations", + "id": "unlockRepoForAuthenticatedUser", + "method": "DELETE", + "url": "/user/migrations/{migration_id}/repos/{repo_name}/lock", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo_name parameter", + "enum": null, + "name": "repo_name", + "type": "string", + "required": true + } + ] + }, + { + "name": "List your organizations", + "scope": "orgs", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/orgs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a user project", + "scope": "projects", + "id": "createForAuthenticatedUser", + "method": "POST", + "url": "/user/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the project.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the project.", + "enum": null, + "name": "body", + "type": "string", + "required": false + } + ] + }, + { + "name": "List public email addresses for a user", + "scope": "users", + "id": "listPublicEmails", + "method": "GET", + "url": "/user/public_emails", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List your repositories", + "scope": "repos", + "id": "list", + "method": "GET", + "url": "/user/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `all`, `public`, or `private`.", + "enum": ["all", "public", "private"], + "name": "visibility", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", + "enum": null, + "name": "affiliation", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "enum": ["all", "owner", "public", "private", "member"], + "name": "type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "enum": ["created", "updated", "pushed", "full_name"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Creates a new repository for the authenticated user", + "scope": "repos", + "id": "createForAuthenticatedUser", + "method": "POST", + "url": "/user/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the repository.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the repository.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL with more information about the repository.", + "enum": null, + "name": "homepage", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "enum": null, + "name": "has_issues", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "enum": null, + "name": "has_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "enum": null, + "name": "has_wiki", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "enum": null, + "name": "is_template", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", + "enum": null, + "name": "team_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Pass `true` to create an initial commit with empty README.", + "enum": null, + "name": "auto_init", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", + "enum": null, + "name": "gitignore_template", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", + "enum": null, + "name": "license_template", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "enum": null, + "name": "allow_squash_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "enum": null, + "name": "allow_merge_commit", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "enum": null, + "name": "allow_rebase_merge", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List a user's repository invitations", + "scope": "repos", + "id": "listInvitationsForAuthenticatedUser", + "method": "GET", + "url": "/user/repository_invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Accept a repository invitation", + "scope": "repos", + "id": "acceptInvitation", + "method": "PATCH", + "url": "/user/repository_invitations/{invitation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Decline a repository invitation", + "scope": "repos", + "id": "declineInvitation", + "method": "DELETE", + "url": "/user/repository_invitations/{invitation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List repositories being starred by the authenticated user", + "scope": "activity", + "id": "listReposStarredByAuthenticatedUser", + "method": "GET", + "url": "/user/starred", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "One of `asc` (ascending) or `desc` (descending).", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if you are starring a repository", + "scope": "activity", + "id": "checkStarringRepo", + "method": "GET", + "url": "/user/starred/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Star a repository", + "scope": "activity", + "id": "starRepo", + "method": "PUT", + "url": "/user/starred/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unstar a repository", + "scope": "activity", + "id": "unstarRepo", + "method": "DELETE", + "url": "/user/starred/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List repositories being watched by the authenticated user", + "scope": "activity", + "id": "listWatchedReposForAuthenticatedUser", + "method": "GET", + "url": "/user/subscriptions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if you are watching a repository (LEGACY)", + "scope": "activity", + "id": "checkWatchingRepoLegacy", + "method": "GET", + "url": "/user/subscriptions/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Watch a repository (LEGACY)", + "scope": "activity", + "id": "watchRepoLegacy", + "method": "PUT", + "url": "/user/subscriptions/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Stop watching a repository (LEGACY)", + "scope": "activity", + "id": "stopWatchingRepoLegacy", + "method": "DELETE", + "url": "/user/subscriptions/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List user teams", + "scope": "teams", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get all users", + "scope": "users", + "id": "list", + "method": "GET", + "url": "/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The integer ID of the last User that you've seen.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single user", + "scope": "users", + "id": "getByUsername", + "method": "GET", + "url": "/users/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List events performed by a user", + "scope": "activity", + "id": "listEventsForUser", + "method": "GET", + "url": "/users/{username}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List events for an organization", + "scope": "activity", + "id": "listEventsForOrg", + "method": "GET", + "url": "/users/{username}/events/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List public events performed by a user", + "scope": "activity", + "id": "listPublicEventsForUser", + "method": "GET", + "url": "/users/{username}/events/public", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List a user's followers", + "scope": "users", + "id": "listFollowersForUser", + "method": "GET", + "url": "/users/{username}/followers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List who a user is following", + "scope": "users", + "id": "listFollowingForUser", + "method": "GET", + "url": "/users/{username}/following", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if one user follows another", + "scope": "users", + "id": "checkFollowingForUser", + "method": "GET", + "url": "/users/{username}/following/{target_user}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "target_user parameter", + "enum": null, + "name": "target_user", + "type": "string", + "required": true + } + ] + }, + { + "name": "List public gists for the specified user", + "scope": "gists", + "id": "listPublicForUser", + "method": "GET", + "url": "/users/{username}/gists", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List GPG keys for a user", + "scope": "users", + "id": "listGpgKeysForUser", + "method": "GET", + "url": "/users/{username}/gpg_keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get contextual information about a user", + "scope": "users", + "id": "getContextForUser", + "method": "GET", + "url": "/users/{username}/hovercard", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.", + "enum": ["organization", "repository", "issue", "pull_request"], + "name": "subject_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", + "enum": null, + "name": "subject_id", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a user installation", + "scope": "apps", + "id": "getUserInstallation", + "method": "GET", + "url": "/users/{username}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a user installation", + "scope": "apps", + "id": "findUserInstallation", + "method": "GET", + "url": "/users/{username}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List public keys for a user", + "scope": "users", + "id": "listPublicKeysForUser", + "method": "GET", + "url": "/users/{username}/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List user organizations", + "scope": "orgs", + "id": "listForUser", + "method": "GET", + "url": "/users/{username}/orgs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List user projects", + "scope": "projects", + "id": "listForUser", + "method": "GET", + "url": "/users/{username}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List events that a user has received", + "scope": "activity", + "id": "listReceivedEventsForUser", + "method": "GET", + "url": "/users/{username}/received_events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List public events that a user has received", + "scope": "activity", + "id": "listReceivedPublicEventsForUser", + "method": "GET", + "url": "/users/{username}/received_events/public", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List user repositories", + "scope": "repos", + "id": "listForUser", + "method": "GET", + "url": "/users/{username}/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `all`, `owner`, `member`.", + "enum": ["all", "owner", "member"], + "name": "type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "enum": ["created", "updated", "pushed", "full_name"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List repositories being starred by a user", + "scope": "activity", + "id": "listReposStarredByUser", + "method": "GET", + "url": "/users/{username}/starred", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "One of `asc` (ascending) or `desc` (descending).", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List repositories being watched by a user", + "scope": "activity", + "id": "listReposWatchedByUser", + "method": "GET", + "url": "/users/{username}/subscriptions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + } +] diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template new file mode 100644 index 00000000..2eceb2f9 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template @@ -0,0 +1,33 @@ +// DO NOT EDIT THIS FILE +import { RequestHeaders } from "../RequestHeaders"; +import { RequestRequestOptions } from "../RequestRequestOptions"; +import { Url } from "../Url"; + +export interface Endpoints { + {{#each endpointsByRoute}} + "{{@key}}": [{{union this "optionsTypeName"}}, {{union this "requestOptionsTypeName"}}] + {{/each}} +} + +{{#each options}} +type {{in.name}} = { +{{#each in.parameters}} + {{&jsdoc}} + {{{name this}}}: {{{type this}}} +{{/each}} +} +type {{out.name}} = { + method: "{{out.method}}", + url: Url, + headers: RequestHeaders, + request: RequestRequestOptions +} +{{/each}} + +{{#childParams}} +export type {{paramTypeName}} = { +{{#params}} + {{{name this}}}: {{{type this}}} +{{/params}} +}; +{{/childParams}} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/typescript.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/typescript.js new file mode 100644 index 00000000..2095c6c2 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/scripts/update-endpoints/typescript.js @@ -0,0 +1,179 @@ +const { readFileSync, writeFileSync } = require("fs"); +const { resolve } = require("path"); + +const Handlebars = require("handlebars"); +const set = require("lodash.set"); +const pascalCase = require("pascal-case"); +const prettier = require("prettier"); +const { stringToJsdocComment } = require("string-to-jsdoc-comment"); +const sortKeys = require("sort-keys"); + +const ENDPOINTS = require("./generated/Endpoints.json"); +const ENDPOINTS_PATH = resolve( + process.cwd(), + "src", + "generated", + "Endpoints.ts" +); +const ENDPOINTS_TEMPLATE_PATH = resolve( + process.cwd(), + "scripts", + "update-endpoints", + "templates", + "endpoints.ts.template" +); + +Handlebars.registerHelper("union", function(endpoints, key) { + return endpoints.map(endpoint => endpoint[key]).join(" | "); +}); +Handlebars.registerHelper("name", function(parameter) { + let name = parameter.key; + + if (/[.\[]/.test(name)) { + name = `"${name}"`; + } + + if (parameter.required) { + return name; + } + + return `${name}?`; +}); + +Handlebars.registerHelper("type", function(parameter) { + const type = typeMap[parameter.type] || parameter.type; + + if (parameter.allowNull) { + return `${type} | null`; + } + + return type; +}); +const template = Handlebars.compile( + readFileSync(ENDPOINTS_TEMPLATE_PATH, "utf8") +); + +const endpointsByRoute = {}; + +const typeMap = { + integer: "number", + "integer[]": "number[]" +}; + +for (const endpoint of ENDPOINTS) { + const route = `${endpoint.method} ${endpoint.url.replace( + /\{([^}]+)}/g, + ":$1" + )}`; + + if (!endpointsByRoute[route]) { + endpointsByRoute[route] = []; + } + + endpointsByRoute[route].push({ + optionsTypeName: + pascalCase(`${endpoint.scope} ${endpoint.id}`) + "Endpoint", + requestOptionsTypeName: + pascalCase(`${endpoint.scope} ${endpoint.id}`) + "RequestOptions" + }); +} + +const options = []; +const childParams = {}; + +for (const endpoint of ENDPOINTS) { + const { method, parameters } = endpoint; + + const optionsTypeName = + pascalCase(`${endpoint.scope} ${endpoint.id}`) + "Endpoint"; + const requestOptionsTypeName = + pascalCase(`${endpoint.scope} ${endpoint.id}`) + "RequestOptions"; + + options.push({ + in: { + name: optionsTypeName, + parameters: parameters + .map(parameterize) + // handle "object" & "object[]" types + .map(parameter => { + if (parameter.deprecated) { + return; + } + + const namespacedParamsName = pascalCase( + `${endpoint.scope}.${endpoint.id}.Params` + ); + + if (parameter.type === "object" || parameter.type === "object[]") { + const childParamsName = pascalCase( + `${namespacedParamsName}.${parameter.key}` + ); + + parameter.type = parameter.type.replace("object", childParamsName); + + if (!childParams[childParamsName]) { + childParams[childParamsName] = {}; + } + } + + if (!/\./.test(parameter.key)) { + return parameter; + } + + const childKey = parameter.key.split(".").pop(); + const parentKey = parameter.key.replace(/\.[^.]+$/, ""); + + parameter.key = childKey; + + const childParamsName = pascalCase( + `${namespacedParamsName}.${parentKey}` + ); + set(childParams, `${childParamsName}.${childKey}`, parameter); + }) + .filter(Boolean) + }, + out: { + name: requestOptionsTypeName, + method + } + }); +} + +const result = template({ + endpointsByRoute: sortKeys(endpointsByRoute, { deep: true }), + options, + childParams: Object.keys(childParams).map(key => { + if (key === "GistsCreateParamsFiles") { + debugger; + } + return { + paramTypeName: key, + params: Object.values(childParams[key]) + }; + }) +}); + +writeFileSync( + ENDPOINTS_PATH, + prettier.format(result, { parser: "typescript" }) +); +console.log(`${ENDPOINTS_PATH} updated.`); + +function parameterize(parameter) { + const key = parameter.name; + const type = typeMap[parameter.type] || parameter.type; + const enums = parameter.enum + ? parameter.enum.map(JSON.stringify).join("|") + : null; + + return { + name: pascalCase(key), + key: key, + required: parameter.required, + type: enums || type, + alias: parameter.alias, + deprecated: parameter.deprecated, + allowNull: parameter.allowNull, + jsdoc: stringToJsdocComment(parameter.description) + }; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/AuthInterface.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/AuthInterface.ts new file mode 100644 index 00000000..8f587436 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/AuthInterface.ts @@ -0,0 +1,43 @@ +import { EndpointOptions } from "./EndpointOptions"; +import { OctokitResponse } from "./OctokitResponse"; +import { RequestInterface } from "./RequestInterface"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; + +/** + * Interface to implement complex authentication strategies for Octokit. + * An object Implementing the AuthInterface can directly be passed as the + * `auth` option in the Octokit constructor. + * + * For the official implementations of the most common authentication + * strategies, see https://github.com/octokit/auth.js + */ +export interface AuthInterface< + AuthOptions extends any[], + Authentication extends any +> { + (...args: AuthOptions): Promise; + + hook: { + /** + * Sends a request using the passed `request` instance + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: RequestInterface, options: EndpointOptions): Promise< + OctokitResponse + >; + + /** + * Sends a request using the passed `request` instance + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + ( + request: RequestInterface, + route: Route, + parameters?: RequestParameters + ): Promise>; + }; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/EndpointDefaults.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/EndpointDefaults.ts new file mode 100644 index 00000000..024f6ebb --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/EndpointDefaults.ts @@ -0,0 +1,22 @@ +import { RequestHeaders } from "./RequestHeaders"; +import { RequestMethod } from "./RequestMethod"; +import { RequestParameters } from "./RequestParameters"; +import { Url } from "./Url"; + +/** + * The `.endpoint()` method is guaranteed to set all keys defined by RequestParameters + * as well as the method property. + */ +export type EndpointDefaults = RequestParameters & { + baseUrl: Url; + method: RequestMethod; + url?: Url; + headers: RequestHeaders & { + accept: string; + "user-agent": string; + }; + mediaType: { + format: string; + previews: string[]; + }; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/EndpointInterface.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/EndpointInterface.ts new file mode 100644 index 00000000..fee78d61 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/EndpointInterface.ts @@ -0,0 +1,74 @@ +import { EndpointDefaults } from "./EndpointDefaults"; +import { EndpointOptions } from "./EndpointOptions"; +import { RequestOptions } from "./RequestOptions"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; + +import { Endpoints } from "./generated/Endpoints"; + +export interface EndpointInterface { + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: EndpointOptions): RequestOptions; + + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + ( + route: keyof Endpoints | R, + options?: R extends keyof Endpoints + ? Endpoints[R][0] & RequestParameters + : RequestParameters + ): R extends keyof Endpoints ? Endpoints[R][1] : RequestOptions; + + /** + * Object with current default route and parameters + */ + DEFAULTS: EndpointDefaults; + + /** + * Returns a new `endpoint` with updated route and parameters + */ + defaults: (newDefaults: RequestParameters) => EndpointInterface; + + merge: { + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * + */ + (route: Route, parameters?: RequestParameters): EndpointDefaults; + + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: RequestParameters): EndpointDefaults; + + /** + * Returns current default options. + * + * @deprecated use endpoint.DEFAULTS instead + */ + (): EndpointDefaults; + }; + + /** + * Stateless method to turn endpoint options into request options. + * Calling `endpoint(options)` is the same as calling `endpoint.parse(endpoint.merge(options))`. + * + * @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + parse: (options: EndpointDefaults) => RequestOptions; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/EndpointOptions.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/EndpointOptions.ts new file mode 100644 index 00000000..01706049 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/EndpointOptions.ts @@ -0,0 +1,8 @@ +import { RequestMethod } from "./RequestMethod"; +import { Url } from "./Url"; +import { RequestParameters } from "./RequestParameters"; + +export type EndpointOptions = RequestParameters & { + method: RequestMethod; + url: Url; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Fetch.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Fetch.ts new file mode 100644 index 00000000..983c79be --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Fetch.ts @@ -0,0 +1,4 @@ +/** + * Browser's fetch method (or compatible such as fetch-mock) + */ +export type Fetch = any; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/OctokitResponse.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/OctokitResponse.ts new file mode 100644 index 00000000..4cec20d9 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/OctokitResponse.ts @@ -0,0 +1,18 @@ +import { ResponseHeaders } from "./ResponseHeaders"; +import { Url } from "./Url"; + +export type OctokitResponse = { + headers: ResponseHeaders; + /** + * http response code + */ + status: number; + /** + * URL of response after all redirects + */ + url: Url; + /** + * This is the data you would see in https://developer.Octokit.com/v3/ + */ + data: T; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestHeaders.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestHeaders.ts new file mode 100644 index 00000000..0df66361 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestHeaders.ts @@ -0,0 +1,15 @@ +export type RequestHeaders = { + /** + * Avoid setting `headers.accept`, use `mediaType.{format|previews}` option instead. + */ + accept?: string; + /** + * Use `authorization` to send authenticated request, remember `token ` / `bearer ` prefixes. Example: `token 1234567890abcdef1234567890abcdef12345678` + */ + authorization?: string; + /** + * `user-agent` is set do a default and can be overwritten as needed. + */ + "user-agent"?: string; + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestInterface.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestInterface.ts new file mode 100644 index 00000000..21bd0876 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestInterface.ts @@ -0,0 +1,51 @@ +import { EndpointInterface } from "./EndpointInterface"; +import { EndpointOptions } from "./EndpointOptions"; +import { RequestParameters } from "./RequestParameters"; +import { ResponseHeaders } from "./ResponseHeaders"; +import { Route } from "./Route"; +import { Url } from "./Url"; + +export interface RequestInterface { + /** + * Sends a request based on endpoint options + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: EndpointOptions): Promise>; + + /** + * Sends a request based on endpoint options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: Route, parameters?: RequestParameters): Promise< + OctokitResponse + >; + + /** + * Returns a new `endpoint` with updated route and parameters + */ + defaults: (newDefaults: RequestParameters) => RequestInterface; + + /** + * Octokit endpoint API, see {@link https://github.com/octokit/endpoint.js|@octokit/endpoint} + */ + endpoint: EndpointInterface; +} + +export type OctokitResponse = { + headers: ResponseHeaders; + /** + * http response code + */ + status: number; + /** + * URL of response after all redirects + */ + url: Url; + /** + * This is the data you would see in https://developer.Octokit.com/v3/ + */ + data: T; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestMethod.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestMethod.ts new file mode 100644 index 00000000..2910435a --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestMethod.ts @@ -0,0 +1,10 @@ +/** + * HTTP Verb supported by GitHub's REST API + */ +export type RequestMethod = + | "DELETE" + | "GET" + | "HEAD" + | "PATCH" + | "POST" + | "PUT"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestOptions.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestOptions.ts new file mode 100644 index 00000000..4d765c09 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestOptions.ts @@ -0,0 +1,15 @@ +import { RequestHeaders } from "./RequestHeaders"; +import { RequestMethod } from "./RequestMethod"; +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { Url } from "./Url"; + +/** + * Generic request options as they are returned by the `endpoint()` method + */ +export type RequestOptions = { + method: RequestMethod; + url: Url; + headers: RequestHeaders; + body?: any; + request?: RequestRequestOptions; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestParameters.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestParameters.ts new file mode 100644 index 00000000..9766be00 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestParameters.ts @@ -0,0 +1,46 @@ +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { RequestHeaders } from "./RequestHeaders"; +import { Url } from "./Url"; + +/** + * Parameters that can be passed into `request(route, parameters)` or `endpoint(route, parameters)` methods + */ +export type RequestParameters = { + /** + * Base URL to be used when a relative URL is passed, such as `/orgs/:org`. + * If `baseUrl` is `https://enterprise.acme-inc.com/api/v3`, then the request + * will be sent to `https://enterprise.acme-inc.com/api/v3/orgs/:org`. + */ + baseUrl?: Url; + /** + * HTTP headers. Use lowercase keys. + */ + headers?: RequestHeaders; + /** + * Media type options, see {@link https://developer.github.com/v3/media/|GitHub Developer Guide} + */ + mediaType?: { + /** + * `json` by default. Can be `raw`, `text`, `html`, `full`, `diff`, `patch`, `sha`, `base64`. Depending on endpoint + */ + format?: string; + /** + * Custom media type names of {@link https://developer.github.com/v3/media/|API Previews} without the `-preview` suffix. + * Example for single preview: `['squirrel-girl']`. + * Example for multiple previews: `['squirrel-girl', 'mister-fantastic']`. + */ + previews?: string[]; + }; + /** + * Pass custom meta information for the request. The `request` object will be returned as is. + */ + request?: RequestRequestOptions; + /** + * Any additional parameter will be passed as follows + * 1. URL parameter if `':parameter'` or `{parameter}` is part of `url` + * 2. Query parameter if `method` is `'GET'` or `'HEAD'` + * 3. Request body if `parameter` is `'data'` + * 4. JSON in the request body in the form of `body[parameter]` unless `parameter` key is `'data'` + */ + [parameter: string]: any; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestRequestOptions.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestRequestOptions.ts new file mode 100644 index 00000000..028d6f72 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/RequestRequestOptions.ts @@ -0,0 +1,27 @@ +import { Agent } from "http"; +import { Fetch } from "./Fetch"; +import { Signal } from "./Signal"; + +/** + * Octokit-specific request options which are ignored for the actual request, but can be used by Octokit or plugins to manipulate how the request is sent or how a response is handled + */ +export type RequestRequestOptions = { + /** + * Node only. Useful for custom proxy, certificate, or dns lookup. + */ + agent?: Agent; + /** + * Custom replacement for built-in fetch method. Useful for testing or request hooks. + */ + fetch?: Fetch; + /** + * Use an `AbortController` instance to cancel a request. In node you can only cancel streamed requests. + */ + signal?: Signal; + /** + * Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). `options.request.signal` is recommended instead. + */ + timeout?: number; + + [option: string]: any; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/ResponseHeaders.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/ResponseHeaders.ts new file mode 100644 index 00000000..17267b60 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/ResponseHeaders.ts @@ -0,0 +1,21 @@ +export type ResponseHeaders = { + "cache-control"?: string; + "content-length"?: number; + "content-type"?: string; + date?: string; + etag?: string; + "last-modified"?: string; + link?: string; + location?: string; + server?: string; + status?: string; + vary?: string; + "x-github-mediatype"?: string; + "x-github-request-id"?: string; + "x-oauth-scopes"?: string; + "x-ratelimit-limit"?: string; + "x-ratelimit-remaining"?: string; + "x-ratelimit-reset"?: string; + + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Route.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Route.ts new file mode 100644 index 00000000..c5229a8b --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Route.ts @@ -0,0 +1,4 @@ +/** + * String consisting of an optional HTTP method and relative path or absolute URL. Examples: `'/orgs/:org'`, `'PUT /orgs/:org'`, `GET https://example.com/foo/bar` + */ +export type Route = string; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Signal.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Signal.ts new file mode 100644 index 00000000..bdf97001 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Signal.ts @@ -0,0 +1,6 @@ +/** + * Abort signal + * + * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal + */ +export type Signal = any; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/StrategyInterface.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/StrategyInterface.ts new file mode 100644 index 00000000..60a55add --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/StrategyInterface.ts @@ -0,0 +1,9 @@ +import { AuthInterface } from "./AuthInterface"; + +export interface StrategyInterface< + StrategyOptions extends any[], + AuthOptions extends any[], + Authentication extends object +> { + (...args: StrategyOptions): AuthInterface; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Url.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Url.ts new file mode 100644 index 00000000..9d228cbf --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/Url.ts @@ -0,0 +1,4 @@ +/** + * Relative or absolute URL. Examples: `'/orgs/:org'`, `https://example.com/foo/bar` + */ +export type Url = string; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/VERSION.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/VERSION.ts new file mode 100644 index 00000000..4652f248 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/VERSION.ts @@ -0,0 +1 @@ +export const VERSION = "2.0.1"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/generated/Endpoints.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/generated/Endpoints.ts new file mode 100644 index 00000000..3aec9145 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/generated/Endpoints.ts @@ -0,0 +1,14190 @@ +// DO NOT EDIT THIS FILE +import { RequestHeaders } from "../RequestHeaders"; +import { RequestRequestOptions } from "../RequestRequestOptions"; +import { Url } from "../Url"; + +export interface Endpoints { + "DELETE /app/installations/:installation_id": [ + AppsDeleteInstallationEndpoint, + AppsDeleteInstallationRequestOptions + ]; + "DELETE /applications/:client_id/grants/:access_token": [ + OauthAuthorizationsRevokeGrantForApplicationEndpoint, + OauthAuthorizationsRevokeGrantForApplicationRequestOptions + ]; + "DELETE /applications/:client_id/tokens/:access_token": [ + OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint, + OauthAuthorizationsRevokeAuthorizationForApplicationRequestOptions + ]; + "DELETE /applications/grants/:grant_id": [ + OauthAuthorizationsDeleteGrantEndpoint, + OauthAuthorizationsDeleteGrantRequestOptions + ]; + "DELETE /authorizations/:authorization_id": [ + OauthAuthorizationsDeleteAuthorizationEndpoint, + OauthAuthorizationsDeleteAuthorizationRequestOptions + ]; + "DELETE /gists/:gist_id": [GistsDeleteEndpoint, GistsDeleteRequestOptions]; + "DELETE /gists/:gist_id/comments/:comment_id": [ + GistsDeleteCommentEndpoint, + GistsDeleteCommentRequestOptions + ]; + "DELETE /gists/:gist_id/star": [ + GistsUnstarEndpoint, + GistsUnstarRequestOptions + ]; + "DELETE /notifications/threads/:thread_id/subscription": [ + ActivityDeleteThreadSubscriptionEndpoint, + ActivityDeleteThreadSubscriptionRequestOptions + ]; + "DELETE /orgs/:org/blocks/:username": [ + OrgsUnblockUserEndpoint, + OrgsUnblockUserRequestOptions + ]; + "DELETE /orgs/:org/credential-authorizations/:credential_id": [ + OrgsRemoveCredentialAuthorizationEndpoint, + OrgsRemoveCredentialAuthorizationRequestOptions + ]; + "DELETE /orgs/:org/hooks/:hook_id": [ + OrgsDeleteHookEndpoint, + OrgsDeleteHookRequestOptions + ]; + "DELETE /orgs/:org/interaction-limits": [ + InteractionsRemoveRestrictionsForOrgEndpoint, + InteractionsRemoveRestrictionsForOrgRequestOptions + ]; + "DELETE /orgs/:org/members/:username": [ + OrgsRemoveMemberEndpoint, + OrgsRemoveMemberRequestOptions + ]; + "DELETE /orgs/:org/memberships/:username": [ + OrgsRemoveMembershipEndpoint, + OrgsRemoveMembershipRequestOptions + ]; + "DELETE /orgs/:org/migrations/:migration_id/archive": [ + MigrationsDeleteArchiveForOrgEndpoint, + MigrationsDeleteArchiveForOrgRequestOptions + ]; + "DELETE /orgs/:org/migrations/:migration_id/repos/:repo_name/lock": [ + MigrationsUnlockRepoForOrgEndpoint, + MigrationsUnlockRepoForOrgRequestOptions + ]; + "DELETE /orgs/:org/outside_collaborators/:username": [ + OrgsRemoveOutsideCollaboratorEndpoint, + OrgsRemoveOutsideCollaboratorRequestOptions + ]; + "DELETE /orgs/:org/public_members/:username": [ + OrgsConcealMembershipEndpoint, + OrgsConcealMembershipRequestOptions + ]; + "DELETE /projects/:project_id": [ + ProjectsDeleteEndpoint, + ProjectsDeleteRequestOptions + ]; + "DELETE /projects/:project_id/collaborators/:username": [ + ProjectsRemoveCollaboratorEndpoint, + ProjectsRemoveCollaboratorRequestOptions + ]; + "DELETE /projects/columns/:column_id": [ + ProjectsDeleteColumnEndpoint, + ProjectsDeleteColumnRequestOptions + ]; + "DELETE /projects/columns/cards/:card_id": [ + ProjectsDeleteCardEndpoint, + ProjectsDeleteCardRequestOptions + ]; + "DELETE /reactions/:reaction_id": [ + ReactionsDeleteEndpoint, + ReactionsDeleteRequestOptions + ]; + "DELETE /repos/:owner/:repo": [ + ReposDeleteEndpoint, + ReposDeleteRequestOptions + ]; + "DELETE /repos/:owner/:repo/automated-security-fixes": [ + ReposDisableAutomatedSecurityFixesEndpoint, + ReposDisableAutomatedSecurityFixesRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection": [ + ReposRemoveBranchProtectionEndpoint, + ReposRemoveBranchProtectionRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ + ReposRemoveProtectedBranchAdminEnforcementEndpoint, + ReposRemoveProtectedBranchAdminEnforcementRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ + ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint, + ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ + ReposRemoveProtectedBranchRequiredSignaturesEndpoint, + ReposRemoveProtectedBranchRequiredSignaturesRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ + ReposRemoveProtectedBranchRequiredStatusChecksEndpoint, + ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ + ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint, + ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions": [ + ReposRemoveProtectedBranchRestrictionsEndpoint, + ReposRemoveProtectedBranchRestrictionsRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ + ReposRemoveProtectedBranchAppRestrictionsEndpoint, + ReposRemoveProtectedBranchAppRestrictionsRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ + ReposRemoveProtectedBranchTeamRestrictionsEndpoint, + ReposRemoveProtectedBranchTeamRestrictionsRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ + ReposRemoveProtectedBranchUserRestrictionsEndpoint, + ReposRemoveProtectedBranchUserRestrictionsRequestOptions + ]; + "DELETE /repos/:owner/:repo/collaborators/:username": [ + ReposRemoveCollaboratorEndpoint, + ReposRemoveCollaboratorRequestOptions + ]; + "DELETE /repos/:owner/:repo/comments/:comment_id": [ + ReposDeleteCommitCommentEndpoint, + ReposDeleteCommitCommentRequestOptions + ]; + "DELETE /repos/:owner/:repo/contents/:path": [ + ReposDeleteFileEndpoint, + ReposDeleteFileRequestOptions + ]; + "DELETE /repos/:owner/:repo/downloads/:download_id": [ + ReposDeleteDownloadEndpoint, + ReposDeleteDownloadRequestOptions + ]; + "DELETE /repos/:owner/:repo/git/refs/:ref": [ + GitDeleteRefEndpoint, + GitDeleteRefRequestOptions + ]; + "DELETE /repos/:owner/:repo/hooks/:hook_id": [ + ReposDeleteHookEndpoint, + ReposDeleteHookRequestOptions + ]; + "DELETE /repos/:owner/:repo/import": [ + MigrationsCancelImportEndpoint, + MigrationsCancelImportRequestOptions + ]; + "DELETE /repos/:owner/:repo/interaction-limits": [ + InteractionsRemoveRestrictionsForRepoEndpoint, + InteractionsRemoveRestrictionsForRepoRequestOptions + ]; + "DELETE /repos/:owner/:repo/invitations/:invitation_id": [ + ReposDeleteInvitationEndpoint, + ReposDeleteInvitationRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/:issue_number/assignees": [ + IssuesRemoveAssigneesEndpoint, + IssuesRemoveAssigneesRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/:issue_number/labels": [ + IssuesRemoveLabelsEndpoint, + IssuesRemoveLabelsRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name": [ + IssuesRemoveLabelEndpoint, + IssuesRemoveLabelRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/:issue_number/lock": [ + IssuesUnlockEndpoint, + IssuesUnlockRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/comments/:comment_id": [ + IssuesDeleteCommentEndpoint, + IssuesDeleteCommentRequestOptions + ]; + "DELETE /repos/:owner/:repo/keys/:key_id": [ + ReposRemoveDeployKeyEndpoint, + ReposRemoveDeployKeyRequestOptions + ]; + "DELETE /repos/:owner/:repo/labels/:name": [ + IssuesDeleteLabelEndpoint, + IssuesDeleteLabelRequestOptions + ]; + "DELETE /repos/:owner/:repo/milestones/:milestone_number": [ + IssuesDeleteMilestoneEndpoint, + IssuesDeleteMilestoneRequestOptions + ]; + "DELETE /repos/:owner/:repo/pages": [ + ReposDisablePagesSiteEndpoint, + ReposDisablePagesSiteRequestOptions + ]; + "DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ + PullsDeleteReviewRequestEndpoint, + PullsDeleteReviewRequestRequestOptions + ]; + "DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ + PullsDeletePendingReviewEndpoint, + PullsDeletePendingReviewRequestOptions + ]; + "DELETE /repos/:owner/:repo/pulls/comments/:comment_id": [ + PullsDeleteCommentEndpoint, + PullsDeleteCommentRequestOptions + ]; + "DELETE /repos/:owner/:repo/releases/:release_id": [ + ReposDeleteReleaseEndpoint, + ReposDeleteReleaseRequestOptions + ]; + "DELETE /repos/:owner/:repo/releases/assets/:asset_id": [ + ReposDeleteReleaseAssetEndpoint, + ReposDeleteReleaseAssetRequestOptions + ]; + "DELETE /repos/:owner/:repo/subscription": [ + ActivityDeleteRepoSubscriptionEndpoint, + ActivityDeleteRepoSubscriptionRequestOptions + ]; + "DELETE /repos/:owner/:repo/vulnerability-alerts": [ + ReposDisableVulnerabilityAlertsEndpoint, + ReposDisableVulnerabilityAlertsRequestOptions + ]; + "DELETE /scim/v2/organizations/:org/Users/:scim_user_id": [ + ScimRemoveUserFromOrgEndpoint, + ScimRemoveUserFromOrgRequestOptions + ]; + "DELETE /teams/:team_id": [TeamsDeleteEndpoint, TeamsDeleteRequestOptions]; + "DELETE /teams/:team_id/discussions/:discussion_number": [ + TeamsDeleteDiscussionEndpoint, + TeamsDeleteDiscussionRequestOptions + ]; + "DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ + TeamsDeleteDiscussionCommentEndpoint, + TeamsDeleteDiscussionCommentRequestOptions + ]; + "DELETE /teams/:team_id/members/:username": [ + TeamsRemoveMemberEndpoint, + TeamsRemoveMemberRequestOptions + ]; + "DELETE /teams/:team_id/memberships/:username": [ + TeamsRemoveMembershipEndpoint, + TeamsRemoveMembershipRequestOptions + ]; + "DELETE /teams/:team_id/projects/:project_id": [ + TeamsRemoveProjectEndpoint, + TeamsRemoveProjectRequestOptions + ]; + "DELETE /teams/:team_id/repos/:owner/:repo": [ + TeamsRemoveRepoEndpoint, + TeamsRemoveRepoRequestOptions + ]; + "DELETE /user/blocks/:username": [ + UsersUnblockEndpoint, + UsersUnblockRequestOptions + ]; + "DELETE /user/emails": [ + UsersDeleteEmailsEndpoint, + UsersDeleteEmailsRequestOptions + ]; + "DELETE /user/following/:username": [ + UsersUnfollowEndpoint, + UsersUnfollowRequestOptions + ]; + "DELETE /user/gpg_keys/:gpg_key_id": [ + UsersDeleteGpgKeyEndpoint, + UsersDeleteGpgKeyRequestOptions + ]; + "DELETE /user/installations/:installation_id/repositories/:repository_id": [ + AppsRemoveRepoFromInstallationEndpoint, + AppsRemoveRepoFromInstallationRequestOptions + ]; + "DELETE /user/keys/:key_id": [ + UsersDeletePublicKeyEndpoint, + UsersDeletePublicKeyRequestOptions + ]; + "DELETE /user/migrations/:migration_id/archive": [ + MigrationsDeleteArchiveForAuthenticatedUserEndpoint, + MigrationsDeleteArchiveForAuthenticatedUserRequestOptions + ]; + "DELETE /user/migrations/:migration_id/repos/:repo_name/lock": [ + MigrationsUnlockRepoForAuthenticatedUserEndpoint, + MigrationsUnlockRepoForAuthenticatedUserRequestOptions + ]; + "DELETE /user/repository_invitations/:invitation_id": [ + ReposDeclineInvitationEndpoint, + ReposDeclineInvitationRequestOptions + ]; + "DELETE /user/starred/:owner/:repo": [ + ActivityUnstarRepoEndpoint, + ActivityUnstarRepoRequestOptions + ]; + "DELETE /user/subscriptions/:owner/:repo": [ + ActivityStopWatchingRepoLegacyEndpoint, + ActivityStopWatchingRepoLegacyRequestOptions + ]; + "GET /app": [ + AppsGetAuthenticatedEndpoint, + AppsGetAuthenticatedRequestOptions + ]; + "GET /app/installations": [ + AppsListInstallationsEndpoint, + AppsListInstallationsRequestOptions + ]; + "GET /app/installations/:installation_id": [ + AppsGetInstallationEndpoint, + AppsGetInstallationRequestOptions + ]; + "GET /applications/:client_id/tokens/:access_token": [ + OauthAuthorizationsCheckAuthorizationEndpoint, + OauthAuthorizationsCheckAuthorizationRequestOptions + ]; + "GET /applications/grants": [ + OauthAuthorizationsListGrantsEndpoint, + OauthAuthorizationsListGrantsRequestOptions + ]; + "GET /applications/grants/:grant_id": [ + OauthAuthorizationsGetGrantEndpoint, + OauthAuthorizationsGetGrantRequestOptions + ]; + "GET /apps/:app_slug": [AppsGetBySlugEndpoint, AppsGetBySlugRequestOptions]; + "GET /authorizations": [ + OauthAuthorizationsListAuthorizationsEndpoint, + OauthAuthorizationsListAuthorizationsRequestOptions + ]; + "GET /authorizations/:authorization_id": [ + OauthAuthorizationsGetAuthorizationEndpoint, + OauthAuthorizationsGetAuthorizationRequestOptions + ]; + "GET /codes_of_conduct": [ + CodesOfConductListConductCodesEndpoint, + CodesOfConductListConductCodesRequestOptions + ]; + "GET /codes_of_conduct/:key": [ + CodesOfConductGetConductCodeEndpoint, + CodesOfConductGetConductCodeRequestOptions + ]; + "GET /emojis": [EmojisGetEndpoint, EmojisGetRequestOptions]; + "GET /events": [ + ActivityListPublicEventsEndpoint, + ActivityListPublicEventsRequestOptions + ]; + "GET /feeds": [ActivityListFeedsEndpoint, ActivityListFeedsRequestOptions]; + "GET /gists": [GistsListEndpoint, GistsListRequestOptions]; + "GET /gists/:gist_id": [GistsGetEndpoint, GistsGetRequestOptions]; + "GET /gists/:gist_id/:sha": [ + GistsGetRevisionEndpoint, + GistsGetRevisionRequestOptions + ]; + "GET /gists/:gist_id/comments": [ + GistsListCommentsEndpoint, + GistsListCommentsRequestOptions + ]; + "GET /gists/:gist_id/comments/:comment_id": [ + GistsGetCommentEndpoint, + GistsGetCommentRequestOptions + ]; + "GET /gists/:gist_id/commits": [ + GistsListCommitsEndpoint, + GistsListCommitsRequestOptions + ]; + "GET /gists/:gist_id/forks": [ + GistsListForksEndpoint, + GistsListForksRequestOptions + ]; + "GET /gists/:gist_id/star": [ + GistsCheckIsStarredEndpoint, + GistsCheckIsStarredRequestOptions + ]; + "GET /gists/public": [GistsListPublicEndpoint, GistsListPublicRequestOptions]; + "GET /gists/starred": [ + GistsListStarredEndpoint, + GistsListStarredRequestOptions + ]; + "GET /gitignore/templates": [ + GitignoreListTemplatesEndpoint, + GitignoreListTemplatesRequestOptions + ]; + "GET /gitignore/templates/:name": [ + GitignoreGetTemplateEndpoint, + GitignoreGetTemplateRequestOptions + ]; + "GET /installation/repositories": [ + AppsListReposEndpoint, + AppsListReposRequestOptions + ]; + "GET /issues": [IssuesListEndpoint, IssuesListRequestOptions]; + "GET /legacy/issues/search/:owner/:repository/:state/:keyword": [ + SearchIssuesLegacyEndpoint, + SearchIssuesLegacyRequestOptions + ]; + "GET /legacy/repos/search/:keyword": [ + SearchReposLegacyEndpoint, + SearchReposLegacyRequestOptions + ]; + "GET /legacy/user/email/:email": [ + SearchEmailLegacyEndpoint, + SearchEmailLegacyRequestOptions + ]; + "GET /legacy/user/search/:keyword": [ + SearchUsersLegacyEndpoint, + SearchUsersLegacyRequestOptions + ]; + "GET /licenses": [ + LicensesListCommonlyUsedEndpoint | LicensesListEndpoint, + LicensesListCommonlyUsedRequestOptions | LicensesListRequestOptions + ]; + "GET /licenses/:license": [LicensesGetEndpoint, LicensesGetRequestOptions]; + "GET /marketplace_listing/accounts/:account_id": [ + AppsCheckAccountIsAssociatedWithAnyEndpoint, + AppsCheckAccountIsAssociatedWithAnyRequestOptions + ]; + "GET /marketplace_listing/plans": [ + AppsListPlansEndpoint, + AppsListPlansRequestOptions + ]; + "GET /marketplace_listing/plans/:plan_id/accounts": [ + AppsListAccountsUserOrOrgOnPlanEndpoint, + AppsListAccountsUserOrOrgOnPlanRequestOptions + ]; + "GET /marketplace_listing/stubbed/accounts/:account_id": [ + AppsCheckAccountIsAssociatedWithAnyStubbedEndpoint, + AppsCheckAccountIsAssociatedWithAnyStubbedRequestOptions + ]; + "GET /marketplace_listing/stubbed/plans": [ + AppsListPlansStubbedEndpoint, + AppsListPlansStubbedRequestOptions + ]; + "GET /marketplace_listing/stubbed/plans/:plan_id/accounts": [ + AppsListAccountsUserOrOrgOnPlanStubbedEndpoint, + AppsListAccountsUserOrOrgOnPlanStubbedRequestOptions + ]; + "GET /meta": [MetaGetEndpoint, MetaGetRequestOptions]; + "GET /networks/:owner/:repo/events": [ + ActivityListPublicEventsForRepoNetworkEndpoint, + ActivityListPublicEventsForRepoNetworkRequestOptions + ]; + "GET /notifications": [ + ActivityListNotificationsEndpoint, + ActivityListNotificationsRequestOptions + ]; + "GET /notifications/threads/:thread_id": [ + ActivityGetThreadEndpoint, + ActivityGetThreadRequestOptions + ]; + "GET /notifications/threads/:thread_id/subscription": [ + ActivityGetThreadSubscriptionEndpoint, + ActivityGetThreadSubscriptionRequestOptions + ]; + "GET /organizations": [OrgsListEndpoint, OrgsListRequestOptions]; + "GET /orgs/:org": [OrgsGetEndpoint, OrgsGetRequestOptions]; + "GET /orgs/:org/blocks": [ + OrgsListBlockedUsersEndpoint, + OrgsListBlockedUsersRequestOptions + ]; + "GET /orgs/:org/blocks/:username": [ + OrgsCheckBlockedUserEndpoint, + OrgsCheckBlockedUserRequestOptions + ]; + "GET /orgs/:org/credential-authorizations": [ + OrgsListCredentialAuthorizationsEndpoint, + OrgsListCredentialAuthorizationsRequestOptions + ]; + "GET /orgs/:org/events": [ + ActivityListPublicEventsForOrgEndpoint, + ActivityListPublicEventsForOrgRequestOptions + ]; + "GET /orgs/:org/hooks": [OrgsListHooksEndpoint, OrgsListHooksRequestOptions]; + "GET /orgs/:org/hooks/:hook_id": [ + OrgsGetHookEndpoint, + OrgsGetHookRequestOptions + ]; + "GET /orgs/:org/installation": [ + AppsGetOrgInstallationEndpoint | AppsFindOrgInstallationEndpoint, + AppsGetOrgInstallationRequestOptions | AppsFindOrgInstallationRequestOptions + ]; + "GET /orgs/:org/interaction-limits": [ + InteractionsGetRestrictionsForOrgEndpoint, + InteractionsGetRestrictionsForOrgRequestOptions + ]; + "GET /orgs/:org/invitations": [ + OrgsListPendingInvitationsEndpoint, + OrgsListPendingInvitationsRequestOptions + ]; + "GET /orgs/:org/invitations/:invitation_id/teams": [ + OrgsListInvitationTeamsEndpoint, + OrgsListInvitationTeamsRequestOptions + ]; + "GET /orgs/:org/issues": [ + IssuesListForOrgEndpoint, + IssuesListForOrgRequestOptions + ]; + "GET /orgs/:org/members": [ + OrgsListMembersEndpoint, + OrgsListMembersRequestOptions + ]; + "GET /orgs/:org/members/:username": [ + OrgsCheckMembershipEndpoint, + OrgsCheckMembershipRequestOptions + ]; + "GET /orgs/:org/memberships/:username": [ + OrgsGetMembershipEndpoint, + OrgsGetMembershipRequestOptions + ]; + "GET /orgs/:org/migrations": [ + MigrationsListForOrgEndpoint, + MigrationsListForOrgRequestOptions + ]; + "GET /orgs/:org/migrations/:migration_id": [ + MigrationsGetStatusForOrgEndpoint, + MigrationsGetStatusForOrgRequestOptions + ]; + "GET /orgs/:org/migrations/:migration_id/archive": [ + MigrationsGetArchiveForOrgEndpoint, + MigrationsGetArchiveForOrgRequestOptions + ]; + "GET /orgs/:org/outside_collaborators": [ + OrgsListOutsideCollaboratorsEndpoint, + OrgsListOutsideCollaboratorsRequestOptions + ]; + "GET /orgs/:org/projects": [ + ProjectsListForOrgEndpoint, + ProjectsListForOrgRequestOptions + ]; + "GET /orgs/:org/public_members": [ + OrgsListPublicMembersEndpoint, + OrgsListPublicMembersRequestOptions + ]; + "GET /orgs/:org/public_members/:username": [ + OrgsCheckPublicMembershipEndpoint, + OrgsCheckPublicMembershipRequestOptions + ]; + "GET /orgs/:org/repos": [ + ReposListForOrgEndpoint, + ReposListForOrgRequestOptions + ]; + "GET /orgs/:org/team-sync/groups": [ + TeamsListIdPGroupsForOrgEndpoint, + TeamsListIdPGroupsForOrgRequestOptions + ]; + "GET /orgs/:org/teams": [TeamsListEndpoint, TeamsListRequestOptions]; + "GET /orgs/:org/teams/:team_slug": [ + TeamsGetByNameEndpoint, + TeamsGetByNameRequestOptions + ]; + "GET /projects/:project_id": [ProjectsGetEndpoint, ProjectsGetRequestOptions]; + "GET /projects/:project_id/collaborators": [ + ProjectsListCollaboratorsEndpoint, + ProjectsListCollaboratorsRequestOptions + ]; + "GET /projects/:project_id/collaborators/:username/permission": [ + ProjectsReviewUserPermissionLevelEndpoint, + ProjectsReviewUserPermissionLevelRequestOptions + ]; + "GET /projects/:project_id/columns": [ + ProjectsListColumnsEndpoint, + ProjectsListColumnsRequestOptions + ]; + "GET /projects/columns/:column_id": [ + ProjectsGetColumnEndpoint, + ProjectsGetColumnRequestOptions + ]; + "GET /projects/columns/:column_id/cards": [ + ProjectsListCardsEndpoint, + ProjectsListCardsRequestOptions + ]; + "GET /projects/columns/cards/:card_id": [ + ProjectsGetCardEndpoint, + ProjectsGetCardRequestOptions + ]; + "GET /rate_limit": [RateLimitGetEndpoint, RateLimitGetRequestOptions]; + "GET /repos/:owner/:repo": [ReposGetEndpoint, ReposGetRequestOptions]; + "GET /repos/:owner/:repo/:archive_format/:ref": [ + ReposGetArchiveLinkEndpoint, + ReposGetArchiveLinkRequestOptions + ]; + "GET /repos/:owner/:repo/assignees": [ + IssuesListAssigneesEndpoint, + IssuesListAssigneesRequestOptions + ]; + "GET /repos/:owner/:repo/assignees/:assignee": [ + IssuesCheckAssigneeEndpoint, + IssuesCheckAssigneeRequestOptions + ]; + "GET /repos/:owner/:repo/branches": [ + ReposListBranchesEndpoint, + ReposListBranchesRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch": [ + ReposGetBranchEndpoint, + ReposGetBranchRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection": [ + ReposGetBranchProtectionEndpoint, + ReposGetBranchProtectionRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ + ReposGetProtectedBranchAdminEnforcementEndpoint, + ReposGetProtectedBranchAdminEnforcementRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ + ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint, + ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ + ReposGetProtectedBranchRequiredSignaturesEndpoint, + ReposGetProtectedBranchRequiredSignaturesRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ + ReposGetProtectedBranchRequiredStatusChecksEndpoint, + ReposGetProtectedBranchRequiredStatusChecksRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ + ReposListProtectedBranchRequiredStatusChecksContextsEndpoint, + ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions": [ + ReposGetProtectedBranchRestrictionsEndpoint, + ReposGetProtectedBranchRestrictionsRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ + + | ReposGetAppsWithAccessToProtectedBranchEndpoint + | ReposListAppsWithAccessToProtectedBranchEndpoint, + + | ReposGetAppsWithAccessToProtectedBranchRequestOptions + | ReposListAppsWithAccessToProtectedBranchRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ + + | ReposGetTeamsWithAccessToProtectedBranchEndpoint + | ReposListProtectedBranchTeamRestrictionsEndpoint + | ReposListTeamsWithAccessToProtectedBranchEndpoint, + + | ReposGetTeamsWithAccessToProtectedBranchRequestOptions + | ReposListProtectedBranchTeamRestrictionsRequestOptions + | ReposListTeamsWithAccessToProtectedBranchRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ + + | ReposGetUsersWithAccessToProtectedBranchEndpoint + | ReposListProtectedBranchUserRestrictionsEndpoint + | ReposListUsersWithAccessToProtectedBranchEndpoint, + + | ReposGetUsersWithAccessToProtectedBranchRequestOptions + | ReposListProtectedBranchUserRestrictionsRequestOptions + | ReposListUsersWithAccessToProtectedBranchRequestOptions + ]; + "GET /repos/:owner/:repo/check-runs/:check_run_id": [ + ChecksGetEndpoint, + ChecksGetRequestOptions + ]; + "GET /repos/:owner/:repo/check-runs/:check_run_id/annotations": [ + ChecksListAnnotationsEndpoint, + ChecksListAnnotationsRequestOptions + ]; + "GET /repos/:owner/:repo/check-suites/:check_suite_id": [ + ChecksGetSuiteEndpoint, + ChecksGetSuiteRequestOptions + ]; + "GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs": [ + ChecksListForSuiteEndpoint, + ChecksListForSuiteRequestOptions + ]; + "GET /repos/:owner/:repo/collaborators": [ + ReposListCollaboratorsEndpoint, + ReposListCollaboratorsRequestOptions + ]; + "GET /repos/:owner/:repo/collaborators/:username": [ + ReposCheckCollaboratorEndpoint, + ReposCheckCollaboratorRequestOptions + ]; + "GET /repos/:owner/:repo/collaborators/:username/permission": [ + ReposGetCollaboratorPermissionLevelEndpoint, + ReposGetCollaboratorPermissionLevelRequestOptions + ]; + "GET /repos/:owner/:repo/comments": [ + ReposListCommitCommentsEndpoint, + ReposListCommitCommentsRequestOptions + ]; + "GET /repos/:owner/:repo/comments/:comment_id": [ + ReposGetCommitCommentEndpoint, + ReposGetCommitCommentRequestOptions + ]; + "GET /repos/:owner/:repo/comments/:comment_id/reactions": [ + ReactionsListForCommitCommentEndpoint, + ReactionsListForCommitCommentRequestOptions + ]; + "GET /repos/:owner/:repo/commits": [ + ReposListCommitsEndpoint, + ReposListCommitsRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:commit_sha/branches-where-head": [ + ReposListBranchesForHeadCommitEndpoint, + ReposListBranchesForHeadCommitRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:commit_sha/comments": [ + ReposListCommentsForCommitEndpoint, + ReposListCommentsForCommitRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:commit_sha/pulls": [ + ReposListPullRequestsAssociatedWithCommitEndpoint, + ReposListPullRequestsAssociatedWithCommitRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref": [ + ReposGetCommitEndpoint, + ReposGetCommitRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref/check-runs": [ + ChecksListForRefEndpoint, + ChecksListForRefRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref/check-suites": [ + ChecksListSuitesForRefEndpoint, + ChecksListSuitesForRefRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref/status": [ + ReposGetCombinedStatusForRefEndpoint, + ReposGetCombinedStatusForRefRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref/statuses": [ + ReposListStatusesForRefEndpoint, + ReposListStatusesForRefRequestOptions + ]; + "GET /repos/:owner/:repo/community/code_of_conduct": [ + CodesOfConductGetForRepoEndpoint, + CodesOfConductGetForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/community/profile": [ + ReposRetrieveCommunityProfileMetricsEndpoint, + ReposRetrieveCommunityProfileMetricsRequestOptions + ]; + "GET /repos/:owner/:repo/compare/:base...:head": [ + ReposCompareCommitsEndpoint, + ReposCompareCommitsRequestOptions + ]; + "GET /repos/:owner/:repo/contents/:path": [ + ReposGetContentsEndpoint, + ReposGetContentsRequestOptions + ]; + "GET /repos/:owner/:repo/contributors": [ + ReposListContributorsEndpoint, + ReposListContributorsRequestOptions + ]; + "GET /repos/:owner/:repo/deployments": [ + ReposListDeploymentsEndpoint, + ReposListDeploymentsRequestOptions + ]; + "GET /repos/:owner/:repo/deployments/:deployment_id": [ + ReposGetDeploymentEndpoint, + ReposGetDeploymentRequestOptions + ]; + "GET /repos/:owner/:repo/deployments/:deployment_id/statuses": [ + ReposListDeploymentStatusesEndpoint, + ReposListDeploymentStatusesRequestOptions + ]; + "GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id": [ + ReposGetDeploymentStatusEndpoint, + ReposGetDeploymentStatusRequestOptions + ]; + "GET /repos/:owner/:repo/downloads": [ + ReposListDownloadsEndpoint, + ReposListDownloadsRequestOptions + ]; + "GET /repos/:owner/:repo/downloads/:download_id": [ + ReposGetDownloadEndpoint, + ReposGetDownloadRequestOptions + ]; + "GET /repos/:owner/:repo/events": [ + ActivityListRepoEventsEndpoint, + ActivityListRepoEventsRequestOptions + ]; + "GET /repos/:owner/:repo/forks": [ + ReposListForksEndpoint, + ReposListForksRequestOptions + ]; + "GET /repos/:owner/:repo/git/blobs/:file_sha": [ + GitGetBlobEndpoint, + GitGetBlobRequestOptions + ]; + "GET /repos/:owner/:repo/git/commits/:commit_sha": [ + GitGetCommitEndpoint, + GitGetCommitRequestOptions + ]; + "GET /repos/:owner/:repo/git/matching-refs/:ref": [ + GitListMatchingRefsEndpoint, + GitListMatchingRefsRequestOptions + ]; + "GET /repos/:owner/:repo/git/ref/:ref": [ + GitGetRefEndpoint, + GitGetRefRequestOptions + ]; + "GET /repos/:owner/:repo/git/tags/:tag_sha": [ + GitGetTagEndpoint, + GitGetTagRequestOptions + ]; + "GET /repos/:owner/:repo/git/trees/:tree_sha": [ + GitGetTreeEndpoint, + GitGetTreeRequestOptions + ]; + "GET /repos/:owner/:repo/hooks": [ + ReposListHooksEndpoint, + ReposListHooksRequestOptions + ]; + "GET /repos/:owner/:repo/hooks/:hook_id": [ + ReposGetHookEndpoint, + ReposGetHookRequestOptions + ]; + "GET /repos/:owner/:repo/import": [ + MigrationsGetImportProgressEndpoint, + MigrationsGetImportProgressRequestOptions + ]; + "GET /repos/:owner/:repo/import/authors": [ + MigrationsGetCommitAuthorsEndpoint, + MigrationsGetCommitAuthorsRequestOptions + ]; + "GET /repos/:owner/:repo/import/large_files": [ + MigrationsGetLargeFilesEndpoint, + MigrationsGetLargeFilesRequestOptions + ]; + "GET /repos/:owner/:repo/installation": [ + AppsGetRepoInstallationEndpoint | AppsFindRepoInstallationEndpoint, + + | AppsGetRepoInstallationRequestOptions + | AppsFindRepoInstallationRequestOptions + ]; + "GET /repos/:owner/:repo/interaction-limits": [ + InteractionsGetRestrictionsForRepoEndpoint, + InteractionsGetRestrictionsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/invitations": [ + ReposListInvitationsEndpoint, + ReposListInvitationsRequestOptions + ]; + "GET /repos/:owner/:repo/issues": [ + IssuesListForRepoEndpoint, + IssuesListForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number": [ + IssuesGetEndpoint, + IssuesGetRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/comments": [ + IssuesListCommentsEndpoint, + IssuesListCommentsRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/events": [ + IssuesListEventsEndpoint, + IssuesListEventsRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/labels": [ + IssuesListLabelsOnIssueEndpoint, + IssuesListLabelsOnIssueRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/reactions": [ + ReactionsListForIssueEndpoint, + ReactionsListForIssueRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/timeline": [ + IssuesListEventsForTimelineEndpoint, + IssuesListEventsForTimelineRequestOptions + ]; + "GET /repos/:owner/:repo/issues/comments": [ + IssuesListCommentsForRepoEndpoint, + IssuesListCommentsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/issues/comments/:comment_id": [ + IssuesGetCommentEndpoint, + IssuesGetCommentRequestOptions + ]; + "GET /repos/:owner/:repo/issues/comments/:comment_id/reactions": [ + ReactionsListForIssueCommentEndpoint, + ReactionsListForIssueCommentRequestOptions + ]; + "GET /repos/:owner/:repo/issues/events": [ + IssuesListEventsForRepoEndpoint, + IssuesListEventsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/issues/events/:event_id": [ + IssuesGetEventEndpoint, + IssuesGetEventRequestOptions + ]; + "GET /repos/:owner/:repo/keys": [ + ReposListDeployKeysEndpoint, + ReposListDeployKeysRequestOptions + ]; + "GET /repos/:owner/:repo/keys/:key_id": [ + ReposGetDeployKeyEndpoint, + ReposGetDeployKeyRequestOptions + ]; + "GET /repos/:owner/:repo/labels": [ + IssuesListLabelsForRepoEndpoint, + IssuesListLabelsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/labels/:name": [ + IssuesGetLabelEndpoint, + IssuesGetLabelRequestOptions + ]; + "GET /repos/:owner/:repo/languages": [ + ReposListLanguagesEndpoint, + ReposListLanguagesRequestOptions + ]; + "GET /repos/:owner/:repo/license": [ + LicensesGetForRepoEndpoint, + LicensesGetForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/milestones": [ + IssuesListMilestonesForRepoEndpoint, + IssuesListMilestonesForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/milestones/:milestone_number": [ + IssuesGetMilestoneEndpoint, + IssuesGetMilestoneRequestOptions + ]; + "GET /repos/:owner/:repo/milestones/:milestone_number/labels": [ + IssuesListLabelsForMilestoneEndpoint, + IssuesListLabelsForMilestoneRequestOptions + ]; + "GET /repos/:owner/:repo/notifications": [ + ActivityListNotificationsForRepoEndpoint, + ActivityListNotificationsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/pages": [ + ReposGetPagesEndpoint, + ReposGetPagesRequestOptions + ]; + "GET /repos/:owner/:repo/pages/builds": [ + ReposListPagesBuildsEndpoint, + ReposListPagesBuildsRequestOptions + ]; + "GET /repos/:owner/:repo/pages/builds/:build_id": [ + ReposGetPagesBuildEndpoint, + ReposGetPagesBuildRequestOptions + ]; + "GET /repos/:owner/:repo/pages/builds/latest": [ + ReposGetLatestPagesBuildEndpoint, + ReposGetLatestPagesBuildRequestOptions + ]; + "GET /repos/:owner/:repo/projects": [ + ProjectsListForRepoEndpoint, + ProjectsListForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/pulls": [PullsListEndpoint, PullsListRequestOptions]; + "GET /repos/:owner/:repo/pulls/:pull_number": [ + PullsGetEndpoint, + PullsGetRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/comments": [ + PullsListCommentsEndpoint, + PullsListCommentsRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/commits": [ + PullsListCommitsEndpoint, + PullsListCommitsRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/files": [ + PullsListFilesEndpoint, + PullsListFilesRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/merge": [ + PullsCheckIfMergedEndpoint, + PullsCheckIfMergedRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ + PullsListReviewRequestsEndpoint, + PullsListReviewRequestsRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/reviews": [ + PullsListReviewsEndpoint, + PullsListReviewsRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ + PullsGetReviewEndpoint, + PullsGetReviewRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments": [ + PullsGetCommentsForReviewEndpoint, + PullsGetCommentsForReviewRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/comments": [ + PullsListCommentsForRepoEndpoint, + PullsListCommentsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/comments/:comment_id": [ + PullsGetCommentEndpoint, + PullsGetCommentRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions": [ + ReactionsListForPullRequestReviewCommentEndpoint, + ReactionsListForPullRequestReviewCommentRequestOptions + ]; + "GET /repos/:owner/:repo/readme": [ + ReposGetReadmeEndpoint, + ReposGetReadmeRequestOptions + ]; + "GET /repos/:owner/:repo/releases": [ + ReposListReleasesEndpoint, + ReposListReleasesRequestOptions + ]; + "GET /repos/:owner/:repo/releases/:release_id": [ + ReposGetReleaseEndpoint, + ReposGetReleaseRequestOptions + ]; + "GET /repos/:owner/:repo/releases/:release_id/assets": [ + ReposListAssetsForReleaseEndpoint, + ReposListAssetsForReleaseRequestOptions + ]; + "GET /repos/:owner/:repo/releases/assets/:asset_id": [ + ReposGetReleaseAssetEndpoint, + ReposGetReleaseAssetRequestOptions + ]; + "GET /repos/:owner/:repo/releases/latest": [ + ReposGetLatestReleaseEndpoint, + ReposGetLatestReleaseRequestOptions + ]; + "GET /repos/:owner/:repo/releases/tags/:tag": [ + ReposGetReleaseByTagEndpoint, + ReposGetReleaseByTagRequestOptions + ]; + "GET /repos/:owner/:repo/stargazers": [ + ActivityListStargazersForRepoEndpoint, + ActivityListStargazersForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/stats/code_frequency": [ + ReposGetCodeFrequencyStatsEndpoint, + ReposGetCodeFrequencyStatsRequestOptions + ]; + "GET /repos/:owner/:repo/stats/commit_activity": [ + ReposGetCommitActivityStatsEndpoint, + ReposGetCommitActivityStatsRequestOptions + ]; + "GET /repos/:owner/:repo/stats/contributors": [ + ReposGetContributorsStatsEndpoint, + ReposGetContributorsStatsRequestOptions + ]; + "GET /repos/:owner/:repo/stats/participation": [ + ReposGetParticipationStatsEndpoint, + ReposGetParticipationStatsRequestOptions + ]; + "GET /repos/:owner/:repo/stats/punch_card": [ + ReposGetPunchCardStatsEndpoint, + ReposGetPunchCardStatsRequestOptions + ]; + "GET /repos/:owner/:repo/subscribers": [ + ActivityListWatchersForRepoEndpoint, + ActivityListWatchersForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/subscription": [ + ActivityGetRepoSubscriptionEndpoint, + ActivityGetRepoSubscriptionRequestOptions + ]; + "GET /repos/:owner/:repo/tags": [ + ReposListTagsEndpoint, + ReposListTagsRequestOptions + ]; + "GET /repos/:owner/:repo/teams": [ + ReposListTeamsEndpoint, + ReposListTeamsRequestOptions + ]; + "GET /repos/:owner/:repo/topics": [ + ReposListTopicsEndpoint, + ReposListTopicsRequestOptions + ]; + "GET /repos/:owner/:repo/traffic/clones": [ + ReposGetClonesEndpoint, + ReposGetClonesRequestOptions + ]; + "GET /repos/:owner/:repo/traffic/popular/paths": [ + ReposGetTopPathsEndpoint, + ReposGetTopPathsRequestOptions + ]; + "GET /repos/:owner/:repo/traffic/popular/referrers": [ + ReposGetTopReferrersEndpoint, + ReposGetTopReferrersRequestOptions + ]; + "GET /repos/:owner/:repo/traffic/views": [ + ReposGetViewsEndpoint, + ReposGetViewsRequestOptions + ]; + "GET /repos/:owner/:repo/vulnerability-alerts": [ + ReposCheckVulnerabilityAlertsEndpoint, + ReposCheckVulnerabilityAlertsRequestOptions + ]; + "GET /repositories": [ReposListPublicEndpoint, ReposListPublicRequestOptions]; + "GET /scim/v2/organizations/:org/Users": [ + ScimListProvisionedIdentitiesEndpoint, + ScimListProvisionedIdentitiesRequestOptions + ]; + "GET /scim/v2/organizations/:org/Users/:scim_user_id": [ + ScimGetProvisioningDetailsForUserEndpoint, + ScimGetProvisioningDetailsForUserRequestOptions + ]; + "GET /search/code": [SearchCodeEndpoint, SearchCodeRequestOptions]; + "GET /search/commits": [SearchCommitsEndpoint, SearchCommitsRequestOptions]; + "GET /search/issues": [ + SearchIssuesAndPullRequestsEndpoint | SearchIssuesEndpoint, + SearchIssuesAndPullRequestsRequestOptions | SearchIssuesRequestOptions + ]; + "GET /search/labels": [SearchLabelsEndpoint, SearchLabelsRequestOptions]; + "GET /search/repositories": [SearchReposEndpoint, SearchReposRequestOptions]; + "GET /search/topics": [SearchTopicsEndpoint, SearchTopicsRequestOptions]; + "GET /search/users": [SearchUsersEndpoint, SearchUsersRequestOptions]; + "GET /teams/:team_id": [TeamsGetEndpoint, TeamsGetRequestOptions]; + "GET /teams/:team_id/discussions": [ + TeamsListDiscussionsEndpoint, + TeamsListDiscussionsRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number": [ + TeamsGetDiscussionEndpoint, + TeamsGetDiscussionRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number/comments": [ + TeamsListDiscussionCommentsEndpoint, + TeamsListDiscussionCommentsRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ + TeamsGetDiscussionCommentEndpoint, + TeamsGetDiscussionCommentRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": [ + ReactionsListForTeamDiscussionCommentEndpoint, + ReactionsListForTeamDiscussionCommentRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number/reactions": [ + ReactionsListForTeamDiscussionEndpoint, + ReactionsListForTeamDiscussionRequestOptions + ]; + "GET /teams/:team_id/invitations": [ + TeamsListPendingInvitationsEndpoint, + TeamsListPendingInvitationsRequestOptions + ]; + "GET /teams/:team_id/members": [ + TeamsListMembersEndpoint, + TeamsListMembersRequestOptions + ]; + "GET /teams/:team_id/members/:username": [ + TeamsGetMemberEndpoint, + TeamsGetMemberRequestOptions + ]; + "GET /teams/:team_id/memberships/:username": [ + TeamsGetMembershipEndpoint, + TeamsGetMembershipRequestOptions + ]; + "GET /teams/:team_id/projects": [ + TeamsListProjectsEndpoint, + TeamsListProjectsRequestOptions + ]; + "GET /teams/:team_id/projects/:project_id": [ + TeamsReviewProjectEndpoint, + TeamsReviewProjectRequestOptions + ]; + "GET /teams/:team_id/repos": [ + TeamsListReposEndpoint, + TeamsListReposRequestOptions + ]; + "GET /teams/:team_id/repos/:owner/:repo": [ + TeamsCheckManagesRepoEndpoint, + TeamsCheckManagesRepoRequestOptions + ]; + "GET /teams/:team_id/team-sync/group-mappings": [ + TeamsListIdPGroupsEndpoint, + TeamsListIdPGroupsRequestOptions + ]; + "GET /teams/:team_id/teams": [ + TeamsListChildEndpoint, + TeamsListChildRequestOptions + ]; + "GET /user": [ + UsersGetAuthenticatedEndpoint, + UsersGetAuthenticatedRequestOptions + ]; + "GET /user/blocks": [ + UsersListBlockedEndpoint, + UsersListBlockedRequestOptions + ]; + "GET /user/blocks/:username": [ + UsersCheckBlockedEndpoint, + UsersCheckBlockedRequestOptions + ]; + "GET /user/emails": [UsersListEmailsEndpoint, UsersListEmailsRequestOptions]; + "GET /user/followers": [ + UsersListFollowersForAuthenticatedUserEndpoint, + UsersListFollowersForAuthenticatedUserRequestOptions + ]; + "GET /user/following": [ + UsersListFollowingForAuthenticatedUserEndpoint, + UsersListFollowingForAuthenticatedUserRequestOptions + ]; + "GET /user/following/:username": [ + UsersCheckFollowingEndpoint, + UsersCheckFollowingRequestOptions + ]; + "GET /user/gpg_keys": [ + UsersListGpgKeysEndpoint, + UsersListGpgKeysRequestOptions + ]; + "GET /user/gpg_keys/:gpg_key_id": [ + UsersGetGpgKeyEndpoint, + UsersGetGpgKeyRequestOptions + ]; + "GET /user/installations": [ + AppsListInstallationsForAuthenticatedUserEndpoint, + AppsListInstallationsForAuthenticatedUserRequestOptions + ]; + "GET /user/installations/:installation_id/repositories": [ + AppsListInstallationReposForAuthenticatedUserEndpoint, + AppsListInstallationReposForAuthenticatedUserRequestOptions + ]; + "GET /user/issues": [ + IssuesListForAuthenticatedUserEndpoint, + IssuesListForAuthenticatedUserRequestOptions + ]; + "GET /user/keys": [ + UsersListPublicKeysEndpoint, + UsersListPublicKeysRequestOptions + ]; + "GET /user/keys/:key_id": [ + UsersGetPublicKeyEndpoint, + UsersGetPublicKeyRequestOptions + ]; + "GET /user/marketplace_purchases": [ + AppsListMarketplacePurchasesForAuthenticatedUserEndpoint, + AppsListMarketplacePurchasesForAuthenticatedUserRequestOptions + ]; + "GET /user/marketplace_purchases/stubbed": [ + AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint, + AppsListMarketplacePurchasesForAuthenticatedUserStubbedRequestOptions + ]; + "GET /user/memberships/orgs": [ + OrgsListMembershipsEndpoint, + OrgsListMembershipsRequestOptions + ]; + "GET /user/memberships/orgs/:org": [ + OrgsGetMembershipForAuthenticatedUserEndpoint, + OrgsGetMembershipForAuthenticatedUserRequestOptions + ]; + "GET /user/migrations": [ + MigrationsListForAuthenticatedUserEndpoint, + MigrationsListForAuthenticatedUserRequestOptions + ]; + "GET /user/migrations/:migration_id": [ + MigrationsGetStatusForAuthenticatedUserEndpoint, + MigrationsGetStatusForAuthenticatedUserRequestOptions + ]; + "GET /user/migrations/:migration_id/archive": [ + MigrationsGetArchiveForAuthenticatedUserEndpoint, + MigrationsGetArchiveForAuthenticatedUserRequestOptions + ]; + "GET /user/orgs": [ + OrgsListForAuthenticatedUserEndpoint, + OrgsListForAuthenticatedUserRequestOptions + ]; + "GET /user/public_emails": [ + UsersListPublicEmailsEndpoint, + UsersListPublicEmailsRequestOptions + ]; + "GET /user/repos": [ReposListEndpoint, ReposListRequestOptions]; + "GET /user/repository_invitations": [ + ReposListInvitationsForAuthenticatedUserEndpoint, + ReposListInvitationsForAuthenticatedUserRequestOptions + ]; + "GET /user/starred": [ + ActivityListReposStarredByAuthenticatedUserEndpoint, + ActivityListReposStarredByAuthenticatedUserRequestOptions + ]; + "GET /user/starred/:owner/:repo": [ + ActivityCheckStarringRepoEndpoint, + ActivityCheckStarringRepoRequestOptions + ]; + "GET /user/subscriptions": [ + ActivityListWatchedReposForAuthenticatedUserEndpoint, + ActivityListWatchedReposForAuthenticatedUserRequestOptions + ]; + "GET /user/subscriptions/:owner/:repo": [ + ActivityCheckWatchingRepoLegacyEndpoint, + ActivityCheckWatchingRepoLegacyRequestOptions + ]; + "GET /user/teams": [ + TeamsListForAuthenticatedUserEndpoint, + TeamsListForAuthenticatedUserRequestOptions + ]; + "GET /users": [UsersListEndpoint, UsersListRequestOptions]; + "GET /users/:username": [ + UsersGetByUsernameEndpoint, + UsersGetByUsernameRequestOptions + ]; + "GET /users/:username/events": [ + ActivityListEventsForUserEndpoint, + ActivityListEventsForUserRequestOptions + ]; + "GET /users/:username/events/orgs/:org": [ + ActivityListEventsForOrgEndpoint, + ActivityListEventsForOrgRequestOptions + ]; + "GET /users/:username/events/public": [ + ActivityListPublicEventsForUserEndpoint, + ActivityListPublicEventsForUserRequestOptions + ]; + "GET /users/:username/followers": [ + UsersListFollowersForUserEndpoint, + UsersListFollowersForUserRequestOptions + ]; + "GET /users/:username/following": [ + UsersListFollowingForUserEndpoint, + UsersListFollowingForUserRequestOptions + ]; + "GET /users/:username/following/:target_user": [ + UsersCheckFollowingForUserEndpoint, + UsersCheckFollowingForUserRequestOptions + ]; + "GET /users/:username/gists": [ + GistsListPublicForUserEndpoint, + GistsListPublicForUserRequestOptions + ]; + "GET /users/:username/gpg_keys": [ + UsersListGpgKeysForUserEndpoint, + UsersListGpgKeysForUserRequestOptions + ]; + "GET /users/:username/hovercard": [ + UsersGetContextForUserEndpoint, + UsersGetContextForUserRequestOptions + ]; + "GET /users/:username/installation": [ + AppsGetUserInstallationEndpoint | AppsFindUserInstallationEndpoint, + + | AppsGetUserInstallationRequestOptions + | AppsFindUserInstallationRequestOptions + ]; + "GET /users/:username/keys": [ + UsersListPublicKeysForUserEndpoint, + UsersListPublicKeysForUserRequestOptions + ]; + "GET /users/:username/orgs": [ + OrgsListForUserEndpoint, + OrgsListForUserRequestOptions + ]; + "GET /users/:username/projects": [ + ProjectsListForUserEndpoint, + ProjectsListForUserRequestOptions + ]; + "GET /users/:username/received_events": [ + ActivityListReceivedEventsForUserEndpoint, + ActivityListReceivedEventsForUserRequestOptions + ]; + "GET /users/:username/received_events/public": [ + ActivityListReceivedPublicEventsForUserEndpoint, + ActivityListReceivedPublicEventsForUserRequestOptions + ]; + "GET /users/:username/repos": [ + ReposListForUserEndpoint, + ReposListForUserRequestOptions + ]; + "GET /users/:username/starred": [ + ActivityListReposStarredByUserEndpoint, + ActivityListReposStarredByUserRequestOptions + ]; + "GET /users/:username/subscriptions": [ + ActivityListReposWatchedByUserEndpoint, + ActivityListReposWatchedByUserRequestOptions + ]; + "PATCH /authorizations/:authorization_id": [ + OauthAuthorizationsUpdateAuthorizationEndpoint, + OauthAuthorizationsUpdateAuthorizationRequestOptions + ]; + "PATCH /gists/:gist_id": [GistsUpdateEndpoint, GistsUpdateRequestOptions]; + "PATCH /gists/:gist_id/comments/:comment_id": [ + GistsUpdateCommentEndpoint, + GistsUpdateCommentRequestOptions + ]; + "PATCH /notifications/threads/:thread_id": [ + ActivityMarkThreadAsReadEndpoint, + ActivityMarkThreadAsReadRequestOptions + ]; + "PATCH /orgs/:org": [OrgsUpdateEndpoint, OrgsUpdateRequestOptions]; + "PATCH /orgs/:org/hooks/:hook_id": [ + OrgsUpdateHookEndpoint, + OrgsUpdateHookRequestOptions + ]; + "PATCH /projects/:project_id": [ + ProjectsUpdateEndpoint, + ProjectsUpdateRequestOptions + ]; + "PATCH /projects/columns/:column_id": [ + ProjectsUpdateColumnEndpoint, + ProjectsUpdateColumnRequestOptions + ]; + "PATCH /projects/columns/cards/:card_id": [ + ProjectsUpdateCardEndpoint, + ProjectsUpdateCardRequestOptions + ]; + "PATCH /repos/:owner/:repo": [ReposUpdateEndpoint, ReposUpdateRequestOptions]; + "PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ + ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint, + ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions + ]; + "PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ + ReposUpdateProtectedBranchRequiredStatusChecksEndpoint, + ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions + ]; + "PATCH /repos/:owner/:repo/check-runs/:check_run_id": [ + ChecksUpdateEndpoint, + ChecksUpdateRequestOptions + ]; + "PATCH /repos/:owner/:repo/check-suites/preferences": [ + ChecksSetSuitesPreferencesEndpoint, + ChecksSetSuitesPreferencesRequestOptions + ]; + "PATCH /repos/:owner/:repo/comments/:comment_id": [ + ReposUpdateCommitCommentEndpoint, + ReposUpdateCommitCommentRequestOptions + ]; + "PATCH /repos/:owner/:repo/git/refs/:ref": [ + GitUpdateRefEndpoint, + GitUpdateRefRequestOptions + ]; + "PATCH /repos/:owner/:repo/hooks/:hook_id": [ + ReposUpdateHookEndpoint, + ReposUpdateHookRequestOptions + ]; + "PATCH /repos/:owner/:repo/import": [ + MigrationsUpdateImportEndpoint, + MigrationsUpdateImportRequestOptions + ]; + "PATCH /repos/:owner/:repo/import/authors/:author_id": [ + MigrationsMapCommitAuthorEndpoint, + MigrationsMapCommitAuthorRequestOptions + ]; + "PATCH /repos/:owner/:repo/import/lfs": [ + MigrationsSetLfsPreferenceEndpoint, + MigrationsSetLfsPreferenceRequestOptions + ]; + "PATCH /repos/:owner/:repo/invitations/:invitation_id": [ + ReposUpdateInvitationEndpoint, + ReposUpdateInvitationRequestOptions + ]; + "PATCH /repos/:owner/:repo/issues/:issue_number": [ + IssuesUpdateEndpoint, + IssuesUpdateRequestOptions + ]; + "PATCH /repos/:owner/:repo/issues/comments/:comment_id": [ + IssuesUpdateCommentEndpoint, + IssuesUpdateCommentRequestOptions + ]; + "PATCH /repos/:owner/:repo/labels/:name": [ + IssuesUpdateLabelEndpoint, + IssuesUpdateLabelRequestOptions + ]; + "PATCH /repos/:owner/:repo/milestones/:milestone_number": [ + IssuesUpdateMilestoneEndpoint, + IssuesUpdateMilestoneRequestOptions + ]; + "PATCH /repos/:owner/:repo/pulls/:pull_number": [ + PullsUpdateEndpoint, + PullsUpdateRequestOptions + ]; + "PATCH /repos/:owner/:repo/pulls/comments/:comment_id": [ + PullsUpdateCommentEndpoint, + PullsUpdateCommentRequestOptions + ]; + "PATCH /repos/:owner/:repo/releases/:release_id": [ + ReposUpdateReleaseEndpoint, + ReposUpdateReleaseRequestOptions + ]; + "PATCH /repos/:owner/:repo/releases/assets/:asset_id": [ + ReposUpdateReleaseAssetEndpoint, + ReposUpdateReleaseAssetRequestOptions + ]; + "PATCH /scim/v2/organizations/:org/Users/:scim_user_id": [ + ScimUpdateUserAttributeEndpoint, + ScimUpdateUserAttributeRequestOptions + ]; + "PATCH /teams/:team_id": [TeamsUpdateEndpoint, TeamsUpdateRequestOptions]; + "PATCH /teams/:team_id/discussions/:discussion_number": [ + TeamsUpdateDiscussionEndpoint, + TeamsUpdateDiscussionRequestOptions + ]; + "PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ + TeamsUpdateDiscussionCommentEndpoint, + TeamsUpdateDiscussionCommentRequestOptions + ]; + "PATCH /teams/:team_id/team-sync/group-mappings": [ + TeamsCreateOrUpdateIdPGroupConnectionsEndpoint, + TeamsCreateOrUpdateIdPGroupConnectionsRequestOptions + ]; + "PATCH /user": [ + UsersUpdateAuthenticatedEndpoint, + UsersUpdateAuthenticatedRequestOptions + ]; + "PATCH /user/email/visibility": [ + UsersTogglePrimaryEmailVisibilityEndpoint, + UsersTogglePrimaryEmailVisibilityRequestOptions + ]; + "PATCH /user/memberships/orgs/:org": [ + OrgsUpdateMembershipEndpoint, + OrgsUpdateMembershipRequestOptions + ]; + "PATCH /user/repository_invitations/:invitation_id": [ + ReposAcceptInvitationEndpoint, + ReposAcceptInvitationRequestOptions + ]; + "POST /app-manifests/:code/conversions": [ + AppsCreateFromManifestEndpoint, + AppsCreateFromManifestRequestOptions + ]; + "POST /app/installations/:installation_id/access_tokens": [ + AppsCreateInstallationTokenEndpoint, + AppsCreateInstallationTokenRequestOptions + ]; + "POST /applications/:client_id/tokens/:access_token": [ + OauthAuthorizationsResetAuthorizationEndpoint, + OauthAuthorizationsResetAuthorizationRequestOptions + ]; + "POST /authorizations": [ + OauthAuthorizationsCreateAuthorizationEndpoint, + OauthAuthorizationsCreateAuthorizationRequestOptions + ]; + "POST /content_references/:content_reference_id/attachments": [ + AppsCreateContentAttachmentEndpoint, + AppsCreateContentAttachmentRequestOptions + ]; + "POST /gists": [GistsCreateEndpoint, GistsCreateRequestOptions]; + "POST /gists/:gist_id/comments": [ + GistsCreateCommentEndpoint, + GistsCreateCommentRequestOptions + ]; + "POST /gists/:gist_id/forks": [GistsForkEndpoint, GistsForkRequestOptions]; + "POST /markdown": [MarkdownRenderEndpoint, MarkdownRenderRequestOptions]; + "POST /markdown/raw": [ + MarkdownRenderRawEndpoint, + MarkdownRenderRawRequestOptions + ]; + "POST /orgs/:org/hooks": [ + OrgsCreateHookEndpoint, + OrgsCreateHookRequestOptions + ]; + "POST /orgs/:org/hooks/:hook_id/pings": [ + OrgsPingHookEndpoint, + OrgsPingHookRequestOptions + ]; + "POST /orgs/:org/invitations": [ + OrgsCreateInvitationEndpoint, + OrgsCreateInvitationRequestOptions + ]; + "POST /orgs/:org/migrations": [ + MigrationsStartForOrgEndpoint, + MigrationsStartForOrgRequestOptions + ]; + "POST /orgs/:org/projects": [ + ProjectsCreateForOrgEndpoint, + ProjectsCreateForOrgRequestOptions + ]; + "POST /orgs/:org/repos": [ + ReposCreateInOrgEndpoint, + ReposCreateInOrgRequestOptions + ]; + "POST /orgs/:org/teams": [TeamsCreateEndpoint, TeamsCreateRequestOptions]; + "POST /projects/:project_id/columns": [ + ProjectsCreateColumnEndpoint, + ProjectsCreateColumnRequestOptions + ]; + "POST /projects/columns/:column_id/cards": [ + ProjectsCreateCardEndpoint, + ProjectsCreateCardRequestOptions + ]; + "POST /projects/columns/:column_id/moves": [ + ProjectsMoveColumnEndpoint, + ProjectsMoveColumnRequestOptions + ]; + "POST /projects/columns/cards/:card_id/moves": [ + ProjectsMoveCardEndpoint, + ProjectsMoveCardRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ + ReposAddProtectedBranchAdminEnforcementEndpoint, + ReposAddProtectedBranchAdminEnforcementRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ + ReposAddProtectedBranchRequiredSignaturesEndpoint, + ReposAddProtectedBranchRequiredSignaturesRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ + ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint, + ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ + ReposAddProtectedBranchAppRestrictionsEndpoint, + ReposAddProtectedBranchAppRestrictionsRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ + ReposAddProtectedBranchTeamRestrictionsEndpoint, + ReposAddProtectedBranchTeamRestrictionsRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ + ReposAddProtectedBranchUserRestrictionsEndpoint, + ReposAddProtectedBranchUserRestrictionsRequestOptions + ]; + "POST /repos/:owner/:repo/check-runs": [ + ChecksCreateEndpoint, + ChecksCreateRequestOptions + ]; + "POST /repos/:owner/:repo/check-suites": [ + ChecksCreateSuiteEndpoint, + ChecksCreateSuiteRequestOptions + ]; + "POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest": [ + ChecksRerequestSuiteEndpoint, + ChecksRerequestSuiteRequestOptions + ]; + "POST /repos/:owner/:repo/comments/:comment_id/reactions": [ + ReactionsCreateForCommitCommentEndpoint, + ReactionsCreateForCommitCommentRequestOptions + ]; + "POST /repos/:owner/:repo/commits/:commit_sha/comments": [ + ReposCreateCommitCommentEndpoint, + ReposCreateCommitCommentRequestOptions + ]; + "POST /repos/:owner/:repo/deployments": [ + ReposCreateDeploymentEndpoint, + ReposCreateDeploymentRequestOptions + ]; + "POST /repos/:owner/:repo/deployments/:deployment_id/statuses": [ + ReposCreateDeploymentStatusEndpoint, + ReposCreateDeploymentStatusRequestOptions + ]; + "POST /repos/:owner/:repo/dispatches": [ + ReposCreateDispatchEventEndpoint, + ReposCreateDispatchEventRequestOptions + ]; + "POST /repos/:owner/:repo/forks": [ + ReposCreateForkEndpoint, + ReposCreateForkRequestOptions + ]; + "POST /repos/:owner/:repo/git/blobs": [ + GitCreateBlobEndpoint, + GitCreateBlobRequestOptions + ]; + "POST /repos/:owner/:repo/git/commits": [ + GitCreateCommitEndpoint, + GitCreateCommitRequestOptions + ]; + "POST /repos/:owner/:repo/git/refs": [ + GitCreateRefEndpoint, + GitCreateRefRequestOptions + ]; + "POST /repos/:owner/:repo/git/tags": [ + GitCreateTagEndpoint, + GitCreateTagRequestOptions + ]; + "POST /repos/:owner/:repo/git/trees": [ + GitCreateTreeEndpoint, + GitCreateTreeRequestOptions + ]; + "POST /repos/:owner/:repo/hooks": [ + ReposCreateHookEndpoint, + ReposCreateHookRequestOptions + ]; + "POST /repos/:owner/:repo/hooks/:hook_id/pings": [ + ReposPingHookEndpoint, + ReposPingHookRequestOptions + ]; + "POST /repos/:owner/:repo/hooks/:hook_id/tests": [ + ReposTestPushHookEndpoint, + ReposTestPushHookRequestOptions + ]; + "POST /repos/:owner/:repo/issues": [ + IssuesCreateEndpoint, + IssuesCreateRequestOptions + ]; + "POST /repos/:owner/:repo/issues/:issue_number/assignees": [ + IssuesAddAssigneesEndpoint, + IssuesAddAssigneesRequestOptions + ]; + "POST /repos/:owner/:repo/issues/:issue_number/comments": [ + IssuesCreateCommentEndpoint, + IssuesCreateCommentRequestOptions + ]; + "POST /repos/:owner/:repo/issues/:issue_number/labels": [ + IssuesAddLabelsEndpoint, + IssuesAddLabelsRequestOptions + ]; + "POST /repos/:owner/:repo/issues/:issue_number/reactions": [ + ReactionsCreateForIssueEndpoint, + ReactionsCreateForIssueRequestOptions + ]; + "POST /repos/:owner/:repo/issues/comments/:comment_id/reactions": [ + ReactionsCreateForIssueCommentEndpoint, + ReactionsCreateForIssueCommentRequestOptions + ]; + "POST /repos/:owner/:repo/keys": [ + ReposAddDeployKeyEndpoint, + ReposAddDeployKeyRequestOptions + ]; + "POST /repos/:owner/:repo/labels": [ + IssuesCreateLabelEndpoint, + IssuesCreateLabelRequestOptions + ]; + "POST /repos/:owner/:repo/merges": [ + ReposMergeEndpoint, + ReposMergeRequestOptions + ]; + "POST /repos/:owner/:repo/milestones": [ + IssuesCreateMilestoneEndpoint, + IssuesCreateMilestoneRequestOptions + ]; + "POST /repos/:owner/:repo/pages": [ + ReposEnablePagesSiteEndpoint, + ReposEnablePagesSiteRequestOptions + ]; + "POST /repos/:owner/:repo/pages/builds": [ + ReposRequestPageBuildEndpoint, + ReposRequestPageBuildRequestOptions + ]; + "POST /repos/:owner/:repo/projects": [ + ProjectsCreateForRepoEndpoint, + ProjectsCreateForRepoRequestOptions + ]; + "POST /repos/:owner/:repo/pulls": [ + PullsCreateEndpoint, + PullsCreateRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/comments": [ + PullsCreateCommentEndpoint | PullsCreateCommentReplyEndpoint, + PullsCreateCommentRequestOptions | PullsCreateCommentReplyRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies": [ + PullsCreateReviewCommentReplyEndpoint, + PullsCreateReviewCommentReplyRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ + PullsCreateReviewRequestEndpoint, + PullsCreateReviewRequestRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/reviews": [ + PullsCreateReviewEndpoint, + PullsCreateReviewRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events": [ + PullsSubmitReviewEndpoint, + PullsSubmitReviewRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions": [ + ReactionsCreateForPullRequestReviewCommentEndpoint, + ReactionsCreateForPullRequestReviewCommentRequestOptions + ]; + "POST /repos/:owner/:repo/releases": [ + ReposCreateReleaseEndpoint, + ReposCreateReleaseRequestOptions + ]; + "POST /repos/:owner/:repo/statuses/:sha": [ + ReposCreateStatusEndpoint, + ReposCreateStatusRequestOptions + ]; + "POST /repos/:owner/:repo/transfer": [ + ReposTransferEndpoint, + ReposTransferRequestOptions + ]; + "POST /repos/:template_owner/:template_repo/generate": [ + ReposCreateUsingTemplateEndpoint, + ReposCreateUsingTemplateRequestOptions + ]; + "POST /scim/v2/organizations/:org/Users": [ + ScimProvisionAndInviteUsersEndpoint | ScimProvisionInviteUsersEndpoint, + + | ScimProvisionAndInviteUsersRequestOptions + | ScimProvisionInviteUsersRequestOptions + ]; + "POST /teams/:team_id/discussions": [ + TeamsCreateDiscussionEndpoint, + TeamsCreateDiscussionRequestOptions + ]; + "POST /teams/:team_id/discussions/:discussion_number/comments": [ + TeamsCreateDiscussionCommentEndpoint, + TeamsCreateDiscussionCommentRequestOptions + ]; + "POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": [ + ReactionsCreateForTeamDiscussionCommentEndpoint, + ReactionsCreateForTeamDiscussionCommentRequestOptions + ]; + "POST /teams/:team_id/discussions/:discussion_number/reactions": [ + ReactionsCreateForTeamDiscussionEndpoint, + ReactionsCreateForTeamDiscussionRequestOptions + ]; + "POST /user/emails": [UsersAddEmailsEndpoint, UsersAddEmailsRequestOptions]; + "POST /user/gpg_keys": [ + UsersCreateGpgKeyEndpoint, + UsersCreateGpgKeyRequestOptions + ]; + "POST /user/keys": [ + UsersCreatePublicKeyEndpoint, + UsersCreatePublicKeyRequestOptions + ]; + "POST /user/migrations": [ + MigrationsStartForAuthenticatedUserEndpoint, + MigrationsStartForAuthenticatedUserRequestOptions + ]; + "POST /user/projects": [ + ProjectsCreateForAuthenticatedUserEndpoint, + ProjectsCreateForAuthenticatedUserRequestOptions + ]; + "POST /user/repos": [ + ReposCreateForAuthenticatedUserEndpoint, + ReposCreateForAuthenticatedUserRequestOptions + ]; + "PUT /authorizations/clients/:client_id": [ + OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint, + OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions + ]; + "PUT /authorizations/clients/:client_id/:fingerprint": [ + + | OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint + | OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintEndpoint, + + | OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions + | OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintRequestOptions + ]; + "PUT /gists/:gist_id/star": [GistsStarEndpoint, GistsStarRequestOptions]; + "PUT /notifications": [ + ActivityMarkAsReadEndpoint, + ActivityMarkAsReadRequestOptions + ]; + "PUT /notifications/threads/:thread_id/subscription": [ + ActivitySetThreadSubscriptionEndpoint, + ActivitySetThreadSubscriptionRequestOptions + ]; + "PUT /orgs/:org/blocks/:username": [ + OrgsBlockUserEndpoint, + OrgsBlockUserRequestOptions + ]; + "PUT /orgs/:org/interaction-limits": [ + InteractionsAddOrUpdateRestrictionsForOrgEndpoint, + InteractionsAddOrUpdateRestrictionsForOrgRequestOptions + ]; + "PUT /orgs/:org/memberships/:username": [ + OrgsAddOrUpdateMembershipEndpoint, + OrgsAddOrUpdateMembershipRequestOptions + ]; + "PUT /orgs/:org/outside_collaborators/:username": [ + OrgsConvertMemberToOutsideCollaboratorEndpoint, + OrgsConvertMemberToOutsideCollaboratorRequestOptions + ]; + "PUT /orgs/:org/public_members/:username": [ + OrgsPublicizeMembershipEndpoint, + OrgsPublicizeMembershipRequestOptions + ]; + "PUT /projects/:project_id/collaborators/:username": [ + ProjectsAddCollaboratorEndpoint, + ProjectsAddCollaboratorRequestOptions + ]; + "PUT /repos/:owner/:repo/automated-security-fixes": [ + ReposEnableAutomatedSecurityFixesEndpoint, + ReposEnableAutomatedSecurityFixesRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection": [ + ReposUpdateBranchProtectionEndpoint, + ReposUpdateBranchProtectionRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ + ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint, + ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ + ReposReplaceProtectedBranchAppRestrictionsEndpoint, + ReposReplaceProtectedBranchAppRestrictionsRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ + ReposReplaceProtectedBranchTeamRestrictionsEndpoint, + ReposReplaceProtectedBranchTeamRestrictionsRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ + ReposReplaceProtectedBranchUserRestrictionsEndpoint, + ReposReplaceProtectedBranchUserRestrictionsRequestOptions + ]; + "PUT /repos/:owner/:repo/collaborators/:username": [ + ReposAddCollaboratorEndpoint, + ReposAddCollaboratorRequestOptions + ]; + "PUT /repos/:owner/:repo/contents/:path": [ + + | ReposCreateOrUpdateFileEndpoint + | ReposCreateFileEndpoint + | ReposUpdateFileEndpoint, + + | ReposCreateOrUpdateFileRequestOptions + | ReposCreateFileRequestOptions + | ReposUpdateFileRequestOptions + ]; + "PUT /repos/:owner/:repo/import": [ + MigrationsStartImportEndpoint, + MigrationsStartImportRequestOptions + ]; + "PUT /repos/:owner/:repo/interaction-limits": [ + InteractionsAddOrUpdateRestrictionsForRepoEndpoint, + InteractionsAddOrUpdateRestrictionsForRepoRequestOptions + ]; + "PUT /repos/:owner/:repo/issues/:issue_number/labels": [ + IssuesReplaceLabelsEndpoint, + IssuesReplaceLabelsRequestOptions + ]; + "PUT /repos/:owner/:repo/issues/:issue_number/lock": [ + IssuesLockEndpoint, + IssuesLockRequestOptions + ]; + "PUT /repos/:owner/:repo/notifications": [ + ActivityMarkNotificationsAsReadForRepoEndpoint, + ActivityMarkNotificationsAsReadForRepoRequestOptions + ]; + "PUT /repos/:owner/:repo/pages": [ + ReposUpdateInformationAboutPagesSiteEndpoint, + ReposUpdateInformationAboutPagesSiteRequestOptions + ]; + "PUT /repos/:owner/:repo/pulls/:pull_number/merge": [ + PullsMergeEndpoint, + PullsMergeRequestOptions + ]; + "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ + PullsUpdateReviewEndpoint, + PullsUpdateReviewRequestOptions + ]; + "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals": [ + PullsDismissReviewEndpoint, + PullsDismissReviewRequestOptions + ]; + "PUT /repos/:owner/:repo/pulls/:pull_number/update-branch": [ + PullsUpdateBranchEndpoint, + PullsUpdateBranchRequestOptions + ]; + "PUT /repos/:owner/:repo/subscription": [ + ActivitySetRepoSubscriptionEndpoint, + ActivitySetRepoSubscriptionRequestOptions + ]; + "PUT /repos/:owner/:repo/topics": [ + ReposReplaceTopicsEndpoint, + ReposReplaceTopicsRequestOptions + ]; + "PUT /repos/:owner/:repo/vulnerability-alerts": [ + ReposEnableVulnerabilityAlertsEndpoint, + ReposEnableVulnerabilityAlertsRequestOptions + ]; + "PUT /scim/v2/organizations/:org/Users/:scim_user_id": [ + + | ScimReplaceProvisionedUserInformationEndpoint + | ScimUpdateProvisionedOrgMembershipEndpoint, + + | ScimReplaceProvisionedUserInformationRequestOptions + | ScimUpdateProvisionedOrgMembershipRequestOptions + ]; + "PUT /teams/:team_id/members/:username": [ + TeamsAddMemberEndpoint, + TeamsAddMemberRequestOptions + ]; + "PUT /teams/:team_id/memberships/:username": [ + TeamsAddOrUpdateMembershipEndpoint, + TeamsAddOrUpdateMembershipRequestOptions + ]; + "PUT /teams/:team_id/projects/:project_id": [ + TeamsAddOrUpdateProjectEndpoint, + TeamsAddOrUpdateProjectRequestOptions + ]; + "PUT /teams/:team_id/repos/:owner/:repo": [ + TeamsAddOrUpdateRepoEndpoint, + TeamsAddOrUpdateRepoRequestOptions + ]; + "PUT /user/blocks/:username": [UsersBlockEndpoint, UsersBlockRequestOptions]; + "PUT /user/following/:username": [ + UsersFollowEndpoint, + UsersFollowRequestOptions + ]; + "PUT /user/installations/:installation_id/repositories/:repository_id": [ + AppsAddRepoToInstallationEndpoint, + AppsAddRepoToInstallationRequestOptions + ]; + "PUT /user/starred/:owner/:repo": [ + ActivityStarRepoEndpoint, + ActivityStarRepoRequestOptions + ]; + "PUT /user/subscriptions/:owner/:repo": [ + ActivityWatchRepoLegacyEndpoint, + ActivityWatchRepoLegacyRequestOptions + ]; +} + +type AppsGetAuthenticatedEndpoint = {}; +type AppsGetAuthenticatedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCreateFromManifestEndpoint = { + /** + * code parameter + */ + code: string; +}; +type AppsCreateFromManifestRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListInstallationsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListInstallationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; +}; +type AppsGetInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsDeleteInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; +}; +type AppsDeleteInstallationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCreateInstallationTokenEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; + /** + * The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the "[List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token. + */ + repository_ids?: number[]; + /** + * The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see "[GitHub App permissions](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions)." + */ + permissions?: AppsCreateInstallationTokenParamsPermissions; +}; +type AppsCreateInstallationTokenRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsListGrantsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OauthAuthorizationsListGrantsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetGrantEndpoint = { + /** + * grant_id parameter + */ + grant_id: number; +}; +type OauthAuthorizationsGetGrantRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsDeleteGrantEndpoint = { + /** + * grant_id parameter + */ + grant_id: number; +}; +type OauthAuthorizationsDeleteGrantRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsRevokeGrantForApplicationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; +type OauthAuthorizationsRevokeGrantForApplicationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsCheckAuthorizationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; +type OauthAuthorizationsCheckAuthorizationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsResetAuthorizationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; +type OauthAuthorizationsResetAuthorizationRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; +type OauthAuthorizationsRevokeAuthorizationForApplicationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetBySlugEndpoint = { + /** + * app_slug parameter + */ + app_slug: string; +}; +type AppsGetBySlugRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsListAuthorizationsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OauthAuthorizationsListAuthorizationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsCreateAuthorizationEndpoint = { + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. + */ + note: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * The 20 character OAuth app client key for which to create the token. + */ + client_id?: string; + /** + * The 40 character OAuth app client secret for which to create the token. + */ + client_secret?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; +}; +type OauthAuthorizationsCreateAuthorizationRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint). + */ + fingerprint?: string; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * fingerprint parameter + */ + fingerprint: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * fingerprint parameter + */ + fingerprint: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetAuthorizationEndpoint = { + /** + * authorization_id parameter + */ + authorization_id: number; +}; +type OauthAuthorizationsGetAuthorizationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsUpdateAuthorizationEndpoint = { + /** + * authorization_id parameter + */ + authorization_id: number; + /** + * Replaces the authorization scopes with these. + */ + scopes?: string[]; + /** + * A list of scopes to add to this authorization. + */ + add_scopes?: string[]; + /** + * A list of scopes to remove from this authorization. + */ + remove_scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; +}; +type OauthAuthorizationsUpdateAuthorizationRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsDeleteAuthorizationEndpoint = { + /** + * authorization_id parameter + */ + authorization_id: number; +}; +type OauthAuthorizationsDeleteAuthorizationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type CodesOfConductListConductCodesEndpoint = {}; +type CodesOfConductListConductCodesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type CodesOfConductGetConductCodeEndpoint = { + /** + * key parameter + */ + key: string; +}; +type CodesOfConductGetConductCodeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCreateContentAttachmentEndpoint = { + /** + * content_reference_id parameter + */ + content_reference_id: number; + /** + * The title of the content attachment displayed in the body or comment of an issue or pull request. + */ + title: string; + /** + * The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown. + */ + body: string; +}; +type AppsCreateContentAttachmentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type EmojisGetEndpoint = {}; +type EmojisGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListPublicEventsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListPublicEventsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListFeedsEndpoint = {}; +type ActivityListFeedsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsCreateEndpoint = { + /** + * The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`. + */ + files: GistsCreateParamsFiles; + /** + * A descriptive name for this gist. + */ + description?: string; + /** + * When `true`, the gist will be public and available for anyone to see. + */ + public?: boolean; +}; +type GistsCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListPublicEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListPublicRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListStarredEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListStarredRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsGetEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsUpdateEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * A descriptive name for this gist. + */ + description?: string; + /** + * The filenames and content that make up this gist. + */ + files?: GistsUpdateParamsFiles; +}; +type GistsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsDeleteEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListCommentsEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsCreateCommentEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * The comment text. + */ + body: string; +}; +type GistsCreateCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsGetCommentEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type GistsGetCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsUpdateCommentEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The comment text. + */ + body: string; +}; +type GistsUpdateCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsDeleteCommentEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type GistsDeleteCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListCommitsEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsForkEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsForkRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListForksEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListForksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsStarEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsStarRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsUnstarEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsUnstarRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsCheckIsStarredEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsCheckIsStarredRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsGetRevisionEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * sha parameter + */ + sha: string; +}; +type GistsGetRevisionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitignoreListTemplatesEndpoint = {}; +type GitignoreListTemplatesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitignoreGetTemplateEndpoint = { + /** + * name parameter + */ + name: string; +}; +type GitignoreGetTemplateRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListReposEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListReposRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListEndpoint = { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchIssuesLegacyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repository parameter + */ + repository: string; + /** + * Indicates the state of the issues to return. Can be either `open` or `closed`. + */ + state: "open" | "closed"; + /** + * The search term. + */ + keyword: string; +}; +type SearchIssuesLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchReposLegacyEndpoint = { + /** + * The search term. + */ + keyword: string; + /** + * Filter results by language. + */ + language?: string; + /** + * The page number to fetch. + */ + start_page?: string; + /** + * The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. + */ + sort?: "stars" | "forks" | "updated"; + /** + * The sort field. if `sort` param is provided. Can be either `asc` or `desc`. + */ + order?: "asc" | "desc"; +}; +type SearchReposLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchEmailLegacyEndpoint = { + /** + * The email address. + */ + email: string; +}; +type SearchEmailLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchUsersLegacyEndpoint = { + /** + * The search term. + */ + keyword: string; + /** + * The page number to fetch. + */ + start_page?: string; + /** + * The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. + */ + sort?: "stars" | "forks" | "updated"; + /** + * The sort field. if `sort` param is provided. Can be either `asc` or `desc`. + */ + order?: "asc" | "desc"; +}; +type SearchUsersLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type LicensesListCommonlyUsedEndpoint = {}; +type LicensesListCommonlyUsedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type LicensesListEndpoint = {}; +type LicensesListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type LicensesGetEndpoint = { + /** + * license parameter + */ + license: string; +}; +type LicensesGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MarkdownRenderEndpoint = { + /** + * The Markdown text to render in HTML. Markdown content must be 400 KB or less. + */ + text: string; + /** + * The rendering mode. Can be either: + * \* `markdown` to render a document in plain Markdown, just like README.md files are rendered. + * \* `gfm` to render a document in [GitHub Flavored Markdown](https://github.github.com/gfm/), which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests. + */ + mode?: "markdown" | "gfm"; + /** + * The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode. + */ + context?: string; +}; +type MarkdownRenderRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MarkdownRenderRawEndpoint = { + /** + * data parameter + */ + data: string; +}; +type MarkdownRenderRawRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCheckAccountIsAssociatedWithAnyEndpoint = { + /** + * account_id parameter + */ + account_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsCheckAccountIsAssociatedWithAnyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListPlansEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListPlansRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListAccountsUserOrOrgOnPlanEndpoint = { + /** + * plan_id parameter + */ + plan_id: number; + /** + * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListAccountsUserOrOrgOnPlanRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCheckAccountIsAssociatedWithAnyStubbedEndpoint = { + /** + * account_id parameter + */ + account_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsCheckAccountIsAssociatedWithAnyStubbedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListPlansStubbedEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListPlansStubbedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListAccountsUserOrOrgOnPlanStubbedEndpoint = { + /** + * plan_id parameter + */ + plan_id: number; + /** + * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListAccountsUserOrOrgOnPlanStubbedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MetaGetEndpoint = {}; +type MetaGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListPublicEventsForRepoNetworkEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListPublicEventsForRepoNetworkRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListNotificationsEndpoint = { + /** + * If `true`, show notifications marked as read. + */ + all?: boolean; + /** + * If `true`, only shows notifications in which the user is directly participating or mentioned. + */ + participating?: boolean; + /** + * Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + before?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListNotificationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityMarkAsReadEndpoint = { + /** + * Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; +}; +type ActivityMarkAsReadRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityGetThreadEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; +}; +type ActivityGetThreadRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityMarkThreadAsReadEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; +}; +type ActivityMarkThreadAsReadRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityGetThreadSubscriptionEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; +}; +type ActivityGetThreadSubscriptionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivitySetThreadSubscriptionEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; + /** + * Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread. + */ + ignored?: boolean; +}; +type ActivitySetThreadSubscriptionRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityDeleteThreadSubscriptionEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; +}; +type ActivityDeleteThreadSubscriptionRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListEndpoint = { + /** + * The integer ID of the last Organization that you've seen. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsGetEndpoint = { + /** + * org parameter + */ + org: string; +}; +type OrgsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsUpdateEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Billing email address. This address is not publicized. + */ + billing_email?: string; + /** + * The company name. + */ + company?: string; + /** + * The publicly visible email address. + */ + email?: string; + /** + * The location. + */ + location?: string; + /** + * The shorthand name of the company. + */ + name?: string; + /** + * The description of the company. + */ + description?: string; + /** + * Toggles whether organization projects are enabled for the organization. + */ + has_organization_projects?: boolean; + /** + * Toggles whether repository projects are enabled for repositories that belong to the organization. + */ + has_repository_projects?: boolean; + /** + * Default permission level members have for organization repositories: + * \* `read` - can pull, but not push to or administer this repository. + * \* `write` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push, and administer this repository. + * \* `none` - no permissions granted by default. + */ + default_repository_permission?: "read" | "write" | "admin" | "none"; + /** + * Toggles the ability of non-admin organization members to create repositories. Can be one of: + * \* `true` - all organization members can create repositories. + * \* `false` - only admin members can create repositories. + * Default: `true` + * **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + */ + members_can_create_repositories?: boolean; + /** + * Specifies which types of repositories non-admin organization members can create. Can be one of: + * \* `all` - all organization members can create public and private repositories. + * \* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). + * \* `none` - only admin members can create repositories. + * **Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + */ + members_allowed_repository_creation_type?: "all" | "private" | "none"; +}; +type OrgsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListBlockedUsersEndpoint = { + /** + * org parameter + */ + org: string; +}; +type OrgsListBlockedUsersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCheckBlockedUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsCheckBlockedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsBlockUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsBlockUserRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsUnblockUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsUnblockUserRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListCredentialAuthorizationsEndpoint = { + /** + * org parameter + */ + org: string; +}; +type OrgsListCredentialAuthorizationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsRemoveCredentialAuthorizationEndpoint = { + /** + * org parameter + */ + org: string; + /** + * credential_id parameter + */ + credential_id: number; +}; +type OrgsRemoveCredentialAuthorizationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListPublicEventsForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListPublicEventsForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListHooksEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListHooksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCreateHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Must be passed as "web". + */ + name: string; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params). + */ + config: OrgsCreateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +type OrgsCreateHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsGetHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type OrgsGetHookRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsUpdateHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * hook_id parameter + */ + hook_id: number; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params). + */ + config?: OrgsUpdateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +type OrgsUpdateHookRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsDeleteHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type OrgsDeleteHookRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsPingHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type OrgsPingHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetOrgInstallationEndpoint = { + /** + * org parameter + */ + org: string; +}; +type AppsGetOrgInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsFindOrgInstallationEndpoint = { + /** + * org parameter + */ + org: string; +}; +type AppsFindOrgInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsGetRestrictionsForOrgEndpoint = { + /** + * org parameter + */ + org: string; +}; +type InteractionsGetRestrictionsForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsAddOrUpdateRestrictionsForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`. + */ + limit: "existing_users" | "contributors_only" | "collaborators_only"; +}; +type InteractionsAddOrUpdateRestrictionsForOrgRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsRemoveRestrictionsForOrgEndpoint = { + /** + * org parameter + */ + org: string; +}; +type InteractionsRemoveRestrictionsForOrgRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListPendingInvitationsEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListPendingInvitationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCreateInvitationEndpoint = { + /** + * org parameter + */ + org: string; + /** + * **Required unless you provide `email`**. GitHub user ID for the person you are inviting. + */ + invitee_id?: number; + /** + * **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. + */ + email?: string; + /** + * Specify role for new member. Can be one of: + * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * \* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * \* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + */ + role?: "admin" | "direct_member" | "billing_manager"; + /** + * Specify IDs for the teams you want to invite new members to. + */ + team_ids?: number[]; +}; +type OrgsCreateInvitationRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListInvitationTeamsEndpoint = { + /** + * org parameter + */ + org: string; + /** + * invitation_id parameter + */ + invitation_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListInvitationTeamsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListMembersEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Filter members returned in the list. Can be one of: + * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. + * \* `all` - All members the authenticated user can see. + */ + filter?: "2fa_disabled" | "all"; + /** + * Filter members returned by their role. Can be one of: + * \* `all` - All members of the organization, regardless of role. + * \* `admin` - Organization owners. + * \* `member` - Non-owner organization members. + */ + role?: "all" | "admin" | "member"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListMembersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCheckMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsCheckMembershipRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsRemoveMemberEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsRemoveMemberRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsGetMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsGetMembershipRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsAddOrUpdateMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; + /** + * The role to give the user in the organization. Can be one of: + * \* `admin` - The user will become an owner of the organization. + * \* `member` - The user will become a non-owner member of the organization. + */ + role?: "admin" | "member"; +}; +type OrgsAddOrUpdateMembershipRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsRemoveMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsRemoveMembershipRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsStartForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * A list of arrays indicating which repositories should be migrated. + */ + repositories: string[]; + /** + * Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + */ + lock_repositories?: boolean; + /** + * Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + */ + exclude_attachments?: boolean; +}; +type MigrationsStartForOrgRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsListForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type MigrationsListForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetStatusForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsGetStatusForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetArchiveForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsGetArchiveForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsDeleteArchiveForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsDeleteArchiveForOrgRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsUnlockRepoForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; + /** + * repo_name parameter + */ + repo_name: string; +}; +type MigrationsUnlockRepoForOrgRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListOutsideCollaboratorsEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Filter the list of outside collaborators. Can be one of: + * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. + * \* `all`: All outside collaborators. + */ + filter?: "2fa_disabled" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListOutsideCollaboratorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsRemoveOutsideCollaboratorEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsRemoveOutsideCollaboratorRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsConvertMemberToOutsideCollaboratorEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsConvertMemberToOutsideCollaboratorRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +}; +type ProjectsCreateForOrgRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListPublicMembersEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListPublicMembersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCheckPublicMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsCheckPublicMembershipRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsPublicizeMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsPublicizeMembershipRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsConcealMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsConcealMembershipRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`. + */ + type?: "all" | "public" | "private" | "forks" | "sources" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * The name of the repository. + */ + name: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account. + */ + private?: boolean; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + */ + team_id?: number; + /** + * Pass `true` to create an initial commit with empty README. + */ + auto_init?: boolean; + /** + * Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". + */ + gitignore_template?: string; + /** + * Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". + */ + license_template?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; +}; +type ReposCreateInOrgRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListIdPGroupsForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListIdPGroupsForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateEndpoint = { + /** + * org parameter + */ + org: string; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The logins of organization members to add as maintainers of the team. + */ + maintainers?: string[]; + /** + * The full name (e.g., "organization-name/repository-name") of repositories to add the team to. + */ + repo_names?: string[]; + /** + * The level of privacy this team should have. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + * Default for child team: `closed` + * **Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. + */ + parent_team_id?: number; +}; +type TeamsCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetByNameEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; +}; +type TeamsGetByNameRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsGetCardEndpoint = { + /** + * card_id parameter + */ + card_id: number; +}; +type ProjectsGetCardRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsUpdateCardEndpoint = { + /** + * card_id parameter + */ + card_id: number; + /** + * The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`. + */ + note?: string; + /** + * Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card. + */ + archived?: boolean; +}; +type ProjectsUpdateCardRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsDeleteCardEndpoint = { + /** + * card_id parameter + */ + card_id: number; +}; +type ProjectsDeleteCardRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsMoveCardEndpoint = { + /** + * card_id parameter + */ + card_id: number; + /** + * Can be one of `top`, `bottom`, or `after:`, where `` is the `id` value of a card in the same column, or in the new column specified by `column_id`. + */ + position: string; + /** + * The `id` value of a column in the same project. + */ + column_id?: number; +}; +type ProjectsMoveCardRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsGetColumnEndpoint = { + /** + * column_id parameter + */ + column_id: number; +}; +type ProjectsGetColumnRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsUpdateColumnEndpoint = { + /** + * column_id parameter + */ + column_id: number; + /** + * The new name of the column. + */ + name: string; +}; +type ProjectsUpdateColumnRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsDeleteColumnEndpoint = { + /** + * column_id parameter + */ + column_id: number; +}; +type ProjectsDeleteColumnRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListCardsEndpoint = { + /** + * column_id parameter + */ + column_id: number; + /** + * Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. + */ + archived_state?: "all" | "archived" | "not_archived"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListCardsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateCardEndpoint = { + /** + * column_id parameter + */ + column_id: number; + /** + * The card's note content. Only valid for cards without another type of content, so you must omit when specifying `content_id` and `content_type`. + */ + note?: string; + /** + * The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. + * **Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`. + */ + content_id?: number; + /** + * **Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id. + */ + content_type?: string; +}; +type ProjectsCreateCardRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsMoveColumnEndpoint = { + /** + * column_id parameter + */ + column_id: number; + /** + * Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project. + */ + position: string; +}; +type ProjectsMoveColumnRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsGetEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsUpdateEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * The name of the project. + */ + name?: string; + /** + * The description of the project. + */ + body?: string; + /** + * State of the project. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project](https://developer.github.com/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). + * + * **Note:** Updating a project's `organization_permission` requires `admin` access to the project. + * + * Can be one of: + * \* `read` - Organization members can read, but not write to or administer this project. + * \* `write` - Organization members can read and write, but not administer this project. + * \* `admin` - Organization members can read, write and administer this project. + * \* `none` - Organization members can only see this project if it is public. + */ + organization_permission?: string; + /** + * Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. + * + * Can be one of: + * \* `false` - Anyone can see the project. + * \* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account. + */ + private?: boolean; +}; +type ProjectsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsDeleteEndpoint = { + /** + * project_id parameter + */ + project_id: number; +}; +type ProjectsDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListCollaboratorsEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * Filters the collaborators by their affiliation. Can be one of: + * \* `outside`: Outside collaborators of a project that are not a member of the project's organization. + * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListCollaboratorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsAddCollaboratorEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * username parameter + */ + username: string; + /** + * The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." Can be one of: + * \* `read` - can read, but not write to or administer this project. + * \* `write` - can read and write, but not administer this project. + * \* `admin` - can read, write and administer this project. + */ + permission?: "read" | "write" | "admin"; +}; +type ProjectsAddCollaboratorRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsRemoveCollaboratorEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * username parameter + */ + username: string; +}; +type ProjectsRemoveCollaboratorRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsReviewUserPermissionLevelEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * username parameter + */ + username: string; +}; +type ProjectsReviewUserPermissionLevelRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListColumnsEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListColumnsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateColumnEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * The name of the column. + */ + name: string; +}; +type ProjectsCreateColumnRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type RateLimitGetEndpoint = {}; +type RateLimitGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsDeleteEndpoint = { + /** + * reaction_id parameter + */ + reaction_id: number; +}; +type ReactionsDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the repository. + */ + name?: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + */ + private?: boolean; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * Updates the default branch for this repository. + */ + default_branch?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; + /** + * `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. + */ + archived?: boolean; +}; +type ReposUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListAssigneesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListAssigneesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCheckAssigneeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * assignee parameter + */ + assignee: string; +}; +type IssuesCheckAssigneeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposEnableAutomatedSecurityFixesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposEnableAutomatedSecurityFixesRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDisableAutomatedSecurityFixesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposDisableAutomatedSecurityFixesRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListBranchesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. + */ + protected?: boolean; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListBranchesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetBranchProtectionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetBranchProtectionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateBranchProtectionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * Require status checks to pass before merging. Set to `null` to disable. + */ + required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null; + /** + * Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + */ + enforce_admins: boolean | null; + /** + * Require at least one approving review on a pull request, before merging. Set to `null` to disable. + */ + required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null; + /** + * Restrict who can push to this branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + */ + restrictions: ReposUpdateBranchProtectionParamsRestrictions | null; +}; +type ReposUpdateBranchProtectionRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveBranchProtectionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveBranchProtectionRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchAdminEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchAdminEnforcementRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchAdminEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposAddProtectedBranchAdminEnforcementRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchAdminEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchAdminEnforcementRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. + */ + dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions; + /** + * Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. + */ + dismiss_stale_reviews?: boolean; + /** + * Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed. + */ + require_code_owner_reviews?: boolean; + /** + * Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6. + */ + required_approving_review_count?: number; +}; +type ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchRequiredSignaturesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchRequiredSignaturesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchRequiredSignaturesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposAddProtectedBranchRequiredSignaturesRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchRequiredSignaturesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchRequiredSignaturesRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchRequiredStatusChecksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchRequiredStatusChecksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateProtectedBranchRequiredStatusChecksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * Require branches to be up to date before merging. + */ + strict?: boolean; + /** + * The list of status checks to require in order to merge into this branch + */ + contexts?: string[]; +}; +type ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchRequiredStatusChecksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListProtectedBranchRequiredStatusChecksContextsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +type ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +type ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +type ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchRestrictionsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchRestrictionsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetAppsWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetAppsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListAppsWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListAppsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceProtectedBranchAppRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +type ReposReplaceProtectedBranchAppRestrictionsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchAppRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +type ReposAddProtectedBranchAppRestrictionsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchAppRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +type ReposRemoveProtectedBranchAppRestrictionsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetTeamsWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetTeamsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListProtectedBranchTeamRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListProtectedBranchTeamRestrictionsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListTeamsWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListTeamsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceProtectedBranchTeamRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +type ReposReplaceProtectedBranchTeamRestrictionsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchTeamRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +type ReposAddProtectedBranchTeamRestrictionsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchTeamRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +type ReposRemoveProtectedBranchTeamRestrictionsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetUsersWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetUsersWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListProtectedBranchUserRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListProtectedBranchUserRestrictionsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListUsersWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListUsersWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceProtectedBranchUserRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * users parameter + */ + users: string[]; +}; +type ReposReplaceProtectedBranchUserRestrictionsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchUserRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * users parameter + */ + users: string[]; +}; +type ReposAddProtectedBranchUserRestrictionsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchUserRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * users parameter + */ + users: string[]; +}; +type ReposRemoveProtectedBranchUserRestrictionsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksCreateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the check. For example, "code-coverage". + */ + name: string; + /** + * The SHA of the commit. + */ + head_sha: string; + /** + * The URL of the integrator's site that has the full details of the check. + */ + details_url?: string; + /** + * A reference for the run on the integrator's system. + */ + external_id?: string; + /** + * The current status. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. + */ + conclusion?: + | "success" + | "failure" + | "neutral" + | "cancelled" + | "timed_out" + | "action_required"; + /** + * The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** + * Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description. + */ + output?: ChecksCreateParamsOutput; + /** + * Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + */ + actions?: ChecksCreateParamsActions[]; +}; +type ChecksCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksUpdateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_run_id parameter + */ + check_run_id: number; + /** + * The name of the check. For example, "code-coverage". + */ + name?: string; + /** + * The URL of the integrator's site that has the full details of the check. + */ + details_url?: string; + /** + * A reference for the run on the integrator's system. + */ + external_id?: string; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * The current status. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. + */ + conclusion?: + | "success" + | "failure" + | "neutral" + | "cancelled" + | "timed_out" + | "action_required"; + /** + * The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** + * Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description. + */ + output?: ChecksUpdateParamsOutput; + /** + * Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + */ + actions?: ChecksUpdateParamsActions[]; +}; +type ChecksUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksGetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_run_id parameter + */ + check_run_id: number; +}; +type ChecksGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksListAnnotationsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_run_id parameter + */ + check_run_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ChecksListAnnotationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksCreateSuiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The sha of the head commit. + */ + head_sha: string; +}; +type ChecksCreateSuiteRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksSetSuitesPreferencesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details. + */ + auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]; +}; +type ChecksSetSuitesPreferencesRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksGetSuiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_suite_id parameter + */ + check_suite_id: number; +}; +type ChecksGetSuiteRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksListForSuiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_suite_id parameter + */ + check_suite_id: number; + /** + * Returns check runs with the specified `name`. + */ + check_name?: string; + /** + * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ChecksListForSuiteRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksRerequestSuiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_suite_id parameter + */ + check_suite_id: number; +}; +type ChecksRerequestSuiteRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListCollaboratorsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Filter collaborators returned by their affiliation. Can be one of: + * \* `outside`: All outside collaborators of an organization-owned repository. + * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListCollaboratorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCheckCollaboratorEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * username parameter + */ + username: string; +}; +type ReposCheckCollaboratorRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddCollaboratorEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * username parameter + */ + username: string; + /** + * The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: + * \* `pull` - can pull, but not push to or administer this repository. + * \* `push` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push and administer this repository. + */ + permission?: "pull" | "push" | "admin"; +}; +type ReposAddCollaboratorRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveCollaboratorEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * username parameter + */ + username: string; +}; +type ReposRemoveCollaboratorRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCollaboratorPermissionLevelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * username parameter + */ + username: string; +}; +type ReposGetCollaboratorPermissionLevelRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListCommitCommentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListCommitCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type ReposGetCommitCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The contents of the comment + */ + body: string; +}; +type ReposUpdateCommitCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type ReposDeleteCommitCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForCommitCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForCommitCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListCommitsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). + */ + sha?: string; + /** + * Only commits containing this file path will be returned. + */ + path?: string; + /** + * GitHub login or email address by which to filter by commit author. + */ + author?: string; + /** + * Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + until?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListBranchesForHeadCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; +}; +type ReposListBranchesForHeadCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListCommentsForCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListCommentsForCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; + /** + * The contents of the comment. + */ + body: string; + /** + * Relative path of the file to comment on. + */ + path?: string; + /** + * Line index in the diff to comment on. + */ + position?: number; + /** + * **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. + */ + line?: number; +}; +type ReposCreateCommitCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListPullRequestsAssociatedWithCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListPullRequestsAssociatedWithCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; +}; +type ReposGetCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksListForRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * Returns check runs with the specified `name`. + */ + check_name?: string; + /** + * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ChecksListForRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksListSuitesForRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * Filters check suites by GitHub App `id`. + */ + app_id?: number; + /** + * Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/). + */ + check_name?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ChecksListSuitesForRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCombinedStatusForRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; +}; +type ReposGetCombinedStatusForRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListStatusesForRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListStatusesForRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type CodesOfConductGetForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type CodesOfConductGetForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRetrieveCommunityProfileMetricsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposRetrieveCommunityProfileMetricsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCompareCommitsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * base parameter + */ + base: string; + /** + * head parameter + */ + head: string; +}; +type ReposCompareCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetContentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) + */ + ref?: string; +}; +type ReposGetContentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateOrUpdateFileEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The commit message. + */ + message: string; + /** + * The new file content, using Base64 encoding. + */ + content: string; + /** + * **Required if you are updating a file**. The blob SHA of the file being replaced. + */ + sha?: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * The person that committed the file. Default: the authenticated user. + */ + committer?: ReposCreateOrUpdateFileParamsCommitter; + /** + * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. + */ + author?: ReposCreateOrUpdateFileParamsAuthor; +}; +type ReposCreateOrUpdateFileRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateFileEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The commit message. + */ + message: string; + /** + * The new file content, using Base64 encoding. + */ + content: string; + /** + * **Required if you are updating a file**. The blob SHA of the file being replaced. + */ + sha?: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * The person that committed the file. Default: the authenticated user. + */ + committer?: ReposCreateFileParamsCommitter; + /** + * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. + */ + author?: ReposCreateFileParamsAuthor; +}; +type ReposCreateFileRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateFileEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The commit message. + */ + message: string; + /** + * The new file content, using Base64 encoding. + */ + content: string; + /** + * **Required if you are updating a file**. The blob SHA of the file being replaced. + */ + sha?: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * The person that committed the file. Default: the authenticated user. + */ + committer?: ReposUpdateFileParamsCommitter; + /** + * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. + */ + author?: ReposUpdateFileParamsAuthor; +}; +type ReposUpdateFileRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteFileEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The commit message. + */ + message: string; + /** + * The blob SHA of the file being replaced. + */ + sha: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * object containing information about the committer. + */ + committer?: ReposDeleteFileParamsCommitter; + /** + * object containing information about the author. + */ + author?: ReposDeleteFileParamsAuthor; +}; +type ReposDeleteFileRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListContributorsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Set to `1` or `true` to include anonymous contributors in results. + */ + anon?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListContributorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListDeploymentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The SHA recorded at creation time. + */ + sha?: string; + /** + * The name of the ref. This can be a branch, tag, or SHA. + */ + ref?: string; + /** + * The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). + */ + task?: string; + /** + * The name of the environment that was deployed to (e.g., `staging` or `production`). + */ + environment?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListDeploymentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateDeploymentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The ref to deploy. This can be a branch, tag, or SHA. + */ + ref: string; + /** + * Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). + */ + task?: string; + /** + * Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. + */ + auto_merge?: boolean; + /** + * The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. + */ + required_contexts?: string[]; + /** + * JSON payload with extra information about the deployment. + */ + payload?: string; + /** + * Name for the target deployment environment (e.g., `production`, `staging`, `qa`). + */ + environment?: string; + /** + * Short description of the deployment. + */ + description?: string; + /** + * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + transient_environment?: boolean; + /** + * Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + production_environment?: boolean; +}; +type ReposCreateDeploymentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetDeploymentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; +}; +type ReposGetDeploymentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListDeploymentStatusesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListDeploymentStatusesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateDeploymentStatusEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; + /** + * The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + */ + state: + | "error" + | "failure" + | "inactive" + | "in_progress" + | "queued" + | "pending" + | "success"; + /** + * The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + */ + target_url?: string; + /** + * The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + log_url?: string; + /** + * A short description of the status. The maximum description length is 140 characters. + */ + description?: string; + /** + * Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + */ + environment?: "production" | "staging" | "qa"; + /** + * Sets the URL for accessing your environment. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + environment_url?: string; + /** + * Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` + * **Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + auto_inactive?: boolean; +}; +type ReposCreateDeploymentStatusRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetDeploymentStatusEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; + /** + * status_id parameter + */ + status_id: number; +}; +type ReposGetDeploymentStatusRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateDispatchEventEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * **Required:** A custom webhook event name. + */ + event_type?: string; +}; +type ReposCreateDispatchEventRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListDownloadsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListDownloadsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetDownloadEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * download_id parameter + */ + download_id: number; +}; +type ReposGetDownloadRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteDownloadEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * download_id parameter + */ + download_id: number; +}; +type ReposDeleteDownloadRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListRepoEventsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListRepoEventsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListForksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The sort order. Can be either `newest`, `oldest`, or `stargazers`. + */ + sort?: "newest" | "oldest" | "stargazers"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListForksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateForkEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Optional parameter to specify the organization name if forking into an organization. + */ + organization?: string; +}; +type ReposCreateForkRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateBlobEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The new blob's content. + */ + content: string; + /** + * The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + */ + encoding?: string; +}; +type GitCreateBlobRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetBlobEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * file_sha parameter + */ + file_sha: string; +}; +type GitGetBlobRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The commit message + */ + message: string; + /** + * The SHA of the tree object this commit points to + */ + tree: string; + /** + * The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. + */ + parents: string[]; + /** + * Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. + */ + author?: GitCreateCommitParamsAuthor; + /** + * Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. + */ + committer?: GitCreateCommitParamsCommitter; + /** + * The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. + */ + signature?: string; +}; +type GitCreateCommitRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; +}; +type GitGetCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitListMatchingRefsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GitListMatchingRefsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; +}; +type GitGetRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. + */ + ref: string; + /** + * The SHA1 value for this reference. + */ + sha: string; +}; +type GitCreateRefRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitUpdateRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * The SHA1 value to set this reference to + */ + sha: string; + /** + * Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. + */ + force?: boolean; +}; +type GitUpdateRefRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitDeleteRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; +}; +type GitDeleteRefRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateTagEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The tag's name. This is typically a version (e.g., "v0.0.1"). + */ + tag: string; + /** + * The tag message. + */ + message: string; + /** + * The SHA of the git object this is tagging. + */ + object: string; + /** + * The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. + */ + type: "commit" | "tree" | "blob"; + /** + * An object with information about the individual creating the tag. + */ + tagger?: GitCreateTagParamsTagger; +}; +type GitCreateTagRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetTagEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * tag_sha parameter + */ + tag_sha: string; +}; +type GitGetTagRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateTreeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. + */ + tree: GitCreateTreeParamsTree[]; + /** + * The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted. + */ + base_tree?: string; +}; +type GitCreateTreeRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetTreeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * tree_sha parameter + */ + tree_sha: string; + /** + * recursive parameter + */ + recursive?: "1"; +}; +type GitGetTreeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListHooksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListHooksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. + */ + name?: string; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). + */ + config: ReposCreateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +type ReposCreateHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type ReposGetHookRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). + */ + config?: ReposUpdateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events. + */ + events?: string[]; + /** + * Determines a list of events to be added to the list of events that the Hook triggers for. + */ + add_events?: string[]; + /** + * Determines a list of events to be removed from the list of events that the Hook triggers for. + */ + remove_events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +type ReposUpdateHookRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type ReposDeleteHookRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposPingHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type ReposPingHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposTestPushHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type ReposTestPushHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsStartImportEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The URL of the originating repository. + */ + vcs_url: string; + /** + * The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. + */ + vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + /** + * If authentication is required, the username to provide to `vcs_url`. + */ + vcs_username?: string; + /** + * If authentication is required, the password to provide to `vcs_url`. + */ + vcs_password?: string; + /** + * For a tfvc import, the name of the project that is being imported. + */ + tfvc_project?: string; +}; +type MigrationsStartImportRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetImportProgressEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type MigrationsGetImportProgressRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsUpdateImportEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The username to provide to the originating repository. + */ + vcs_username?: string; + /** + * The password to provide to the originating repository. + */ + vcs_password?: string; +}; +type MigrationsUpdateImportRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsCancelImportEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type MigrationsCancelImportRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetCommitAuthorsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step. + */ + since?: string; +}; +type MigrationsGetCommitAuthorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsMapCommitAuthorEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * author_id parameter + */ + author_id: number; + /** + * The new Git author email. + */ + email?: string; + /** + * The new Git author name. + */ + name?: string; +}; +type MigrationsMapCommitAuthorRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetLargeFilesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type MigrationsGetLargeFilesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsSetLfsPreferenceEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import). + */ + use_lfs: "opt_in" | "opt_out"; +}; +type MigrationsSetLfsPreferenceRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetRepoInstallationEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type AppsGetRepoInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsFindRepoInstallationEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type AppsFindRepoInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsGetRestrictionsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type InteractionsGetRestrictionsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsAddOrUpdateRestrictionsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`. + */ + limit: "existing_users" | "contributors_only" | "collaborators_only"; +}; +type InteractionsAddOrUpdateRestrictionsForRepoRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsRemoveRestrictionsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type InteractionsRemoveRestrictionsForRepoRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListInvitationsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListInvitationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteInvitationEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * invitation_id parameter + */ + invitation_id: number; +}; +type ReposDeleteInvitationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateInvitationEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * invitation_id parameter + */ + invitation_id: number; + /** + * The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`. + */ + permissions?: "read" | "write" | "admin"; +}; +type ReposUpdateInvitationRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. + */ + milestone?: string; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. + */ + assignee?: string; + /** + * The user that created the issue. + */ + creator?: string; + /** + * A user that's mentioned in the issue. + */ + mentioned?: string; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCreateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The title of the issue. + */ + title: string; + /** + * The contents of the issue. + */ + body?: string; + /** + * Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ + */ + assignee?: string; + /** + * The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._ + */ + milestone?: number; + /** + * Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ + */ + labels?: string[]; + /** + * Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + */ + assignees?: string[]; +}; +type IssuesCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListCommentsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Either `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * Either `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; +}; +type IssuesListCommentsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesGetCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUpdateCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The contents of the comment. + */ + body: string; +}; +type IssuesUpdateCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesDeleteCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type IssuesDeleteCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForIssueCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForIssueCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForIssueCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForIssueCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListEventsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListEventsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetEventEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * event_id parameter + */ + event_id: number; +}; +type IssuesGetEventRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; +}; +type IssuesGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUpdateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The title of the issue. + */ + title?: string; + /** + * The contents of the issue. + */ + body?: string; + /** + * Login for the user that this issue should be assigned to. **This field is deprecated.** + */ + assignee?: string; + /** + * State of the issue. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ + */ + milestone?: number | null; + /** + * Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ + */ + labels?: string[]; + /** + * Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + */ + assignees?: string[]; +}; +type IssuesUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesAddAssigneesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ + */ + assignees?: string[]; +}; +type IssuesAddAssigneesRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesRemoveAssigneesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ + */ + assignees?: string[]; +}; +type IssuesRemoveAssigneesRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListCommentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCreateCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The contents of the comment. + */ + body: string; +}; +type IssuesCreateCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListEventsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListEventsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListLabelsOnIssueEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListLabelsOnIssueRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesAddLabelsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. + */ + labels: string[]; +}; +type IssuesAddLabelsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesReplaceLabelsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. + */ + labels?: string[]; +}; +type IssuesReplaceLabelsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesRemoveLabelsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; +}; +type IssuesRemoveLabelsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesRemoveLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * name parameter + */ + name: string; +}; +type IssuesRemoveLabelRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesLockEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: + * \* `off-topic` + * \* `too heated` + * \* `resolved` + * \* `spam` + */ + lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; +}; +type IssuesLockRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUnlockEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; +}; +type IssuesUnlockRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForIssueEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForIssueRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForIssueEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForIssueRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListEventsForTimelineEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListEventsForTimelineRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListDeployKeysEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListDeployKeysRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddDeployKeyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * A name for the key. + */ + title?: string; + /** + * The contents of the key. + */ + key: string; + /** + * If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + * + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/)." + */ + read_only?: boolean; +}; +type ReposAddDeployKeyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetDeployKeyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * key_id parameter + */ + key_id: number; +}; +type ReposGetDeployKeyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveDeployKeyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * key_id parameter + */ + key_id: number; +}; +type ReposRemoveDeployKeyRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListLabelsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListLabelsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCreateLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). + */ + name: string; + /** + * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + */ + color: string; + /** + * A short description of the label. + */ + description?: string; +}; +type IssuesCreateLabelRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * name parameter + */ + name: string; +}; +type IssuesGetLabelRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUpdateLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * name parameter + */ + name: string; + /** + * The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). + */ + new_name?: string; + /** + * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + */ + color?: string; + /** + * A short description of the label. + */ + description?: string; +}; +type IssuesUpdateLabelRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesDeleteLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * name parameter + */ + name: string; +}; +type IssuesDeleteLabelRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListLanguagesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposListLanguagesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type LicensesGetForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type LicensesGetForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposMergeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the base branch that the head will be merged into. + */ + base: string; + /** + * The head to merge. This can be a branch name or a commit SHA1. + */ + head: string; + /** + * Commit message to use for the merge commit. If omitted, a default message will be used. + */ + commit_message?: string; +}; +type ReposMergeRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListMilestonesForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The state of the milestone. Either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * What to sort results by. Either `due_on` or `completeness`. + */ + sort?: "due_on" | "completeness"; + /** + * The direction of the sort. Either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListMilestonesForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCreateMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The title of the milestone. + */ + title: string; + /** + * The state of the milestone. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * A description of the milestone. + */ + description?: string; + /** + * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + due_on?: string; +}; +type IssuesCreateMilestoneRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * milestone_number parameter + */ + milestone_number: number; +}; +type IssuesGetMilestoneRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUpdateMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * milestone_number parameter + */ + milestone_number: number; + /** + * The title of the milestone. + */ + title?: string; + /** + * The state of the milestone. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * A description of the milestone. + */ + description?: string; + /** + * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + due_on?: string; +}; +type IssuesUpdateMilestoneRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesDeleteMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * milestone_number parameter + */ + milestone_number: number; +}; +type IssuesDeleteMilestoneRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListLabelsForMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * milestone_number parameter + */ + milestone_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListLabelsForMilestoneRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListNotificationsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * If `true`, show notifications marked as read. + */ + all?: boolean; + /** + * If `true`, only shows notifications in which the user is directly participating or mentioned. + */ + participating?: boolean; + /** + * Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + before?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListNotificationsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityMarkNotificationsAsReadForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; +}; +type ActivityMarkNotificationsAsReadForRepoRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetPagesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetPagesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposEnablePagesSiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * source parameter + */ + source?: ReposEnablePagesSiteParamsSource; +}; +type ReposEnablePagesSiteRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDisablePagesSiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposDisablePagesSiteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateInformationAboutPagesSiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/)." + */ + cname?: string; + /** + * Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `"gh-pages"`, `"master"`, and `"master /docs"`. + */ + source?: '"gh-pages"' | '"master"' | '"master /docs"'; +}; +type ReposUpdateInformationAboutPagesSiteRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRequestPageBuildEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposRequestPageBuildRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListPagesBuildsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListPagesBuildsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetLatestPagesBuildEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetLatestPagesBuildRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetPagesBuildEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * build_id parameter + */ + build_id: number; +}; +type ReposGetPagesBuildRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +}; +type ProjectsCreateForRepoRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Either `open`, `closed`, or `all` to filter by state. + */ + state?: "open" | "closed" | "all"; + /** + * Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. + */ + head?: string; + /** + * Filter pulls by base branch name. Example: `gh-pages`. + */ + base?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). + */ + sort?: "created" | "updated" | "popularity" | "long-running"; + /** + * The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The title of the new pull request. + */ + title: string; + /** + * The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. + */ + head: string; + /** + * The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. + */ + base: string; + /** + * The contents of the pull request. + */ + body?: string; + /** + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + */ + maintainer_can_modify?: boolean; + /** + * Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. + */ + draft?: boolean; +}; +type PullsCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListCommentsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Can be either `created` or `updated` comments. + */ + sort?: "created" | "updated"; + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListCommentsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsGetCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type PullsGetCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsUpdateCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The text of the reply to the review comment. + */ + body: string; +}; +type PullsUpdateCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsDeleteCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type PullsDeleteCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForPullRequestReviewCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForPullRequestReviewCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForPullRequestReviewCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForPullRequestReviewCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsGetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; +}; +type PullsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsUpdateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The title of the pull request. + */ + title?: string; + /** + * The contents of the pull request. + */ + body?: string; + /** + * State of this Pull Request. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. + */ + base?: string; + /** + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + */ + maintainer_can_modify?: boolean; +}; +type PullsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListCommentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Can be either `created` or `updated` comments. + */ + sort?: "created" | "updated"; + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The text of the review comment. + */ + body: string; + /** + * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. + */ + commit_id: string; + /** + * The relative path to the file that necessitates a comment. + */ + path: string; + /** + * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + */ + position?: number; + /** + * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + */ + side?: "LEFT" | "RIGHT"; + /** + * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. + */ + line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. + */ + start_line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + */ + start_side?: "LEFT" | "RIGHT" | "side"; +}; +type PullsCreateCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateCommentReplyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The text of the review comment. + */ + body: string; + /** + * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. + */ + commit_id: string; + /** + * The relative path to the file that necessitates a comment. + */ + path: string; + /** + * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + */ + position?: number; + /** + * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + */ + side?: "LEFT" | "RIGHT"; + /** + * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. + */ + line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. + */ + start_line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + */ + start_side?: "LEFT" | "RIGHT" | "side"; +}; +type PullsCreateCommentReplyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateReviewCommentReplyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The text of the review comment. + */ + body: string; +}; +type PullsCreateReviewCommentReplyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListCommitsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListFilesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListFilesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCheckIfMergedEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; +}; +type PullsCheckIfMergedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsMergeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Title for the automatic commit message. + */ + commit_title?: string; + /** + * Extra detail to append to automatic commit message. + */ + commit_message?: string; + /** + * SHA that pull request head must match to allow merge. + */ + sha?: string; + /** + * Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. + */ + merge_method?: "merge" | "squash" | "rebase"; +}; +type PullsMergeRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListReviewRequestsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListReviewRequestsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateReviewRequestEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * An array of user `login`s that will be requested. + */ + reviewers?: string[]; + /** + * An array of team `slug`s that will be requested. + */ + team_reviewers?: string[]; +}; +type PullsCreateReviewRequestRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsDeleteReviewRequestEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * An array of user `login`s that will be removed. + */ + reviewers?: string[]; + /** + * An array of team `slug`s that will be removed. + */ + team_reviewers?: string[]; +}; +type PullsDeleteReviewRequestRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListReviewsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListReviewsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. + */ + commit_id?: string; + /** + * **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. + */ + body?: string; + /** + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready. + */ + event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + /** + * Use the following table to specify the location, destination, and contents of the draft review comment. + */ + comments?: PullsCreateReviewParamsComments[]; +}; +type PullsCreateReviewRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsGetReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; +}; +type PullsGetReviewRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsDeletePendingReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; +}; +type PullsDeletePendingReviewRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsUpdateReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; + /** + * The body text of the pull request review. + */ + body: string; +}; +type PullsUpdateReviewRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsGetCommentsForReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsGetCommentsForReviewRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsDismissReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; + /** + * The message for the pull request review dismissal + */ + message: string; +}; +type PullsDismissReviewRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsSubmitReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; + /** + * The body text of the pull request review + */ + body?: string; + /** + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. + */ + event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; +}; +type PullsSubmitReviewRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsUpdateBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. + */ + expected_head_sha?: string; +}; +type PullsUpdateBranchRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetReadmeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) + */ + ref?: string; +}; +type ReposGetReadmeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListReleasesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListReleasesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the tag. + */ + tag_name: string; + /** + * Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). + */ + target_commitish?: string; + /** + * The name of the release. + */ + name?: string; + /** + * Text describing the contents of the tag. + */ + body?: string; + /** + * `true` to create a draft (unpublished) release, `false` to create a published one. + */ + draft?: boolean; + /** + * `true` to identify the release as a prerelease. `false` to identify the release as a full release. + */ + prerelease?: boolean; +}; +type ReposCreateReleaseRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetReleaseAssetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * asset_id parameter + */ + asset_id: number; +}; +type ReposGetReleaseAssetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateReleaseAssetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * asset_id parameter + */ + asset_id: number; + /** + * The file name of the asset. + */ + name?: string; + /** + * An alternate short description of the asset. Used in place of the filename. + */ + label?: string; +}; +type ReposUpdateReleaseAssetRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteReleaseAssetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * asset_id parameter + */ + asset_id: number; +}; +type ReposDeleteReleaseAssetRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetLatestReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetLatestReleaseRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetReleaseByTagEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * tag parameter + */ + tag: string; +}; +type ReposGetReleaseByTagRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; +}; +type ReposGetReleaseRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; + /** + * The name of the tag. + */ + tag_name?: string; + /** + * Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). + */ + target_commitish?: string; + /** + * The name of the release. + */ + name?: string; + /** + * Text describing the contents of the tag. + */ + body?: string; + /** + * `true` makes the release a draft, and `false` publishes the release. + */ + draft?: boolean; + /** + * `true` to identify the release as a prerelease, `false` to identify the release as a full release. + */ + prerelease?: boolean; +}; +type ReposUpdateReleaseRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; +}; +type ReposDeleteReleaseRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListAssetsForReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListAssetsForReleaseRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListStargazersForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListStargazersForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCodeFrequencyStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetCodeFrequencyStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCommitActivityStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetCommitActivityStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetContributorsStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetContributorsStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetParticipationStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetParticipationStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetPunchCardStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetPunchCardStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateStatusEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * sha parameter + */ + sha: string; + /** + * The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. + */ + state: "error" | "failure" | "pending" | "success"; + /** + * The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` + */ + target_url?: string; + /** + * A short description of the status. + */ + description?: string; + /** + * A string label to differentiate this status from the status of other systems. + */ + context?: string; +}; +type ReposCreateStatusRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListWatchersForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListWatchersForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityGetRepoSubscriptionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityGetRepoSubscriptionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivitySetRepoSubscriptionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Determines if notifications should be received from this repository. + */ + subscribed?: boolean; + /** + * Determines if all notifications should be blocked from this repository. + */ + ignored?: boolean; +}; +type ActivitySetRepoSubscriptionRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityDeleteRepoSubscriptionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityDeleteRepoSubscriptionRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListTagsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListTagsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListTeamsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListTeamsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListTopicsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposListTopicsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceTopicsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. + */ + names: string[]; +}; +type ReposReplaceTopicsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetClonesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Must be one of: `day`, `week`. + */ + per?: "day" | "week"; +}; +type ReposGetClonesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetTopPathsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetTopPathsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetTopReferrersEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetTopReferrersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetViewsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Must be one of: `day`, `week`. + */ + per?: "day" | "week"; +}; +type ReposGetViewsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposTransferEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * **Required:** The username or organization name the repository will be transferred to. + */ + new_owner?: string; + /** + * ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. + */ + team_ids?: number[]; +}; +type ReposTransferRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCheckVulnerabilityAlertsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposCheckVulnerabilityAlertsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposEnableVulnerabilityAlertsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposEnableVulnerabilityAlertsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDisableVulnerabilityAlertsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposDisableVulnerabilityAlertsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetArchiveLinkEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * archive_format parameter + */ + archive_format: string; + /** + * ref parameter + */ + ref: string; +}; +type ReposGetArchiveLinkRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateUsingTemplateEndpoint = { + /** + * template_owner parameter + */ + template_owner: string; + /** + * template_repo parameter + */ + template_repo: string; + /** + * The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. + */ + owner?: string; + /** + * The name of the new repository. + */ + name: string; + /** + * A short description of the new repository. + */ + description?: string; + /** + * Either `true` to create a new private repository or `false` to create a new public one. + */ + private?: boolean; +}; +type ReposCreateUsingTemplateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListPublicEndpoint = { + /** + * The integer ID of the last Repository that you've seen. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListPublicRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimListProvisionedIdentitiesEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Used for pagination: the index of the first result to return. + */ + startIndex?: number; + /** + * Used for pagination: the number of results to return. + */ + count?: number; + /** + * Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: `?filter=userName%20eq%20\"Octocat\"`. + */ + filter?: string; +}; +type ScimListProvisionedIdentitiesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimProvisionAndInviteUsersEndpoint = { + /** + * org parameter + */ + org: string; +}; +type ScimProvisionAndInviteUsersRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimProvisionInviteUsersEndpoint = { + /** + * org parameter + */ + org: string; +}; +type ScimProvisionInviteUsersRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimGetProvisioningDetailsForUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimGetProvisioningDetailsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimReplaceProvisionedUserInformationEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimReplaceProvisionedUserInformationRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimUpdateProvisionedOrgMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimUpdateProvisionedOrgMembershipRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimUpdateUserAttributeEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimUpdateUserAttributeRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimRemoveUserFromOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimRemoveUserFromOrgRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchCodeEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching code](https://help.github.com/articles/searching-code/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "indexed"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchCodeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchCommitsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching commits](https://help.github.com/articles/searching-commits/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "author-date" | "committer-date"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchIssuesAndPullRequestsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: + | "comments" + | "reactions" + | "reactions-+1" + | "reactions--1" + | "reactions-smile" + | "reactions-thinking_face" + | "reactions-heart" + | "reactions-tada" + | "interactions" + | "created" + | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchIssuesAndPullRequestsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchIssuesEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: + | "comments" + | "reactions" + | "reactions-+1" + | "reactions--1" + | "reactions-smile" + | "reactions-thinking_face" + | "reactions-heart" + | "reactions-tada" + | "interactions" + | "created" + | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchIssuesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchLabelsEndpoint = { + /** + * The id of the repository. + */ + repository_id: number; + /** + * The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). + */ + q: string; + /** + * Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "created" | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; +}; +type SearchLabelsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchReposEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchReposRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchTopicsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). + */ + q: string; +}; +type SearchTopicsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchUsersEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching users](https://help.github.com/articles/searching-users/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "followers" | "repositories" | "joined"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchUsersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetEndpoint = { + /** + * team_id parameter + */ + team_id: number; +}; +type TeamsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsUpdateEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. + */ + parent_team_id?: number; +}; +type TeamsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsDeleteEndpoint = { + /** + * team_id parameter + */ + team_id: number; +}; +type TeamsDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListDiscussionsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListDiscussionsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * The discussion post's title. + */ + title: string; + /** + * The discussion post's body text. + */ + body: string; + /** + * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + */ + private?: boolean; +}; +type TeamsCreateDiscussionRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; +}; +type TeamsGetDiscussionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsUpdateDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * The discussion post's title. + */ + title?: string; + /** + * The discussion post's body text. + */ + body?: string; +}; +type TeamsUpdateDiscussionRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsDeleteDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; +}; +type TeamsDeleteDiscussionRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListDiscussionCommentsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListDiscussionCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +type TeamsCreateDiscussionCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; +}; +type TeamsGetDiscussionCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsUpdateDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +type TeamsUpdateDiscussionCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsDeleteDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; +}; +type TeamsDeleteDiscussionCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForTeamDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForTeamDiscussionCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForTeamDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForTeamDiscussionCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForTeamDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForTeamDiscussionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForTeamDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForTeamDiscussionRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListPendingInvitationsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListPendingInvitationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListMembersEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListMembersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetMemberEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsGetMemberRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddMemberEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsAddMemberRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsRemoveMemberEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsRemoveMemberRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetMembershipEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsGetMembershipRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddOrUpdateMembershipEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; +}; +type TeamsAddOrUpdateMembershipRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsRemoveMembershipEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsRemoveMembershipRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListProjectsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListProjectsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsReviewProjectEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * project_id parameter + */ + project_id: number; +}; +type TeamsReviewProjectRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddOrUpdateProjectEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * project_id parameter + */ + project_id: number; + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team. + */ + permission?: "read" | "write" | "admin"; +}; +type TeamsAddOrUpdateProjectRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsRemoveProjectEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * project_id parameter + */ + project_id: number; +}; +type TeamsRemoveProjectRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListReposEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListReposRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCheckManagesRepoEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type TeamsCheckManagesRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddOrUpdateRepoEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team. + */ + permission?: "pull" | "push" | "admin"; +}; +type TeamsAddOrUpdateRepoRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsRemoveRepoEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type TeamsRemoveRepoRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListIdPGroupsEndpoint = { + /** + * team_id parameter + */ + team_id: number; +}; +type TeamsListIdPGroupsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateOrUpdateIdPGroupConnectionsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. + */ + groups: TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups[]; +}; +type TeamsCreateOrUpdateIdPGroupConnectionsRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListChildEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListChildRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetAuthenticatedEndpoint = {}; +type UsersGetAuthenticatedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersUpdateAuthenticatedEndpoint = { + /** + * The new name of the user. + */ + name?: string; + /** + * The publicly visible email address of the user. + */ + email?: string; + /** + * The new blog URL of the user. + */ + blog?: string; + /** + * The new company of the user. + */ + company?: string; + /** + * The new location of the user. + */ + location?: string; + /** + * The new hiring availability of the user. + */ + hireable?: boolean; + /** + * The new short biography of the user. + */ + bio?: string; +}; +type UsersUpdateAuthenticatedRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListBlockedEndpoint = {}; +type UsersListBlockedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCheckBlockedEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersCheckBlockedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersBlockEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersBlockRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersUnblockEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersUnblockRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersTogglePrimaryEmailVisibilityEndpoint = { + /** + * Specify the _primary_ email address that needs a visibility change. + */ + email: string; + /** + * Use `public` to enable an authenticated user to view the specified email address, or use `private` so this primary email address cannot be seen publicly. + */ + visibility: string; +}; +type UsersTogglePrimaryEmailVisibilityRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListEmailsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListEmailsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersAddEmailsEndpoint = { + /** + * Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. + */ + emails: string[]; +}; +type UsersAddEmailsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersDeleteEmailsEndpoint = { + /** + * Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. + */ + emails: string[]; +}; +type UsersDeleteEmailsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListFollowersForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListFollowersForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListFollowingForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListFollowingForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCheckFollowingEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersCheckFollowingRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersFollowEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersFollowRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersUnfollowEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersUnfollowRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListGpgKeysEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListGpgKeysRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCreateGpgKeyEndpoint = { + /** + * Your GPG key, generated in ASCII-armored format. See "[Generating a new GPG key](https://help.github.com/articles/generating-a-new-gpg-key/)" for help creating a GPG key. + */ + armored_public_key?: string; +}; +type UsersCreateGpgKeyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetGpgKeyEndpoint = { + /** + * gpg_key_id parameter + */ + gpg_key_id: number; +}; +type UsersGetGpgKeyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersDeleteGpgKeyEndpoint = { + /** + * gpg_key_id parameter + */ + gpg_key_id: number; +}; +type UsersDeleteGpgKeyRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListInstallationsForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListInstallationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListInstallationReposForAuthenticatedUserEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListInstallationReposForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsAddRepoToInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; + /** + * repository_id parameter + */ + repository_id: number; +}; +type AppsAddRepoToInstallationRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsRemoveRepoFromInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; + /** + * repository_id parameter + */ + repository_id: number; +}; +type AppsRemoveRepoFromInstallationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListForAuthenticatedUserEndpoint = { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListPublicKeysEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListPublicKeysRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCreatePublicKeyEndpoint = { + /** + * A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air". + */ + title?: string; + /** + * The public SSH key to add to your GitHub account. See "[Generating a new SSH key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)" for guidance on how to create a public SSH key. + */ + key?: string; +}; +type UsersCreatePublicKeyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetPublicKeyEndpoint = { + /** + * key_id parameter + */ + key_id: number; +}; +type UsersGetPublicKeyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersDeletePublicKeyEndpoint = { + /** + * key_id parameter + */ + key_id: number; +}; +type UsersDeletePublicKeyRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListMarketplacePurchasesForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListMarketplacePurchasesForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListMarketplacePurchasesForAuthenticatedUserStubbedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListMembershipsEndpoint = { + /** + * Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. + */ + state?: "active" | "pending"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListMembershipsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsGetMembershipForAuthenticatedUserEndpoint = { + /** + * org parameter + */ + org: string; +}; +type OrgsGetMembershipForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsUpdateMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * The state that the membership should be in. Only `"active"` will be accepted. + */ + state: "active"; +}; +type OrgsUpdateMembershipRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsStartForAuthenticatedUserEndpoint = { + /** + * An array of repositories to include in the migration. + */ + repositories: string[]; + /** + * Locks the `repositories` to prevent changes during the migration when set to `true`. + */ + lock_repositories?: boolean; + /** + * Does not include attachments uploaded to GitHub.com in the migration data when set to `true`. Excluding attachments will reduce the migration archive file size. + */ + exclude_attachments?: boolean; +}; +type MigrationsStartForAuthenticatedUserRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type MigrationsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetStatusForAuthenticatedUserEndpoint = { + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsGetStatusForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetArchiveForAuthenticatedUserEndpoint = { + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsGetArchiveForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsDeleteArchiveForAuthenticatedUserEndpoint = { + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsDeleteArchiveForAuthenticatedUserRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsUnlockRepoForAuthenticatedUserEndpoint = { + /** + * migration_id parameter + */ + migration_id: number; + /** + * repo_name parameter + */ + repo_name: string; +}; +type MigrationsUnlockRepoForAuthenticatedUserRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateForAuthenticatedUserEndpoint = { + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +}; +type ProjectsCreateForAuthenticatedUserRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListPublicEmailsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListPublicEmailsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListEndpoint = { + /** + * Can be one of `all`, `public`, or `private`. + */ + visibility?: "all" | "public" | "private"; + /** + * Comma-separated list of values. Can include: + * \* `owner`: Repositories that are owned by the authenticated user. + * \* `collaborator`: Repositories that the user has been added to as a collaborator. + * \* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. + */ + affiliation?: string; + /** + * Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` + * + * Will cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. + */ + type?: "all" | "owner" | "public" | "private" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateForAuthenticatedUserEndpoint = { + /** + * The name of the repository. + */ + name: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account. + */ + private?: boolean; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + */ + team_id?: number; + /** + * Pass `true` to create an initial commit with empty README. + */ + auto_init?: boolean; + /** + * Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". + */ + gitignore_template?: string; + /** + * Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". + */ + license_template?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; +}; +type ReposCreateForAuthenticatedUserRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListInvitationsForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListInvitationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAcceptInvitationEndpoint = { + /** + * invitation_id parameter + */ + invitation_id: number; +}; +type ReposAcceptInvitationRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeclineInvitationEndpoint = { + /** + * invitation_id parameter + */ + invitation_id: number; +}; +type ReposDeclineInvitationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReposStarredByAuthenticatedUserEndpoint = { + /** + * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). + */ + sort?: "created" | "updated"; + /** + * One of `asc` (ascending) or `desc` (descending). + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReposStarredByAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityCheckStarringRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityCheckStarringRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityStarRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityStarRepoRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityUnstarRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityUnstarRepoRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListWatchedReposForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListWatchedReposForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityCheckWatchingRepoLegacyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityCheckWatchingRepoLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityWatchRepoLegacyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityWatchRepoLegacyRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityStopWatchingRepoLegacyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityStopWatchingRepoLegacyRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListEndpoint = { + /** + * The integer ID of the last User that you've seen. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetByUsernameEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersGetByUsernameRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListEventsForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListEventsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListEventsForOrgEndpoint = { + /** + * username parameter + */ + username: string; + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListEventsForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListPublicEventsForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListPublicEventsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListFollowersForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListFollowersForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListFollowingForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListFollowingForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCheckFollowingForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * target_user parameter + */ + target_user: string; +}; +type UsersCheckFollowingForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListPublicForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListPublicForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListGpgKeysForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListGpgKeysForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetContextForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. + */ + subject_type?: "organization" | "repository" | "issue" | "pull_request"; + /** + * Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. + */ + subject_id?: string; +}; +type UsersGetContextForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetUserInstallationEndpoint = { + /** + * username parameter + */ + username: string; +}; +type AppsGetUserInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsFindUserInstallationEndpoint = { + /** + * username parameter + */ + username: string; +}; +type AppsFindUserInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListPublicKeysForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListPublicKeysForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReceivedEventsForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReceivedEventsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReceivedPublicEventsForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReceivedPublicEventsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Can be one of `all`, `owner`, `member`. + */ + type?: "all" | "owner" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReposStarredByUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). + */ + sort?: "created" | "updated"; + /** + * One of `asc` (ascending) or `desc` (descending). + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReposStarredByUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReposWatchedByUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReposWatchedByUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +export type AppsCreateInstallationTokenParamsPermissions = {}; +export type GistsCreateParamsFiles = { + content?: string; +}; +export type GistsUpdateParamsFiles = { + content?: string; + filename?: string; +}; +export type OrgsCreateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +export type OrgsUpdateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +export type ReposUpdateBranchProtectionParamsRequiredStatusChecks = { + strict: boolean; + contexts: string[]; +}; +export type ReposUpdateBranchProtectionParamsRequiredPullRequestReviews = { + dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions; + dismiss_stale_reviews?: boolean; + require_code_owner_reviews?: boolean; + required_approving_review_count?: number; +}; +export type ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions = { + users?: string[]; + teams?: string[]; +}; +export type ReposUpdateBranchProtectionParamsRestrictions = { + users: string[]; + teams: string[]; + apps?: string[]; +}; +export type ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions = { + users?: string[]; + teams?: string[]; +}; +export type ChecksCreateParamsOutput = { + title: string; + summary: string; + text?: string; + annotations?: ChecksCreateParamsOutputAnnotations[]; + images?: ChecksCreateParamsOutputImages[]; +}; +export type ChecksCreateParamsOutputAnnotations = { + path: string; + start_line: number; + end_line: number; + start_column?: number; + end_column?: number; + annotation_level: "notice" | "warning" | "failure"; + message: string; + title?: string; + raw_details?: string; +}; +export type ChecksCreateParamsOutputImages = { + alt: string; + image_url: string; + caption?: string; +}; +export type ChecksCreateParamsActions = { + label: string; + description: string; + identifier: string; +}; +export type ChecksUpdateParamsOutput = { + title?: string; + summary: string; + text?: string; + annotations?: ChecksUpdateParamsOutputAnnotations[]; + images?: ChecksUpdateParamsOutputImages[]; +}; +export type ChecksUpdateParamsOutputAnnotations = { + path: string; + start_line: number; + end_line: number; + start_column?: number; + end_column?: number; + annotation_level: "notice" | "warning" | "failure"; + message: string; + title?: string; + raw_details?: string; +}; +export type ChecksUpdateParamsOutputImages = { + alt: string; + image_url: string; + caption?: string; +}; +export type ChecksUpdateParamsActions = { + label: string; + description: string; + identifier: string; +}; +export type ChecksSetSuitesPreferencesParamsAutoTriggerChecks = { + app_id: number; + setting: boolean; +}; +export type ReposCreateOrUpdateFileParamsCommitter = { + name: string; + email: string; +}; +export type ReposCreateOrUpdateFileParamsAuthor = { + name: string; + email: string; +}; +export type ReposCreateFileParamsCommitter = { + name: string; + email: string; +}; +export type ReposCreateFileParamsAuthor = { + name: string; + email: string; +}; +export type ReposUpdateFileParamsCommitter = { + name: string; + email: string; +}; +export type ReposUpdateFileParamsAuthor = { + name: string; + email: string; +}; +export type ReposDeleteFileParamsCommitter = { + name?: string; + email?: string; +}; +export type ReposDeleteFileParamsAuthor = { + name?: string; + email?: string; +}; +export type GitCreateCommitParamsAuthor = { + name?: string; + email?: string; + date?: string; +}; +export type GitCreateCommitParamsCommitter = { + name?: string; + email?: string; + date?: string; +}; +export type GitCreateTagParamsTagger = { + name?: string; + email?: string; + date?: string; +}; +export type GitCreateTreeParamsTree = { + path?: string; + mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + type?: "blob" | "tree" | "commit"; + sha?: string; + content?: string; +}; +export type ReposCreateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +export type ReposUpdateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +export type ReposEnablePagesSiteParamsSource = { + branch?: "master" | "gh-pages"; + path?: string; +}; +export type PullsCreateReviewParamsComments = { + path: string; + position: number; + body: string; +}; +export type TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups = { + group_id: string; + group_name: string; + group_description: string; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/generated/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/generated/README.md new file mode 100644 index 00000000..2bc90d20 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/generated/README.md @@ -0,0 +1,3 @@ +# ⚠️ Do not edit files in this folder + +All files are generated. Manual changes will be overwritten. If you find a problem, please look into how they are generated. When in doubt, please open a new issue. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/index.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/index.ts new file mode 100644 index 00000000..a0f51b31 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/@octokit/types/src/index.ts @@ -0,0 +1,18 @@ +export { AuthInterface } from "./AuthInterface"; +export { EndpointDefaults } from "./EndpointDefaults"; +export { EndpointInterface } from "./EndpointInterface"; +export { EndpointOptions } from "./EndpointOptions"; +export { Fetch } from "./Fetch"; +export { OctokitResponse } from "./OctokitResponse"; +export { RequestHeaders } from "./RequestHeaders"; +export { RequestInterface } from "./RequestInterface"; +export { RequestMethod } from "./RequestMethod"; +export { RequestOptions } from "./RequestOptions"; +export { RequestParameters } from "./RequestParameters"; +export { RequestRequestOptions } from "./RequestRequestOptions"; +export { ResponseHeaders } from "./ResponseHeaders"; +export { Route } from "./Route"; +export { Signal } from "./Signal"; +export { StrategyInterface } from "./StrategyInterface"; +export { Url } from "./Url"; +export { VERSION } from "./VERSION"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/LICENSE.md b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/LICENSE.md new file mode 100644 index 00000000..f105ab0c --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/LICENSE.md @@ -0,0 +1,7 @@ +# [ISC License](https://spdx.org/licenses/ISC) + +Copyright (c) 2018, Gregor Martynus (https://github.com/gr2m) + +Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/README.md new file mode 100644 index 00000000..d00d14c1 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/README.md @@ -0,0 +1,25 @@ +# universal-user-agent + +> Get a user agent string in both browser and node + +[![@latest](https://img.shields.io/npm/v/universal-user-agent.svg)](https://www.npmjs.com/package/universal-user-agent) +[![Build Status](https://travis-ci.com/gr2m/universal-user-agent.svg?branch=master)](https://travis-ci.com/gr2m/universal-user-agent) +[![Greenkeeper](https://badges.greenkeeper.io/gr2m/universal-user-agent.svg)](https://greenkeeper.io/) + +```js +const { getUserAgent } = require("universal-user-agent"); +// or import { getUserAgent } from "universal-user-agent"; + +const userAgent = getUserAgent(); +// userAgent will look like this +// in browser: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:61.0) Gecko/20100101 Firefox/61.0" +// in node: Node.js/v8.9.4 (macOS High Sierra; x64) +``` + +## Credits + +The Node implementation was originally inspired by [default-user-agent](https://www.npmjs.com/package/default-user-agent). + +## License + +[ISC](LICENSE.md) diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js new file mode 100644 index 00000000..80a07105 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js @@ -0,0 +1,22 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } + +var osName = _interopDefault(require('os-name')); + +function getUserAgent() { + try { + return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; + } catch (error) { + if (/wmic os get Caption/.test(error.message)) { + return "Windows "; + } + + throw error; + } +} + +exports.getUserAgent = getUserAgent; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map new file mode 100644 index 00000000..aff09ec4 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/node.js"],"sourcesContent":["import osName from \"os-name\";\nexport function getUserAgent() {\n try {\n return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`;\n }\n catch (error) {\n if (/wmic os get Caption/.test(error.message)) {\n return \"Windows \";\n }\n throw error;\n }\n}\n"],"names":["getUserAgent","process","version","substr","osName","arch","error","test","message"],"mappings":";;;;;;;;AACO,SAASA,YAAT,GAAwB;MACvB;WACQ,WAAUC,OAAO,CAACC,OAAR,CAAgBC,MAAhB,CAAuB,CAAvB,CAA0B,KAAIC,MAAM,EAAG,KAAIH,OAAO,CAACI,IAAK,GAA1E;GADJ,CAGA,OAAOC,KAAP,EAAc;QACN,sBAAsBC,IAAtB,CAA2BD,KAAK,CAACE,OAAjC,CAAJ,EAA+C;aACpC,gCAAP;;;UAEEF,KAAN;;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js new file mode 100644 index 00000000..6f52232c --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/browser.js @@ -0,0 +1,3 @@ +export function getUserAgent() { + return navigator.userAgent; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/index.js new file mode 100644 index 00000000..c6253f5a --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/index.js @@ -0,0 +1 @@ +export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js new file mode 100644 index 00000000..8b70a038 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-src/node.js @@ -0,0 +1,12 @@ +import osName from "os-name"; +export function getUserAgent() { + try { + return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; + } + catch (error) { + if (/wmic os get Caption/.test(error.message)) { + return "Windows "; + } + throw error; + } +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/browser.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/browser.d.ts new file mode 100644 index 00000000..a7bb1c44 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/browser.d.ts @@ -0,0 +1 @@ +export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/index.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/index.d.ts new file mode 100644 index 00000000..c6253f5a --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/index.d.ts @@ -0,0 +1 @@ +export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/node.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/node.d.ts new file mode 100644 index 00000000..a7bb1c44 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-types/node.d.ts @@ -0,0 +1 @@ +export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js new file mode 100644 index 00000000..11ec79b3 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js @@ -0,0 +1,6 @@ +function getUserAgent() { + return navigator.userAgent; +} + +export { getUserAgent }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map new file mode 100644 index 00000000..549407ec --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/browser.js"],"sourcesContent":["export function getUserAgent() {\n return navigator.userAgent;\n}\n"],"names":[],"mappings":"AAAO,SAAS,YAAY,GAAG;IAC3B,OAAO,SAAS,CAAC,SAAS,CAAC;CAC9B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json new file mode 100644 index 00000000..a65a2c55 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/node_modules/universal-user-agent/package.json @@ -0,0 +1,33 @@ +{ + "name": "universal-user-agent", + "description": "Get a user agent string in both browser and node", + "version": "4.0.0", + "license": "ISC", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [], + "repository": "https://github.com/gr2m/universal-user-agent.git", + "dependencies": { + "os-name": "^3.1.0" + }, + "devDependencies": { + "@gr2m/pika-plugin-build-web": "^0.6.0-issue-84.1", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.6.0", + "@pika/plugin-ts-standard-pkg": "^0.6.0", + "@types/jest": "^24.0.18", + "jest": "^24.9.0", + "prettier": "^1.18.2", + "semantic-release": "^15.9.15", + "ts-jest": "^24.0.2", + "typescript": "^3.6.2" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/package.json b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/package.json new file mode 100644 index 00000000..eed87452 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/endpoint/package.json @@ -0,0 +1,51 @@ +{ + "name": "@octokit/endpoint", + "description": "Turns REST API endpoints into generic request options", + "version": "5.5.1", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "octokit", + "github", + "api", + "rest" + ], + "homepage": "https://github.com/octokit/endpoint.js#readme", + "bugs": { + "url": "https://github.com/octokit/endpoint.js/issues" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/octokit/endpoint.js.git" + }, + "dependencies": { + "@octokit/types": "^2.0.0", + "is-plain-object": "^3.0.0", + "universal-user-agent": "^4.0.0" + }, + "devDependencies": { + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.7.0", + "@pika/plugin-build-web": "^0.7.0", + "@pika/plugin-ts-standard-pkg": "^0.7.0", + "@types/jest": "^24.0.11", + "jest": "^24.7.1", + "prettier": "1.18.2", + "semantic-release": "^15.13.8", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "ts-jest": "^24.0.2", + "typescript": "^3.4.5" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "deno": "dist-web/index.js" +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/LICENSE b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/LICENSE new file mode 100644 index 00000000..ef2c18ee --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/README.md new file mode 100644 index 00000000..bcb711d9 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/README.md @@ -0,0 +1,68 @@ +# http-error.js + +> Error class for Octokit request errors + +[![@latest](https://img.shields.io/npm/v/@octokit/request-error.svg)](https://www.npmjs.com/package/@octokit/request-error) +[![Build Status](https://travis-ci.com/octokit/request-error.js.svg?branch=master)](https://travis-ci.com/octokit/request-error.js) +[![Greenkeeper](https://badges.greenkeeper.io/octokit/request-error.js.svg)](https://greenkeeper.io/) + +## Usage + + + + + + +
+Browsers + +Load @octokit/request-error directly from cdn.pika.dev + +```html + +``` + +
+Node + + +Install with npm install @octokit/request-error + +```js +const { RequestError } = require("@octokit/request-error"); +// or: import { RequestError } from "@octokit/request-error"; +``` + +
+ +```js +const error = new RequestError("Oops", 500, { + headers: { + "x-github-request-id": "1:2:3:4" + }, // response headers + request: { + method: "POST", + url: "https://api.github.com/foo", + body: { + bar: "baz" + }, + headers: { + authorization: "token secret123" + } + } +}); + +error.message; // Oops +error.status; // 500 +error.headers; // { 'x-github-request-id': '1:2:3:4' } +error.request.method; // POST +error.request.url; // https://api.github.com/foo +error.request.body; // { bar: 'baz' } +error.request.headers; // { authorization: 'token [REDACTED]' } +``` + +## LICENSE + +[MIT](LICENSE) diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-node/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-node/index.js new file mode 100644 index 00000000..95b9c579 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-node/index.js @@ -0,0 +1,55 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } + +var deprecation = require('deprecation'); +var once = _interopDefault(require('once')); + +const logOnce = once(deprecation => console.warn(deprecation)); +/** + * Error with extra properties to help with debugging + */ + +class RequestError extends Error { + constructor(message, statusCode, options) { + super(message); // Maintains proper stack trace (only available on V8) + + /* istanbul ignore next */ + + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + + this.name = "HttpError"; + this.status = statusCode; + Object.defineProperty(this, "code", { + get() { + logOnce(new deprecation.Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); + return statusCode; + } + + }); + this.headers = options.headers || {}; // redact request credentials without mutating original request options + + const requestCopy = Object.assign({}, options.request); + + if (options.request.headers.authorization) { + requestCopy.headers = Object.assign({}, options.request.headers, { + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]") + }); + } + + requestCopy.url = requestCopy.url // client_id & client_secret can be passed as URL query parameters to increase rate limit + // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications + .replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]") // OAuth tokens can be passed as URL query parameters, although it is not recommended + // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header + .replace(/\baccess_token=\w+/g, "access_token=[REDACTED]"); + this.request = requestCopy; + } + +} + +exports.RequestError = RequestError; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-node/index.js.map b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-node/index.js.map new file mode 100644 index 00000000..ec1c6dbc --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n }\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\")\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":["logOnce","once","deprecation","console","warn","RequestError","Error","constructor","message","statusCode","options","captureStackTrace","name","status","Object","defineProperty","get","Deprecation","headers","requestCopy","assign","request","authorization","replace","url"],"mappings":";;;;;;;;;AAEA,MAAMA,OAAO,GAAGC,IAAI,CAAEC,WAAD,IAAiBC,OAAO,CAACC,IAAR,CAAaF,WAAb,CAAlB,CAApB;;;;;AAIA,AAAO,MAAMG,YAAN,SAA2BC,KAA3B,CAAiC;EACpCC,WAAW,CAACC,OAAD,EAAUC,UAAV,EAAsBC,OAAtB,EAA+B;UAChCF,OAAN,EADsC;;;;QAIlCF,KAAK,CAACK,iBAAV,EAA6B;MACzBL,KAAK,CAACK,iBAAN,CAAwB,IAAxB,EAA8B,KAAKJ,WAAnC;;;SAECK,IAAL,GAAY,WAAZ;SACKC,MAAL,GAAcJ,UAAd;IACAK,MAAM,CAACC,cAAP,CAAsB,IAAtB,EAA4B,MAA5B,EAAoC;MAChCC,GAAG,GAAG;QACFhB,OAAO,CAAC,IAAIiB,uBAAJ,CAAgB,0EAAhB,CAAD,CAAP;eACOR,UAAP;;;KAHR;SAMKS,OAAL,GAAeR,OAAO,CAACQ,OAAR,IAAmB,EAAlC,CAfsC;;UAiBhCC,WAAW,GAAGL,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAA1B,CAApB;;QACIX,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAA5B,EAA2C;MACvCH,WAAW,CAACD,OAAZ,GAAsBJ,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAAR,CAAgBH,OAAlC,EAA2C;QAC7DI,aAAa,EAAEZ,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAAxB,CAAsCC,OAAtC,CAA8C,MAA9C,EAAsD,aAAtD;OADG,CAAtB;;;IAIJJ,WAAW,CAACK,GAAZ,GAAkBL,WAAW,CAACK,GAAZ;;KAGbD,OAHa,CAGL,sBAHK,EAGmB,0BAHnB;;KAMbA,OANa,CAML,qBANK,EAMkB,yBANlB,CAAlB;SAOKF,OAAL,GAAeF,WAAf;;;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-src/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-src/index.js new file mode 100644 index 00000000..cfcb7c41 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-src/index.js @@ -0,0 +1,40 @@ +import { Deprecation } from "deprecation"; +import once from "once"; +const logOnce = once((deprecation) => console.warn(deprecation)); +/** + * Error with extra properties to help with debugging + */ +export class RequestError extends Error { + constructor(message, statusCode, options) { + super(message); + // Maintains proper stack trace (only available on V8) + /* istanbul ignore next */ + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + this.name = "HttpError"; + this.status = statusCode; + Object.defineProperty(this, "code", { + get() { + logOnce(new Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); + return statusCode; + } + }); + this.headers = options.headers || {}; + // redact request credentials without mutating original request options + const requestCopy = Object.assign({}, options.request); + if (options.request.headers.authorization) { + requestCopy.headers = Object.assign({}, options.request.headers, { + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]") + }); + } + requestCopy.url = requestCopy.url + // client_id & client_secret can be passed as URL query parameters to increase rate limit + // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications + .replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]") + // OAuth tokens can be passed as URL query parameters, although it is not recommended + // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header + .replace(/\baccess_token=\w+/g, "access_token=[REDACTED]"); + this.request = requestCopy; + } +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-src/types.js b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-src/types.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-types/index.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-types/index.d.ts new file mode 100644 index 00000000..baa8a0eb --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-types/index.d.ts @@ -0,0 +1,27 @@ +import { RequestOptions, ResponseHeaders } from "@octokit/types"; +import { RequestErrorOptions } from "./types"; +/** + * Error with extra properties to help with debugging + */ +export declare class RequestError extends Error { + name: "HttpError"; + /** + * http status code + */ + status: number; + /** + * http status code + * + * @deprecated `error.code` is deprecated in favor of `error.status` + */ + code: number; + /** + * error response headers + */ + headers: ResponseHeaders; + /** + * Request options that lead to the error. + */ + request: RequestOptions; + constructor(message: string, statusCode: number, options: RequestErrorOptions); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-types/types.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-types/types.d.ts new file mode 100644 index 00000000..865d2139 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-types/types.d.ts @@ -0,0 +1,5 @@ +import { RequestOptions, ResponseHeaders } from "@octokit/types"; +export declare type RequestErrorOptions = { + headers?: ResponseHeaders; + request: RequestOptions; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-web/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-web/index.js new file mode 100644 index 00000000..32b45a36 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-web/index.js @@ -0,0 +1,44 @@ +import { Deprecation } from 'deprecation'; +import once from 'once'; + +const logOnce = once((deprecation) => console.warn(deprecation)); +/** + * Error with extra properties to help with debugging + */ +class RequestError extends Error { + constructor(message, statusCode, options) { + super(message); + // Maintains proper stack trace (only available on V8) + /* istanbul ignore next */ + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + this.name = "HttpError"; + this.status = statusCode; + Object.defineProperty(this, "code", { + get() { + logOnce(new Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); + return statusCode; + } + }); + this.headers = options.headers || {}; + // redact request credentials without mutating original request options + const requestCopy = Object.assign({}, options.request); + if (options.request.headers.authorization) { + requestCopy.headers = Object.assign({}, options.request.headers, { + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]") + }); + } + requestCopy.url = requestCopy.url + // client_id & client_secret can be passed as URL query parameters to increase rate limit + // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications + .replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]") + // OAuth tokens can be passed as URL query parameters, although it is not recommended + // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header + .replace(/\baccess_token=\w+/g, "access_token=[REDACTED]"); + this.request = requestCopy; + } +} + +export { RequestError }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-web/index.js.map b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-web/index.js.map new file mode 100644 index 00000000..05151b09 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n }\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\")\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":[],"mappings":";;;AAEA,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;;;;AAIjE,AAAO,MAAM,YAAY,SAAS,KAAK,CAAC;IACpC,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE;QACtC,KAAK,CAAC,OAAO,CAAC,CAAC;;;QAGf,IAAI,KAAK,CAAC,iBAAiB,EAAE;YACzB,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;SACnD;QACD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;QACzB,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE;YAChC,GAAG,GAAG;gBACF,OAAO,CAAC,IAAI,WAAW,CAAC,0EAA0E,CAAC,CAAC,CAAC;gBACrG,OAAO,UAAU,CAAC;aACrB;SACJ,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;;QAErC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE;YACvC,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE;gBAC7D,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC;aACtF,CAAC,CAAC;SACN;QACD,WAAW,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG;;;aAG5B,OAAO,CAAC,sBAAsB,EAAE,0BAA0B,CAAC;;;aAG3D,OAAO,CAAC,qBAAqB,EAAE,yBAAyB,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC;KAC9B;CACJ;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md new file mode 100644 index 00000000..b5185152 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md @@ -0,0 +1,5 @@ +--- +name: "🆘 Help" +about: "How does this even work 🤷‍♂️" +labels: support +--- diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md new file mode 100644 index 00000000..d7e83250 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md @@ -0,0 +1,19 @@ +--- +name: "🐛 Bug Report" +about: "If something isn't working as expected 🤔" +labels: bug +--- + + + +**What happened?** + + + +**What did you expect to happen?** + + + +**What the problem might be** + + diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md new file mode 100644 index 00000000..89a54819 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md @@ -0,0 +1,19 @@ +--- +name: "🧚‍♂️ Feature Request" +about: "Wouldn’t it be nice if 💭" +labels: feature +--- + + + +**What’s missing?** + + + +**Why?** + + + +**Alternatives you tried** + + diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md new file mode 100644 index 00000000..c67ce83b --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md @@ -0,0 +1,19 @@ +--- +name: "💝 Thank you" +about: "@octokit/types is awesome 🙌" +labels: thanks +--- + + + +**How do you use @octokit/types?** + + + +**What do you love about it?** + + + +**How did you learn about it?** + + diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/workflows/release.yml b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/workflows/release.yml new file mode 100644 index 00000000..e47f42cb --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/workflows/release.yml @@ -0,0 +1,25 @@ +name: Release +on: + push: + branches: + - master + +jobs: + release: + name: release + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: actions/setup-node@v1 + with: + node-version: "12.x" + - run: npm ci + - run: npx semantic-release + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + - run: npm run docs + - uses: maxheld83/ghpages@master + env: + BUILD_DIR: docs/ + GH_PAT: ${{ secrets.OCTOKIT_PAT }} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/workflows/routes-update.yml b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/workflows/routes-update.yml new file mode 100644 index 00000000..f1639d90 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/workflows/routes-update.yml @@ -0,0 +1,37 @@ +name: octokit/routes update +on: + repository_dispatch: + types: [octokit-routes-release] + +jobs: + update_routes: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: actions/setup-node@v1 + with: + node-version: "12.x" + # try checking out routes-update branch. Ignore error if it does not exist + - run: git checkout routes-update || true + - run: npm ci + - run: npm run update-endpoints + - name: Create Pull Request + uses: gr2m/create-or-update-pull-request-action@v1.x + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + title: "🚧 GitHub REST Endpoints changed" + body: | + See what changed at https://github.com/octokit/routes/releases/latest. + + Make sure to update the commits so that the merge results in helpful release notes, see [Merging the Pull Request & releasing a new version](https://github.com/octokit/rest.js/blob/master/CONTRIBUTING.md#merging-the-pull-request--releasing-a-new-version). + + In general + + - Avoid breaking changes at all costs + - If there are no typescript or code changes, use a `docs` prefix + - If there are typescript changes but no code changes, use `fix(typescript)` prefix + - If there are code changes, use `fix` if a problem was resolved, `feat` if new endpoints / parameters were added, and `feat(deprecation)` if a method was deprecated. + branch: "routes-update" + commit-message: "WIP octokit/routes updated" + author: "Octokit Bot <33075676+octokitbot@users.noreply.github.com>" diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/workflows/test.yml b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/workflows/test.yml new file mode 100644 index 00000000..702220fd --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/.github/workflows/test.yml @@ -0,0 +1,19 @@ +name: Test +on: + push: + branches: + - master + - "greenkeeper/*" + pull_request: + types: [opened, synchronize] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: actions/setup-node@v1 + with: + node-version: 12 + - run: npm ci + - run: npm test diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/CODE_OF_CONDUCT.md b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..8392e63e --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/CODE_OF_CONDUCT.md @@ -0,0 +1,75 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at opensource+octokit@github.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [https://contributor-covenant.org/version/1/4][version] + +[homepage]: https://contributor-covenant.org +[version]: https://contributor-covenant.org/version/1/4/ + diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/CONTRIBUTING.md b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/CONTRIBUTING.md new file mode 100644 index 00000000..6b275990 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/CONTRIBUTING.md @@ -0,0 +1,59 @@ +# How to contribute + +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). +By participating in this project you agree to abide by its terms. + +## Creating an Issue + +Before you create a new Issue: + +1. Please make sure there is no [open issue](https://github.com/octokit/plugin-paginate-rest/issues?utf8=%E2%9C%93&q=is%3Aissue) yet. +2. If it is a bug report, include the steps to reproduce the issue and please create a reproducible test case on [runkit.com](https://runkit.com/). Example: https://runkit.com/gr2m/5aa034f1440b420012a6eebf +3. If it is a feature request, please share the motivation for the new feature, what alternatives you tried, and how you would implement it. +4. Please include links to the corresponding github documentation. + +## Setup the repository locally + +First, fork the repository. + +Setup the repository locally. Replace `` with the name of the account you forked to. + +```shell +git clone https://github.com//plugin-paginate-rest.js.git +cd plugin-paginate-rest.js +npm install +``` + +Run the tests before making changes to make sure the local setup is working as expected + +```shell +npm test +``` + +## Submitting the Pull Request + +- Create a new branch locally. +- Make your changes in that branch to your fork repository +- Submit a pull request from your topic branch to the master branch on the `octokit/plugin-paginate-rest.js` repository. +- Be sure to tag any issues your pull request is taking care of / contributing to. Adding "Closes #123" to a pull request description will automatically close the issue once the pull request is merged in. + +## Testing a pull request from github repo locally: + +You can install `@octokit/plugin-paginate-rest` from each pull request. Replace `[PULL REQUEST NUMBER]` + +Once you are done testing, you can revert back to the default module `@octokit/plugin-paginate-rest` from npm with `npm install @octokit/plugin-paginate-rest` + +## Merging the Pull Request & releasing a new version + +Releases are automated using [semantic-release](https://github.com/semantic-release/semantic-release). +The following commit message conventions determine which version is released: + +1. `fix: ...` or `fix(scope name): ...` prefix in subject: bumps fix version, e.g. `1.2.3` → `1.2.4` +2. `feat: ...` or `feat(scope name): ...` prefix in subject: bumps feature version, e.g. `1.2.3` → `1.3.0` +3. `BREAKING CHANGE:` in body: bumps breaking version, e.g. `1.2.3` → `2.0.0` + +Only one version number is bumped at a time, the highest version change trumps the others. +Besides publishing a new version to npm, semantic-release also creates a git tag and release +on GitHub, generates changelogs from the commit messages and puts them into the release notes. +s +If the pull request looks good but does not follow the commit conventions, use the Squash & merge button. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/LICENSE b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/LICENSE new file mode 100644 index 00000000..57bee5f1 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/LICENSE @@ -0,0 +1,7 @@ +MIT License Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/README.md new file mode 100644 index 00000000..482dae00 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/README.md @@ -0,0 +1,19 @@ +# types.ts + +> Shared TypeScript definitions for Octokit projects + +[![@latest](https://img.shields.io/npm/v/@octokit/types.svg)](https://www.npmjs.com/package/@octokit/types) +[![Build Status](https://github.com/octokit/types.ts/workflows/Test/badge.svg)](https://github.com/octokit/types.ts/actions?workflow=Test) +[![Greenkeeper](https://badges.greenkeeper.io/octokit/types.ts.svg)](https://greenkeeper.io/) + +## Usage + +See https://octokit.github.io/types.ts for all exported types + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/package.json b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/package.json new file mode 100644 index 00000000..7f014514 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/package.json @@ -0,0 +1,62 @@ +{ + "name": "@octokit/types", + "version": "2.0.1", + "publishConfig": { + "access": "public" + }, + "description": "Shared TypeScript definitions for Octokit projects", + "main": "src/index.ts", + "scripts": { + "docs": "typedoc --module commonjs --readme none --out docs src/", + "lint": "prettier --check '{src,test}/**/*' README.md package.json !src/generated/*", + "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json !src/generated/*", + "pretest": "npm run -s lint", + "test": "./node_modules/.bin/tsc --noEmit --declaration src/index.ts", + "update-endpoints": "npm-run-all update-endpoints:*", + "update-endpoints:fetch-json": "node scripts/update-endpoints/fetch-json", + "update-endpoints:typescript": "node scripts/update-endpoints/typescript" + }, + "repository": "https://github.com/octokit/types.ts", + "keywords": [ + "github", + "api", + "sdk", + "toolkit", + "typescript" + ], + "author": "Gregor Martynus (https://twitter.com/gr2m)", + "license": "MIT", + "devDependencies": { + "@octokit/graphql": "^4.2.2", + "handlebars": "^4.4.5", + "lodash.set": "^4.3.2", + "npm-run-all": "^4.1.5", + "pascal-case": "^2.0.1", + "prettier": "^1.18.2", + "semantic-release": "^15.13.24", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "sort-keys": "^4.0.0", + "string-to-jsdoc-comment": "^1.0.0", + "typedoc": "^0.15.0", + "typescript": "^3.6.4" + }, + "release": { + "plugins": [ + "@semantic-release/commit-analyzer", + "@semantic-release/release-notes-generator", + "@semantic-release/github", + "@semantic-release/npm", + [ + "semantic-release-plugin-update-version-in-files", + { + "files": [ + "src/VERSION.ts" + ] + } + ] + ] + }, + "dependencies": { + "@types/node": ">= 8" + } +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js new file mode 100644 index 00000000..6bca9300 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js @@ -0,0 +1,41 @@ +const { writeFileSync } = require("fs"); +const path = require("path"); + +const { graphql } = require("@octokit/graphql"); +const prettier = require("prettier"); + +const QUERY = ` + { + endpoints { + name + scope(format: CAMELCASE) + id(format: CAMELCASE) + method + url + parameters { + alias + allowNull + deprecated + description + enum + name + type + required + } + } + }`; + +main(); + +async function main() { + const { endpoints } = await graphql(QUERY, { + url: "https://octokit-routes-graphql-server.now.sh/" + }); + + writeFileSync( + path.resolve(__dirname, "generated", "endpoints.json"), + prettier.format(JSON.stringify(endpoints), { + parser: "json" + }) + ); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md new file mode 100644 index 00000000..6beaf58e --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md @@ -0,0 +1,3 @@ +# DO NOT EDIT FILES IN THIS DIRECTORY + +All files are generated automatically and will be overwritten next time [octokit/routes](https://github.com/octokit/routes/) has a new release. If you find a problem, please file an issue. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json new file mode 100644 index 00000000..6c3d62a3 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json @@ -0,0 +1,25258 @@ +[ + { + "name": "Get the authenticated GitHub App", + "scope": "apps", + "id": "getAuthenticated", + "method": "GET", + "url": "/app", + "parameters": [] + }, + { + "name": "Create a GitHub App from a manifest", + "scope": "apps", + "id": "createFromManifest", + "method": "POST", + "url": "/app-manifests/{code}/conversions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "code parameter", + "enum": null, + "name": "code", + "type": "string", + "required": true + } + ] + }, + { + "name": "List installations", + "scope": "apps", + "id": "listInstallations", + "method": "GET", + "url": "/app/installations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get an installation", + "scope": "apps", + "id": "getInstallation", + "method": "GET", + "url": "/app/installations/{installation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete an installation", + "scope": "apps", + "id": "deleteInstallation", + "method": "DELETE", + "url": "/app/installations/{installation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Create a new installation token", + "scope": "apps", + "id": "createInstallationToken", + "method": "POST", + "url": "/app/installations/{installation_id}/access_tokens", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the \"[List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)\" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.", + "enum": null, + "name": "repository_ids", + "type": "integer[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see \"[GitHub App permissions](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions).\"", + "enum": null, + "name": "permissions", + "type": "object", + "required": false + } + ] + }, + { + "name": "List your grants", + "scope": "oauthAuthorizations", + "id": "listGrants", + "method": "GET", + "url": "/applications/grants", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single grant", + "scope": "oauthAuthorizations", + "id": "getGrant", + "method": "GET", + "url": "/applications/grants/{grant_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "grant_id parameter", + "enum": null, + "name": "grant_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a grant", + "scope": "oauthAuthorizations", + "id": "deleteGrant", + "method": "DELETE", + "url": "/applications/grants/{grant_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "grant_id parameter", + "enum": null, + "name": "grant_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Revoke a grant for an application", + "scope": "oauthAuthorizations", + "id": "revokeGrantForApplication", + "method": "DELETE", + "url": "/applications/{client_id}/grants/{access_token}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "access_token parameter", + "enum": null, + "name": "access_token", + "type": "string", + "required": true + } + ] + }, + { + "name": "Check an authorization", + "scope": "oauthAuthorizations", + "id": "checkAuthorization", + "method": "GET", + "url": "/applications/{client_id}/tokens/{access_token}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "access_token parameter", + "enum": null, + "name": "access_token", + "type": "string", + "required": true + } + ] + }, + { + "name": "Reset an authorization", + "scope": "oauthAuthorizations", + "id": "resetAuthorization", + "method": "POST", + "url": "/applications/{client_id}/tokens/{access_token}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "access_token parameter", + "enum": null, + "name": "access_token", + "type": "string", + "required": true + } + ] + }, + { + "name": "Revoke an authorization for an application", + "scope": "oauthAuthorizations", + "id": "revokeAuthorizationForApplication", + "method": "DELETE", + "url": "/applications/{client_id}/tokens/{access_token}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "access_token parameter", + "enum": null, + "name": "access_token", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single GitHub App", + "scope": "apps", + "id": "getBySlug", + "method": "GET", + "url": "/apps/{app_slug}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "app_slug parameter", + "enum": null, + "name": "app_slug", + "type": "string", + "required": true + } + ] + }, + { + "name": "List your authorizations", + "scope": "oauthAuthorizations", + "id": "listAuthorizations", + "method": "GET", + "url": "/authorizations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a new authorization", + "scope": "oauthAuthorizations", + "id": "createAuthorization", + "method": "POST", + "url": "/authorizations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes that this authorization is in.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.", + "enum": null, + "name": "note", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 20 character OAuth app client key for which to create the token.", + "enum": null, + "name": "client_id", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 40 character OAuth app client secret for which to create the token.", + "enum": null, + "name": "client_secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get-or-create an authorization for a specific app", + "scope": "oauthAuthorizations", + "id": "getOrCreateAuthorizationForApp", + "method": "PUT", + "url": "/authorizations/clients/{client_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", + "enum": null, + "name": "client_secret", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes that this authorization is in.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get-or-create an authorization for a specific app and fingerprint", + "scope": "oauthAuthorizations", + "id": "getOrCreateAuthorizationForAppAndFingerprint", + "method": "PUT", + "url": "/authorizations/clients/{client_id}/{fingerprint}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "fingerprint parameter", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", + "enum": null, + "name": "client_secret", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes that this authorization is in.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get-or-create an authorization for a specific app and fingerprint", + "scope": "oauthAuthorizations", + "id": "getOrCreateAuthorizationForAppFingerprint", + "method": "PUT", + "url": "/authorizations/clients/{client_id}/{fingerprint}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "fingerprint parameter", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", + "enum": null, + "name": "client_secret", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes that this authorization is in.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single authorization", + "scope": "oauthAuthorizations", + "id": "getAuthorization", + "method": "GET", + "url": "/authorizations/{authorization_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "authorization_id parameter", + "enum": null, + "name": "authorization_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update an existing authorization", + "scope": "oauthAuthorizations", + "id": "updateAuthorization", + "method": "PATCH", + "url": "/authorizations/{authorization_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "authorization_id parameter", + "enum": null, + "name": "authorization_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Replaces the authorization scopes with these.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes to add to this authorization.", + "enum": null, + "name": "add_scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes to remove from this authorization.", + "enum": null, + "name": "remove_scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete an authorization", + "scope": "oauthAuthorizations", + "id": "deleteAuthorization", + "method": "DELETE", + "url": "/authorizations/{authorization_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "authorization_id parameter", + "enum": null, + "name": "authorization_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List all codes of conduct", + "scope": "codesOfConduct", + "id": "listConductCodes", + "method": "GET", + "url": "/codes_of_conduct", + "parameters": [] + }, + { + "name": "Get an individual code of conduct", + "scope": "codesOfConduct", + "id": "getConductCode", + "method": "GET", + "url": "/codes_of_conduct/{key}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key parameter", + "enum": null, + "name": "key", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a content attachment", + "scope": "apps", + "id": "createContentAttachment", + "method": "POST", + "url": "/content_references/{content_reference_id}/attachments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "content_reference_id parameter", + "enum": null, + "name": "content_reference_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the content attachment displayed in the body or comment of an issue or pull request.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get", + "scope": "emojis", + "id": "get", + "method": "GET", + "url": "/emojis", + "parameters": [] + }, + { + "name": "List public events", + "scope": "activity", + "id": "listPublicEvents", + "method": "GET", + "url": "/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List feeds", + "scope": "activity", + "id": "listFeeds", + "method": "GET", + "url": "/feeds", + "parameters": [] + }, + { + "name": "List the authenticated user's gists or if called anonymously, this will return all public gists", + "scope": "gists", + "id": "list", + "method": "GET", + "url": "/gists", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a gist", + "scope": "gists", + "id": "create", + "method": "POST", + "url": "/gists", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`.", + "enum": null, + "name": "files", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The content of the file.", + "enum": null, + "name": "files.content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A descriptive name for this gist.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "When `true`, the gist will be public and available for anyone to see.", + "enum": null, + "name": "public", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List all public gists", + "scope": "gists", + "id": "listPublic", + "method": "GET", + "url": "/gists/public", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List starred gists", + "scope": "gists", + "id": "listStarred", + "method": "GET", + "url": "/gists/starred", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single gist", + "scope": "gists", + "id": "get", + "method": "GET", + "url": "/gists/{gist_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "Edit a gist", + "scope": "gists", + "id": "update", + "method": "PATCH", + "url": "/gists/{gist_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A descriptive name for this gist.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The filenames and content that make up this gist.", + "enum": null, + "name": "files", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The updated content of the file.", + "enum": null, + "name": "files.content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new name for this file. To delete a file, set the value of the filename to `null`.", + "enum": null, + "name": "files.filename", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete a gist", + "scope": "gists", + "id": "delete", + "method": "DELETE", + "url": "/gists/{gist_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "List comments on a gist", + "scope": "gists", + "id": "listComments", + "method": "GET", + "url": "/gists/{gist_id}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a comment", + "scope": "gists", + "id": "createComment", + "method": "POST", + "url": "/gists/{gist_id}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The comment text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single comment", + "scope": "gists", + "id": "getComment", + "method": "GET", + "url": "/gists/{gist_id}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a comment", + "scope": "gists", + "id": "updateComment", + "method": "PATCH", + "url": "/gists/{gist_id}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The comment text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a comment", + "scope": "gists", + "id": "deleteComment", + "method": "DELETE", + "url": "/gists/{gist_id}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List gist commits", + "scope": "gists", + "id": "listCommits", + "method": "GET", + "url": "/gists/{gist_id}/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Fork a gist", + "scope": "gists", + "id": "fork", + "method": "POST", + "url": "/gists/{gist_id}/forks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "List gist forks", + "scope": "gists", + "id": "listForks", + "method": "GET", + "url": "/gists/{gist_id}/forks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Star a gist", + "scope": "gists", + "id": "star", + "method": "PUT", + "url": "/gists/{gist_id}/star", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unstar a gist", + "scope": "gists", + "id": "unstar", + "method": "DELETE", + "url": "/gists/{gist_id}/star", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "Check if a gist is starred", + "scope": "gists", + "id": "checkIsStarred", + "method": "GET", + "url": "/gists/{gist_id}/star", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a specific revision of a gist", + "scope": "gists", + "id": "getRevision", + "method": "GET", + "url": "/gists/{gist_id}/{sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "sha parameter", + "enum": null, + "name": "sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Listing available templates", + "scope": "gitignore", + "id": "listTemplates", + "method": "GET", + "url": "/gitignore/templates", + "parameters": [] + }, + { + "name": "Get a single template", + "scope": "gitignore", + "id": "getTemplate", + "method": "GET", + "url": "/gitignore/templates/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "List repositories", + "scope": "apps", + "id": "listRepos", + "method": "GET", + "url": "/installation/repositories", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories", + "scope": "issues", + "id": "list", + "method": "GET", + "url": "/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "enum": null, + "name": "labels", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "enum": ["created", "updated", "comments"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search issues", + "scope": "search", + "id": "issuesLegacy", + "method": "GET", + "url": "/legacy/issues/search/{owner}/{repository}/{state}/{keyword}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repository parameter", + "enum": null, + "name": "repository", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The search term.", + "enum": null, + "name": "keyword", + "type": "string", + "required": true + } + ] + }, + { + "name": "Search repositories", + "scope": "search", + "id": "reposLegacy", + "method": "GET", + "url": "/legacy/repos/search/{keyword}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The search term.", + "enum": null, + "name": "keyword", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter results by language.", + "enum": null, + "name": "language", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The page number to fetch.", + "enum": null, + "name": "start_page", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", + "enum": ["stars", "forks", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "order", + "type": "string", + "required": false + } + ] + }, + { + "name": "Email search", + "scope": "search", + "id": "emailLegacy", + "method": "GET", + "url": "/legacy/user/email/{email}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email address.", + "enum": null, + "name": "email", + "type": "string", + "required": true + } + ] + }, + { + "name": "Search users", + "scope": "search", + "id": "usersLegacy", + "method": "GET", + "url": "/legacy/user/search/{keyword}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The search term.", + "enum": null, + "name": "keyword", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The page number to fetch.", + "enum": null, + "name": "start_page", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", + "enum": ["stars", "forks", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "order", + "type": "string", + "required": false + } + ] + }, + { + "name": "List commonly used licenses", + "scope": "licenses", + "id": "listCommonlyUsed", + "method": "GET", + "url": "/licenses", + "parameters": [] + }, + { + "name": "List commonly used licenses", + "scope": "licenses", + "id": "list", + "method": "GET", + "url": "/licenses", + "parameters": [] + }, + { + "name": "Get an individual license", + "scope": "licenses", + "id": "get", + "method": "GET", + "url": "/licenses/{license}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "license parameter", + "enum": null, + "name": "license", + "type": "string", + "required": true + } + ] + }, + { + "name": "Render an arbitrary Markdown document", + "scope": "markdown", + "id": "render", + "method": "POST", + "url": "/markdown", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.", + "enum": null, + "name": "text", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The rendering mode. Can be either: \n\\* `markdown` to render a document in plain Markdown, just like README.md files are rendered. \n\\* `gfm` to render a document in [GitHub Flavored Markdown](https://github.github.com/gfm/), which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.", + "enum": ["markdown", "gfm"], + "name": "mode", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.", + "enum": null, + "name": "context", + "type": "string", + "required": false + } + ] + }, + { + "name": "Render a Markdown document in raw mode", + "scope": "markdown", + "id": "renderRaw", + "method": "POST", + "url": "/markdown/raw", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "data parameter", + "enum": null, + "name": "data", + "type": "string", + "required": true + } + ] + }, + { + "name": "Check if a GitHub account is associated with any Marketplace listing", + "scope": "apps", + "id": "checkAccountIsAssociatedWithAny", + "method": "GET", + "url": "/marketplace_listing/accounts/{account_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "account_id parameter", + "enum": null, + "name": "account_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all plans for your Marketplace listing", + "scope": "apps", + "id": "listPlans", + "method": "GET", + "url": "/marketplace_listing/plans", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all GitHub accounts (user or organization) on a specific plan", + "scope": "apps", + "id": "listAccountsUserOrOrgOnPlan", + "method": "GET", + "url": "/marketplace_listing/plans/{plan_id}/accounts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "plan_id parameter", + "enum": null, + "name": "plan_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if a GitHub account is associated with any Marketplace listing (stubbed)", + "scope": "apps", + "id": "checkAccountIsAssociatedWithAnyStubbed", + "method": "GET", + "url": "/marketplace_listing/stubbed/accounts/{account_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "account_id parameter", + "enum": null, + "name": "account_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all plans for your Marketplace listing (stubbed)", + "scope": "apps", + "id": "listPlansStubbed", + "method": "GET", + "url": "/marketplace_listing/stubbed/plans", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all GitHub accounts (user or organization) on a specific plan (stubbed)", + "scope": "apps", + "id": "listAccountsUserOrOrgOnPlanStubbed", + "method": "GET", + "url": "/marketplace_listing/stubbed/plans/{plan_id}/accounts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "plan_id parameter", + "enum": null, + "name": "plan_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get", + "scope": "meta", + "id": "get", + "method": "GET", + "url": "/meta", + "parameters": [] + }, + { + "name": "List public events for a network of repositories", + "scope": "activity", + "id": "listPublicEventsForRepoNetwork", + "method": "GET", + "url": "/networks/{owner}/{repo}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List your notifications", + "scope": "activity", + "id": "listNotifications", + "method": "GET", + "url": "/notifications", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, show notifications marked as read.", + "enum": null, + "name": "all", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", + "enum": null, + "name": "participating", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "before", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Mark as read", + "scope": "activity", + "id": "markAsRead", + "method": "PUT", + "url": "/notifications", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", + "enum": null, + "name": "last_read_at", + "type": "string", + "required": false + } + ] + }, + { + "name": "View a single thread", + "scope": "activity", + "id": "getThread", + "method": "GET", + "url": "/notifications/threads/{thread_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Mark a thread as read", + "scope": "activity", + "id": "markThreadAsRead", + "method": "PATCH", + "url": "/notifications/threads/{thread_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get a thread subscription", + "scope": "activity", + "id": "getThreadSubscription", + "method": "GET", + "url": "/notifications/threads/{thread_id}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Set a thread subscription", + "scope": "activity", + "id": "setThreadSubscription", + "method": "PUT", + "url": "/notifications/threads/{thread_id}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.", + "enum": null, + "name": "ignored", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a thread subscription", + "scope": "activity", + "id": "deleteThreadSubscription", + "method": "DELETE", + "url": "/notifications/threads/{thread_id}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List all organizations", + "scope": "orgs", + "id": "list", + "method": "GET", + "url": "/organizations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The integer ID of the last Organization that you've seen.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get an organization", + "scope": "orgs", + "id": "get", + "method": "GET", + "url": "/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Edit an organization", + "scope": "orgs", + "id": "update", + "method": "PATCH", + "url": "/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Billing email address. This address is not publicized.", + "enum": null, + "name": "billing_email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The company name.", + "enum": null, + "name": "company", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The publicly visible email address.", + "enum": null, + "name": "email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The location.", + "enum": null, + "name": "location", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The shorthand name of the company.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the company.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Toggles whether organization projects are enabled for the organization.", + "enum": null, + "name": "has_organization_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Toggles whether repository projects are enabled for repositories that belong to the organization.", + "enum": null, + "name": "has_repository_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.", + "enum": ["read", "write", "admin", "none"], + "name": "default_repository_permission", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only admin members can create repositories. \nDefault: `true` \n**Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", + "enum": null, + "name": "members_can_create_repositories", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). \n\\* `none` - only admin members can create repositories. \n**Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", + "enum": ["all", "private", "none"], + "name": "members_allowed_repository_creation_type", + "type": "string", + "required": false + } + ] + }, + { + "name": "List blocked users", + "scope": "orgs", + "id": "listBlockedUsers", + "method": "GET", + "url": "/orgs/{org}/blocks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Check whether a user is blocked from an organization", + "scope": "orgs", + "id": "checkBlockedUser", + "method": "GET", + "url": "/orgs/{org}/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Block a user", + "scope": "orgs", + "id": "blockUser", + "method": "PUT", + "url": "/orgs/{org}/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unblock a user", + "scope": "orgs", + "id": "unblockUser", + "method": "DELETE", + "url": "/orgs/{org}/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List credential authorizations for an organization", + "scope": "orgs", + "id": "listCredentialAuthorizations", + "method": "GET", + "url": "/orgs/{org}/credential-authorizations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove a credential authorization for an organization", + "scope": "orgs", + "id": "removeCredentialAuthorization", + "method": "DELETE", + "url": "/orgs/{org}/credential-authorizations/{credential_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "credential_id parameter", + "enum": null, + "name": "credential_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List public events for an organization", + "scope": "activity", + "id": "listPublicEventsForOrg", + "method": "GET", + "url": "/orgs/{org}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List hooks", + "scope": "orgs", + "id": "listHooks", + "method": "GET", + "url": "/orgs/{org}/hooks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a hook", + "scope": "orgs", + "id": "createHook", + "method": "POST", + "url": "/orgs/{org}/hooks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Must be passed as \"web\".", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params).", + "enum": null, + "name": "config", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL to which the payloads will be delivered.", + "enum": null, + "name": "config.url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "enum": null, + "name": "config.content_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "enum": null, + "name": "config.secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "enum": null, + "name": "config.insecure_ssl", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", + "enum": null, + "name": "events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "enum": null, + "name": "active", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get single hook", + "scope": "orgs", + "id": "getHook", + "method": "GET", + "url": "/orgs/{org}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a hook", + "scope": "orgs", + "id": "updateHook", + "method": "PATCH", + "url": "/orgs/{org}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params).", + "enum": null, + "name": "config", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL to which the payloads will be delivered.", + "enum": null, + "name": "config.url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "enum": null, + "name": "config.content_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "enum": null, + "name": "config.secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "enum": null, + "name": "config.insecure_ssl", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", + "enum": null, + "name": "events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "enum": null, + "name": "active", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a hook", + "scope": "orgs", + "id": "deleteHook", + "method": "DELETE", + "url": "/orgs/{org}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Ping a hook", + "scope": "orgs", + "id": "pingHook", + "method": "POST", + "url": "/orgs/{org}/hooks/{hook_id}/pings", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get an organization installation", + "scope": "apps", + "id": "getOrgInstallation", + "method": "GET", + "url": "/orgs/{org}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get an organization installation", + "scope": "apps", + "id": "findOrgInstallation", + "method": "GET", + "url": "/orgs/{org}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get interaction restrictions for an organization", + "scope": "interactions", + "id": "getRestrictionsForOrg", + "method": "GET", + "url": "/orgs/{org}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update interaction restrictions for an organization", + "scope": "interactions", + "id": "addOrUpdateRestrictionsForOrg", + "method": "PUT", + "url": "/orgs/{org}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", + "enum": ["existing_users", "contributors_only", "collaborators_only"], + "name": "limit", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove interaction restrictions for an organization", + "scope": "interactions", + "id": "removeRestrictionsForOrg", + "method": "DELETE", + "url": "/orgs/{org}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "List pending organization invitations", + "scope": "orgs", + "id": "listPendingInvitations", + "method": "GET", + "url": "/orgs/{org}/invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create organization invitation", + "scope": "orgs", + "id": "createInvitation", + "method": "POST", + "url": "/orgs/{org}/invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting.", + "enum": null, + "name": "invitee_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.", + "enum": null, + "name": "email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify role for new member. Can be one of: \n\\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n\\* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n\\* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.", + "enum": ["admin", "direct_member", "billing_manager"], + "name": "role", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify IDs for the teams you want to invite new members to.", + "enum": null, + "name": "team_ids", + "type": "integer[]", + "required": false + } + ] + }, + { + "name": "List organization invitation teams", + "scope": "orgs", + "id": "listInvitationTeams", + "method": "GET", + "url": "/orgs/{org}/invitations/{invitation_id}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all issues for a given organization assigned to the authenticated user", + "scope": "issues", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "enum": null, + "name": "labels", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "enum": ["created", "updated", "comments"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Members list", + "scope": "orgs", + "id": "listMembers", + "method": "GET", + "url": "/orgs/{org}/members", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", + "enum": ["2fa_disabled", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", + "enum": ["all", "admin", "member"], + "name": "role", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check membership", + "scope": "orgs", + "id": "checkMembership", + "method": "GET", + "url": "/orgs/{org}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove a member", + "scope": "orgs", + "id": "removeMember", + "method": "DELETE", + "url": "/orgs/{org}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get organization membership", + "scope": "orgs", + "id": "getMembership", + "method": "GET", + "url": "/orgs/{org}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update organization membership", + "scope": "orgs", + "id": "addOrUpdateMembership", + "method": "PUT", + "url": "/orgs/{org}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", + "enum": ["admin", "member"], + "name": "role", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove organization membership", + "scope": "orgs", + "id": "removeMembership", + "method": "DELETE", + "url": "/orgs/{org}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Start an organization migration", + "scope": "migrations", + "id": "startForOrg", + "method": "POST", + "url": "/orgs/{org}/migrations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of arrays indicating which repositories should be migrated.", + "enum": null, + "name": "repositories", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", + "enum": null, + "name": "lock_repositories", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", + "enum": null, + "name": "exclude_attachments", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a list of organization migrations", + "scope": "migrations", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/migrations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the status of an organization migration", + "scope": "migrations", + "id": "getStatusForOrg", + "method": "GET", + "url": "/orgs/{org}/migrations/{migration_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Download an organization migration archive", + "scope": "migrations", + "id": "getArchiveForOrg", + "method": "GET", + "url": "/orgs/{org}/migrations/{migration_id}/archive", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete an organization migration archive", + "scope": "migrations", + "id": "deleteArchiveForOrg", + "method": "DELETE", + "url": "/orgs/{org}/migrations/{migration_id}/archive", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Unlock an organization repository", + "scope": "migrations", + "id": "unlockRepoForOrg", + "method": "DELETE", + "url": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo_name parameter", + "enum": null, + "name": "repo_name", + "type": "string", + "required": true + } + ] + }, + { + "name": "List outside collaborators", + "scope": "orgs", + "id": "listOutsideCollaborators", + "method": "GET", + "url": "/orgs/{org}/outside_collaborators", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", + "enum": ["2fa_disabled", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Remove outside collaborator", + "scope": "orgs", + "id": "removeOutsideCollaborator", + "method": "DELETE", + "url": "/orgs/{org}/outside_collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Convert member to outside collaborator", + "scope": "orgs", + "id": "convertMemberToOutsideCollaborator", + "method": "PUT", + "url": "/orgs/{org}/outside_collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List organization projects", + "scope": "projects", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create an organization project", + "scope": "projects", + "id": "createForOrg", + "method": "POST", + "url": "/orgs/{org}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the project.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the project.", + "enum": null, + "name": "body", + "type": "string", + "required": false + } + ] + }, + { + "name": "Public members list", + "scope": "orgs", + "id": "listPublicMembers", + "method": "GET", + "url": "/orgs/{org}/public_members", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check public membership", + "scope": "orgs", + "id": "checkPublicMembership", + "method": "GET", + "url": "/orgs/{org}/public_members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Publicize a user's membership", + "scope": "orgs", + "id": "publicizeMembership", + "method": "PUT", + "url": "/orgs/{org}/public_members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Conceal a user's membership", + "scope": "orgs", + "id": "concealMembership", + "method": "DELETE", + "url": "/orgs/{org}/public_members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List organization repositories", + "scope": "repos", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`.", + "enum": ["all", "public", "private", "forks", "sources", "member"], + "name": "type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "enum": ["created", "updated", "pushed", "full_name"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Creates a new repository in the specified organization", + "scope": "repos", + "id": "createInOrg", + "method": "POST", + "url": "/orgs/{org}/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the repository.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the repository.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL with more information about the repository.", + "enum": null, + "name": "homepage", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "enum": null, + "name": "has_issues", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "enum": null, + "name": "has_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "enum": null, + "name": "has_wiki", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "enum": null, + "name": "is_template", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", + "enum": null, + "name": "team_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Pass `true` to create an initial commit with empty README.", + "enum": null, + "name": "auto_init", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", + "enum": null, + "name": "gitignore_template", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", + "enum": null, + "name": "license_template", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "enum": null, + "name": "allow_squash_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "enum": null, + "name": "allow_merge_commit", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "enum": null, + "name": "allow_rebase_merge", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List IdP groups in an organization", + "scope": "teams", + "id": "listIdPGroupsForOrg", + "method": "GET", + "url": "/orgs/{org}/team-sync/groups", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List teams", + "scope": "teams", + "id": "list", + "method": "GET", + "url": "/orgs/{org}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create team", + "scope": "teams", + "id": "create", + "method": "POST", + "url": "/orgs/{org}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the team.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the team.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The logins of organization members to add as maintainers of the team.", + "enum": null, + "name": "maintainers", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", + "enum": null, + "name": "repo_names", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed` \n**Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams.", + "enum": ["secret", "closed"], + "name": "privacy", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "enum": ["pull", "push", "admin"], + "name": "permission", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.", + "enum": null, + "name": "parent_team_id", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get team by name", + "scope": "teams", + "id": "getByName", + "method": "GET", + "url": "/orgs/{org}/teams/{team_slug}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_slug parameter", + "enum": null, + "name": "team_slug", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a project card", + "scope": "projects", + "id": "getCard", + "method": "GET", + "url": "/projects/columns/cards/{card_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "card_id parameter", + "enum": null, + "name": "card_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update a project card", + "scope": "projects", + "id": "updateCard", + "method": "PATCH", + "url": "/projects/columns/cards/{card_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "card_id parameter", + "enum": null, + "name": "card_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card.", + "enum": null, + "name": "archived", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a project card", + "scope": "projects", + "id": "deleteCard", + "method": "DELETE", + "url": "/projects/columns/cards/{card_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "card_id parameter", + "enum": null, + "name": "card_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Move a project card", + "scope": "projects", + "id": "moveCard", + "method": "POST", + "url": "/projects/columns/cards/{card_id}/moves", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "card_id parameter", + "enum": null, + "name": "card_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `top`, `bottom`, or `after:`, where `` is the `id` value of a card in the same column, or in the new column specified by `column_id`.", + "enum": null, + "name": "position", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The `id` value of a column in the same project.", + "enum": null, + "name": "column_id", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a project column", + "scope": "projects", + "id": "getColumn", + "method": "GET", + "url": "/projects/columns/{column_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update a project column", + "scope": "projects", + "id": "updateColumn", + "method": "PATCH", + "url": "/projects/columns/{column_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new name of the column.", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a project column", + "scope": "projects", + "id": "deleteColumn", + "method": "DELETE", + "url": "/projects/columns/{column_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List project cards", + "scope": "projects", + "id": "listCards", + "method": "GET", + "url": "/projects/columns/{column_id}/cards", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", + "enum": ["all", "archived", "not_archived"], + "name": "archived_state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a project card", + "scope": "projects", + "id": "createCard", + "method": "POST", + "url": "/projects/columns/{column_id}/cards", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The card's note content. Only valid for cards without another type of content, so you must omit when specifying `content_id` and `content_type`.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. \n**Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`.", + "enum": null, + "name": "content_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id.", + "enum": null, + "name": "content_type", + "type": "string", + "required": false + } + ] + }, + { + "name": "Move a project column", + "scope": "projects", + "id": "moveColumn", + "method": "POST", + "url": "/projects/columns/{column_id}/moves", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project.", + "enum": null, + "name": "position", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a project", + "scope": "projects", + "id": "get", + "method": "GET", + "url": "/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Update a project", + "scope": "projects", + "id": "update", + "method": "PATCH", + "url": "/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the project.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the project.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "State of the project. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project](https://developer.github.com/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). \n \n**Note:** Updating a project's `organization_permission` requires `admin` access to the project. \n \nCan be one of: \n\\* `read` - Organization members can read, but not write to or administer this project. \n\\* `write` - Organization members can read and write, but not administer this project. \n\\* `admin` - Organization members can read, write and administer this project. \n\\* `none` - Organization members can only see this project if it is public.", + "enum": null, + "name": "organization_permission", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. \n \nCan be one of: \n\\* `false` - Anyone can see the project. \n\\* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a project", + "scope": "projects", + "id": "delete", + "method": "DELETE", + "url": "/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List collaborators", + "scope": "projects", + "id": "listCollaborators", + "method": "GET", + "url": "/projects/{project_id}/collaborators", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", + "enum": ["outside", "direct", "all"], + "name": "affiliation", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Add user as a collaborator", + "scope": "projects", + "id": "addCollaborator", + "method": "PUT", + "url": "/projects/{project_id}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\" Can be one of: \n\\* `read` - can read, but not write to or administer this project. \n\\* `write` - can read and write, but not administer this project. \n\\* `admin` - can read, write and administer this project.", + "enum": ["read", "write", "admin"], + "name": "permission", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove user as a collaborator", + "scope": "projects", + "id": "removeCollaborator", + "method": "DELETE", + "url": "/projects/{project_id}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Review a user's permission level", + "scope": "projects", + "id": "reviewUserPermissionLevel", + "method": "GET", + "url": "/projects/{project_id}/collaborators/{username}/permission", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List project columns", + "scope": "projects", + "id": "listColumns", + "method": "GET", + "url": "/projects/{project_id}/columns", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a project column", + "scope": "projects", + "id": "createColumn", + "method": "POST", + "url": "/projects/{project_id}/columns", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the column.", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get your current rate limit status", + "scope": "rateLimit", + "id": "get", + "method": "GET", + "url": "/rate_limit", + "parameters": [] + }, + { + "name": "Delete a reaction", + "scope": "reactions", + "id": "delete", + "method": "DELETE", + "url": "/reactions/{reaction_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "reaction_id parameter", + "enum": null, + "name": "reaction_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get", + "scope": "repos", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Edit", + "scope": "repos", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the repository.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the repository.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL with more information about the repository.", + "enum": null, + "name": "homepage", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "enum": null, + "name": "has_issues", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "enum": null, + "name": "has_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "enum": null, + "name": "has_wiki", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "enum": null, + "name": "is_template", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Updates the default branch for this repository.", + "enum": null, + "name": "default_branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "enum": null, + "name": "allow_squash_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "enum": null, + "name": "allow_merge_commit", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "enum": null, + "name": "allow_rebase_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "enum": null, + "name": "archived", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a repository", + "scope": "repos", + "id": "delete", + "method": "DELETE", + "url": "/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List assignees", + "scope": "issues", + "id": "listAssignees", + "method": "GET", + "url": "/repos/{owner}/{repo}/assignees", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check assignee", + "scope": "issues", + "id": "checkAssignee", + "method": "GET", + "url": "/repos/{owner}/{repo}/assignees/{assignee}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "assignee parameter", + "enum": null, + "name": "assignee", + "type": "string", + "required": true + } + ] + }, + { + "name": "Enable automated security fixes", + "scope": "repos", + "id": "enableAutomatedSecurityFixes", + "method": "PUT", + "url": "/repos/{owner}/{repo}/automated-security-fixes", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Disable automated security fixes", + "scope": "repos", + "id": "disableAutomatedSecurityFixes", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/automated-security-fixes", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List branches", + "scope": "repos", + "id": "listBranches", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", + "enum": null, + "name": "protected", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get branch", + "scope": "repos", + "id": "getBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get branch protection", + "scope": "repos", + "id": "getBranchProtection", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update branch protection", + "scope": "repos", + "id": "updateBranchProtection", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "Require status checks to pass before merging. Set to `null` to disable.", + "enum": null, + "name": "required_status_checks", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Require branches to be up to date before merging.", + "enum": null, + "name": "required_status_checks.strict", + "type": "boolean", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of status checks to require in order to merge into this branch", + "enum": null, + "name": "required_status_checks.contexts", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", + "enum": null, + "name": "enforce_admins", + "type": "boolean", + "required": true + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", + "enum": null, + "name": "required_pull_request_reviews", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "enum": null, + "name": "required_pull_request_reviews.dismissal_restrictions", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of user `login`s with dismissal access", + "enum": null, + "name": "required_pull_request_reviews.dismissal_restrictions.users", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of team `slug`s with dismissal access", + "enum": null, + "name": "required_pull_request_reviews.dismissal_restrictions.teams", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "enum": null, + "name": "required_pull_request_reviews.dismiss_stale_reviews", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", + "enum": null, + "name": "required_pull_request_reviews.require_code_owner_reviews", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "enum": null, + "name": "required_pull_request_reviews.required_approving_review_count", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "Restrict who can push to this branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", + "enum": null, + "name": "restrictions", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of user `login`s with push access", + "enum": null, + "name": "restrictions.users", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of team `slug`s with push access", + "enum": null, + "name": "restrictions.teams", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of app `slug`s with push access", + "enum": null, + "name": "restrictions.apps", + "type": "string[]", + "required": false + } + ] + }, + { + "name": "Remove branch protection", + "scope": "repos", + "id": "removeBranchProtection", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get admin enforcement of protected branch", + "scope": "repos", + "id": "getProtectedBranchAdminEnforcement", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add admin enforcement of protected branch", + "scope": "repos", + "id": "addProtectedBranchAdminEnforcement", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove admin enforcement of protected branch", + "scope": "repos", + "id": "removeProtectedBranchAdminEnforcement", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get pull request review enforcement of protected branch", + "scope": "repos", + "id": "getProtectedBranchPullRequestReviewEnforcement", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update pull request review enforcement of protected branch", + "scope": "repos", + "id": "updateProtectedBranchPullRequestReviewEnforcement", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "enum": null, + "name": "dismissal_restrictions", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of user `login`s with dismissal access", + "enum": null, + "name": "dismissal_restrictions.users", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of team `slug`s with dismissal access", + "enum": null, + "name": "dismissal_restrictions.teams", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "enum": null, + "name": "dismiss_stale_reviews", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", + "enum": null, + "name": "require_code_owner_reviews", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "enum": null, + "name": "required_approving_review_count", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Remove pull request review enforcement of protected branch", + "scope": "repos", + "id": "removeProtectedBranchPullRequestReviewEnforcement", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get required signatures of protected branch", + "scope": "repos", + "id": "getProtectedBranchRequiredSignatures", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add required signatures of protected branch", + "scope": "repos", + "id": "addProtectedBranchRequiredSignatures", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove required signatures of protected branch", + "scope": "repos", + "id": "removeProtectedBranchRequiredSignatures", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get required status checks of protected branch", + "scope": "repos", + "id": "getProtectedBranchRequiredStatusChecks", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update required status checks of protected branch", + "scope": "repos", + "id": "updateProtectedBranchRequiredStatusChecks", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Require branches to be up to date before merging.", + "enum": null, + "name": "strict", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of status checks to require in order to merge into this branch", + "enum": null, + "name": "contexts", + "type": "string[]", + "required": false + } + ] + }, + { + "name": "Remove required status checks of protected branch", + "scope": "repos", + "id": "removeProtectedBranchRequiredStatusChecks", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "List required status checks contexts of protected branch", + "scope": "repos", + "id": "listProtectedBranchRequiredStatusChecksContexts", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace required status checks contexts of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchRequiredStatusChecksContexts", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "contexts parameter", + "enum": null, + "name": "contexts", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Add required status checks contexts of protected branch", + "scope": "repos", + "id": "addProtectedBranchRequiredStatusChecksContexts", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "contexts parameter", + "enum": null, + "name": "contexts", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Remove required status checks contexts of protected branch", + "scope": "repos", + "id": "removeProtectedBranchRequiredStatusChecksContexts", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "contexts parameter", + "enum": null, + "name": "contexts", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Get restrictions of protected branch", + "scope": "repos", + "id": "getProtectedBranchRestrictions", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get apps with access to protected branch", + "scope": "repos", + "id": "getAppsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get apps with access to protected branch", + "scope": "repos", + "id": "listAppsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace app restrictions of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchAppRestrictions", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "apps parameter", + "enum": null, + "name": "apps", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Add app restrictions of protected branch", + "scope": "repos", + "id": "addProtectedBranchAppRestrictions", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "apps parameter", + "enum": null, + "name": "apps", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Remove app restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchAppRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "apps parameter", + "enum": null, + "name": "apps", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Get teams with access to protected branch", + "scope": "repos", + "id": "getTeamsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get teams with access to protected branch", + "scope": "repos", + "id": "listProtectedBranchTeamRestrictions", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get teams with access to protected branch", + "scope": "repos", + "id": "listTeamsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace team restrictions of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchTeamRestrictions", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "teams parameter", + "enum": null, + "name": "teams", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Add team restrictions of protected branch", + "scope": "repos", + "id": "addProtectedBranchTeamRestrictions", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "teams parameter", + "enum": null, + "name": "teams", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Remove team restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchTeamRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "teams parameter", + "enum": null, + "name": "teams", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Get users with access to protected branch", + "scope": "repos", + "id": "getUsersWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get users with access to protected branch", + "scope": "repos", + "id": "listProtectedBranchUserRestrictions", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get users with access to protected branch", + "scope": "repos", + "id": "listUsersWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace user restrictions of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchUserRestrictions", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "users parameter", + "enum": null, + "name": "users", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Add user restrictions of protected branch", + "scope": "repos", + "id": "addProtectedBranchUserRestrictions", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "users parameter", + "enum": null, + "name": "users", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Remove user restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchUserRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "users parameter", + "enum": null, + "name": "users", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Create a check run", + "scope": "checks", + "id": "create", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-runs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the check. For example, \"code-coverage\".", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the commit.", + "enum": null, + "name": "head_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL of the integrator's site that has the full details of the check.", + "enum": null, + "name": "details_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A reference for the run on the integrator's system.", + "enum": null, + "name": "external_id", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "name": "status", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "started_at", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`.", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required" + ], + "name": "conclusion", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "completed_at", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description.", + "enum": null, + "name": "output", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the check run.", + "enum": null, + "name": "output.title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The summary of the check run. This parameter supports Markdown.", + "enum": null, + "name": "output.summary", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The details of the check run. This parameter supports Markdown.", + "enum": null, + "name": "output.text", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", + "enum": null, + "name": "output.annotations", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", + "enum": null, + "name": "output.annotations[].path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The start line of the annotation.", + "enum": null, + "name": "output.annotations[].start_line", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The end line of the annotation.", + "enum": null, + "name": "output.annotations[].end_line", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "enum": null, + "name": "output.annotations[].start_column", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "enum": null, + "name": "output.annotations[].end_column", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", + "enum": ["notice", "warning", "failure"], + "name": "output.annotations[].annotation_level", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", + "enum": null, + "name": "output.annotations[].message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title that represents the annotation. The maximum size is 255 characters.", + "enum": null, + "name": "output.annotations[].title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Details about this annotation. The maximum size is 64 KB.", + "enum": null, + "name": "output.annotations[].raw_details", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#images-object) description for details.", + "enum": null, + "name": "output.images", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The alternative text for the image.", + "enum": null, + "name": "output.images[].alt", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The full URL of the image.", + "enum": null, + "name": "output.images[].image_url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short image description.", + "enum": null, + "name": "output.images[].caption", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", + "enum": null, + "name": "actions", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", + "enum": null, + "name": "actions[].label", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short explanation of what this action would do. The maximum size is 40 characters.", + "enum": null, + "name": "actions[].description", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", + "enum": null, + "name": "actions[].identifier", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update a check run", + "scope": "checks", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_run_id parameter", + "enum": null, + "name": "check_run_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the check. For example, \"code-coverage\".", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL of the integrator's site that has the full details of the check.", + "enum": null, + "name": "details_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A reference for the run on the integrator's system.", + "enum": null, + "name": "external_id", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "started_at", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "name": "status", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`.", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required" + ], + "name": "conclusion", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "completed_at", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description.", + "enum": null, + "name": "output", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required**.", + "enum": null, + "name": "output.title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can contain Markdown.", + "enum": null, + "name": "output.summary", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can contain Markdown.", + "enum": null, + "name": "output.text", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", + "enum": null, + "name": "output.annotations", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", + "enum": null, + "name": "output.annotations[].path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The start line of the annotation.", + "enum": null, + "name": "output.annotations[].start_line", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The end line of the annotation.", + "enum": null, + "name": "output.annotations[].end_line", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "enum": null, + "name": "output.annotations[].start_column", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "enum": null, + "name": "output.annotations[].end_column", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", + "enum": ["notice", "warning", "failure"], + "name": "output.annotations[].annotation_level", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", + "enum": null, + "name": "output.annotations[].message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title that represents the annotation. The maximum size is 255 characters.", + "enum": null, + "name": "output.annotations[].title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Details about this annotation. The maximum size is 64 KB.", + "enum": null, + "name": "output.annotations[].raw_details", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", + "enum": null, + "name": "output.images", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The alternative text for the image.", + "enum": null, + "name": "output.images[].alt", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The full URL of the image.", + "enum": null, + "name": "output.images[].image_url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short image description.", + "enum": null, + "name": "output.images[].caption", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", + "enum": null, + "name": "actions", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", + "enum": null, + "name": "actions[].label", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short explanation of what this action would do. The maximum size is 40 characters.", + "enum": null, + "name": "actions[].description", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", + "enum": null, + "name": "actions[].identifier", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single check run", + "scope": "checks", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_run_id parameter", + "enum": null, + "name": "check_run_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List annotations for a check run", + "scope": "checks", + "id": "listAnnotations", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_run_id parameter", + "enum": null, + "name": "check_run_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a check suite", + "scope": "checks", + "id": "createSuite", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-suites", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sha of the head commit.", + "enum": null, + "name": "head_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Set preferences for check suites on a repository", + "scope": "checks", + "id": "setSuitesPreferences", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/check-suites/preferences", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details.", + "enum": null, + "name": "auto_trigger_checks", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The `id` of the GitHub App.", + "enum": null, + "name": "auto_trigger_checks[].app_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", + "enum": null, + "name": "auto_trigger_checks[].setting", + "type": "boolean", + "required": true + } + ] + }, + { + "name": "Get a single check suite", + "scope": "checks", + "id": "getSuite", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_suite_id parameter", + "enum": null, + "name": "check_suite_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List check runs in a check suite", + "scope": "checks", + "id": "listForSuite", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_suite_id parameter", + "enum": null, + "name": "check_suite_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns check runs with the specified `name`.", + "enum": null, + "name": "check_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "name": "status", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", + "enum": ["latest", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Rerequest check suite", + "scope": "checks", + "id": "rerequestSuite", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_suite_id parameter", + "enum": null, + "name": "check_suite_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List collaborators", + "scope": "repos", + "id": "listCollaborators", + "method": "GET", + "url": "/repos/{owner}/{repo}/collaborators", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", + "enum": ["outside", "direct", "all"], + "name": "affiliation", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if a user is a collaborator", + "scope": "repos", + "id": "checkCollaborator", + "method": "GET", + "url": "/repos/{owner}/{repo}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add user as a collaborator", + "scope": "repos", + "id": "addCollaborator", + "method": "PUT", + "url": "/repos/{owner}/{repo}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository.", + "enum": ["pull", "push", "admin"], + "name": "permission", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove user as a collaborator", + "scope": "repos", + "id": "removeCollaborator", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Review a user's permission level", + "scope": "repos", + "id": "getCollaboratorPermissionLevel", + "method": "GET", + "url": "/repos/{owner}/{repo}/collaborators/{username}/permission", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List commit comments for a repository", + "scope": "repos", + "id": "listCommitComments", + "method": "GET", + "url": "/repos/{owner}/{repo}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single commit comment", + "scope": "repos", + "id": "getCommitComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update a commit comment", + "scope": "repos", + "id": "updateCommitComment", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the comment", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a commit comment", + "scope": "repos", + "id": "deleteCommitComment", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List reactions for a commit comment", + "scope": "reactions", + "id": "listForCommitComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for a commit comment", + "scope": "reactions", + "id": "createForCommitComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "List commits on a repository", + "scope": "repos", + "id": "listCommits", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only commits containing this file path will be returned.", + "enum": null, + "name": "path", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "GitHub login or email address by which to filter by commit author.", + "enum": null, + "name": "author", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "until", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List branches for HEAD commit", + "scope": "repos", + "id": "listBranchesForHeadCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "List comments for a single commit", + "scope": "repos", + "id": "listCommentsForCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "commit_sha", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "ref", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a commit comment", + "scope": "repos", + "id": "createCommitComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Relative path of the file to comment on.", + "enum": null, + "name": "path", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Line index in the diff to comment on.", + "enum": null, + "name": "position", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", + "enum": null, + "name": "line", + "type": "integer", + "required": false + }, + { + "alias": "commit_sha", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "sha", + "type": null, + "required": null + } + ] + }, + { + "name": "List pull requests associated with commit", + "scope": "repos", + "id": "listPullRequestsAssociatedWithCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single commit", + "scope": "repos", + "id": "getCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": "ref", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "sha", + "type": null, + "required": null + }, + { + "alias": "ref", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "commit_sha", + "type": null, + "required": null + } + ] + }, + { + "name": "List check runs for a specific ref", + "scope": "checks", + "id": "listForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns check runs with the specified `name`.", + "enum": null, + "name": "check_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "name": "status", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", + "enum": ["latest", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List check suites for a specific ref", + "scope": "checks", + "id": "listSuitesForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters check suites by GitHub App `id`.", + "enum": null, + "name": "app_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/).", + "enum": null, + "name": "check_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the combined status for a specific ref", + "scope": "repos", + "id": "getCombinedStatusForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/status", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + } + ] + }, + { + "name": "List statuses for a specific ref", + "scope": "repos", + "id": "listStatusesForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/statuses", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the contents of a repository's code of conduct", + "scope": "codesOfConduct", + "id": "getForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/community/code_of_conduct", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Retrieve community profile metrics", + "scope": "repos", + "id": "retrieveCommunityProfileMetrics", + "method": "GET", + "url": "/repos/{owner}/{repo}/community/profile", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Compare two commits", + "scope": "repos", + "id": "compareCommits", + "method": "GET", + "url": "/repos/{owner}/{repo}/compare/{base}...{head}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "base parameter", + "enum": null, + "name": "base", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "head parameter", + "enum": null, + "name": "head", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get contents", + "scope": "repos", + "id": "getContents", + "method": "GET", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "ref", + "type": "string", + "required": false + } + ] + }, + { + "name": "Create or update a file", + "scope": "repos", + "id": "createOrUpdateFile", + "method": "PUT", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new file content, using Base64 encoding.", + "enum": null, + "name": "content", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The person that committed the file. Default: the authenticated user.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.email", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.email", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create or update a file", + "scope": "repos", + "id": "createFile", + "method": "PUT", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new file content, using Base64 encoding.", + "enum": null, + "name": "content", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The person that committed the file. Default: the authenticated user.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.email", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.email", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create or update a file", + "scope": "repos", + "id": "updateFile", + "method": "PUT", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new file content, using Base64 encoding.", + "enum": null, + "name": "content", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The person that committed the file. Default: the authenticated user.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.email", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.email", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a file", + "scope": "repos", + "id": "deleteFile", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The blob SHA of the file being replaced.", + "enum": null, + "name": "sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "object containing information about the committer.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author (or committer) of the commit", + "enum": null, + "name": "committer.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author (or committer) of the commit", + "enum": null, + "name": "committer.email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "object containing information about the author.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author (or committer) of the commit", + "enum": null, + "name": "author.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author (or committer) of the commit", + "enum": null, + "name": "author.email", + "type": "string", + "required": false + } + ] + }, + { + "name": "List contributors", + "scope": "repos", + "id": "listContributors", + "method": "GET", + "url": "/repos/{owner}/{repo}/contributors", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Set to `1` or `true` to include anonymous contributors in results.", + "enum": null, + "name": "anon", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List deployments", + "scope": "repos", + "id": "listDeployments", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA recorded at creation time.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the ref. This can be a branch, tag, or SHA.", + "enum": null, + "name": "ref", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", + "enum": null, + "name": "task", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", + "enum": null, + "name": "environment", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a deployment", + "scope": "repos", + "id": "createDeployment", + "method": "POST", + "url": "/repos/{owner}/{repo}/deployments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The ref to deploy. This can be a branch, tag, or SHA.", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", + "enum": null, + "name": "task", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", + "enum": null, + "name": "auto_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", + "enum": null, + "name": "required_contexts", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "JSON payload with extra information about the deployment.", + "enum": null, + "name": "payload", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", + "enum": null, + "name": "environment", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Short description of the deployment.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "transient_environment", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "production_environment", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a single deployment", + "scope": "repos", + "id": "getDeployment", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "deployment_id parameter", + "enum": null, + "name": "deployment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List deployment statuses", + "scope": "repos", + "id": "listDeploymentStatuses", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "deployment_id parameter", + "enum": null, + "name": "deployment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a deployment status", + "scope": "repos", + "id": "createDeploymentStatus", + "method": "POST", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "deployment_id parameter", + "enum": null, + "name": "deployment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", + "enum": [ + "error", + "failure", + "inactive", + "in_progress", + "queued", + "pending", + "success" + ], + "name": "state", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", + "enum": null, + "name": "target_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "log_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the status. The maximum description length is 140 characters.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", + "enum": ["production", "staging", "qa"], + "name": "environment", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "environment_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "auto_inactive", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a single deployment status", + "scope": "repos", + "id": "getDeploymentStatus", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "deployment_id parameter", + "enum": null, + "name": "deployment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "status_id parameter", + "enum": null, + "name": "status_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Create a repository dispatch event", + "scope": "repos", + "id": "createDispatchEvent", + "method": "POST", + "url": "/repos/{owner}/{repo}/dispatches", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required:** A custom webhook event name.", + "enum": null, + "name": "event_type", + "type": "string", + "required": false + } + ] + }, + { + "name": "List downloads for a repository", + "scope": "repos", + "id": "listDownloads", + "method": "GET", + "url": "/repos/{owner}/{repo}/downloads", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single download", + "scope": "repos", + "id": "getDownload", + "method": "GET", + "url": "/repos/{owner}/{repo}/downloads/{download_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "download_id parameter", + "enum": null, + "name": "download_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a download", + "scope": "repos", + "id": "deleteDownload", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/downloads/{download_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "download_id parameter", + "enum": null, + "name": "download_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List repository events", + "scope": "activity", + "id": "listRepoEvents", + "method": "GET", + "url": "/repos/{owner}/{repo}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List forks", + "scope": "repos", + "id": "listForks", + "method": "GET", + "url": "/repos/{owner}/{repo}/forks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", + "enum": ["newest", "oldest", "stargazers"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a fork", + "scope": "repos", + "id": "createFork", + "method": "POST", + "url": "/repos/{owner}/{repo}/forks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Optional parameter to specify the organization name if forking into an organization.", + "enum": null, + "name": "organization", + "type": "string", + "required": false + } + ] + }, + { + "name": "Create a blob", + "scope": "git", + "id": "createBlob", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/blobs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new blob's content.", + "enum": null, + "name": "content", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "enum": null, + "name": "encoding", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a blob", + "scope": "git", + "id": "getBlob", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/blobs/{file_sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "file_sha parameter", + "enum": null, + "name": "file_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a commit", + "scope": "git", + "id": "createCommit", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the tree object this commit points to", + "enum": null, + "name": "tree", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "enum": null, + "name": "parents", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author (or committer) of the commit", + "enum": null, + "name": "author.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author (or committer) of the commit", + "enum": null, + "name": "author.email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "author.date", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author (or committer) of the commit", + "enum": null, + "name": "committer.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author (or committer) of the commit", + "enum": null, + "name": "committer.email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "committer.date", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", + "enum": null, + "name": "signature", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a commit", + "scope": "git", + "id": "getCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/commits/{commit_sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "List matching references", + "scope": "git", + "id": "listMatchingRefs", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/matching-refs/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single reference", + "scope": "git", + "id": "getRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/ref/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a reference", + "scope": "git", + "id": "createRef", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/refs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA1 value for this reference.", + "enum": null, + "name": "sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update a reference", + "scope": "git", + "id": "updateRef", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/git/refs/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA1 value to set this reference to", + "enum": null, + "name": "sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", + "enum": null, + "name": "force", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a reference", + "scope": "git", + "id": "deleteRef", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/git/refs/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a tag object", + "scope": "git", + "id": "createTag", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/tags", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", + "enum": null, + "name": "tag", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The tag message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the git object this is tagging.", + "enum": null, + "name": "object", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", + "enum": ["commit", "tree", "blob"], + "name": "type", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An object with information about the individual creating the tag.", + "enum": null, + "name": "tagger", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author of the tag", + "enum": null, + "name": "tagger.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author of the tag", + "enum": null, + "name": "tagger.email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "tagger.date", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a tag", + "scope": "git", + "id": "getTag", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/tags/{tag_sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "tag_sha parameter", + "enum": null, + "name": "tag_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a tree", + "scope": "git", + "id": "createTree", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/trees", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", + "enum": null, + "name": "tree", + "type": "object[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The file referenced in the tree.", + "enum": null, + "name": "tree[].path", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", + "enum": ["100644", "100755", "040000", "160000", "120000"], + "name": "tree[].mode", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `blob`, `tree`, or `commit`.", + "enum": ["blob", "tree", "commit"], + "name": "tree[].type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", + "enum": null, + "name": "tree[].sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", + "enum": null, + "name": "tree[].content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.", + "enum": null, + "name": "base_tree", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a tree", + "scope": "git", + "id": "getTree", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/trees/{tree_sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "tree_sha parameter", + "enum": null, + "name": "tree_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "recursive parameter", + "enum": ["1"], + "name": "recursive", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List hooks", + "scope": "repos", + "id": "listHooks", + "method": "GET", + "url": "/repos/{owner}/{repo}/hooks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a hook", + "scope": "repos", + "id": "createHook", + "method": "POST", + "url": "/repos/{owner}/{repo}/hooks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", + "enum": null, + "name": "config", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL to which the payloads will be delivered.", + "enum": null, + "name": "config.url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "enum": null, + "name": "config.content_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "enum": null, + "name": "config.secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "enum": null, + "name": "config.insecure_ssl", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", + "enum": null, + "name": "events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "enum": null, + "name": "active", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get single hook", + "scope": "repos", + "id": "getHook", + "method": "GET", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a hook", + "scope": "repos", + "id": "updateHook", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", + "enum": null, + "name": "config", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL to which the payloads will be delivered.", + "enum": null, + "name": "config.url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "enum": null, + "name": "config.content_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "enum": null, + "name": "config.secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "enum": null, + "name": "config.insecure_ssl", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", + "enum": null, + "name": "events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", + "enum": null, + "name": "add_events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", + "enum": null, + "name": "remove_events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "enum": null, + "name": "active", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a hook", + "scope": "repos", + "id": "deleteHook", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Ping a hook", + "scope": "repos", + "id": "pingHook", + "method": "POST", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Test a push hook", + "scope": "repos", + "id": "testPushHook", + "method": "POST", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Start an import", + "scope": "migrations", + "id": "startImport", + "method": "PUT", + "url": "/repos/{owner}/{repo}/import", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL of the originating repository.", + "enum": null, + "name": "vcs_url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", + "enum": ["subversion", "git", "mercurial", "tfvc"], + "name": "vcs", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If authentication is required, the username to provide to `vcs_url`.", + "enum": null, + "name": "vcs_username", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If authentication is required, the password to provide to `vcs_url`.", + "enum": null, + "name": "vcs_password", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "For a tfvc import, the name of the project that is being imported.", + "enum": null, + "name": "tfvc_project", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get import progress", + "scope": "migrations", + "id": "getImportProgress", + "method": "GET", + "url": "/repos/{owner}/{repo}/import", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update existing import", + "scope": "migrations", + "id": "updateImport", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/import", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The username to provide to the originating repository.", + "enum": null, + "name": "vcs_username", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The password to provide to the originating repository.", + "enum": null, + "name": "vcs_password", + "type": "string", + "required": false + } + ] + }, + { + "name": "Cancel an import", + "scope": "migrations", + "id": "cancelImport", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/import", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get commit authors", + "scope": "migrations", + "id": "getCommitAuthors", + "method": "GET", + "url": "/repos/{owner}/{repo}/import/authors", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step.", + "enum": null, + "name": "since", + "type": "string", + "required": false + } + ] + }, + { + "name": "Map a commit author", + "scope": "migrations", + "id": "mapCommitAuthor", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/import/authors/{author_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "author_id parameter", + "enum": null, + "name": "author_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new Git author email.", + "enum": null, + "name": "email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new Git author name.", + "enum": null, + "name": "name", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get large files", + "scope": "migrations", + "id": "getLargeFiles", + "method": "GET", + "url": "/repos/{owner}/{repo}/import/large_files", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Set Git LFS preference", + "scope": "migrations", + "id": "setLfsPreference", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/import/lfs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import).", + "enum": ["opt_in", "opt_out"], + "name": "use_lfs", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a repository installation", + "scope": "apps", + "id": "getRepoInstallation", + "method": "GET", + "url": "/repos/{owner}/{repo}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a repository installation", + "scope": "apps", + "id": "findRepoInstallation", + "method": "GET", + "url": "/repos/{owner}/{repo}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get interaction restrictions for a repository", + "scope": "interactions", + "id": "getRestrictionsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update interaction restrictions for a repository", + "scope": "interactions", + "id": "addOrUpdateRestrictionsForRepo", + "method": "PUT", + "url": "/repos/{owner}/{repo}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", + "enum": ["existing_users", "contributors_only", "collaborators_only"], + "name": "limit", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove interaction restrictions for a repository", + "scope": "interactions", + "id": "removeRestrictionsForRepo", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List invitations for a repository", + "scope": "repos", + "id": "listInvitations", + "method": "GET", + "url": "/repos/{owner}/{repo}/invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Delete a repository invitation", + "scope": "repos", + "id": "deleteInvitation", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update a repository invitation", + "scope": "repos", + "id": "updateInvitation", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.", + "enum": ["read", "write", "admin"], + "name": "permissions", + "type": "string", + "required": false + } + ] + }, + { + "name": "List issues for a repository", + "scope": "issues", + "id": "listForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", + "enum": null, + "name": "milestone", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", + "enum": null, + "name": "assignee", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The user that created the issue.", + "enum": null, + "name": "creator", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A user that's mentioned in the issue.", + "enum": null, + "name": "mentioned", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "enum": null, + "name": "labels", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "enum": ["created", "updated", "comments"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create an issue", + "scope": "issues", + "id": "create", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the issue.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the issue.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", + "enum": null, + "name": "assignee", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._", + "enum": null, + "name": "milestone", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", + "enum": null, + "name": "labels", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", + "enum": null, + "name": "assignees", + "type": "string[]", + "required": false + } + ] + }, + { + "name": "List comments in a repository", + "scope": "issues", + "id": "listCommentsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `created` or `updated`.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single comment", + "scope": "issues", + "id": "getComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Edit a comment", + "scope": "issues", + "id": "updateComment", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a comment", + "scope": "issues", + "id": "deleteComment", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List reactions for an issue comment", + "scope": "reactions", + "id": "listForIssueComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for an issue comment", + "scope": "reactions", + "id": "createForIssueComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "List events for a repository", + "scope": "issues", + "id": "listEventsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single event", + "scope": "issues", + "id": "getEvent", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/events/{event_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "event_id parameter", + "enum": null, + "name": "event_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get a single issue", + "scope": "issues", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Edit an issue", + "scope": "issues", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/issues/{issue_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the issue.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the issue.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", + "enum": null, + "name": "assignee", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "State of the issue. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._", + "enum": null, + "name": "milestone", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", + "enum": null, + "name": "labels", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", + "enum": null, + "name": "assignees", + "type": "string[]", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Add assignees to an issue", + "scope": "issues", + "id": "addAssignees", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", + "enum": null, + "name": "assignees", + "type": "string[]", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Remove assignees from an issue", + "scope": "issues", + "id": "removeAssignees", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", + "enum": null, + "name": "assignees", + "type": "string[]", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List comments on an issue", + "scope": "issues", + "id": "listComments", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a comment", + "scope": "issues", + "id": "createComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List events for an issue", + "scope": "issues", + "id": "listEvents", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List labels on an issue", + "scope": "issues", + "id": "listLabelsOnIssue", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Add labels to an issue", + "scope": "issues", + "id": "addLabels", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "enum": null, + "name": "labels", + "type": "string[]", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Replace all labels for an issue", + "scope": "issues", + "id": "replaceLabels", + "method": "PUT", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "enum": null, + "name": "labels", + "type": "string[]", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Remove all labels from an issue", + "scope": "issues", + "id": "removeLabels", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Remove a label from an issue", + "scope": "issues", + "id": "removeLabel", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Lock an issue", + "scope": "issues", + "id": "lock", + "method": "PUT", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", + "enum": ["off-topic", "too heated", "resolved", "spam"], + "name": "lock_reason", + "type": "string", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Unlock an issue", + "scope": "issues", + "id": "unlock", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List reactions for an issue", + "scope": "reactions", + "id": "listForIssue", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create reaction for an issue", + "scope": "reactions", + "id": "createForIssue", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List events for an issue", + "scope": "issues", + "id": "listEventsForTimeline", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List deploy keys", + "scope": "repos", + "id": "listDeployKeys", + "method": "GET", + "url": "/repos/{owner}/{repo}/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Add a new deploy key", + "scope": "repos", + "id": "addDeployKey", + "method": "POST", + "url": "/repos/{owner}/{repo}/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A name for the key.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the key.", + "enum": null, + "name": "key", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/).\"", + "enum": null, + "name": "read_only", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a deploy key", + "scope": "repos", + "id": "getDeployKey", + "method": "GET", + "url": "/repos/{owner}/{repo}/keys/{key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key_id parameter", + "enum": null, + "name": "key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Remove a deploy key", + "scope": "repos", + "id": "removeDeployKey", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/keys/{key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key_id parameter", + "enum": null, + "name": "key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List all labels for this repository", + "scope": "issues", + "id": "listLabelsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a label", + "scope": "issues", + "id": "createLabel", + "method": "POST", + "url": "/repos/{owner}/{repo}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", + "enum": null, + "name": "color", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the label.", + "enum": null, + "name": "description", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single label", + "scope": "issues", + "id": "getLabel", + "method": "GET", + "url": "/repos/{owner}/{repo}/labels/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update a label", + "scope": "issues", + "id": "updateLabel", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/labels/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", + "enum": null, + "name": "new_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", + "enum": null, + "name": "color", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the label.", + "enum": null, + "name": "description", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete a label", + "scope": "issues", + "id": "deleteLabel", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/labels/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "List languages", + "scope": "repos", + "id": "listLanguages", + "method": "GET", + "url": "/repos/{owner}/{repo}/languages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get the contents of a repository's license", + "scope": "licenses", + "id": "getForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/license", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Perform a merge", + "scope": "repos", + "id": "merge", + "method": "POST", + "url": "/repos/{owner}/{repo}/merges", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the base branch that the head will be merged into.", + "enum": null, + "name": "base", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The head to merge. This can be a branch name or a commit SHA1.", + "enum": null, + "name": "head", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", + "enum": null, + "name": "commit_message", + "type": "string", + "required": false + } + ] + }, + { + "name": "List milestones for a repository", + "scope": "issues", + "id": "listMilestonesForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/milestones", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the milestone. Either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Either `due_on` or `completeness`.", + "enum": ["due_on", "completeness"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a milestone", + "scope": "issues", + "id": "createMilestone", + "method": "POST", + "url": "/repos/{owner}/{repo}/milestones", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the milestone.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the milestone. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A description of the milestone.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "due_on", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single milestone", + "scope": "issues", + "id": "getMilestone", + "method": "GET", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "milestone_number parameter", + "enum": null, + "name": "milestone_number", + "type": "integer", + "required": true + }, + { + "alias": "milestone_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a milestone", + "scope": "issues", + "id": "updateMilestone", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "milestone_number parameter", + "enum": null, + "name": "milestone_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the milestone.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the milestone. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A description of the milestone.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "due_on", + "type": "string", + "required": false + }, + { + "alias": "milestone_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Delete a milestone", + "scope": "issues", + "id": "deleteMilestone", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "milestone_number parameter", + "enum": null, + "name": "milestone_number", + "type": "integer", + "required": true + }, + { + "alias": "milestone_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Get labels for every issue in a milestone", + "scope": "issues", + "id": "listLabelsForMilestone", + "method": "GET", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "milestone_number parameter", + "enum": null, + "name": "milestone_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "milestone_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List your notifications in a repository", + "scope": "activity", + "id": "listNotificationsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/notifications", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, show notifications marked as read.", + "enum": null, + "name": "all", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", + "enum": null, + "name": "participating", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "before", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Mark notifications as read in a repository", + "scope": "activity", + "id": "markNotificationsAsReadForRepo", + "method": "PUT", + "url": "/repos/{owner}/{repo}/notifications", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", + "enum": null, + "name": "last_read_at", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get information about a Pages site", + "scope": "repos", + "id": "getPages", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Enable a Pages site", + "scope": "repos", + "id": "enablePagesSite", + "method": "POST", + "url": "/repos/{owner}/{repo}/pages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "source parameter", + "enum": null, + "name": "source", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The repository branch used to publish your [site's source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.", + "enum": ["master", "gh-pages"], + "name": "source.branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.", + "enum": null, + "name": "source.path", + "type": "string", + "required": false + } + ] + }, + { + "name": "Disable a Pages site", + "scope": "repos", + "id": "disablePagesSite", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update information about a Pages site", + "scope": "repos", + "id": "updateInformationAboutPagesSite", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"", + "enum": null, + "name": "cname", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", + "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""], + "name": "source", + "type": "string", + "required": false + } + ] + }, + { + "name": "Request a page build", + "scope": "repos", + "id": "requestPageBuild", + "method": "POST", + "url": "/repos/{owner}/{repo}/pages/builds", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List Pages builds", + "scope": "repos", + "id": "listPagesBuilds", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages/builds", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get latest Pages build", + "scope": "repos", + "id": "getLatestPagesBuild", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages/builds/latest", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a specific Pages build", + "scope": "repos", + "id": "getPagesBuild", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages/builds/{build_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "build_id parameter", + "enum": null, + "name": "build_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List repository projects", + "scope": "projects", + "id": "listForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a repository project", + "scope": "projects", + "id": "createForRepo", + "method": "POST", + "url": "/repos/{owner}/{repo}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the project.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the project.", + "enum": null, + "name": "body", + "type": "string", + "required": false + } + ] + }, + { + "name": "List pull requests", + "scope": "pulls", + "id": "list", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `open`, `closed`, or `all` to filter by state.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", + "enum": null, + "name": "head", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter pulls by base branch name. Example: `gh-pages`.", + "enum": null, + "name": "base", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", + "enum": ["created", "updated", "popularity", "long-running"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a pull request", + "scope": "pulls", + "id": "create", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the new pull request.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", + "enum": null, + "name": "head", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", + "enum": null, + "name": "base", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the pull request.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "enum": null, + "name": "maintainer_can_modify", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", + "enum": null, + "name": "draft", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List comments in a repository", + "scope": "pulls", + "id": "listCommentsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be either `created` or `updated` comments.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single comment", + "scope": "pulls", + "id": "getComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a comment", + "scope": "pulls", + "id": "updateComment", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text of the reply to the review comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a comment", + "scope": "pulls", + "id": "deleteComment", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List reactions for a pull request review comment", + "scope": "reactions", + "id": "listForPullRequestReviewComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for a pull request review comment", + "scope": "reactions", + "id": "createForPullRequestReviewComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single pull request", + "scope": "pulls", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a pull request", + "scope": "pulls", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the pull request.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the pull request.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "State of this Pull Request. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", + "enum": null, + "name": "base", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "enum": null, + "name": "maintainer_can_modify", + "type": "boolean", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List comments on a pull request", + "scope": "pulls", + "id": "listComments", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be either `created` or `updated` comments.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a comment", + "scope": "pulls", + "id": "createComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text of the review comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", + "enum": null, + "name": "commit_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The relative path to the file that necessitates a comment.", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "enum": null, + "name": "position", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "enum": ["LEFT", "RIGHT"], + "name": "side", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "enum": null, + "name": "line", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "enum": null, + "name": "start_line", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "enum": ["LEFT", "RIGHT", "side"], + "name": "start_side", + "type": "string", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + }, + { + "alias": null, + "allowNull": null, + "deprecated": true, + "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", + "enum": null, + "name": "in_reply_to", + "type": "integer", + "required": null + } + ] + }, + { + "name": "Create a comment", + "scope": "pulls", + "id": "createCommentReply", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text of the review comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", + "enum": null, + "name": "commit_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The relative path to the file that necessitates a comment.", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "enum": null, + "name": "position", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "enum": ["LEFT", "RIGHT"], + "name": "side", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "enum": null, + "name": "line", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "enum": null, + "name": "start_line", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "enum": ["LEFT", "RIGHT", "side"], + "name": "start_side", + "type": "string", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + }, + { + "alias": null, + "allowNull": null, + "deprecated": true, + "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", + "enum": null, + "name": "in_reply_to", + "type": "integer", + "required": null + } + ] + }, + { + "name": "Create a review comment reply", + "scope": "pulls", + "id": "createReviewCommentReply", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text of the review comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "List commits on a pull request", + "scope": "pulls", + "id": "listCommits", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List pull requests files", + "scope": "pulls", + "id": "listFiles", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Get if a pull request has been merged", + "scope": "pulls", + "id": "checkIfMerged", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Merge a pull request (Merge Button)", + "scope": "pulls", + "id": "merge", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Title for the automatic commit message.", + "enum": null, + "name": "commit_title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Extra detail to append to automatic commit message.", + "enum": null, + "name": "commit_message", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "SHA that pull request head must match to allow merge.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", + "enum": ["merge", "squash", "rebase"], + "name": "merge_method", + "type": "string", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List review requests", + "scope": "pulls", + "id": "listReviewRequests", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a review request", + "scope": "pulls", + "id": "createReviewRequest", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of user `login`s that will be requested.", + "enum": null, + "name": "reviewers", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of team `slug`s that will be requested.", + "enum": null, + "name": "team_reviewers", + "type": "string[]", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Delete a review request", + "scope": "pulls", + "id": "deleteReviewRequest", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of user `login`s that will be removed.", + "enum": null, + "name": "reviewers", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of team `slug`s that will be removed.", + "enum": null, + "name": "team_reviewers", + "type": "string[]", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List reviews on a pull request", + "scope": "pulls", + "id": "listReviews", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a pull request review", + "scope": "pulls", + "id": "createReview", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", + "enum": null, + "name": "commit_id", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", + "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], + "name": "event", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", + "enum": null, + "name": "comments", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The relative path to the file that necessitates a review comment.", + "enum": null, + "name": "comments[].path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", + "enum": null, + "name": "comments[].position", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Text of the review comment.", + "enum": null, + "name": "comments[].body", + "type": "string", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Get a single review", + "scope": "pulls", + "id": "getReview", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Delete a pending review", + "scope": "pulls", + "id": "deletePendingReview", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a pull request review", + "scope": "pulls", + "id": "updateReview", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The body text of the pull request review.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Get comments for a single review", + "scope": "pulls", + "id": "getCommentsForReview", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Dismiss a pull request review", + "scope": "pulls", + "id": "dismissReview", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The message for the pull request review dismissal", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Submit a pull request review", + "scope": "pulls", + "id": "submitReview", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The body text of the pull request review", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", + "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], + "name": "event", + "type": "string", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a pull request branch", + "scope": "pulls", + "id": "updateBranch", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", + "enum": null, + "name": "expected_head_sha", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get the README", + "scope": "repos", + "id": "getReadme", + "method": "GET", + "url": "/repos/{owner}/{repo}/readme", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "ref", + "type": "string", + "required": false + } + ] + }, + { + "name": "List releases for a repository", + "scope": "repos", + "id": "listReleases", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a release", + "scope": "repos", + "id": "createRelease", + "method": "POST", + "url": "/repos/{owner}/{repo}/releases", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the tag.", + "enum": null, + "name": "tag_name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", + "enum": null, + "name": "target_commitish", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the release.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Text describing the contents of the tag.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", + "enum": null, + "name": "draft", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", + "enum": null, + "name": "prerelease", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a single release asset", + "scope": "repos", + "id": "getReleaseAsset", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "asset_id parameter", + "enum": null, + "name": "asset_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a release asset", + "scope": "repos", + "id": "updateReleaseAsset", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "asset_id parameter", + "enum": null, + "name": "asset_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The file name of the asset.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An alternate short description of the asset. Used in place of the filename.", + "enum": null, + "name": "label", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete a release asset", + "scope": "repos", + "id": "deleteReleaseAsset", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "asset_id parameter", + "enum": null, + "name": "asset_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get the latest release", + "scope": "repos", + "id": "getLatestRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/latest", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a release by tag name", + "scope": "repos", + "id": "getReleaseByTag", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/tags/{tag}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "tag parameter", + "enum": null, + "name": "tag", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single release", + "scope": "repos", + "id": "getRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "release_id parameter", + "enum": null, + "name": "release_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a release", + "scope": "repos", + "id": "updateRelease", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "release_id parameter", + "enum": null, + "name": "release_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the tag.", + "enum": null, + "name": "tag_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", + "enum": null, + "name": "target_commitish", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the release.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Text describing the contents of the tag.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` makes the release a draft, and `false` publishes the release.", + "enum": null, + "name": "draft", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", + "enum": null, + "name": "prerelease", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a release", + "scope": "repos", + "id": "deleteRelease", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "release_id parameter", + "enum": null, + "name": "release_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List assets for a release", + "scope": "repos", + "id": "listAssetsForRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/{release_id}/assets", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "release_id parameter", + "enum": null, + "name": "release_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List Stargazers", + "scope": "activity", + "id": "listStargazersForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/stargazers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the number of additions and deletions per week", + "scope": "repos", + "id": "getCodeFrequencyStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/code_frequency", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get the last year of commit activity data", + "scope": "repos", + "id": "getCommitActivityStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/commit_activity", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get contributors list with additions, deletions, and commit counts", + "scope": "repos", + "id": "getContributorsStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/contributors", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get the weekly commit count for the repository owner and everyone else", + "scope": "repos", + "id": "getParticipationStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/participation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get the number of commits per hour in each day", + "scope": "repos", + "id": "getPunchCardStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/punch_card", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a status", + "scope": "repos", + "id": "createStatus", + "method": "POST", + "url": "/repos/{owner}/{repo}/statuses/{sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "sha parameter", + "enum": null, + "name": "sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", + "enum": ["error", "failure", "pending", "success"], + "name": "state", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", + "enum": null, + "name": "target_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the status.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A string label to differentiate this status from the status of other systems.", + "enum": null, + "name": "context", + "type": "string", + "required": false + } + ] + }, + { + "name": "List watchers", + "scope": "activity", + "id": "listWatchersForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/subscribers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a Repository Subscription", + "scope": "activity", + "id": "getRepoSubscription", + "method": "GET", + "url": "/repos/{owner}/{repo}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Set a Repository Subscription", + "scope": "activity", + "id": "setRepoSubscription", + "method": "PUT", + "url": "/repos/{owner}/{repo}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications should be received from this repository.", + "enum": null, + "name": "subscribed", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if all notifications should be blocked from this repository.", + "enum": null, + "name": "ignored", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a Repository Subscription", + "scope": "activity", + "id": "deleteRepoSubscription", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List tags", + "scope": "repos", + "id": "listTags", + "method": "GET", + "url": "/repos/{owner}/{repo}/tags", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List teams", + "scope": "repos", + "id": "listTeams", + "method": "GET", + "url": "/repos/{owner}/{repo}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all topics for a repository", + "scope": "repos", + "id": "listTopics", + "method": "GET", + "url": "/repos/{owner}/{repo}/topics", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace all topics for a repository", + "scope": "repos", + "id": "replaceTopics", + "method": "PUT", + "url": "/repos/{owner}/{repo}/topics", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", + "enum": null, + "name": "names", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Clones", + "scope": "repos", + "id": "getClones", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/clones", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Must be one of: `day`, `week`.", + "enum": ["day", "week"], + "name": "per", + "type": "string", + "required": false + } + ] + }, + { + "name": "List paths", + "scope": "repos", + "id": "getTopPaths", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/popular/paths", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List referrers", + "scope": "repos", + "id": "getTopReferrers", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/popular/referrers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Views", + "scope": "repos", + "id": "getViews", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/views", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Must be one of: `day`, `week`.", + "enum": ["day", "week"], + "name": "per", + "type": "string", + "required": false + } + ] + }, + { + "name": "Transfer a repository", + "scope": "repos", + "id": "transfer", + "method": "POST", + "url": "/repos/{owner}/{repo}/transfer", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required:** The username or organization name the repository will be transferred to.", + "enum": null, + "name": "new_owner", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", + "enum": null, + "name": "team_ids", + "type": "integer[]", + "required": false + } + ] + }, + { + "name": "Check if vulnerability alerts are enabled for a repository", + "scope": "repos", + "id": "checkVulnerabilityAlerts", + "method": "GET", + "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Enable vulnerability alerts", + "scope": "repos", + "id": "enableVulnerabilityAlerts", + "method": "PUT", + "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Disable vulnerability alerts", + "scope": "repos", + "id": "disableVulnerabilityAlerts", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get archive link", + "scope": "repos", + "id": "getArchiveLink", + "method": "GET", + "url": "/repos/{owner}/{repo}/{archive_format}/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "archive_format parameter", + "enum": null, + "name": "archive_format", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create repository using a repository template", + "scope": "repos", + "id": "createUsingTemplate", + "method": "POST", + "url": "/repos/{template_owner}/{template_repo}/generate", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "template_owner parameter", + "enum": null, + "name": "template_owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "template_repo parameter", + "enum": null, + "name": "template_repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", + "enum": null, + "name": "owner", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the new repository.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the new repository.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to create a new private repository or `false` to create a new public one.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List all public repositories", + "scope": "repos", + "id": "listPublic", + "method": "GET", + "url": "/repositories", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The integer ID of the last Repository that you've seen.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a list of provisioned identities", + "scope": "scim", + "id": "listProvisionedIdentities", + "method": "GET", + "url": "/scim/v2/organizations/{org}/Users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Used for pagination: the index of the first result to return.", + "enum": null, + "name": "startIndex", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Used for pagination: the number of results to return.", + "enum": null, + "name": "count", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: `?filter=userName%20eq%20\\\"Octocat\\\"`.", + "enum": null, + "name": "filter", + "type": "string", + "required": false + } + ] + }, + { + "name": "Provision and invite users", + "scope": "scim", + "id": "provisionAndInviteUsers", + "method": "POST", + "url": "/scim/v2/organizations/{org}/Users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Provision and invite users", + "scope": "scim", + "id": "provisionInviteUsers", + "method": "POST", + "url": "/scim/v2/organizations/{org}/Users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get provisioning details for a single user", + "scope": "scim", + "id": "getProvisioningDetailsForUser", + "method": "GET", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Replace a provisioned user's information", + "scope": "scim", + "id": "replaceProvisionedUserInformation", + "method": "PUT", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Replace a provisioned user's information", + "scope": "scim", + "id": "updateProvisionedOrgMembership", + "method": "PUT", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a user attribute", + "scope": "scim", + "id": "updateUserAttribute", + "method": "PATCH", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Remove a user from the organization", + "scope": "scim", + "id": "removeUserFromOrg", + "method": "DELETE", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Search code", + "scope": "search", + "id": "code", + "method": "GET", + "url": "/search/code", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["indexed"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search commits", + "scope": "search", + "id": "commits", + "method": "GET", + "url": "/search/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["author-date", "committer-date"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search issues and pull requests", + "scope": "search", + "id": "issuesAndPullRequests", + "method": "GET", + "url": "/search/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": [ + "comments", + "reactions", + "reactions-+1", + "reactions--1", + "reactions-smile", + "reactions-thinking_face", + "reactions-heart", + "reactions-tada", + "interactions", + "created", + "updated" + ], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search issues and pull requests", + "scope": "search", + "id": "issues", + "method": "GET", + "url": "/search/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": [ + "comments", + "reactions", + "reactions-+1", + "reactions--1", + "reactions-smile", + "reactions-thinking_face", + "reactions-heart", + "reactions-tada", + "interactions", + "created", + "updated" + ], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search labels", + "scope": "search", + "id": "labels", + "method": "GET", + "url": "/search/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The id of the repository.", + "enum": null, + "name": "repository_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + } + ] + }, + { + "name": "Search repositories", + "scope": "search", + "id": "repos", + "method": "GET", + "url": "/search/repositories", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["stars", "forks", "help-wanted-issues", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search topics", + "scope": "search", + "id": "topics", + "method": "GET", + "url": "/search/topics", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", + "enum": null, + "name": "q", + "type": "string", + "required": true + } + ] + }, + { + "name": "Search users", + "scope": "search", + "id": "users", + "method": "GET", + "url": "/search/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["followers", "repositories", "joined"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get team", + "scope": "teams", + "id": "get", + "method": "GET", + "url": "/teams/{team_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit team", + "scope": "teams", + "id": "update", + "method": "PATCH", + "url": "/teams/{team_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the team.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the team.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "enum": ["secret", "closed"], + "name": "privacy", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "enum": ["pull", "push", "admin"], + "name": "permission", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.", + "enum": null, + "name": "parent_team_id", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Delete team", + "scope": "teams", + "id": "delete", + "method": "DELETE", + "url": "/teams/{team_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List discussions", + "scope": "teams", + "id": "listDiscussions", + "method": "GET", + "url": "/teams/{team_id}/discussions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a discussion", + "scope": "teams", + "id": "createDiscussion", + "method": "POST", + "url": "/teams/{team_id}/discussions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion post's title.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion post's body text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a single discussion", + "scope": "teams", + "id": "getDiscussion", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a discussion", + "scope": "teams", + "id": "updateDiscussion", + "method": "PATCH", + "url": "/teams/{team_id}/discussions/{discussion_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion post's title.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion post's body text.", + "enum": null, + "name": "body", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete a discussion", + "scope": "teams", + "id": "deleteDiscussion", + "method": "DELETE", + "url": "/teams/{team_id}/discussions/{discussion_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List comments", + "scope": "teams", + "id": "listDiscussionComments", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a comment", + "scope": "teams", + "id": "createDiscussionComment", + "method": "POST", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion comment's body text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single comment", + "scope": "teams", + "id": "getDiscussionComment", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a comment", + "scope": "teams", + "id": "updateDiscussionComment", + "method": "PATCH", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion comment's body text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a comment", + "scope": "teams", + "id": "deleteDiscussionComment", + "method": "DELETE", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List reactions for a team discussion comment", + "scope": "reactions", + "id": "listForTeamDiscussionComment", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for a team discussion comment", + "scope": "reactions", + "id": "createForTeamDiscussionComment", + "method": "POST", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "List reactions for a team discussion", + "scope": "reactions", + "id": "listForTeamDiscussion", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for a team discussion", + "scope": "reactions", + "id": "createForTeamDiscussion", + "method": "POST", + "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "List pending team invitations", + "scope": "teams", + "id": "listPendingInvitations", + "method": "GET", + "url": "/teams/{team_id}/invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List team members", + "scope": "teams", + "id": "listMembers", + "method": "GET", + "url": "/teams/{team_id}/members", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", + "enum": ["member", "maintainer", "all"], + "name": "role", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get team member", + "scope": "teams", + "id": "getMember", + "method": "GET", + "url": "/teams/{team_id}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add team member", + "scope": "teams", + "id": "addMember", + "method": "PUT", + "url": "/teams/{team_id}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove team member", + "scope": "teams", + "id": "removeMember", + "method": "DELETE", + "url": "/teams/{team_id}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get team membership", + "scope": "teams", + "id": "getMembership", + "method": "GET", + "url": "/teams/{team_id}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update team membership", + "scope": "teams", + "id": "addOrUpdateMembership", + "method": "PUT", + "url": "/teams/{team_id}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", + "enum": ["member", "maintainer"], + "name": "role", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove team membership", + "scope": "teams", + "id": "removeMembership", + "method": "DELETE", + "url": "/teams/{team_id}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List team projects", + "scope": "teams", + "id": "listProjects", + "method": "GET", + "url": "/teams/{team_id}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Review a team project", + "scope": "teams", + "id": "reviewProject", + "method": "GET", + "url": "/teams/{team_id}/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Add or update team project", + "scope": "teams", + "id": "addOrUpdateProject", + "method": "PUT", + "url": "/teams/{team_id}/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.", + "enum": ["read", "write", "admin"], + "name": "permission", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove team project", + "scope": "teams", + "id": "removeProject", + "method": "DELETE", + "url": "/teams/{team_id}/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List team repos", + "scope": "teams", + "id": "listRepos", + "method": "GET", + "url": "/teams/{team_id}/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if a team manages a repository", + "scope": "teams", + "id": "checkManagesRepo", + "method": "GET", + "url": "/teams/{team_id}/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update team repository", + "scope": "teams", + "id": "addOrUpdateRepo", + "method": "PUT", + "url": "/teams/{team_id}/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team.", + "enum": ["pull", "push", "admin"], + "name": "permission", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove team repository", + "scope": "teams", + "id": "removeRepo", + "method": "DELETE", + "url": "/teams/{team_id}/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List IdP groups for a team", + "scope": "teams", + "id": "listIdPGroups", + "method": "GET", + "url": "/teams/{team_id}/team-sync/group-mappings", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Create or update IdP group connections", + "scope": "teams", + "id": "createOrUpdateIdPGroupConnections", + "method": "PATCH", + "url": "/teams/{team_id}/team-sync/group-mappings", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", + "enum": null, + "name": "groups", + "type": "object[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ID of the IdP group.", + "enum": null, + "name": "groups[].group_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Name of the IdP group.", + "enum": null, + "name": "groups[].group_name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Description of the IdP group.", + "enum": null, + "name": "groups[].group_description", + "type": "string", + "required": true + } + ] + }, + { + "name": "List child teams", + "scope": "teams", + "id": "listChild", + "method": "GET", + "url": "/teams/{team_id}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the authenticated user", + "scope": "users", + "id": "getAuthenticated", + "method": "GET", + "url": "/user", + "parameters": [] + }, + { + "name": "Update the authenticated user", + "scope": "users", + "id": "updateAuthenticated", + "method": "PATCH", + "url": "/user", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new name of the user.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The publicly visible email address of the user.", + "enum": null, + "name": "email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new blog URL of the user.", + "enum": null, + "name": "blog", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new company of the user.", + "enum": null, + "name": "company", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new location of the user.", + "enum": null, + "name": "location", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new hiring availability of the user.", + "enum": null, + "name": "hireable", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new short biography of the user.", + "enum": null, + "name": "bio", + "type": "string", + "required": false + } + ] + }, + { + "name": "List blocked users", + "scope": "users", + "id": "listBlocked", + "method": "GET", + "url": "/user/blocks", + "parameters": [] + }, + { + "name": "Check whether you've blocked a user", + "scope": "users", + "id": "checkBlocked", + "method": "GET", + "url": "/user/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Block a user", + "scope": "users", + "id": "block", + "method": "PUT", + "url": "/user/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unblock a user", + "scope": "users", + "id": "unblock", + "method": "DELETE", + "url": "/user/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Toggle primary email visibility", + "scope": "users", + "id": "togglePrimaryEmailVisibility", + "method": "PATCH", + "url": "/user/email/visibility", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify the _primary_ email address that needs a visibility change.", + "enum": null, + "name": "email", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Use `public` to enable an authenticated user to view the specified email address, or use `private` so this primary email address cannot be seen publicly.", + "enum": null, + "name": "visibility", + "type": "string", + "required": true + } + ] + }, + { + "name": "List email addresses for a user", + "scope": "users", + "id": "listEmails", + "method": "GET", + "url": "/user/emails", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Add email address(es)", + "scope": "users", + "id": "addEmails", + "method": "POST", + "url": "/user/emails", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "enum": null, + "name": "emails", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Delete email address(es)", + "scope": "users", + "id": "deleteEmails", + "method": "DELETE", + "url": "/user/emails", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "enum": null, + "name": "emails", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "List the authenticated user's followers", + "scope": "users", + "id": "listFollowersForAuthenticatedUser", + "method": "GET", + "url": "/user/followers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List who the authenticated user is following", + "scope": "users", + "id": "listFollowingForAuthenticatedUser", + "method": "GET", + "url": "/user/following", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if you are following a user", + "scope": "users", + "id": "checkFollowing", + "method": "GET", + "url": "/user/following/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Follow a user", + "scope": "users", + "id": "follow", + "method": "PUT", + "url": "/user/following/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unfollow a user", + "scope": "users", + "id": "unfollow", + "method": "DELETE", + "url": "/user/following/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List your GPG keys", + "scope": "users", + "id": "listGpgKeys", + "method": "GET", + "url": "/user/gpg_keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a GPG key", + "scope": "users", + "id": "createGpgKey", + "method": "POST", + "url": "/user/gpg_keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Your GPG key, generated in ASCII-armored format. See \"[Generating a new GPG key](https://help.github.com/articles/generating-a-new-gpg-key/)\" for help creating a GPG key.", + "enum": null, + "name": "armored_public_key", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single GPG key", + "scope": "users", + "id": "getGpgKey", + "method": "GET", + "url": "/user/gpg_keys/{gpg_key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gpg_key_id parameter", + "enum": null, + "name": "gpg_key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a GPG key", + "scope": "users", + "id": "deleteGpgKey", + "method": "DELETE", + "url": "/user/gpg_keys/{gpg_key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gpg_key_id parameter", + "enum": null, + "name": "gpg_key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List installations for a user", + "scope": "apps", + "id": "listInstallationsForAuthenticatedUser", + "method": "GET", + "url": "/user/installations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List repositories accessible to the user for an installation", + "scope": "apps", + "id": "listInstallationReposForAuthenticatedUser", + "method": "GET", + "url": "/user/installations/{installation_id}/repositories", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Add repository to installation", + "scope": "apps", + "id": "addRepoToInstallation", + "method": "PUT", + "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repository_id parameter", + "enum": null, + "name": "repository_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Remove repository from installation", + "scope": "apps", + "id": "removeRepoFromInstallation", + "method": "DELETE", + "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repository_id parameter", + "enum": null, + "name": "repository_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List all issues across owned and member repositories assigned to the authenticated user", + "scope": "issues", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "enum": null, + "name": "labels", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "enum": ["created", "updated", "comments"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List your public keys", + "scope": "users", + "id": "listPublicKeys", + "method": "GET", + "url": "/user/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a public key", + "scope": "users", + "id": "createPublicKey", + "method": "POST", + "url": "/user/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key \"Personal MacBook Air\".", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The public SSH key to add to your GitHub account. See \"[Generating a new SSH key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)\" for guidance on how to create a public SSH key.", + "enum": null, + "name": "key", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single public key", + "scope": "users", + "id": "getPublicKey", + "method": "GET", + "url": "/user/keys/{key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key_id parameter", + "enum": null, + "name": "key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a public key", + "scope": "users", + "id": "deletePublicKey", + "method": "DELETE", + "url": "/user/keys/{key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key_id parameter", + "enum": null, + "name": "key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get a user's Marketplace purchases", + "scope": "apps", + "id": "listMarketplacePurchasesForAuthenticatedUser", + "method": "GET", + "url": "/user/marketplace_purchases", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a user's Marketplace purchases (stubbed)", + "scope": "apps", + "id": "listMarketplacePurchasesForAuthenticatedUserStubbed", + "method": "GET", + "url": "/user/marketplace_purchases/stubbed", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List your organization memberships", + "scope": "orgs", + "id": "listMemberships", + "method": "GET", + "url": "/user/memberships/orgs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.", + "enum": ["active", "pending"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get your organization membership", + "scope": "orgs", + "id": "getMembershipForAuthenticatedUser", + "method": "GET", + "url": "/user/memberships/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Edit your organization membership", + "scope": "orgs", + "id": "updateMembership", + "method": "PATCH", + "url": "/user/memberships/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", + "enum": ["active"], + "name": "state", + "type": "string", + "required": true + } + ] + }, + { + "name": "Start a user migration", + "scope": "migrations", + "id": "startForAuthenticatedUser", + "method": "POST", + "url": "/user/migrations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of repositories to include in the migration.", + "enum": null, + "name": "repositories", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Locks the `repositories` to prevent changes during the migration when set to `true`.", + "enum": null, + "name": "lock_repositories", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Does not include attachments uploaded to GitHub.com in the migration data when set to `true`. Excluding attachments will reduce the migration archive file size.", + "enum": null, + "name": "exclude_attachments", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a list of user migrations", + "scope": "migrations", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/migrations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the status of a user migration", + "scope": "migrations", + "id": "getStatusForAuthenticatedUser", + "method": "GET", + "url": "/user/migrations/{migration_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Download a user migration archive", + "scope": "migrations", + "id": "getArchiveForAuthenticatedUser", + "method": "GET", + "url": "/user/migrations/{migration_id}/archive", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a user migration archive", + "scope": "migrations", + "id": "deleteArchiveForAuthenticatedUser", + "method": "DELETE", + "url": "/user/migrations/{migration_id}/archive", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Unlock a user repository", + "scope": "migrations", + "id": "unlockRepoForAuthenticatedUser", + "method": "DELETE", + "url": "/user/migrations/{migration_id}/repos/{repo_name}/lock", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo_name parameter", + "enum": null, + "name": "repo_name", + "type": "string", + "required": true + } + ] + }, + { + "name": "List your organizations", + "scope": "orgs", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/orgs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a user project", + "scope": "projects", + "id": "createForAuthenticatedUser", + "method": "POST", + "url": "/user/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the project.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the project.", + "enum": null, + "name": "body", + "type": "string", + "required": false + } + ] + }, + { + "name": "List public email addresses for a user", + "scope": "users", + "id": "listPublicEmails", + "method": "GET", + "url": "/user/public_emails", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List your repositories", + "scope": "repos", + "id": "list", + "method": "GET", + "url": "/user/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `all`, `public`, or `private`.", + "enum": ["all", "public", "private"], + "name": "visibility", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", + "enum": null, + "name": "affiliation", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "enum": ["all", "owner", "public", "private", "member"], + "name": "type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "enum": ["created", "updated", "pushed", "full_name"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Creates a new repository for the authenticated user", + "scope": "repos", + "id": "createForAuthenticatedUser", + "method": "POST", + "url": "/user/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the repository.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the repository.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL with more information about the repository.", + "enum": null, + "name": "homepage", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "enum": null, + "name": "has_issues", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "enum": null, + "name": "has_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "enum": null, + "name": "has_wiki", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "enum": null, + "name": "is_template", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", + "enum": null, + "name": "team_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Pass `true` to create an initial commit with empty README.", + "enum": null, + "name": "auto_init", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", + "enum": null, + "name": "gitignore_template", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", + "enum": null, + "name": "license_template", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "enum": null, + "name": "allow_squash_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "enum": null, + "name": "allow_merge_commit", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "enum": null, + "name": "allow_rebase_merge", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List a user's repository invitations", + "scope": "repos", + "id": "listInvitationsForAuthenticatedUser", + "method": "GET", + "url": "/user/repository_invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Accept a repository invitation", + "scope": "repos", + "id": "acceptInvitation", + "method": "PATCH", + "url": "/user/repository_invitations/{invitation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Decline a repository invitation", + "scope": "repos", + "id": "declineInvitation", + "method": "DELETE", + "url": "/user/repository_invitations/{invitation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List repositories being starred by the authenticated user", + "scope": "activity", + "id": "listReposStarredByAuthenticatedUser", + "method": "GET", + "url": "/user/starred", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "One of `asc` (ascending) or `desc` (descending).", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if you are starring a repository", + "scope": "activity", + "id": "checkStarringRepo", + "method": "GET", + "url": "/user/starred/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Star a repository", + "scope": "activity", + "id": "starRepo", + "method": "PUT", + "url": "/user/starred/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unstar a repository", + "scope": "activity", + "id": "unstarRepo", + "method": "DELETE", + "url": "/user/starred/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List repositories being watched by the authenticated user", + "scope": "activity", + "id": "listWatchedReposForAuthenticatedUser", + "method": "GET", + "url": "/user/subscriptions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if you are watching a repository (LEGACY)", + "scope": "activity", + "id": "checkWatchingRepoLegacy", + "method": "GET", + "url": "/user/subscriptions/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Watch a repository (LEGACY)", + "scope": "activity", + "id": "watchRepoLegacy", + "method": "PUT", + "url": "/user/subscriptions/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Stop watching a repository (LEGACY)", + "scope": "activity", + "id": "stopWatchingRepoLegacy", + "method": "DELETE", + "url": "/user/subscriptions/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List user teams", + "scope": "teams", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get all users", + "scope": "users", + "id": "list", + "method": "GET", + "url": "/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The integer ID of the last User that you've seen.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single user", + "scope": "users", + "id": "getByUsername", + "method": "GET", + "url": "/users/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List events performed by a user", + "scope": "activity", + "id": "listEventsForUser", + "method": "GET", + "url": "/users/{username}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List events for an organization", + "scope": "activity", + "id": "listEventsForOrg", + "method": "GET", + "url": "/users/{username}/events/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List public events performed by a user", + "scope": "activity", + "id": "listPublicEventsForUser", + "method": "GET", + "url": "/users/{username}/events/public", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List a user's followers", + "scope": "users", + "id": "listFollowersForUser", + "method": "GET", + "url": "/users/{username}/followers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List who a user is following", + "scope": "users", + "id": "listFollowingForUser", + "method": "GET", + "url": "/users/{username}/following", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if one user follows another", + "scope": "users", + "id": "checkFollowingForUser", + "method": "GET", + "url": "/users/{username}/following/{target_user}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "target_user parameter", + "enum": null, + "name": "target_user", + "type": "string", + "required": true + } + ] + }, + { + "name": "List public gists for the specified user", + "scope": "gists", + "id": "listPublicForUser", + "method": "GET", + "url": "/users/{username}/gists", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List GPG keys for a user", + "scope": "users", + "id": "listGpgKeysForUser", + "method": "GET", + "url": "/users/{username}/gpg_keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get contextual information about a user", + "scope": "users", + "id": "getContextForUser", + "method": "GET", + "url": "/users/{username}/hovercard", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.", + "enum": ["organization", "repository", "issue", "pull_request"], + "name": "subject_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", + "enum": null, + "name": "subject_id", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a user installation", + "scope": "apps", + "id": "getUserInstallation", + "method": "GET", + "url": "/users/{username}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a user installation", + "scope": "apps", + "id": "findUserInstallation", + "method": "GET", + "url": "/users/{username}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List public keys for a user", + "scope": "users", + "id": "listPublicKeysForUser", + "method": "GET", + "url": "/users/{username}/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List user organizations", + "scope": "orgs", + "id": "listForUser", + "method": "GET", + "url": "/users/{username}/orgs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List user projects", + "scope": "projects", + "id": "listForUser", + "method": "GET", + "url": "/users/{username}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List events that a user has received", + "scope": "activity", + "id": "listReceivedEventsForUser", + "method": "GET", + "url": "/users/{username}/received_events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List public events that a user has received", + "scope": "activity", + "id": "listReceivedPublicEventsForUser", + "method": "GET", + "url": "/users/{username}/received_events/public", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List user repositories", + "scope": "repos", + "id": "listForUser", + "method": "GET", + "url": "/users/{username}/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `all`, `owner`, `member`.", + "enum": ["all", "owner", "member"], + "name": "type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "enum": ["created", "updated", "pushed", "full_name"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List repositories being starred by a user", + "scope": "activity", + "id": "listReposStarredByUser", + "method": "GET", + "url": "/users/{username}/starred", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "One of `asc` (ascending) or `desc` (descending).", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List repositories being watched by a user", + "scope": "activity", + "id": "listReposWatchedByUser", + "method": "GET", + "url": "/users/{username}/subscriptions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + } +] diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template new file mode 100644 index 00000000..2eceb2f9 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template @@ -0,0 +1,33 @@ +// DO NOT EDIT THIS FILE +import { RequestHeaders } from "../RequestHeaders"; +import { RequestRequestOptions } from "../RequestRequestOptions"; +import { Url } from "../Url"; + +export interface Endpoints { + {{#each endpointsByRoute}} + "{{@key}}": [{{union this "optionsTypeName"}}, {{union this "requestOptionsTypeName"}}] + {{/each}} +} + +{{#each options}} +type {{in.name}} = { +{{#each in.parameters}} + {{&jsdoc}} + {{{name this}}}: {{{type this}}} +{{/each}} +} +type {{out.name}} = { + method: "{{out.method}}", + url: Url, + headers: RequestHeaders, + request: RequestRequestOptions +} +{{/each}} + +{{#childParams}} +export type {{paramTypeName}} = { +{{#params}} + {{{name this}}}: {{{type this}}} +{{/params}} +}; +{{/childParams}} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/typescript.js b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/typescript.js new file mode 100644 index 00000000..2095c6c2 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/scripts/update-endpoints/typescript.js @@ -0,0 +1,179 @@ +const { readFileSync, writeFileSync } = require("fs"); +const { resolve } = require("path"); + +const Handlebars = require("handlebars"); +const set = require("lodash.set"); +const pascalCase = require("pascal-case"); +const prettier = require("prettier"); +const { stringToJsdocComment } = require("string-to-jsdoc-comment"); +const sortKeys = require("sort-keys"); + +const ENDPOINTS = require("./generated/Endpoints.json"); +const ENDPOINTS_PATH = resolve( + process.cwd(), + "src", + "generated", + "Endpoints.ts" +); +const ENDPOINTS_TEMPLATE_PATH = resolve( + process.cwd(), + "scripts", + "update-endpoints", + "templates", + "endpoints.ts.template" +); + +Handlebars.registerHelper("union", function(endpoints, key) { + return endpoints.map(endpoint => endpoint[key]).join(" | "); +}); +Handlebars.registerHelper("name", function(parameter) { + let name = parameter.key; + + if (/[.\[]/.test(name)) { + name = `"${name}"`; + } + + if (parameter.required) { + return name; + } + + return `${name}?`; +}); + +Handlebars.registerHelper("type", function(parameter) { + const type = typeMap[parameter.type] || parameter.type; + + if (parameter.allowNull) { + return `${type} | null`; + } + + return type; +}); +const template = Handlebars.compile( + readFileSync(ENDPOINTS_TEMPLATE_PATH, "utf8") +); + +const endpointsByRoute = {}; + +const typeMap = { + integer: "number", + "integer[]": "number[]" +}; + +for (const endpoint of ENDPOINTS) { + const route = `${endpoint.method} ${endpoint.url.replace( + /\{([^}]+)}/g, + ":$1" + )}`; + + if (!endpointsByRoute[route]) { + endpointsByRoute[route] = []; + } + + endpointsByRoute[route].push({ + optionsTypeName: + pascalCase(`${endpoint.scope} ${endpoint.id}`) + "Endpoint", + requestOptionsTypeName: + pascalCase(`${endpoint.scope} ${endpoint.id}`) + "RequestOptions" + }); +} + +const options = []; +const childParams = {}; + +for (const endpoint of ENDPOINTS) { + const { method, parameters } = endpoint; + + const optionsTypeName = + pascalCase(`${endpoint.scope} ${endpoint.id}`) + "Endpoint"; + const requestOptionsTypeName = + pascalCase(`${endpoint.scope} ${endpoint.id}`) + "RequestOptions"; + + options.push({ + in: { + name: optionsTypeName, + parameters: parameters + .map(parameterize) + // handle "object" & "object[]" types + .map(parameter => { + if (parameter.deprecated) { + return; + } + + const namespacedParamsName = pascalCase( + `${endpoint.scope}.${endpoint.id}.Params` + ); + + if (parameter.type === "object" || parameter.type === "object[]") { + const childParamsName = pascalCase( + `${namespacedParamsName}.${parameter.key}` + ); + + parameter.type = parameter.type.replace("object", childParamsName); + + if (!childParams[childParamsName]) { + childParams[childParamsName] = {}; + } + } + + if (!/\./.test(parameter.key)) { + return parameter; + } + + const childKey = parameter.key.split(".").pop(); + const parentKey = parameter.key.replace(/\.[^.]+$/, ""); + + parameter.key = childKey; + + const childParamsName = pascalCase( + `${namespacedParamsName}.${parentKey}` + ); + set(childParams, `${childParamsName}.${childKey}`, parameter); + }) + .filter(Boolean) + }, + out: { + name: requestOptionsTypeName, + method + } + }); +} + +const result = template({ + endpointsByRoute: sortKeys(endpointsByRoute, { deep: true }), + options, + childParams: Object.keys(childParams).map(key => { + if (key === "GistsCreateParamsFiles") { + debugger; + } + return { + paramTypeName: key, + params: Object.values(childParams[key]) + }; + }) +}); + +writeFileSync( + ENDPOINTS_PATH, + prettier.format(result, { parser: "typescript" }) +); +console.log(`${ENDPOINTS_PATH} updated.`); + +function parameterize(parameter) { + const key = parameter.name; + const type = typeMap[parameter.type] || parameter.type; + const enums = parameter.enum + ? parameter.enum.map(JSON.stringify).join("|") + : null; + + return { + name: pascalCase(key), + key: key, + required: parameter.required, + type: enums || type, + alias: parameter.alias, + deprecated: parameter.deprecated, + allowNull: parameter.allowNull, + jsdoc: stringToJsdocComment(parameter.description) + }; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/AuthInterface.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/AuthInterface.ts new file mode 100644 index 00000000..8f587436 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/AuthInterface.ts @@ -0,0 +1,43 @@ +import { EndpointOptions } from "./EndpointOptions"; +import { OctokitResponse } from "./OctokitResponse"; +import { RequestInterface } from "./RequestInterface"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; + +/** + * Interface to implement complex authentication strategies for Octokit. + * An object Implementing the AuthInterface can directly be passed as the + * `auth` option in the Octokit constructor. + * + * For the official implementations of the most common authentication + * strategies, see https://github.com/octokit/auth.js + */ +export interface AuthInterface< + AuthOptions extends any[], + Authentication extends any +> { + (...args: AuthOptions): Promise; + + hook: { + /** + * Sends a request using the passed `request` instance + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: RequestInterface, options: EndpointOptions): Promise< + OctokitResponse + >; + + /** + * Sends a request using the passed `request` instance + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + ( + request: RequestInterface, + route: Route, + parameters?: RequestParameters + ): Promise>; + }; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/EndpointDefaults.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/EndpointDefaults.ts new file mode 100644 index 00000000..024f6ebb --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/EndpointDefaults.ts @@ -0,0 +1,22 @@ +import { RequestHeaders } from "./RequestHeaders"; +import { RequestMethod } from "./RequestMethod"; +import { RequestParameters } from "./RequestParameters"; +import { Url } from "./Url"; + +/** + * The `.endpoint()` method is guaranteed to set all keys defined by RequestParameters + * as well as the method property. + */ +export type EndpointDefaults = RequestParameters & { + baseUrl: Url; + method: RequestMethod; + url?: Url; + headers: RequestHeaders & { + accept: string; + "user-agent": string; + }; + mediaType: { + format: string; + previews: string[]; + }; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/EndpointInterface.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/EndpointInterface.ts new file mode 100644 index 00000000..fee78d61 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/EndpointInterface.ts @@ -0,0 +1,74 @@ +import { EndpointDefaults } from "./EndpointDefaults"; +import { EndpointOptions } from "./EndpointOptions"; +import { RequestOptions } from "./RequestOptions"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; + +import { Endpoints } from "./generated/Endpoints"; + +export interface EndpointInterface { + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: EndpointOptions): RequestOptions; + + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + ( + route: keyof Endpoints | R, + options?: R extends keyof Endpoints + ? Endpoints[R][0] & RequestParameters + : RequestParameters + ): R extends keyof Endpoints ? Endpoints[R][1] : RequestOptions; + + /** + * Object with current default route and parameters + */ + DEFAULTS: EndpointDefaults; + + /** + * Returns a new `endpoint` with updated route and parameters + */ + defaults: (newDefaults: RequestParameters) => EndpointInterface; + + merge: { + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * + */ + (route: Route, parameters?: RequestParameters): EndpointDefaults; + + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: RequestParameters): EndpointDefaults; + + /** + * Returns current default options. + * + * @deprecated use endpoint.DEFAULTS instead + */ + (): EndpointDefaults; + }; + + /** + * Stateless method to turn endpoint options into request options. + * Calling `endpoint(options)` is the same as calling `endpoint.parse(endpoint.merge(options))`. + * + * @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + parse: (options: EndpointDefaults) => RequestOptions; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/EndpointOptions.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/EndpointOptions.ts new file mode 100644 index 00000000..01706049 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/EndpointOptions.ts @@ -0,0 +1,8 @@ +import { RequestMethod } from "./RequestMethod"; +import { Url } from "./Url"; +import { RequestParameters } from "./RequestParameters"; + +export type EndpointOptions = RequestParameters & { + method: RequestMethod; + url: Url; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Fetch.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Fetch.ts new file mode 100644 index 00000000..983c79be --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Fetch.ts @@ -0,0 +1,4 @@ +/** + * Browser's fetch method (or compatible such as fetch-mock) + */ +export type Fetch = any; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/OctokitResponse.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/OctokitResponse.ts new file mode 100644 index 00000000..4cec20d9 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/OctokitResponse.ts @@ -0,0 +1,18 @@ +import { ResponseHeaders } from "./ResponseHeaders"; +import { Url } from "./Url"; + +export type OctokitResponse = { + headers: ResponseHeaders; + /** + * http response code + */ + status: number; + /** + * URL of response after all redirects + */ + url: Url; + /** + * This is the data you would see in https://developer.Octokit.com/v3/ + */ + data: T; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestHeaders.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestHeaders.ts new file mode 100644 index 00000000..0df66361 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestHeaders.ts @@ -0,0 +1,15 @@ +export type RequestHeaders = { + /** + * Avoid setting `headers.accept`, use `mediaType.{format|previews}` option instead. + */ + accept?: string; + /** + * Use `authorization` to send authenticated request, remember `token ` / `bearer ` prefixes. Example: `token 1234567890abcdef1234567890abcdef12345678` + */ + authorization?: string; + /** + * `user-agent` is set do a default and can be overwritten as needed. + */ + "user-agent"?: string; + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestInterface.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestInterface.ts new file mode 100644 index 00000000..21bd0876 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestInterface.ts @@ -0,0 +1,51 @@ +import { EndpointInterface } from "./EndpointInterface"; +import { EndpointOptions } from "./EndpointOptions"; +import { RequestParameters } from "./RequestParameters"; +import { ResponseHeaders } from "./ResponseHeaders"; +import { Route } from "./Route"; +import { Url } from "./Url"; + +export interface RequestInterface { + /** + * Sends a request based on endpoint options + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: EndpointOptions): Promise>; + + /** + * Sends a request based on endpoint options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: Route, parameters?: RequestParameters): Promise< + OctokitResponse + >; + + /** + * Returns a new `endpoint` with updated route and parameters + */ + defaults: (newDefaults: RequestParameters) => RequestInterface; + + /** + * Octokit endpoint API, see {@link https://github.com/octokit/endpoint.js|@octokit/endpoint} + */ + endpoint: EndpointInterface; +} + +export type OctokitResponse = { + headers: ResponseHeaders; + /** + * http response code + */ + status: number; + /** + * URL of response after all redirects + */ + url: Url; + /** + * This is the data you would see in https://developer.Octokit.com/v3/ + */ + data: T; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestMethod.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestMethod.ts new file mode 100644 index 00000000..2910435a --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestMethod.ts @@ -0,0 +1,10 @@ +/** + * HTTP Verb supported by GitHub's REST API + */ +export type RequestMethod = + | "DELETE" + | "GET" + | "HEAD" + | "PATCH" + | "POST" + | "PUT"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestOptions.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestOptions.ts new file mode 100644 index 00000000..4d765c09 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestOptions.ts @@ -0,0 +1,15 @@ +import { RequestHeaders } from "./RequestHeaders"; +import { RequestMethod } from "./RequestMethod"; +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { Url } from "./Url"; + +/** + * Generic request options as they are returned by the `endpoint()` method + */ +export type RequestOptions = { + method: RequestMethod; + url: Url; + headers: RequestHeaders; + body?: any; + request?: RequestRequestOptions; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestParameters.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestParameters.ts new file mode 100644 index 00000000..9766be00 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestParameters.ts @@ -0,0 +1,46 @@ +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { RequestHeaders } from "./RequestHeaders"; +import { Url } from "./Url"; + +/** + * Parameters that can be passed into `request(route, parameters)` or `endpoint(route, parameters)` methods + */ +export type RequestParameters = { + /** + * Base URL to be used when a relative URL is passed, such as `/orgs/:org`. + * If `baseUrl` is `https://enterprise.acme-inc.com/api/v3`, then the request + * will be sent to `https://enterprise.acme-inc.com/api/v3/orgs/:org`. + */ + baseUrl?: Url; + /** + * HTTP headers. Use lowercase keys. + */ + headers?: RequestHeaders; + /** + * Media type options, see {@link https://developer.github.com/v3/media/|GitHub Developer Guide} + */ + mediaType?: { + /** + * `json` by default. Can be `raw`, `text`, `html`, `full`, `diff`, `patch`, `sha`, `base64`. Depending on endpoint + */ + format?: string; + /** + * Custom media type names of {@link https://developer.github.com/v3/media/|API Previews} without the `-preview` suffix. + * Example for single preview: `['squirrel-girl']`. + * Example for multiple previews: `['squirrel-girl', 'mister-fantastic']`. + */ + previews?: string[]; + }; + /** + * Pass custom meta information for the request. The `request` object will be returned as is. + */ + request?: RequestRequestOptions; + /** + * Any additional parameter will be passed as follows + * 1. URL parameter if `':parameter'` or `{parameter}` is part of `url` + * 2. Query parameter if `method` is `'GET'` or `'HEAD'` + * 3. Request body if `parameter` is `'data'` + * 4. JSON in the request body in the form of `body[parameter]` unless `parameter` key is `'data'` + */ + [parameter: string]: any; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestRequestOptions.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestRequestOptions.ts new file mode 100644 index 00000000..028d6f72 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/RequestRequestOptions.ts @@ -0,0 +1,27 @@ +import { Agent } from "http"; +import { Fetch } from "./Fetch"; +import { Signal } from "./Signal"; + +/** + * Octokit-specific request options which are ignored for the actual request, but can be used by Octokit or plugins to manipulate how the request is sent or how a response is handled + */ +export type RequestRequestOptions = { + /** + * Node only. Useful for custom proxy, certificate, or dns lookup. + */ + agent?: Agent; + /** + * Custom replacement for built-in fetch method. Useful for testing or request hooks. + */ + fetch?: Fetch; + /** + * Use an `AbortController` instance to cancel a request. In node you can only cancel streamed requests. + */ + signal?: Signal; + /** + * Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). `options.request.signal` is recommended instead. + */ + timeout?: number; + + [option: string]: any; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/ResponseHeaders.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/ResponseHeaders.ts new file mode 100644 index 00000000..17267b60 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/ResponseHeaders.ts @@ -0,0 +1,21 @@ +export type ResponseHeaders = { + "cache-control"?: string; + "content-length"?: number; + "content-type"?: string; + date?: string; + etag?: string; + "last-modified"?: string; + link?: string; + location?: string; + server?: string; + status?: string; + vary?: string; + "x-github-mediatype"?: string; + "x-github-request-id"?: string; + "x-oauth-scopes"?: string; + "x-ratelimit-limit"?: string; + "x-ratelimit-remaining"?: string; + "x-ratelimit-reset"?: string; + + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Route.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Route.ts new file mode 100644 index 00000000..c5229a8b --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Route.ts @@ -0,0 +1,4 @@ +/** + * String consisting of an optional HTTP method and relative path or absolute URL. Examples: `'/orgs/:org'`, `'PUT /orgs/:org'`, `GET https://example.com/foo/bar` + */ +export type Route = string; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Signal.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Signal.ts new file mode 100644 index 00000000..bdf97001 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Signal.ts @@ -0,0 +1,6 @@ +/** + * Abort signal + * + * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal + */ +export type Signal = any; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/StrategyInterface.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/StrategyInterface.ts new file mode 100644 index 00000000..60a55add --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/StrategyInterface.ts @@ -0,0 +1,9 @@ +import { AuthInterface } from "./AuthInterface"; + +export interface StrategyInterface< + StrategyOptions extends any[], + AuthOptions extends any[], + Authentication extends object +> { + (...args: StrategyOptions): AuthInterface; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Url.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Url.ts new file mode 100644 index 00000000..9d228cbf --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/Url.ts @@ -0,0 +1,4 @@ +/** + * Relative or absolute URL. Examples: `'/orgs/:org'`, `https://example.com/foo/bar` + */ +export type Url = string; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/VERSION.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/VERSION.ts new file mode 100644 index 00000000..4652f248 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/VERSION.ts @@ -0,0 +1 @@ +export const VERSION = "2.0.1"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/generated/Endpoints.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/generated/Endpoints.ts new file mode 100644 index 00000000..3aec9145 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/generated/Endpoints.ts @@ -0,0 +1,14190 @@ +// DO NOT EDIT THIS FILE +import { RequestHeaders } from "../RequestHeaders"; +import { RequestRequestOptions } from "../RequestRequestOptions"; +import { Url } from "../Url"; + +export interface Endpoints { + "DELETE /app/installations/:installation_id": [ + AppsDeleteInstallationEndpoint, + AppsDeleteInstallationRequestOptions + ]; + "DELETE /applications/:client_id/grants/:access_token": [ + OauthAuthorizationsRevokeGrantForApplicationEndpoint, + OauthAuthorizationsRevokeGrantForApplicationRequestOptions + ]; + "DELETE /applications/:client_id/tokens/:access_token": [ + OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint, + OauthAuthorizationsRevokeAuthorizationForApplicationRequestOptions + ]; + "DELETE /applications/grants/:grant_id": [ + OauthAuthorizationsDeleteGrantEndpoint, + OauthAuthorizationsDeleteGrantRequestOptions + ]; + "DELETE /authorizations/:authorization_id": [ + OauthAuthorizationsDeleteAuthorizationEndpoint, + OauthAuthorizationsDeleteAuthorizationRequestOptions + ]; + "DELETE /gists/:gist_id": [GistsDeleteEndpoint, GistsDeleteRequestOptions]; + "DELETE /gists/:gist_id/comments/:comment_id": [ + GistsDeleteCommentEndpoint, + GistsDeleteCommentRequestOptions + ]; + "DELETE /gists/:gist_id/star": [ + GistsUnstarEndpoint, + GistsUnstarRequestOptions + ]; + "DELETE /notifications/threads/:thread_id/subscription": [ + ActivityDeleteThreadSubscriptionEndpoint, + ActivityDeleteThreadSubscriptionRequestOptions + ]; + "DELETE /orgs/:org/blocks/:username": [ + OrgsUnblockUserEndpoint, + OrgsUnblockUserRequestOptions + ]; + "DELETE /orgs/:org/credential-authorizations/:credential_id": [ + OrgsRemoveCredentialAuthorizationEndpoint, + OrgsRemoveCredentialAuthorizationRequestOptions + ]; + "DELETE /orgs/:org/hooks/:hook_id": [ + OrgsDeleteHookEndpoint, + OrgsDeleteHookRequestOptions + ]; + "DELETE /orgs/:org/interaction-limits": [ + InteractionsRemoveRestrictionsForOrgEndpoint, + InteractionsRemoveRestrictionsForOrgRequestOptions + ]; + "DELETE /orgs/:org/members/:username": [ + OrgsRemoveMemberEndpoint, + OrgsRemoveMemberRequestOptions + ]; + "DELETE /orgs/:org/memberships/:username": [ + OrgsRemoveMembershipEndpoint, + OrgsRemoveMembershipRequestOptions + ]; + "DELETE /orgs/:org/migrations/:migration_id/archive": [ + MigrationsDeleteArchiveForOrgEndpoint, + MigrationsDeleteArchiveForOrgRequestOptions + ]; + "DELETE /orgs/:org/migrations/:migration_id/repos/:repo_name/lock": [ + MigrationsUnlockRepoForOrgEndpoint, + MigrationsUnlockRepoForOrgRequestOptions + ]; + "DELETE /orgs/:org/outside_collaborators/:username": [ + OrgsRemoveOutsideCollaboratorEndpoint, + OrgsRemoveOutsideCollaboratorRequestOptions + ]; + "DELETE /orgs/:org/public_members/:username": [ + OrgsConcealMembershipEndpoint, + OrgsConcealMembershipRequestOptions + ]; + "DELETE /projects/:project_id": [ + ProjectsDeleteEndpoint, + ProjectsDeleteRequestOptions + ]; + "DELETE /projects/:project_id/collaborators/:username": [ + ProjectsRemoveCollaboratorEndpoint, + ProjectsRemoveCollaboratorRequestOptions + ]; + "DELETE /projects/columns/:column_id": [ + ProjectsDeleteColumnEndpoint, + ProjectsDeleteColumnRequestOptions + ]; + "DELETE /projects/columns/cards/:card_id": [ + ProjectsDeleteCardEndpoint, + ProjectsDeleteCardRequestOptions + ]; + "DELETE /reactions/:reaction_id": [ + ReactionsDeleteEndpoint, + ReactionsDeleteRequestOptions + ]; + "DELETE /repos/:owner/:repo": [ + ReposDeleteEndpoint, + ReposDeleteRequestOptions + ]; + "DELETE /repos/:owner/:repo/automated-security-fixes": [ + ReposDisableAutomatedSecurityFixesEndpoint, + ReposDisableAutomatedSecurityFixesRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection": [ + ReposRemoveBranchProtectionEndpoint, + ReposRemoveBranchProtectionRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ + ReposRemoveProtectedBranchAdminEnforcementEndpoint, + ReposRemoveProtectedBranchAdminEnforcementRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ + ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint, + ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ + ReposRemoveProtectedBranchRequiredSignaturesEndpoint, + ReposRemoveProtectedBranchRequiredSignaturesRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ + ReposRemoveProtectedBranchRequiredStatusChecksEndpoint, + ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ + ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint, + ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions": [ + ReposRemoveProtectedBranchRestrictionsEndpoint, + ReposRemoveProtectedBranchRestrictionsRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ + ReposRemoveProtectedBranchAppRestrictionsEndpoint, + ReposRemoveProtectedBranchAppRestrictionsRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ + ReposRemoveProtectedBranchTeamRestrictionsEndpoint, + ReposRemoveProtectedBranchTeamRestrictionsRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ + ReposRemoveProtectedBranchUserRestrictionsEndpoint, + ReposRemoveProtectedBranchUserRestrictionsRequestOptions + ]; + "DELETE /repos/:owner/:repo/collaborators/:username": [ + ReposRemoveCollaboratorEndpoint, + ReposRemoveCollaboratorRequestOptions + ]; + "DELETE /repos/:owner/:repo/comments/:comment_id": [ + ReposDeleteCommitCommentEndpoint, + ReposDeleteCommitCommentRequestOptions + ]; + "DELETE /repos/:owner/:repo/contents/:path": [ + ReposDeleteFileEndpoint, + ReposDeleteFileRequestOptions + ]; + "DELETE /repos/:owner/:repo/downloads/:download_id": [ + ReposDeleteDownloadEndpoint, + ReposDeleteDownloadRequestOptions + ]; + "DELETE /repos/:owner/:repo/git/refs/:ref": [ + GitDeleteRefEndpoint, + GitDeleteRefRequestOptions + ]; + "DELETE /repos/:owner/:repo/hooks/:hook_id": [ + ReposDeleteHookEndpoint, + ReposDeleteHookRequestOptions + ]; + "DELETE /repos/:owner/:repo/import": [ + MigrationsCancelImportEndpoint, + MigrationsCancelImportRequestOptions + ]; + "DELETE /repos/:owner/:repo/interaction-limits": [ + InteractionsRemoveRestrictionsForRepoEndpoint, + InteractionsRemoveRestrictionsForRepoRequestOptions + ]; + "DELETE /repos/:owner/:repo/invitations/:invitation_id": [ + ReposDeleteInvitationEndpoint, + ReposDeleteInvitationRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/:issue_number/assignees": [ + IssuesRemoveAssigneesEndpoint, + IssuesRemoveAssigneesRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/:issue_number/labels": [ + IssuesRemoveLabelsEndpoint, + IssuesRemoveLabelsRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name": [ + IssuesRemoveLabelEndpoint, + IssuesRemoveLabelRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/:issue_number/lock": [ + IssuesUnlockEndpoint, + IssuesUnlockRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/comments/:comment_id": [ + IssuesDeleteCommentEndpoint, + IssuesDeleteCommentRequestOptions + ]; + "DELETE /repos/:owner/:repo/keys/:key_id": [ + ReposRemoveDeployKeyEndpoint, + ReposRemoveDeployKeyRequestOptions + ]; + "DELETE /repos/:owner/:repo/labels/:name": [ + IssuesDeleteLabelEndpoint, + IssuesDeleteLabelRequestOptions + ]; + "DELETE /repos/:owner/:repo/milestones/:milestone_number": [ + IssuesDeleteMilestoneEndpoint, + IssuesDeleteMilestoneRequestOptions + ]; + "DELETE /repos/:owner/:repo/pages": [ + ReposDisablePagesSiteEndpoint, + ReposDisablePagesSiteRequestOptions + ]; + "DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ + PullsDeleteReviewRequestEndpoint, + PullsDeleteReviewRequestRequestOptions + ]; + "DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ + PullsDeletePendingReviewEndpoint, + PullsDeletePendingReviewRequestOptions + ]; + "DELETE /repos/:owner/:repo/pulls/comments/:comment_id": [ + PullsDeleteCommentEndpoint, + PullsDeleteCommentRequestOptions + ]; + "DELETE /repos/:owner/:repo/releases/:release_id": [ + ReposDeleteReleaseEndpoint, + ReposDeleteReleaseRequestOptions + ]; + "DELETE /repos/:owner/:repo/releases/assets/:asset_id": [ + ReposDeleteReleaseAssetEndpoint, + ReposDeleteReleaseAssetRequestOptions + ]; + "DELETE /repos/:owner/:repo/subscription": [ + ActivityDeleteRepoSubscriptionEndpoint, + ActivityDeleteRepoSubscriptionRequestOptions + ]; + "DELETE /repos/:owner/:repo/vulnerability-alerts": [ + ReposDisableVulnerabilityAlertsEndpoint, + ReposDisableVulnerabilityAlertsRequestOptions + ]; + "DELETE /scim/v2/organizations/:org/Users/:scim_user_id": [ + ScimRemoveUserFromOrgEndpoint, + ScimRemoveUserFromOrgRequestOptions + ]; + "DELETE /teams/:team_id": [TeamsDeleteEndpoint, TeamsDeleteRequestOptions]; + "DELETE /teams/:team_id/discussions/:discussion_number": [ + TeamsDeleteDiscussionEndpoint, + TeamsDeleteDiscussionRequestOptions + ]; + "DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ + TeamsDeleteDiscussionCommentEndpoint, + TeamsDeleteDiscussionCommentRequestOptions + ]; + "DELETE /teams/:team_id/members/:username": [ + TeamsRemoveMemberEndpoint, + TeamsRemoveMemberRequestOptions + ]; + "DELETE /teams/:team_id/memberships/:username": [ + TeamsRemoveMembershipEndpoint, + TeamsRemoveMembershipRequestOptions + ]; + "DELETE /teams/:team_id/projects/:project_id": [ + TeamsRemoveProjectEndpoint, + TeamsRemoveProjectRequestOptions + ]; + "DELETE /teams/:team_id/repos/:owner/:repo": [ + TeamsRemoveRepoEndpoint, + TeamsRemoveRepoRequestOptions + ]; + "DELETE /user/blocks/:username": [ + UsersUnblockEndpoint, + UsersUnblockRequestOptions + ]; + "DELETE /user/emails": [ + UsersDeleteEmailsEndpoint, + UsersDeleteEmailsRequestOptions + ]; + "DELETE /user/following/:username": [ + UsersUnfollowEndpoint, + UsersUnfollowRequestOptions + ]; + "DELETE /user/gpg_keys/:gpg_key_id": [ + UsersDeleteGpgKeyEndpoint, + UsersDeleteGpgKeyRequestOptions + ]; + "DELETE /user/installations/:installation_id/repositories/:repository_id": [ + AppsRemoveRepoFromInstallationEndpoint, + AppsRemoveRepoFromInstallationRequestOptions + ]; + "DELETE /user/keys/:key_id": [ + UsersDeletePublicKeyEndpoint, + UsersDeletePublicKeyRequestOptions + ]; + "DELETE /user/migrations/:migration_id/archive": [ + MigrationsDeleteArchiveForAuthenticatedUserEndpoint, + MigrationsDeleteArchiveForAuthenticatedUserRequestOptions + ]; + "DELETE /user/migrations/:migration_id/repos/:repo_name/lock": [ + MigrationsUnlockRepoForAuthenticatedUserEndpoint, + MigrationsUnlockRepoForAuthenticatedUserRequestOptions + ]; + "DELETE /user/repository_invitations/:invitation_id": [ + ReposDeclineInvitationEndpoint, + ReposDeclineInvitationRequestOptions + ]; + "DELETE /user/starred/:owner/:repo": [ + ActivityUnstarRepoEndpoint, + ActivityUnstarRepoRequestOptions + ]; + "DELETE /user/subscriptions/:owner/:repo": [ + ActivityStopWatchingRepoLegacyEndpoint, + ActivityStopWatchingRepoLegacyRequestOptions + ]; + "GET /app": [ + AppsGetAuthenticatedEndpoint, + AppsGetAuthenticatedRequestOptions + ]; + "GET /app/installations": [ + AppsListInstallationsEndpoint, + AppsListInstallationsRequestOptions + ]; + "GET /app/installations/:installation_id": [ + AppsGetInstallationEndpoint, + AppsGetInstallationRequestOptions + ]; + "GET /applications/:client_id/tokens/:access_token": [ + OauthAuthorizationsCheckAuthorizationEndpoint, + OauthAuthorizationsCheckAuthorizationRequestOptions + ]; + "GET /applications/grants": [ + OauthAuthorizationsListGrantsEndpoint, + OauthAuthorizationsListGrantsRequestOptions + ]; + "GET /applications/grants/:grant_id": [ + OauthAuthorizationsGetGrantEndpoint, + OauthAuthorizationsGetGrantRequestOptions + ]; + "GET /apps/:app_slug": [AppsGetBySlugEndpoint, AppsGetBySlugRequestOptions]; + "GET /authorizations": [ + OauthAuthorizationsListAuthorizationsEndpoint, + OauthAuthorizationsListAuthorizationsRequestOptions + ]; + "GET /authorizations/:authorization_id": [ + OauthAuthorizationsGetAuthorizationEndpoint, + OauthAuthorizationsGetAuthorizationRequestOptions + ]; + "GET /codes_of_conduct": [ + CodesOfConductListConductCodesEndpoint, + CodesOfConductListConductCodesRequestOptions + ]; + "GET /codes_of_conduct/:key": [ + CodesOfConductGetConductCodeEndpoint, + CodesOfConductGetConductCodeRequestOptions + ]; + "GET /emojis": [EmojisGetEndpoint, EmojisGetRequestOptions]; + "GET /events": [ + ActivityListPublicEventsEndpoint, + ActivityListPublicEventsRequestOptions + ]; + "GET /feeds": [ActivityListFeedsEndpoint, ActivityListFeedsRequestOptions]; + "GET /gists": [GistsListEndpoint, GistsListRequestOptions]; + "GET /gists/:gist_id": [GistsGetEndpoint, GistsGetRequestOptions]; + "GET /gists/:gist_id/:sha": [ + GistsGetRevisionEndpoint, + GistsGetRevisionRequestOptions + ]; + "GET /gists/:gist_id/comments": [ + GistsListCommentsEndpoint, + GistsListCommentsRequestOptions + ]; + "GET /gists/:gist_id/comments/:comment_id": [ + GistsGetCommentEndpoint, + GistsGetCommentRequestOptions + ]; + "GET /gists/:gist_id/commits": [ + GistsListCommitsEndpoint, + GistsListCommitsRequestOptions + ]; + "GET /gists/:gist_id/forks": [ + GistsListForksEndpoint, + GistsListForksRequestOptions + ]; + "GET /gists/:gist_id/star": [ + GistsCheckIsStarredEndpoint, + GistsCheckIsStarredRequestOptions + ]; + "GET /gists/public": [GistsListPublicEndpoint, GistsListPublicRequestOptions]; + "GET /gists/starred": [ + GistsListStarredEndpoint, + GistsListStarredRequestOptions + ]; + "GET /gitignore/templates": [ + GitignoreListTemplatesEndpoint, + GitignoreListTemplatesRequestOptions + ]; + "GET /gitignore/templates/:name": [ + GitignoreGetTemplateEndpoint, + GitignoreGetTemplateRequestOptions + ]; + "GET /installation/repositories": [ + AppsListReposEndpoint, + AppsListReposRequestOptions + ]; + "GET /issues": [IssuesListEndpoint, IssuesListRequestOptions]; + "GET /legacy/issues/search/:owner/:repository/:state/:keyword": [ + SearchIssuesLegacyEndpoint, + SearchIssuesLegacyRequestOptions + ]; + "GET /legacy/repos/search/:keyword": [ + SearchReposLegacyEndpoint, + SearchReposLegacyRequestOptions + ]; + "GET /legacy/user/email/:email": [ + SearchEmailLegacyEndpoint, + SearchEmailLegacyRequestOptions + ]; + "GET /legacy/user/search/:keyword": [ + SearchUsersLegacyEndpoint, + SearchUsersLegacyRequestOptions + ]; + "GET /licenses": [ + LicensesListCommonlyUsedEndpoint | LicensesListEndpoint, + LicensesListCommonlyUsedRequestOptions | LicensesListRequestOptions + ]; + "GET /licenses/:license": [LicensesGetEndpoint, LicensesGetRequestOptions]; + "GET /marketplace_listing/accounts/:account_id": [ + AppsCheckAccountIsAssociatedWithAnyEndpoint, + AppsCheckAccountIsAssociatedWithAnyRequestOptions + ]; + "GET /marketplace_listing/plans": [ + AppsListPlansEndpoint, + AppsListPlansRequestOptions + ]; + "GET /marketplace_listing/plans/:plan_id/accounts": [ + AppsListAccountsUserOrOrgOnPlanEndpoint, + AppsListAccountsUserOrOrgOnPlanRequestOptions + ]; + "GET /marketplace_listing/stubbed/accounts/:account_id": [ + AppsCheckAccountIsAssociatedWithAnyStubbedEndpoint, + AppsCheckAccountIsAssociatedWithAnyStubbedRequestOptions + ]; + "GET /marketplace_listing/stubbed/plans": [ + AppsListPlansStubbedEndpoint, + AppsListPlansStubbedRequestOptions + ]; + "GET /marketplace_listing/stubbed/plans/:plan_id/accounts": [ + AppsListAccountsUserOrOrgOnPlanStubbedEndpoint, + AppsListAccountsUserOrOrgOnPlanStubbedRequestOptions + ]; + "GET /meta": [MetaGetEndpoint, MetaGetRequestOptions]; + "GET /networks/:owner/:repo/events": [ + ActivityListPublicEventsForRepoNetworkEndpoint, + ActivityListPublicEventsForRepoNetworkRequestOptions + ]; + "GET /notifications": [ + ActivityListNotificationsEndpoint, + ActivityListNotificationsRequestOptions + ]; + "GET /notifications/threads/:thread_id": [ + ActivityGetThreadEndpoint, + ActivityGetThreadRequestOptions + ]; + "GET /notifications/threads/:thread_id/subscription": [ + ActivityGetThreadSubscriptionEndpoint, + ActivityGetThreadSubscriptionRequestOptions + ]; + "GET /organizations": [OrgsListEndpoint, OrgsListRequestOptions]; + "GET /orgs/:org": [OrgsGetEndpoint, OrgsGetRequestOptions]; + "GET /orgs/:org/blocks": [ + OrgsListBlockedUsersEndpoint, + OrgsListBlockedUsersRequestOptions + ]; + "GET /orgs/:org/blocks/:username": [ + OrgsCheckBlockedUserEndpoint, + OrgsCheckBlockedUserRequestOptions + ]; + "GET /orgs/:org/credential-authorizations": [ + OrgsListCredentialAuthorizationsEndpoint, + OrgsListCredentialAuthorizationsRequestOptions + ]; + "GET /orgs/:org/events": [ + ActivityListPublicEventsForOrgEndpoint, + ActivityListPublicEventsForOrgRequestOptions + ]; + "GET /orgs/:org/hooks": [OrgsListHooksEndpoint, OrgsListHooksRequestOptions]; + "GET /orgs/:org/hooks/:hook_id": [ + OrgsGetHookEndpoint, + OrgsGetHookRequestOptions + ]; + "GET /orgs/:org/installation": [ + AppsGetOrgInstallationEndpoint | AppsFindOrgInstallationEndpoint, + AppsGetOrgInstallationRequestOptions | AppsFindOrgInstallationRequestOptions + ]; + "GET /orgs/:org/interaction-limits": [ + InteractionsGetRestrictionsForOrgEndpoint, + InteractionsGetRestrictionsForOrgRequestOptions + ]; + "GET /orgs/:org/invitations": [ + OrgsListPendingInvitationsEndpoint, + OrgsListPendingInvitationsRequestOptions + ]; + "GET /orgs/:org/invitations/:invitation_id/teams": [ + OrgsListInvitationTeamsEndpoint, + OrgsListInvitationTeamsRequestOptions + ]; + "GET /orgs/:org/issues": [ + IssuesListForOrgEndpoint, + IssuesListForOrgRequestOptions + ]; + "GET /orgs/:org/members": [ + OrgsListMembersEndpoint, + OrgsListMembersRequestOptions + ]; + "GET /orgs/:org/members/:username": [ + OrgsCheckMembershipEndpoint, + OrgsCheckMembershipRequestOptions + ]; + "GET /orgs/:org/memberships/:username": [ + OrgsGetMembershipEndpoint, + OrgsGetMembershipRequestOptions + ]; + "GET /orgs/:org/migrations": [ + MigrationsListForOrgEndpoint, + MigrationsListForOrgRequestOptions + ]; + "GET /orgs/:org/migrations/:migration_id": [ + MigrationsGetStatusForOrgEndpoint, + MigrationsGetStatusForOrgRequestOptions + ]; + "GET /orgs/:org/migrations/:migration_id/archive": [ + MigrationsGetArchiveForOrgEndpoint, + MigrationsGetArchiveForOrgRequestOptions + ]; + "GET /orgs/:org/outside_collaborators": [ + OrgsListOutsideCollaboratorsEndpoint, + OrgsListOutsideCollaboratorsRequestOptions + ]; + "GET /orgs/:org/projects": [ + ProjectsListForOrgEndpoint, + ProjectsListForOrgRequestOptions + ]; + "GET /orgs/:org/public_members": [ + OrgsListPublicMembersEndpoint, + OrgsListPublicMembersRequestOptions + ]; + "GET /orgs/:org/public_members/:username": [ + OrgsCheckPublicMembershipEndpoint, + OrgsCheckPublicMembershipRequestOptions + ]; + "GET /orgs/:org/repos": [ + ReposListForOrgEndpoint, + ReposListForOrgRequestOptions + ]; + "GET /orgs/:org/team-sync/groups": [ + TeamsListIdPGroupsForOrgEndpoint, + TeamsListIdPGroupsForOrgRequestOptions + ]; + "GET /orgs/:org/teams": [TeamsListEndpoint, TeamsListRequestOptions]; + "GET /orgs/:org/teams/:team_slug": [ + TeamsGetByNameEndpoint, + TeamsGetByNameRequestOptions + ]; + "GET /projects/:project_id": [ProjectsGetEndpoint, ProjectsGetRequestOptions]; + "GET /projects/:project_id/collaborators": [ + ProjectsListCollaboratorsEndpoint, + ProjectsListCollaboratorsRequestOptions + ]; + "GET /projects/:project_id/collaborators/:username/permission": [ + ProjectsReviewUserPermissionLevelEndpoint, + ProjectsReviewUserPermissionLevelRequestOptions + ]; + "GET /projects/:project_id/columns": [ + ProjectsListColumnsEndpoint, + ProjectsListColumnsRequestOptions + ]; + "GET /projects/columns/:column_id": [ + ProjectsGetColumnEndpoint, + ProjectsGetColumnRequestOptions + ]; + "GET /projects/columns/:column_id/cards": [ + ProjectsListCardsEndpoint, + ProjectsListCardsRequestOptions + ]; + "GET /projects/columns/cards/:card_id": [ + ProjectsGetCardEndpoint, + ProjectsGetCardRequestOptions + ]; + "GET /rate_limit": [RateLimitGetEndpoint, RateLimitGetRequestOptions]; + "GET /repos/:owner/:repo": [ReposGetEndpoint, ReposGetRequestOptions]; + "GET /repos/:owner/:repo/:archive_format/:ref": [ + ReposGetArchiveLinkEndpoint, + ReposGetArchiveLinkRequestOptions + ]; + "GET /repos/:owner/:repo/assignees": [ + IssuesListAssigneesEndpoint, + IssuesListAssigneesRequestOptions + ]; + "GET /repos/:owner/:repo/assignees/:assignee": [ + IssuesCheckAssigneeEndpoint, + IssuesCheckAssigneeRequestOptions + ]; + "GET /repos/:owner/:repo/branches": [ + ReposListBranchesEndpoint, + ReposListBranchesRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch": [ + ReposGetBranchEndpoint, + ReposGetBranchRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection": [ + ReposGetBranchProtectionEndpoint, + ReposGetBranchProtectionRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ + ReposGetProtectedBranchAdminEnforcementEndpoint, + ReposGetProtectedBranchAdminEnforcementRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ + ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint, + ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ + ReposGetProtectedBranchRequiredSignaturesEndpoint, + ReposGetProtectedBranchRequiredSignaturesRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ + ReposGetProtectedBranchRequiredStatusChecksEndpoint, + ReposGetProtectedBranchRequiredStatusChecksRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ + ReposListProtectedBranchRequiredStatusChecksContextsEndpoint, + ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions": [ + ReposGetProtectedBranchRestrictionsEndpoint, + ReposGetProtectedBranchRestrictionsRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ + + | ReposGetAppsWithAccessToProtectedBranchEndpoint + | ReposListAppsWithAccessToProtectedBranchEndpoint, + + | ReposGetAppsWithAccessToProtectedBranchRequestOptions + | ReposListAppsWithAccessToProtectedBranchRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ + + | ReposGetTeamsWithAccessToProtectedBranchEndpoint + | ReposListProtectedBranchTeamRestrictionsEndpoint + | ReposListTeamsWithAccessToProtectedBranchEndpoint, + + | ReposGetTeamsWithAccessToProtectedBranchRequestOptions + | ReposListProtectedBranchTeamRestrictionsRequestOptions + | ReposListTeamsWithAccessToProtectedBranchRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ + + | ReposGetUsersWithAccessToProtectedBranchEndpoint + | ReposListProtectedBranchUserRestrictionsEndpoint + | ReposListUsersWithAccessToProtectedBranchEndpoint, + + | ReposGetUsersWithAccessToProtectedBranchRequestOptions + | ReposListProtectedBranchUserRestrictionsRequestOptions + | ReposListUsersWithAccessToProtectedBranchRequestOptions + ]; + "GET /repos/:owner/:repo/check-runs/:check_run_id": [ + ChecksGetEndpoint, + ChecksGetRequestOptions + ]; + "GET /repos/:owner/:repo/check-runs/:check_run_id/annotations": [ + ChecksListAnnotationsEndpoint, + ChecksListAnnotationsRequestOptions + ]; + "GET /repos/:owner/:repo/check-suites/:check_suite_id": [ + ChecksGetSuiteEndpoint, + ChecksGetSuiteRequestOptions + ]; + "GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs": [ + ChecksListForSuiteEndpoint, + ChecksListForSuiteRequestOptions + ]; + "GET /repos/:owner/:repo/collaborators": [ + ReposListCollaboratorsEndpoint, + ReposListCollaboratorsRequestOptions + ]; + "GET /repos/:owner/:repo/collaborators/:username": [ + ReposCheckCollaboratorEndpoint, + ReposCheckCollaboratorRequestOptions + ]; + "GET /repos/:owner/:repo/collaborators/:username/permission": [ + ReposGetCollaboratorPermissionLevelEndpoint, + ReposGetCollaboratorPermissionLevelRequestOptions + ]; + "GET /repos/:owner/:repo/comments": [ + ReposListCommitCommentsEndpoint, + ReposListCommitCommentsRequestOptions + ]; + "GET /repos/:owner/:repo/comments/:comment_id": [ + ReposGetCommitCommentEndpoint, + ReposGetCommitCommentRequestOptions + ]; + "GET /repos/:owner/:repo/comments/:comment_id/reactions": [ + ReactionsListForCommitCommentEndpoint, + ReactionsListForCommitCommentRequestOptions + ]; + "GET /repos/:owner/:repo/commits": [ + ReposListCommitsEndpoint, + ReposListCommitsRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:commit_sha/branches-where-head": [ + ReposListBranchesForHeadCommitEndpoint, + ReposListBranchesForHeadCommitRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:commit_sha/comments": [ + ReposListCommentsForCommitEndpoint, + ReposListCommentsForCommitRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:commit_sha/pulls": [ + ReposListPullRequestsAssociatedWithCommitEndpoint, + ReposListPullRequestsAssociatedWithCommitRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref": [ + ReposGetCommitEndpoint, + ReposGetCommitRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref/check-runs": [ + ChecksListForRefEndpoint, + ChecksListForRefRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref/check-suites": [ + ChecksListSuitesForRefEndpoint, + ChecksListSuitesForRefRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref/status": [ + ReposGetCombinedStatusForRefEndpoint, + ReposGetCombinedStatusForRefRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref/statuses": [ + ReposListStatusesForRefEndpoint, + ReposListStatusesForRefRequestOptions + ]; + "GET /repos/:owner/:repo/community/code_of_conduct": [ + CodesOfConductGetForRepoEndpoint, + CodesOfConductGetForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/community/profile": [ + ReposRetrieveCommunityProfileMetricsEndpoint, + ReposRetrieveCommunityProfileMetricsRequestOptions + ]; + "GET /repos/:owner/:repo/compare/:base...:head": [ + ReposCompareCommitsEndpoint, + ReposCompareCommitsRequestOptions + ]; + "GET /repos/:owner/:repo/contents/:path": [ + ReposGetContentsEndpoint, + ReposGetContentsRequestOptions + ]; + "GET /repos/:owner/:repo/contributors": [ + ReposListContributorsEndpoint, + ReposListContributorsRequestOptions + ]; + "GET /repos/:owner/:repo/deployments": [ + ReposListDeploymentsEndpoint, + ReposListDeploymentsRequestOptions + ]; + "GET /repos/:owner/:repo/deployments/:deployment_id": [ + ReposGetDeploymentEndpoint, + ReposGetDeploymentRequestOptions + ]; + "GET /repos/:owner/:repo/deployments/:deployment_id/statuses": [ + ReposListDeploymentStatusesEndpoint, + ReposListDeploymentStatusesRequestOptions + ]; + "GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id": [ + ReposGetDeploymentStatusEndpoint, + ReposGetDeploymentStatusRequestOptions + ]; + "GET /repos/:owner/:repo/downloads": [ + ReposListDownloadsEndpoint, + ReposListDownloadsRequestOptions + ]; + "GET /repos/:owner/:repo/downloads/:download_id": [ + ReposGetDownloadEndpoint, + ReposGetDownloadRequestOptions + ]; + "GET /repos/:owner/:repo/events": [ + ActivityListRepoEventsEndpoint, + ActivityListRepoEventsRequestOptions + ]; + "GET /repos/:owner/:repo/forks": [ + ReposListForksEndpoint, + ReposListForksRequestOptions + ]; + "GET /repos/:owner/:repo/git/blobs/:file_sha": [ + GitGetBlobEndpoint, + GitGetBlobRequestOptions + ]; + "GET /repos/:owner/:repo/git/commits/:commit_sha": [ + GitGetCommitEndpoint, + GitGetCommitRequestOptions + ]; + "GET /repos/:owner/:repo/git/matching-refs/:ref": [ + GitListMatchingRefsEndpoint, + GitListMatchingRefsRequestOptions + ]; + "GET /repos/:owner/:repo/git/ref/:ref": [ + GitGetRefEndpoint, + GitGetRefRequestOptions + ]; + "GET /repos/:owner/:repo/git/tags/:tag_sha": [ + GitGetTagEndpoint, + GitGetTagRequestOptions + ]; + "GET /repos/:owner/:repo/git/trees/:tree_sha": [ + GitGetTreeEndpoint, + GitGetTreeRequestOptions + ]; + "GET /repos/:owner/:repo/hooks": [ + ReposListHooksEndpoint, + ReposListHooksRequestOptions + ]; + "GET /repos/:owner/:repo/hooks/:hook_id": [ + ReposGetHookEndpoint, + ReposGetHookRequestOptions + ]; + "GET /repos/:owner/:repo/import": [ + MigrationsGetImportProgressEndpoint, + MigrationsGetImportProgressRequestOptions + ]; + "GET /repos/:owner/:repo/import/authors": [ + MigrationsGetCommitAuthorsEndpoint, + MigrationsGetCommitAuthorsRequestOptions + ]; + "GET /repos/:owner/:repo/import/large_files": [ + MigrationsGetLargeFilesEndpoint, + MigrationsGetLargeFilesRequestOptions + ]; + "GET /repos/:owner/:repo/installation": [ + AppsGetRepoInstallationEndpoint | AppsFindRepoInstallationEndpoint, + + | AppsGetRepoInstallationRequestOptions + | AppsFindRepoInstallationRequestOptions + ]; + "GET /repos/:owner/:repo/interaction-limits": [ + InteractionsGetRestrictionsForRepoEndpoint, + InteractionsGetRestrictionsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/invitations": [ + ReposListInvitationsEndpoint, + ReposListInvitationsRequestOptions + ]; + "GET /repos/:owner/:repo/issues": [ + IssuesListForRepoEndpoint, + IssuesListForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number": [ + IssuesGetEndpoint, + IssuesGetRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/comments": [ + IssuesListCommentsEndpoint, + IssuesListCommentsRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/events": [ + IssuesListEventsEndpoint, + IssuesListEventsRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/labels": [ + IssuesListLabelsOnIssueEndpoint, + IssuesListLabelsOnIssueRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/reactions": [ + ReactionsListForIssueEndpoint, + ReactionsListForIssueRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/timeline": [ + IssuesListEventsForTimelineEndpoint, + IssuesListEventsForTimelineRequestOptions + ]; + "GET /repos/:owner/:repo/issues/comments": [ + IssuesListCommentsForRepoEndpoint, + IssuesListCommentsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/issues/comments/:comment_id": [ + IssuesGetCommentEndpoint, + IssuesGetCommentRequestOptions + ]; + "GET /repos/:owner/:repo/issues/comments/:comment_id/reactions": [ + ReactionsListForIssueCommentEndpoint, + ReactionsListForIssueCommentRequestOptions + ]; + "GET /repos/:owner/:repo/issues/events": [ + IssuesListEventsForRepoEndpoint, + IssuesListEventsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/issues/events/:event_id": [ + IssuesGetEventEndpoint, + IssuesGetEventRequestOptions + ]; + "GET /repos/:owner/:repo/keys": [ + ReposListDeployKeysEndpoint, + ReposListDeployKeysRequestOptions + ]; + "GET /repos/:owner/:repo/keys/:key_id": [ + ReposGetDeployKeyEndpoint, + ReposGetDeployKeyRequestOptions + ]; + "GET /repos/:owner/:repo/labels": [ + IssuesListLabelsForRepoEndpoint, + IssuesListLabelsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/labels/:name": [ + IssuesGetLabelEndpoint, + IssuesGetLabelRequestOptions + ]; + "GET /repos/:owner/:repo/languages": [ + ReposListLanguagesEndpoint, + ReposListLanguagesRequestOptions + ]; + "GET /repos/:owner/:repo/license": [ + LicensesGetForRepoEndpoint, + LicensesGetForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/milestones": [ + IssuesListMilestonesForRepoEndpoint, + IssuesListMilestonesForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/milestones/:milestone_number": [ + IssuesGetMilestoneEndpoint, + IssuesGetMilestoneRequestOptions + ]; + "GET /repos/:owner/:repo/milestones/:milestone_number/labels": [ + IssuesListLabelsForMilestoneEndpoint, + IssuesListLabelsForMilestoneRequestOptions + ]; + "GET /repos/:owner/:repo/notifications": [ + ActivityListNotificationsForRepoEndpoint, + ActivityListNotificationsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/pages": [ + ReposGetPagesEndpoint, + ReposGetPagesRequestOptions + ]; + "GET /repos/:owner/:repo/pages/builds": [ + ReposListPagesBuildsEndpoint, + ReposListPagesBuildsRequestOptions + ]; + "GET /repos/:owner/:repo/pages/builds/:build_id": [ + ReposGetPagesBuildEndpoint, + ReposGetPagesBuildRequestOptions + ]; + "GET /repos/:owner/:repo/pages/builds/latest": [ + ReposGetLatestPagesBuildEndpoint, + ReposGetLatestPagesBuildRequestOptions + ]; + "GET /repos/:owner/:repo/projects": [ + ProjectsListForRepoEndpoint, + ProjectsListForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/pulls": [PullsListEndpoint, PullsListRequestOptions]; + "GET /repos/:owner/:repo/pulls/:pull_number": [ + PullsGetEndpoint, + PullsGetRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/comments": [ + PullsListCommentsEndpoint, + PullsListCommentsRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/commits": [ + PullsListCommitsEndpoint, + PullsListCommitsRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/files": [ + PullsListFilesEndpoint, + PullsListFilesRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/merge": [ + PullsCheckIfMergedEndpoint, + PullsCheckIfMergedRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ + PullsListReviewRequestsEndpoint, + PullsListReviewRequestsRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/reviews": [ + PullsListReviewsEndpoint, + PullsListReviewsRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ + PullsGetReviewEndpoint, + PullsGetReviewRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments": [ + PullsGetCommentsForReviewEndpoint, + PullsGetCommentsForReviewRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/comments": [ + PullsListCommentsForRepoEndpoint, + PullsListCommentsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/comments/:comment_id": [ + PullsGetCommentEndpoint, + PullsGetCommentRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions": [ + ReactionsListForPullRequestReviewCommentEndpoint, + ReactionsListForPullRequestReviewCommentRequestOptions + ]; + "GET /repos/:owner/:repo/readme": [ + ReposGetReadmeEndpoint, + ReposGetReadmeRequestOptions + ]; + "GET /repos/:owner/:repo/releases": [ + ReposListReleasesEndpoint, + ReposListReleasesRequestOptions + ]; + "GET /repos/:owner/:repo/releases/:release_id": [ + ReposGetReleaseEndpoint, + ReposGetReleaseRequestOptions + ]; + "GET /repos/:owner/:repo/releases/:release_id/assets": [ + ReposListAssetsForReleaseEndpoint, + ReposListAssetsForReleaseRequestOptions + ]; + "GET /repos/:owner/:repo/releases/assets/:asset_id": [ + ReposGetReleaseAssetEndpoint, + ReposGetReleaseAssetRequestOptions + ]; + "GET /repos/:owner/:repo/releases/latest": [ + ReposGetLatestReleaseEndpoint, + ReposGetLatestReleaseRequestOptions + ]; + "GET /repos/:owner/:repo/releases/tags/:tag": [ + ReposGetReleaseByTagEndpoint, + ReposGetReleaseByTagRequestOptions + ]; + "GET /repos/:owner/:repo/stargazers": [ + ActivityListStargazersForRepoEndpoint, + ActivityListStargazersForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/stats/code_frequency": [ + ReposGetCodeFrequencyStatsEndpoint, + ReposGetCodeFrequencyStatsRequestOptions + ]; + "GET /repos/:owner/:repo/stats/commit_activity": [ + ReposGetCommitActivityStatsEndpoint, + ReposGetCommitActivityStatsRequestOptions + ]; + "GET /repos/:owner/:repo/stats/contributors": [ + ReposGetContributorsStatsEndpoint, + ReposGetContributorsStatsRequestOptions + ]; + "GET /repos/:owner/:repo/stats/participation": [ + ReposGetParticipationStatsEndpoint, + ReposGetParticipationStatsRequestOptions + ]; + "GET /repos/:owner/:repo/stats/punch_card": [ + ReposGetPunchCardStatsEndpoint, + ReposGetPunchCardStatsRequestOptions + ]; + "GET /repos/:owner/:repo/subscribers": [ + ActivityListWatchersForRepoEndpoint, + ActivityListWatchersForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/subscription": [ + ActivityGetRepoSubscriptionEndpoint, + ActivityGetRepoSubscriptionRequestOptions + ]; + "GET /repos/:owner/:repo/tags": [ + ReposListTagsEndpoint, + ReposListTagsRequestOptions + ]; + "GET /repos/:owner/:repo/teams": [ + ReposListTeamsEndpoint, + ReposListTeamsRequestOptions + ]; + "GET /repos/:owner/:repo/topics": [ + ReposListTopicsEndpoint, + ReposListTopicsRequestOptions + ]; + "GET /repos/:owner/:repo/traffic/clones": [ + ReposGetClonesEndpoint, + ReposGetClonesRequestOptions + ]; + "GET /repos/:owner/:repo/traffic/popular/paths": [ + ReposGetTopPathsEndpoint, + ReposGetTopPathsRequestOptions + ]; + "GET /repos/:owner/:repo/traffic/popular/referrers": [ + ReposGetTopReferrersEndpoint, + ReposGetTopReferrersRequestOptions + ]; + "GET /repos/:owner/:repo/traffic/views": [ + ReposGetViewsEndpoint, + ReposGetViewsRequestOptions + ]; + "GET /repos/:owner/:repo/vulnerability-alerts": [ + ReposCheckVulnerabilityAlertsEndpoint, + ReposCheckVulnerabilityAlertsRequestOptions + ]; + "GET /repositories": [ReposListPublicEndpoint, ReposListPublicRequestOptions]; + "GET /scim/v2/organizations/:org/Users": [ + ScimListProvisionedIdentitiesEndpoint, + ScimListProvisionedIdentitiesRequestOptions + ]; + "GET /scim/v2/organizations/:org/Users/:scim_user_id": [ + ScimGetProvisioningDetailsForUserEndpoint, + ScimGetProvisioningDetailsForUserRequestOptions + ]; + "GET /search/code": [SearchCodeEndpoint, SearchCodeRequestOptions]; + "GET /search/commits": [SearchCommitsEndpoint, SearchCommitsRequestOptions]; + "GET /search/issues": [ + SearchIssuesAndPullRequestsEndpoint | SearchIssuesEndpoint, + SearchIssuesAndPullRequestsRequestOptions | SearchIssuesRequestOptions + ]; + "GET /search/labels": [SearchLabelsEndpoint, SearchLabelsRequestOptions]; + "GET /search/repositories": [SearchReposEndpoint, SearchReposRequestOptions]; + "GET /search/topics": [SearchTopicsEndpoint, SearchTopicsRequestOptions]; + "GET /search/users": [SearchUsersEndpoint, SearchUsersRequestOptions]; + "GET /teams/:team_id": [TeamsGetEndpoint, TeamsGetRequestOptions]; + "GET /teams/:team_id/discussions": [ + TeamsListDiscussionsEndpoint, + TeamsListDiscussionsRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number": [ + TeamsGetDiscussionEndpoint, + TeamsGetDiscussionRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number/comments": [ + TeamsListDiscussionCommentsEndpoint, + TeamsListDiscussionCommentsRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ + TeamsGetDiscussionCommentEndpoint, + TeamsGetDiscussionCommentRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": [ + ReactionsListForTeamDiscussionCommentEndpoint, + ReactionsListForTeamDiscussionCommentRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number/reactions": [ + ReactionsListForTeamDiscussionEndpoint, + ReactionsListForTeamDiscussionRequestOptions + ]; + "GET /teams/:team_id/invitations": [ + TeamsListPendingInvitationsEndpoint, + TeamsListPendingInvitationsRequestOptions + ]; + "GET /teams/:team_id/members": [ + TeamsListMembersEndpoint, + TeamsListMembersRequestOptions + ]; + "GET /teams/:team_id/members/:username": [ + TeamsGetMemberEndpoint, + TeamsGetMemberRequestOptions + ]; + "GET /teams/:team_id/memberships/:username": [ + TeamsGetMembershipEndpoint, + TeamsGetMembershipRequestOptions + ]; + "GET /teams/:team_id/projects": [ + TeamsListProjectsEndpoint, + TeamsListProjectsRequestOptions + ]; + "GET /teams/:team_id/projects/:project_id": [ + TeamsReviewProjectEndpoint, + TeamsReviewProjectRequestOptions + ]; + "GET /teams/:team_id/repos": [ + TeamsListReposEndpoint, + TeamsListReposRequestOptions + ]; + "GET /teams/:team_id/repos/:owner/:repo": [ + TeamsCheckManagesRepoEndpoint, + TeamsCheckManagesRepoRequestOptions + ]; + "GET /teams/:team_id/team-sync/group-mappings": [ + TeamsListIdPGroupsEndpoint, + TeamsListIdPGroupsRequestOptions + ]; + "GET /teams/:team_id/teams": [ + TeamsListChildEndpoint, + TeamsListChildRequestOptions + ]; + "GET /user": [ + UsersGetAuthenticatedEndpoint, + UsersGetAuthenticatedRequestOptions + ]; + "GET /user/blocks": [ + UsersListBlockedEndpoint, + UsersListBlockedRequestOptions + ]; + "GET /user/blocks/:username": [ + UsersCheckBlockedEndpoint, + UsersCheckBlockedRequestOptions + ]; + "GET /user/emails": [UsersListEmailsEndpoint, UsersListEmailsRequestOptions]; + "GET /user/followers": [ + UsersListFollowersForAuthenticatedUserEndpoint, + UsersListFollowersForAuthenticatedUserRequestOptions + ]; + "GET /user/following": [ + UsersListFollowingForAuthenticatedUserEndpoint, + UsersListFollowingForAuthenticatedUserRequestOptions + ]; + "GET /user/following/:username": [ + UsersCheckFollowingEndpoint, + UsersCheckFollowingRequestOptions + ]; + "GET /user/gpg_keys": [ + UsersListGpgKeysEndpoint, + UsersListGpgKeysRequestOptions + ]; + "GET /user/gpg_keys/:gpg_key_id": [ + UsersGetGpgKeyEndpoint, + UsersGetGpgKeyRequestOptions + ]; + "GET /user/installations": [ + AppsListInstallationsForAuthenticatedUserEndpoint, + AppsListInstallationsForAuthenticatedUserRequestOptions + ]; + "GET /user/installations/:installation_id/repositories": [ + AppsListInstallationReposForAuthenticatedUserEndpoint, + AppsListInstallationReposForAuthenticatedUserRequestOptions + ]; + "GET /user/issues": [ + IssuesListForAuthenticatedUserEndpoint, + IssuesListForAuthenticatedUserRequestOptions + ]; + "GET /user/keys": [ + UsersListPublicKeysEndpoint, + UsersListPublicKeysRequestOptions + ]; + "GET /user/keys/:key_id": [ + UsersGetPublicKeyEndpoint, + UsersGetPublicKeyRequestOptions + ]; + "GET /user/marketplace_purchases": [ + AppsListMarketplacePurchasesForAuthenticatedUserEndpoint, + AppsListMarketplacePurchasesForAuthenticatedUserRequestOptions + ]; + "GET /user/marketplace_purchases/stubbed": [ + AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint, + AppsListMarketplacePurchasesForAuthenticatedUserStubbedRequestOptions + ]; + "GET /user/memberships/orgs": [ + OrgsListMembershipsEndpoint, + OrgsListMembershipsRequestOptions + ]; + "GET /user/memberships/orgs/:org": [ + OrgsGetMembershipForAuthenticatedUserEndpoint, + OrgsGetMembershipForAuthenticatedUserRequestOptions + ]; + "GET /user/migrations": [ + MigrationsListForAuthenticatedUserEndpoint, + MigrationsListForAuthenticatedUserRequestOptions + ]; + "GET /user/migrations/:migration_id": [ + MigrationsGetStatusForAuthenticatedUserEndpoint, + MigrationsGetStatusForAuthenticatedUserRequestOptions + ]; + "GET /user/migrations/:migration_id/archive": [ + MigrationsGetArchiveForAuthenticatedUserEndpoint, + MigrationsGetArchiveForAuthenticatedUserRequestOptions + ]; + "GET /user/orgs": [ + OrgsListForAuthenticatedUserEndpoint, + OrgsListForAuthenticatedUserRequestOptions + ]; + "GET /user/public_emails": [ + UsersListPublicEmailsEndpoint, + UsersListPublicEmailsRequestOptions + ]; + "GET /user/repos": [ReposListEndpoint, ReposListRequestOptions]; + "GET /user/repository_invitations": [ + ReposListInvitationsForAuthenticatedUserEndpoint, + ReposListInvitationsForAuthenticatedUserRequestOptions + ]; + "GET /user/starred": [ + ActivityListReposStarredByAuthenticatedUserEndpoint, + ActivityListReposStarredByAuthenticatedUserRequestOptions + ]; + "GET /user/starred/:owner/:repo": [ + ActivityCheckStarringRepoEndpoint, + ActivityCheckStarringRepoRequestOptions + ]; + "GET /user/subscriptions": [ + ActivityListWatchedReposForAuthenticatedUserEndpoint, + ActivityListWatchedReposForAuthenticatedUserRequestOptions + ]; + "GET /user/subscriptions/:owner/:repo": [ + ActivityCheckWatchingRepoLegacyEndpoint, + ActivityCheckWatchingRepoLegacyRequestOptions + ]; + "GET /user/teams": [ + TeamsListForAuthenticatedUserEndpoint, + TeamsListForAuthenticatedUserRequestOptions + ]; + "GET /users": [UsersListEndpoint, UsersListRequestOptions]; + "GET /users/:username": [ + UsersGetByUsernameEndpoint, + UsersGetByUsernameRequestOptions + ]; + "GET /users/:username/events": [ + ActivityListEventsForUserEndpoint, + ActivityListEventsForUserRequestOptions + ]; + "GET /users/:username/events/orgs/:org": [ + ActivityListEventsForOrgEndpoint, + ActivityListEventsForOrgRequestOptions + ]; + "GET /users/:username/events/public": [ + ActivityListPublicEventsForUserEndpoint, + ActivityListPublicEventsForUserRequestOptions + ]; + "GET /users/:username/followers": [ + UsersListFollowersForUserEndpoint, + UsersListFollowersForUserRequestOptions + ]; + "GET /users/:username/following": [ + UsersListFollowingForUserEndpoint, + UsersListFollowingForUserRequestOptions + ]; + "GET /users/:username/following/:target_user": [ + UsersCheckFollowingForUserEndpoint, + UsersCheckFollowingForUserRequestOptions + ]; + "GET /users/:username/gists": [ + GistsListPublicForUserEndpoint, + GistsListPublicForUserRequestOptions + ]; + "GET /users/:username/gpg_keys": [ + UsersListGpgKeysForUserEndpoint, + UsersListGpgKeysForUserRequestOptions + ]; + "GET /users/:username/hovercard": [ + UsersGetContextForUserEndpoint, + UsersGetContextForUserRequestOptions + ]; + "GET /users/:username/installation": [ + AppsGetUserInstallationEndpoint | AppsFindUserInstallationEndpoint, + + | AppsGetUserInstallationRequestOptions + | AppsFindUserInstallationRequestOptions + ]; + "GET /users/:username/keys": [ + UsersListPublicKeysForUserEndpoint, + UsersListPublicKeysForUserRequestOptions + ]; + "GET /users/:username/orgs": [ + OrgsListForUserEndpoint, + OrgsListForUserRequestOptions + ]; + "GET /users/:username/projects": [ + ProjectsListForUserEndpoint, + ProjectsListForUserRequestOptions + ]; + "GET /users/:username/received_events": [ + ActivityListReceivedEventsForUserEndpoint, + ActivityListReceivedEventsForUserRequestOptions + ]; + "GET /users/:username/received_events/public": [ + ActivityListReceivedPublicEventsForUserEndpoint, + ActivityListReceivedPublicEventsForUserRequestOptions + ]; + "GET /users/:username/repos": [ + ReposListForUserEndpoint, + ReposListForUserRequestOptions + ]; + "GET /users/:username/starred": [ + ActivityListReposStarredByUserEndpoint, + ActivityListReposStarredByUserRequestOptions + ]; + "GET /users/:username/subscriptions": [ + ActivityListReposWatchedByUserEndpoint, + ActivityListReposWatchedByUserRequestOptions + ]; + "PATCH /authorizations/:authorization_id": [ + OauthAuthorizationsUpdateAuthorizationEndpoint, + OauthAuthorizationsUpdateAuthorizationRequestOptions + ]; + "PATCH /gists/:gist_id": [GistsUpdateEndpoint, GistsUpdateRequestOptions]; + "PATCH /gists/:gist_id/comments/:comment_id": [ + GistsUpdateCommentEndpoint, + GistsUpdateCommentRequestOptions + ]; + "PATCH /notifications/threads/:thread_id": [ + ActivityMarkThreadAsReadEndpoint, + ActivityMarkThreadAsReadRequestOptions + ]; + "PATCH /orgs/:org": [OrgsUpdateEndpoint, OrgsUpdateRequestOptions]; + "PATCH /orgs/:org/hooks/:hook_id": [ + OrgsUpdateHookEndpoint, + OrgsUpdateHookRequestOptions + ]; + "PATCH /projects/:project_id": [ + ProjectsUpdateEndpoint, + ProjectsUpdateRequestOptions + ]; + "PATCH /projects/columns/:column_id": [ + ProjectsUpdateColumnEndpoint, + ProjectsUpdateColumnRequestOptions + ]; + "PATCH /projects/columns/cards/:card_id": [ + ProjectsUpdateCardEndpoint, + ProjectsUpdateCardRequestOptions + ]; + "PATCH /repos/:owner/:repo": [ReposUpdateEndpoint, ReposUpdateRequestOptions]; + "PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ + ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint, + ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions + ]; + "PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ + ReposUpdateProtectedBranchRequiredStatusChecksEndpoint, + ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions + ]; + "PATCH /repos/:owner/:repo/check-runs/:check_run_id": [ + ChecksUpdateEndpoint, + ChecksUpdateRequestOptions + ]; + "PATCH /repos/:owner/:repo/check-suites/preferences": [ + ChecksSetSuitesPreferencesEndpoint, + ChecksSetSuitesPreferencesRequestOptions + ]; + "PATCH /repos/:owner/:repo/comments/:comment_id": [ + ReposUpdateCommitCommentEndpoint, + ReposUpdateCommitCommentRequestOptions + ]; + "PATCH /repos/:owner/:repo/git/refs/:ref": [ + GitUpdateRefEndpoint, + GitUpdateRefRequestOptions + ]; + "PATCH /repos/:owner/:repo/hooks/:hook_id": [ + ReposUpdateHookEndpoint, + ReposUpdateHookRequestOptions + ]; + "PATCH /repos/:owner/:repo/import": [ + MigrationsUpdateImportEndpoint, + MigrationsUpdateImportRequestOptions + ]; + "PATCH /repos/:owner/:repo/import/authors/:author_id": [ + MigrationsMapCommitAuthorEndpoint, + MigrationsMapCommitAuthorRequestOptions + ]; + "PATCH /repos/:owner/:repo/import/lfs": [ + MigrationsSetLfsPreferenceEndpoint, + MigrationsSetLfsPreferenceRequestOptions + ]; + "PATCH /repos/:owner/:repo/invitations/:invitation_id": [ + ReposUpdateInvitationEndpoint, + ReposUpdateInvitationRequestOptions + ]; + "PATCH /repos/:owner/:repo/issues/:issue_number": [ + IssuesUpdateEndpoint, + IssuesUpdateRequestOptions + ]; + "PATCH /repos/:owner/:repo/issues/comments/:comment_id": [ + IssuesUpdateCommentEndpoint, + IssuesUpdateCommentRequestOptions + ]; + "PATCH /repos/:owner/:repo/labels/:name": [ + IssuesUpdateLabelEndpoint, + IssuesUpdateLabelRequestOptions + ]; + "PATCH /repos/:owner/:repo/milestones/:milestone_number": [ + IssuesUpdateMilestoneEndpoint, + IssuesUpdateMilestoneRequestOptions + ]; + "PATCH /repos/:owner/:repo/pulls/:pull_number": [ + PullsUpdateEndpoint, + PullsUpdateRequestOptions + ]; + "PATCH /repos/:owner/:repo/pulls/comments/:comment_id": [ + PullsUpdateCommentEndpoint, + PullsUpdateCommentRequestOptions + ]; + "PATCH /repos/:owner/:repo/releases/:release_id": [ + ReposUpdateReleaseEndpoint, + ReposUpdateReleaseRequestOptions + ]; + "PATCH /repos/:owner/:repo/releases/assets/:asset_id": [ + ReposUpdateReleaseAssetEndpoint, + ReposUpdateReleaseAssetRequestOptions + ]; + "PATCH /scim/v2/organizations/:org/Users/:scim_user_id": [ + ScimUpdateUserAttributeEndpoint, + ScimUpdateUserAttributeRequestOptions + ]; + "PATCH /teams/:team_id": [TeamsUpdateEndpoint, TeamsUpdateRequestOptions]; + "PATCH /teams/:team_id/discussions/:discussion_number": [ + TeamsUpdateDiscussionEndpoint, + TeamsUpdateDiscussionRequestOptions + ]; + "PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ + TeamsUpdateDiscussionCommentEndpoint, + TeamsUpdateDiscussionCommentRequestOptions + ]; + "PATCH /teams/:team_id/team-sync/group-mappings": [ + TeamsCreateOrUpdateIdPGroupConnectionsEndpoint, + TeamsCreateOrUpdateIdPGroupConnectionsRequestOptions + ]; + "PATCH /user": [ + UsersUpdateAuthenticatedEndpoint, + UsersUpdateAuthenticatedRequestOptions + ]; + "PATCH /user/email/visibility": [ + UsersTogglePrimaryEmailVisibilityEndpoint, + UsersTogglePrimaryEmailVisibilityRequestOptions + ]; + "PATCH /user/memberships/orgs/:org": [ + OrgsUpdateMembershipEndpoint, + OrgsUpdateMembershipRequestOptions + ]; + "PATCH /user/repository_invitations/:invitation_id": [ + ReposAcceptInvitationEndpoint, + ReposAcceptInvitationRequestOptions + ]; + "POST /app-manifests/:code/conversions": [ + AppsCreateFromManifestEndpoint, + AppsCreateFromManifestRequestOptions + ]; + "POST /app/installations/:installation_id/access_tokens": [ + AppsCreateInstallationTokenEndpoint, + AppsCreateInstallationTokenRequestOptions + ]; + "POST /applications/:client_id/tokens/:access_token": [ + OauthAuthorizationsResetAuthorizationEndpoint, + OauthAuthorizationsResetAuthorizationRequestOptions + ]; + "POST /authorizations": [ + OauthAuthorizationsCreateAuthorizationEndpoint, + OauthAuthorizationsCreateAuthorizationRequestOptions + ]; + "POST /content_references/:content_reference_id/attachments": [ + AppsCreateContentAttachmentEndpoint, + AppsCreateContentAttachmentRequestOptions + ]; + "POST /gists": [GistsCreateEndpoint, GistsCreateRequestOptions]; + "POST /gists/:gist_id/comments": [ + GistsCreateCommentEndpoint, + GistsCreateCommentRequestOptions + ]; + "POST /gists/:gist_id/forks": [GistsForkEndpoint, GistsForkRequestOptions]; + "POST /markdown": [MarkdownRenderEndpoint, MarkdownRenderRequestOptions]; + "POST /markdown/raw": [ + MarkdownRenderRawEndpoint, + MarkdownRenderRawRequestOptions + ]; + "POST /orgs/:org/hooks": [ + OrgsCreateHookEndpoint, + OrgsCreateHookRequestOptions + ]; + "POST /orgs/:org/hooks/:hook_id/pings": [ + OrgsPingHookEndpoint, + OrgsPingHookRequestOptions + ]; + "POST /orgs/:org/invitations": [ + OrgsCreateInvitationEndpoint, + OrgsCreateInvitationRequestOptions + ]; + "POST /orgs/:org/migrations": [ + MigrationsStartForOrgEndpoint, + MigrationsStartForOrgRequestOptions + ]; + "POST /orgs/:org/projects": [ + ProjectsCreateForOrgEndpoint, + ProjectsCreateForOrgRequestOptions + ]; + "POST /orgs/:org/repos": [ + ReposCreateInOrgEndpoint, + ReposCreateInOrgRequestOptions + ]; + "POST /orgs/:org/teams": [TeamsCreateEndpoint, TeamsCreateRequestOptions]; + "POST /projects/:project_id/columns": [ + ProjectsCreateColumnEndpoint, + ProjectsCreateColumnRequestOptions + ]; + "POST /projects/columns/:column_id/cards": [ + ProjectsCreateCardEndpoint, + ProjectsCreateCardRequestOptions + ]; + "POST /projects/columns/:column_id/moves": [ + ProjectsMoveColumnEndpoint, + ProjectsMoveColumnRequestOptions + ]; + "POST /projects/columns/cards/:card_id/moves": [ + ProjectsMoveCardEndpoint, + ProjectsMoveCardRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ + ReposAddProtectedBranchAdminEnforcementEndpoint, + ReposAddProtectedBranchAdminEnforcementRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ + ReposAddProtectedBranchRequiredSignaturesEndpoint, + ReposAddProtectedBranchRequiredSignaturesRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ + ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint, + ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ + ReposAddProtectedBranchAppRestrictionsEndpoint, + ReposAddProtectedBranchAppRestrictionsRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ + ReposAddProtectedBranchTeamRestrictionsEndpoint, + ReposAddProtectedBranchTeamRestrictionsRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ + ReposAddProtectedBranchUserRestrictionsEndpoint, + ReposAddProtectedBranchUserRestrictionsRequestOptions + ]; + "POST /repos/:owner/:repo/check-runs": [ + ChecksCreateEndpoint, + ChecksCreateRequestOptions + ]; + "POST /repos/:owner/:repo/check-suites": [ + ChecksCreateSuiteEndpoint, + ChecksCreateSuiteRequestOptions + ]; + "POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest": [ + ChecksRerequestSuiteEndpoint, + ChecksRerequestSuiteRequestOptions + ]; + "POST /repos/:owner/:repo/comments/:comment_id/reactions": [ + ReactionsCreateForCommitCommentEndpoint, + ReactionsCreateForCommitCommentRequestOptions + ]; + "POST /repos/:owner/:repo/commits/:commit_sha/comments": [ + ReposCreateCommitCommentEndpoint, + ReposCreateCommitCommentRequestOptions + ]; + "POST /repos/:owner/:repo/deployments": [ + ReposCreateDeploymentEndpoint, + ReposCreateDeploymentRequestOptions + ]; + "POST /repos/:owner/:repo/deployments/:deployment_id/statuses": [ + ReposCreateDeploymentStatusEndpoint, + ReposCreateDeploymentStatusRequestOptions + ]; + "POST /repos/:owner/:repo/dispatches": [ + ReposCreateDispatchEventEndpoint, + ReposCreateDispatchEventRequestOptions + ]; + "POST /repos/:owner/:repo/forks": [ + ReposCreateForkEndpoint, + ReposCreateForkRequestOptions + ]; + "POST /repos/:owner/:repo/git/blobs": [ + GitCreateBlobEndpoint, + GitCreateBlobRequestOptions + ]; + "POST /repos/:owner/:repo/git/commits": [ + GitCreateCommitEndpoint, + GitCreateCommitRequestOptions + ]; + "POST /repos/:owner/:repo/git/refs": [ + GitCreateRefEndpoint, + GitCreateRefRequestOptions + ]; + "POST /repos/:owner/:repo/git/tags": [ + GitCreateTagEndpoint, + GitCreateTagRequestOptions + ]; + "POST /repos/:owner/:repo/git/trees": [ + GitCreateTreeEndpoint, + GitCreateTreeRequestOptions + ]; + "POST /repos/:owner/:repo/hooks": [ + ReposCreateHookEndpoint, + ReposCreateHookRequestOptions + ]; + "POST /repos/:owner/:repo/hooks/:hook_id/pings": [ + ReposPingHookEndpoint, + ReposPingHookRequestOptions + ]; + "POST /repos/:owner/:repo/hooks/:hook_id/tests": [ + ReposTestPushHookEndpoint, + ReposTestPushHookRequestOptions + ]; + "POST /repos/:owner/:repo/issues": [ + IssuesCreateEndpoint, + IssuesCreateRequestOptions + ]; + "POST /repos/:owner/:repo/issues/:issue_number/assignees": [ + IssuesAddAssigneesEndpoint, + IssuesAddAssigneesRequestOptions + ]; + "POST /repos/:owner/:repo/issues/:issue_number/comments": [ + IssuesCreateCommentEndpoint, + IssuesCreateCommentRequestOptions + ]; + "POST /repos/:owner/:repo/issues/:issue_number/labels": [ + IssuesAddLabelsEndpoint, + IssuesAddLabelsRequestOptions + ]; + "POST /repos/:owner/:repo/issues/:issue_number/reactions": [ + ReactionsCreateForIssueEndpoint, + ReactionsCreateForIssueRequestOptions + ]; + "POST /repos/:owner/:repo/issues/comments/:comment_id/reactions": [ + ReactionsCreateForIssueCommentEndpoint, + ReactionsCreateForIssueCommentRequestOptions + ]; + "POST /repos/:owner/:repo/keys": [ + ReposAddDeployKeyEndpoint, + ReposAddDeployKeyRequestOptions + ]; + "POST /repos/:owner/:repo/labels": [ + IssuesCreateLabelEndpoint, + IssuesCreateLabelRequestOptions + ]; + "POST /repos/:owner/:repo/merges": [ + ReposMergeEndpoint, + ReposMergeRequestOptions + ]; + "POST /repos/:owner/:repo/milestones": [ + IssuesCreateMilestoneEndpoint, + IssuesCreateMilestoneRequestOptions + ]; + "POST /repos/:owner/:repo/pages": [ + ReposEnablePagesSiteEndpoint, + ReposEnablePagesSiteRequestOptions + ]; + "POST /repos/:owner/:repo/pages/builds": [ + ReposRequestPageBuildEndpoint, + ReposRequestPageBuildRequestOptions + ]; + "POST /repos/:owner/:repo/projects": [ + ProjectsCreateForRepoEndpoint, + ProjectsCreateForRepoRequestOptions + ]; + "POST /repos/:owner/:repo/pulls": [ + PullsCreateEndpoint, + PullsCreateRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/comments": [ + PullsCreateCommentEndpoint | PullsCreateCommentReplyEndpoint, + PullsCreateCommentRequestOptions | PullsCreateCommentReplyRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies": [ + PullsCreateReviewCommentReplyEndpoint, + PullsCreateReviewCommentReplyRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ + PullsCreateReviewRequestEndpoint, + PullsCreateReviewRequestRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/reviews": [ + PullsCreateReviewEndpoint, + PullsCreateReviewRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events": [ + PullsSubmitReviewEndpoint, + PullsSubmitReviewRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions": [ + ReactionsCreateForPullRequestReviewCommentEndpoint, + ReactionsCreateForPullRequestReviewCommentRequestOptions + ]; + "POST /repos/:owner/:repo/releases": [ + ReposCreateReleaseEndpoint, + ReposCreateReleaseRequestOptions + ]; + "POST /repos/:owner/:repo/statuses/:sha": [ + ReposCreateStatusEndpoint, + ReposCreateStatusRequestOptions + ]; + "POST /repos/:owner/:repo/transfer": [ + ReposTransferEndpoint, + ReposTransferRequestOptions + ]; + "POST /repos/:template_owner/:template_repo/generate": [ + ReposCreateUsingTemplateEndpoint, + ReposCreateUsingTemplateRequestOptions + ]; + "POST /scim/v2/organizations/:org/Users": [ + ScimProvisionAndInviteUsersEndpoint | ScimProvisionInviteUsersEndpoint, + + | ScimProvisionAndInviteUsersRequestOptions + | ScimProvisionInviteUsersRequestOptions + ]; + "POST /teams/:team_id/discussions": [ + TeamsCreateDiscussionEndpoint, + TeamsCreateDiscussionRequestOptions + ]; + "POST /teams/:team_id/discussions/:discussion_number/comments": [ + TeamsCreateDiscussionCommentEndpoint, + TeamsCreateDiscussionCommentRequestOptions + ]; + "POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": [ + ReactionsCreateForTeamDiscussionCommentEndpoint, + ReactionsCreateForTeamDiscussionCommentRequestOptions + ]; + "POST /teams/:team_id/discussions/:discussion_number/reactions": [ + ReactionsCreateForTeamDiscussionEndpoint, + ReactionsCreateForTeamDiscussionRequestOptions + ]; + "POST /user/emails": [UsersAddEmailsEndpoint, UsersAddEmailsRequestOptions]; + "POST /user/gpg_keys": [ + UsersCreateGpgKeyEndpoint, + UsersCreateGpgKeyRequestOptions + ]; + "POST /user/keys": [ + UsersCreatePublicKeyEndpoint, + UsersCreatePublicKeyRequestOptions + ]; + "POST /user/migrations": [ + MigrationsStartForAuthenticatedUserEndpoint, + MigrationsStartForAuthenticatedUserRequestOptions + ]; + "POST /user/projects": [ + ProjectsCreateForAuthenticatedUserEndpoint, + ProjectsCreateForAuthenticatedUserRequestOptions + ]; + "POST /user/repos": [ + ReposCreateForAuthenticatedUserEndpoint, + ReposCreateForAuthenticatedUserRequestOptions + ]; + "PUT /authorizations/clients/:client_id": [ + OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint, + OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions + ]; + "PUT /authorizations/clients/:client_id/:fingerprint": [ + + | OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint + | OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintEndpoint, + + | OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions + | OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintRequestOptions + ]; + "PUT /gists/:gist_id/star": [GistsStarEndpoint, GistsStarRequestOptions]; + "PUT /notifications": [ + ActivityMarkAsReadEndpoint, + ActivityMarkAsReadRequestOptions + ]; + "PUT /notifications/threads/:thread_id/subscription": [ + ActivitySetThreadSubscriptionEndpoint, + ActivitySetThreadSubscriptionRequestOptions + ]; + "PUT /orgs/:org/blocks/:username": [ + OrgsBlockUserEndpoint, + OrgsBlockUserRequestOptions + ]; + "PUT /orgs/:org/interaction-limits": [ + InteractionsAddOrUpdateRestrictionsForOrgEndpoint, + InteractionsAddOrUpdateRestrictionsForOrgRequestOptions + ]; + "PUT /orgs/:org/memberships/:username": [ + OrgsAddOrUpdateMembershipEndpoint, + OrgsAddOrUpdateMembershipRequestOptions + ]; + "PUT /orgs/:org/outside_collaborators/:username": [ + OrgsConvertMemberToOutsideCollaboratorEndpoint, + OrgsConvertMemberToOutsideCollaboratorRequestOptions + ]; + "PUT /orgs/:org/public_members/:username": [ + OrgsPublicizeMembershipEndpoint, + OrgsPublicizeMembershipRequestOptions + ]; + "PUT /projects/:project_id/collaborators/:username": [ + ProjectsAddCollaboratorEndpoint, + ProjectsAddCollaboratorRequestOptions + ]; + "PUT /repos/:owner/:repo/automated-security-fixes": [ + ReposEnableAutomatedSecurityFixesEndpoint, + ReposEnableAutomatedSecurityFixesRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection": [ + ReposUpdateBranchProtectionEndpoint, + ReposUpdateBranchProtectionRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ + ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint, + ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ + ReposReplaceProtectedBranchAppRestrictionsEndpoint, + ReposReplaceProtectedBranchAppRestrictionsRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ + ReposReplaceProtectedBranchTeamRestrictionsEndpoint, + ReposReplaceProtectedBranchTeamRestrictionsRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ + ReposReplaceProtectedBranchUserRestrictionsEndpoint, + ReposReplaceProtectedBranchUserRestrictionsRequestOptions + ]; + "PUT /repos/:owner/:repo/collaborators/:username": [ + ReposAddCollaboratorEndpoint, + ReposAddCollaboratorRequestOptions + ]; + "PUT /repos/:owner/:repo/contents/:path": [ + + | ReposCreateOrUpdateFileEndpoint + | ReposCreateFileEndpoint + | ReposUpdateFileEndpoint, + + | ReposCreateOrUpdateFileRequestOptions + | ReposCreateFileRequestOptions + | ReposUpdateFileRequestOptions + ]; + "PUT /repos/:owner/:repo/import": [ + MigrationsStartImportEndpoint, + MigrationsStartImportRequestOptions + ]; + "PUT /repos/:owner/:repo/interaction-limits": [ + InteractionsAddOrUpdateRestrictionsForRepoEndpoint, + InteractionsAddOrUpdateRestrictionsForRepoRequestOptions + ]; + "PUT /repos/:owner/:repo/issues/:issue_number/labels": [ + IssuesReplaceLabelsEndpoint, + IssuesReplaceLabelsRequestOptions + ]; + "PUT /repos/:owner/:repo/issues/:issue_number/lock": [ + IssuesLockEndpoint, + IssuesLockRequestOptions + ]; + "PUT /repos/:owner/:repo/notifications": [ + ActivityMarkNotificationsAsReadForRepoEndpoint, + ActivityMarkNotificationsAsReadForRepoRequestOptions + ]; + "PUT /repos/:owner/:repo/pages": [ + ReposUpdateInformationAboutPagesSiteEndpoint, + ReposUpdateInformationAboutPagesSiteRequestOptions + ]; + "PUT /repos/:owner/:repo/pulls/:pull_number/merge": [ + PullsMergeEndpoint, + PullsMergeRequestOptions + ]; + "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ + PullsUpdateReviewEndpoint, + PullsUpdateReviewRequestOptions + ]; + "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals": [ + PullsDismissReviewEndpoint, + PullsDismissReviewRequestOptions + ]; + "PUT /repos/:owner/:repo/pulls/:pull_number/update-branch": [ + PullsUpdateBranchEndpoint, + PullsUpdateBranchRequestOptions + ]; + "PUT /repos/:owner/:repo/subscription": [ + ActivitySetRepoSubscriptionEndpoint, + ActivitySetRepoSubscriptionRequestOptions + ]; + "PUT /repos/:owner/:repo/topics": [ + ReposReplaceTopicsEndpoint, + ReposReplaceTopicsRequestOptions + ]; + "PUT /repos/:owner/:repo/vulnerability-alerts": [ + ReposEnableVulnerabilityAlertsEndpoint, + ReposEnableVulnerabilityAlertsRequestOptions + ]; + "PUT /scim/v2/organizations/:org/Users/:scim_user_id": [ + + | ScimReplaceProvisionedUserInformationEndpoint + | ScimUpdateProvisionedOrgMembershipEndpoint, + + | ScimReplaceProvisionedUserInformationRequestOptions + | ScimUpdateProvisionedOrgMembershipRequestOptions + ]; + "PUT /teams/:team_id/members/:username": [ + TeamsAddMemberEndpoint, + TeamsAddMemberRequestOptions + ]; + "PUT /teams/:team_id/memberships/:username": [ + TeamsAddOrUpdateMembershipEndpoint, + TeamsAddOrUpdateMembershipRequestOptions + ]; + "PUT /teams/:team_id/projects/:project_id": [ + TeamsAddOrUpdateProjectEndpoint, + TeamsAddOrUpdateProjectRequestOptions + ]; + "PUT /teams/:team_id/repos/:owner/:repo": [ + TeamsAddOrUpdateRepoEndpoint, + TeamsAddOrUpdateRepoRequestOptions + ]; + "PUT /user/blocks/:username": [UsersBlockEndpoint, UsersBlockRequestOptions]; + "PUT /user/following/:username": [ + UsersFollowEndpoint, + UsersFollowRequestOptions + ]; + "PUT /user/installations/:installation_id/repositories/:repository_id": [ + AppsAddRepoToInstallationEndpoint, + AppsAddRepoToInstallationRequestOptions + ]; + "PUT /user/starred/:owner/:repo": [ + ActivityStarRepoEndpoint, + ActivityStarRepoRequestOptions + ]; + "PUT /user/subscriptions/:owner/:repo": [ + ActivityWatchRepoLegacyEndpoint, + ActivityWatchRepoLegacyRequestOptions + ]; +} + +type AppsGetAuthenticatedEndpoint = {}; +type AppsGetAuthenticatedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCreateFromManifestEndpoint = { + /** + * code parameter + */ + code: string; +}; +type AppsCreateFromManifestRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListInstallationsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListInstallationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; +}; +type AppsGetInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsDeleteInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; +}; +type AppsDeleteInstallationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCreateInstallationTokenEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; + /** + * The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the "[List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token. + */ + repository_ids?: number[]; + /** + * The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see "[GitHub App permissions](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions)." + */ + permissions?: AppsCreateInstallationTokenParamsPermissions; +}; +type AppsCreateInstallationTokenRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsListGrantsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OauthAuthorizationsListGrantsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetGrantEndpoint = { + /** + * grant_id parameter + */ + grant_id: number; +}; +type OauthAuthorizationsGetGrantRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsDeleteGrantEndpoint = { + /** + * grant_id parameter + */ + grant_id: number; +}; +type OauthAuthorizationsDeleteGrantRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsRevokeGrantForApplicationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; +type OauthAuthorizationsRevokeGrantForApplicationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsCheckAuthorizationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; +type OauthAuthorizationsCheckAuthorizationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsResetAuthorizationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; +type OauthAuthorizationsResetAuthorizationRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; +type OauthAuthorizationsRevokeAuthorizationForApplicationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetBySlugEndpoint = { + /** + * app_slug parameter + */ + app_slug: string; +}; +type AppsGetBySlugRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsListAuthorizationsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OauthAuthorizationsListAuthorizationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsCreateAuthorizationEndpoint = { + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. + */ + note: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * The 20 character OAuth app client key for which to create the token. + */ + client_id?: string; + /** + * The 40 character OAuth app client secret for which to create the token. + */ + client_secret?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; +}; +type OauthAuthorizationsCreateAuthorizationRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint). + */ + fingerprint?: string; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * fingerprint parameter + */ + fingerprint: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * fingerprint parameter + */ + fingerprint: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetAuthorizationEndpoint = { + /** + * authorization_id parameter + */ + authorization_id: number; +}; +type OauthAuthorizationsGetAuthorizationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsUpdateAuthorizationEndpoint = { + /** + * authorization_id parameter + */ + authorization_id: number; + /** + * Replaces the authorization scopes with these. + */ + scopes?: string[]; + /** + * A list of scopes to add to this authorization. + */ + add_scopes?: string[]; + /** + * A list of scopes to remove from this authorization. + */ + remove_scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; +}; +type OauthAuthorizationsUpdateAuthorizationRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsDeleteAuthorizationEndpoint = { + /** + * authorization_id parameter + */ + authorization_id: number; +}; +type OauthAuthorizationsDeleteAuthorizationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type CodesOfConductListConductCodesEndpoint = {}; +type CodesOfConductListConductCodesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type CodesOfConductGetConductCodeEndpoint = { + /** + * key parameter + */ + key: string; +}; +type CodesOfConductGetConductCodeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCreateContentAttachmentEndpoint = { + /** + * content_reference_id parameter + */ + content_reference_id: number; + /** + * The title of the content attachment displayed in the body or comment of an issue or pull request. + */ + title: string; + /** + * The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown. + */ + body: string; +}; +type AppsCreateContentAttachmentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type EmojisGetEndpoint = {}; +type EmojisGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListPublicEventsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListPublicEventsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListFeedsEndpoint = {}; +type ActivityListFeedsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsCreateEndpoint = { + /** + * The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`. + */ + files: GistsCreateParamsFiles; + /** + * A descriptive name for this gist. + */ + description?: string; + /** + * When `true`, the gist will be public and available for anyone to see. + */ + public?: boolean; +}; +type GistsCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListPublicEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListPublicRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListStarredEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListStarredRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsGetEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsUpdateEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * A descriptive name for this gist. + */ + description?: string; + /** + * The filenames and content that make up this gist. + */ + files?: GistsUpdateParamsFiles; +}; +type GistsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsDeleteEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListCommentsEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsCreateCommentEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * The comment text. + */ + body: string; +}; +type GistsCreateCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsGetCommentEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type GistsGetCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsUpdateCommentEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The comment text. + */ + body: string; +}; +type GistsUpdateCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsDeleteCommentEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type GistsDeleteCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListCommitsEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsForkEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsForkRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListForksEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListForksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsStarEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsStarRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsUnstarEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsUnstarRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsCheckIsStarredEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsCheckIsStarredRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsGetRevisionEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * sha parameter + */ + sha: string; +}; +type GistsGetRevisionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitignoreListTemplatesEndpoint = {}; +type GitignoreListTemplatesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitignoreGetTemplateEndpoint = { + /** + * name parameter + */ + name: string; +}; +type GitignoreGetTemplateRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListReposEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListReposRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListEndpoint = { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchIssuesLegacyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repository parameter + */ + repository: string; + /** + * Indicates the state of the issues to return. Can be either `open` or `closed`. + */ + state: "open" | "closed"; + /** + * The search term. + */ + keyword: string; +}; +type SearchIssuesLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchReposLegacyEndpoint = { + /** + * The search term. + */ + keyword: string; + /** + * Filter results by language. + */ + language?: string; + /** + * The page number to fetch. + */ + start_page?: string; + /** + * The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. + */ + sort?: "stars" | "forks" | "updated"; + /** + * The sort field. if `sort` param is provided. Can be either `asc` or `desc`. + */ + order?: "asc" | "desc"; +}; +type SearchReposLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchEmailLegacyEndpoint = { + /** + * The email address. + */ + email: string; +}; +type SearchEmailLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchUsersLegacyEndpoint = { + /** + * The search term. + */ + keyword: string; + /** + * The page number to fetch. + */ + start_page?: string; + /** + * The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. + */ + sort?: "stars" | "forks" | "updated"; + /** + * The sort field. if `sort` param is provided. Can be either `asc` or `desc`. + */ + order?: "asc" | "desc"; +}; +type SearchUsersLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type LicensesListCommonlyUsedEndpoint = {}; +type LicensesListCommonlyUsedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type LicensesListEndpoint = {}; +type LicensesListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type LicensesGetEndpoint = { + /** + * license parameter + */ + license: string; +}; +type LicensesGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MarkdownRenderEndpoint = { + /** + * The Markdown text to render in HTML. Markdown content must be 400 KB or less. + */ + text: string; + /** + * The rendering mode. Can be either: + * \* `markdown` to render a document in plain Markdown, just like README.md files are rendered. + * \* `gfm` to render a document in [GitHub Flavored Markdown](https://github.github.com/gfm/), which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests. + */ + mode?: "markdown" | "gfm"; + /** + * The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode. + */ + context?: string; +}; +type MarkdownRenderRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MarkdownRenderRawEndpoint = { + /** + * data parameter + */ + data: string; +}; +type MarkdownRenderRawRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCheckAccountIsAssociatedWithAnyEndpoint = { + /** + * account_id parameter + */ + account_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsCheckAccountIsAssociatedWithAnyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListPlansEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListPlansRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListAccountsUserOrOrgOnPlanEndpoint = { + /** + * plan_id parameter + */ + plan_id: number; + /** + * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListAccountsUserOrOrgOnPlanRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCheckAccountIsAssociatedWithAnyStubbedEndpoint = { + /** + * account_id parameter + */ + account_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsCheckAccountIsAssociatedWithAnyStubbedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListPlansStubbedEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListPlansStubbedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListAccountsUserOrOrgOnPlanStubbedEndpoint = { + /** + * plan_id parameter + */ + plan_id: number; + /** + * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListAccountsUserOrOrgOnPlanStubbedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MetaGetEndpoint = {}; +type MetaGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListPublicEventsForRepoNetworkEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListPublicEventsForRepoNetworkRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListNotificationsEndpoint = { + /** + * If `true`, show notifications marked as read. + */ + all?: boolean; + /** + * If `true`, only shows notifications in which the user is directly participating or mentioned. + */ + participating?: boolean; + /** + * Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + before?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListNotificationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityMarkAsReadEndpoint = { + /** + * Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; +}; +type ActivityMarkAsReadRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityGetThreadEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; +}; +type ActivityGetThreadRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityMarkThreadAsReadEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; +}; +type ActivityMarkThreadAsReadRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityGetThreadSubscriptionEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; +}; +type ActivityGetThreadSubscriptionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivitySetThreadSubscriptionEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; + /** + * Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread. + */ + ignored?: boolean; +}; +type ActivitySetThreadSubscriptionRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityDeleteThreadSubscriptionEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; +}; +type ActivityDeleteThreadSubscriptionRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListEndpoint = { + /** + * The integer ID of the last Organization that you've seen. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsGetEndpoint = { + /** + * org parameter + */ + org: string; +}; +type OrgsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsUpdateEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Billing email address. This address is not publicized. + */ + billing_email?: string; + /** + * The company name. + */ + company?: string; + /** + * The publicly visible email address. + */ + email?: string; + /** + * The location. + */ + location?: string; + /** + * The shorthand name of the company. + */ + name?: string; + /** + * The description of the company. + */ + description?: string; + /** + * Toggles whether organization projects are enabled for the organization. + */ + has_organization_projects?: boolean; + /** + * Toggles whether repository projects are enabled for repositories that belong to the organization. + */ + has_repository_projects?: boolean; + /** + * Default permission level members have for organization repositories: + * \* `read` - can pull, but not push to or administer this repository. + * \* `write` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push, and administer this repository. + * \* `none` - no permissions granted by default. + */ + default_repository_permission?: "read" | "write" | "admin" | "none"; + /** + * Toggles the ability of non-admin organization members to create repositories. Can be one of: + * \* `true` - all organization members can create repositories. + * \* `false` - only admin members can create repositories. + * Default: `true` + * **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + */ + members_can_create_repositories?: boolean; + /** + * Specifies which types of repositories non-admin organization members can create. Can be one of: + * \* `all` - all organization members can create public and private repositories. + * \* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). + * \* `none` - only admin members can create repositories. + * **Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + */ + members_allowed_repository_creation_type?: "all" | "private" | "none"; +}; +type OrgsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListBlockedUsersEndpoint = { + /** + * org parameter + */ + org: string; +}; +type OrgsListBlockedUsersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCheckBlockedUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsCheckBlockedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsBlockUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsBlockUserRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsUnblockUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsUnblockUserRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListCredentialAuthorizationsEndpoint = { + /** + * org parameter + */ + org: string; +}; +type OrgsListCredentialAuthorizationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsRemoveCredentialAuthorizationEndpoint = { + /** + * org parameter + */ + org: string; + /** + * credential_id parameter + */ + credential_id: number; +}; +type OrgsRemoveCredentialAuthorizationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListPublicEventsForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListPublicEventsForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListHooksEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListHooksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCreateHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Must be passed as "web". + */ + name: string; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params). + */ + config: OrgsCreateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +type OrgsCreateHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsGetHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type OrgsGetHookRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsUpdateHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * hook_id parameter + */ + hook_id: number; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params). + */ + config?: OrgsUpdateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +type OrgsUpdateHookRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsDeleteHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type OrgsDeleteHookRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsPingHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type OrgsPingHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetOrgInstallationEndpoint = { + /** + * org parameter + */ + org: string; +}; +type AppsGetOrgInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsFindOrgInstallationEndpoint = { + /** + * org parameter + */ + org: string; +}; +type AppsFindOrgInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsGetRestrictionsForOrgEndpoint = { + /** + * org parameter + */ + org: string; +}; +type InteractionsGetRestrictionsForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsAddOrUpdateRestrictionsForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`. + */ + limit: "existing_users" | "contributors_only" | "collaborators_only"; +}; +type InteractionsAddOrUpdateRestrictionsForOrgRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsRemoveRestrictionsForOrgEndpoint = { + /** + * org parameter + */ + org: string; +}; +type InteractionsRemoveRestrictionsForOrgRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListPendingInvitationsEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListPendingInvitationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCreateInvitationEndpoint = { + /** + * org parameter + */ + org: string; + /** + * **Required unless you provide `email`**. GitHub user ID for the person you are inviting. + */ + invitee_id?: number; + /** + * **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. + */ + email?: string; + /** + * Specify role for new member. Can be one of: + * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * \* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * \* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + */ + role?: "admin" | "direct_member" | "billing_manager"; + /** + * Specify IDs for the teams you want to invite new members to. + */ + team_ids?: number[]; +}; +type OrgsCreateInvitationRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListInvitationTeamsEndpoint = { + /** + * org parameter + */ + org: string; + /** + * invitation_id parameter + */ + invitation_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListInvitationTeamsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListMembersEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Filter members returned in the list. Can be one of: + * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. + * \* `all` - All members the authenticated user can see. + */ + filter?: "2fa_disabled" | "all"; + /** + * Filter members returned by their role. Can be one of: + * \* `all` - All members of the organization, regardless of role. + * \* `admin` - Organization owners. + * \* `member` - Non-owner organization members. + */ + role?: "all" | "admin" | "member"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListMembersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCheckMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsCheckMembershipRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsRemoveMemberEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsRemoveMemberRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsGetMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsGetMembershipRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsAddOrUpdateMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; + /** + * The role to give the user in the organization. Can be one of: + * \* `admin` - The user will become an owner of the organization. + * \* `member` - The user will become a non-owner member of the organization. + */ + role?: "admin" | "member"; +}; +type OrgsAddOrUpdateMembershipRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsRemoveMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsRemoveMembershipRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsStartForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * A list of arrays indicating which repositories should be migrated. + */ + repositories: string[]; + /** + * Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + */ + lock_repositories?: boolean; + /** + * Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + */ + exclude_attachments?: boolean; +}; +type MigrationsStartForOrgRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsListForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type MigrationsListForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetStatusForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsGetStatusForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetArchiveForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsGetArchiveForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsDeleteArchiveForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsDeleteArchiveForOrgRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsUnlockRepoForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; + /** + * repo_name parameter + */ + repo_name: string; +}; +type MigrationsUnlockRepoForOrgRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListOutsideCollaboratorsEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Filter the list of outside collaborators. Can be one of: + * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. + * \* `all`: All outside collaborators. + */ + filter?: "2fa_disabled" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListOutsideCollaboratorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsRemoveOutsideCollaboratorEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsRemoveOutsideCollaboratorRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsConvertMemberToOutsideCollaboratorEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsConvertMemberToOutsideCollaboratorRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +}; +type ProjectsCreateForOrgRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListPublicMembersEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListPublicMembersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCheckPublicMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsCheckPublicMembershipRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsPublicizeMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsPublicizeMembershipRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsConcealMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsConcealMembershipRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`. + */ + type?: "all" | "public" | "private" | "forks" | "sources" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * The name of the repository. + */ + name: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account. + */ + private?: boolean; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + */ + team_id?: number; + /** + * Pass `true` to create an initial commit with empty README. + */ + auto_init?: boolean; + /** + * Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". + */ + gitignore_template?: string; + /** + * Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". + */ + license_template?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; +}; +type ReposCreateInOrgRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListIdPGroupsForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListIdPGroupsForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateEndpoint = { + /** + * org parameter + */ + org: string; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The logins of organization members to add as maintainers of the team. + */ + maintainers?: string[]; + /** + * The full name (e.g., "organization-name/repository-name") of repositories to add the team to. + */ + repo_names?: string[]; + /** + * The level of privacy this team should have. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + * Default for child team: `closed` + * **Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. + */ + parent_team_id?: number; +}; +type TeamsCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetByNameEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; +}; +type TeamsGetByNameRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsGetCardEndpoint = { + /** + * card_id parameter + */ + card_id: number; +}; +type ProjectsGetCardRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsUpdateCardEndpoint = { + /** + * card_id parameter + */ + card_id: number; + /** + * The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`. + */ + note?: string; + /** + * Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card. + */ + archived?: boolean; +}; +type ProjectsUpdateCardRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsDeleteCardEndpoint = { + /** + * card_id parameter + */ + card_id: number; +}; +type ProjectsDeleteCardRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsMoveCardEndpoint = { + /** + * card_id parameter + */ + card_id: number; + /** + * Can be one of `top`, `bottom`, or `after:`, where `` is the `id` value of a card in the same column, or in the new column specified by `column_id`. + */ + position: string; + /** + * The `id` value of a column in the same project. + */ + column_id?: number; +}; +type ProjectsMoveCardRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsGetColumnEndpoint = { + /** + * column_id parameter + */ + column_id: number; +}; +type ProjectsGetColumnRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsUpdateColumnEndpoint = { + /** + * column_id parameter + */ + column_id: number; + /** + * The new name of the column. + */ + name: string; +}; +type ProjectsUpdateColumnRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsDeleteColumnEndpoint = { + /** + * column_id parameter + */ + column_id: number; +}; +type ProjectsDeleteColumnRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListCardsEndpoint = { + /** + * column_id parameter + */ + column_id: number; + /** + * Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. + */ + archived_state?: "all" | "archived" | "not_archived"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListCardsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateCardEndpoint = { + /** + * column_id parameter + */ + column_id: number; + /** + * The card's note content. Only valid for cards without another type of content, so you must omit when specifying `content_id` and `content_type`. + */ + note?: string; + /** + * The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. + * **Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`. + */ + content_id?: number; + /** + * **Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id. + */ + content_type?: string; +}; +type ProjectsCreateCardRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsMoveColumnEndpoint = { + /** + * column_id parameter + */ + column_id: number; + /** + * Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project. + */ + position: string; +}; +type ProjectsMoveColumnRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsGetEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsUpdateEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * The name of the project. + */ + name?: string; + /** + * The description of the project. + */ + body?: string; + /** + * State of the project. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project](https://developer.github.com/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). + * + * **Note:** Updating a project's `organization_permission` requires `admin` access to the project. + * + * Can be one of: + * \* `read` - Organization members can read, but not write to or administer this project. + * \* `write` - Organization members can read and write, but not administer this project. + * \* `admin` - Organization members can read, write and administer this project. + * \* `none` - Organization members can only see this project if it is public. + */ + organization_permission?: string; + /** + * Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. + * + * Can be one of: + * \* `false` - Anyone can see the project. + * \* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account. + */ + private?: boolean; +}; +type ProjectsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsDeleteEndpoint = { + /** + * project_id parameter + */ + project_id: number; +}; +type ProjectsDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListCollaboratorsEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * Filters the collaborators by their affiliation. Can be one of: + * \* `outside`: Outside collaborators of a project that are not a member of the project's organization. + * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListCollaboratorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsAddCollaboratorEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * username parameter + */ + username: string; + /** + * The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." Can be one of: + * \* `read` - can read, but not write to or administer this project. + * \* `write` - can read and write, but not administer this project. + * \* `admin` - can read, write and administer this project. + */ + permission?: "read" | "write" | "admin"; +}; +type ProjectsAddCollaboratorRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsRemoveCollaboratorEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * username parameter + */ + username: string; +}; +type ProjectsRemoveCollaboratorRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsReviewUserPermissionLevelEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * username parameter + */ + username: string; +}; +type ProjectsReviewUserPermissionLevelRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListColumnsEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListColumnsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateColumnEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * The name of the column. + */ + name: string; +}; +type ProjectsCreateColumnRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type RateLimitGetEndpoint = {}; +type RateLimitGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsDeleteEndpoint = { + /** + * reaction_id parameter + */ + reaction_id: number; +}; +type ReactionsDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the repository. + */ + name?: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + */ + private?: boolean; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * Updates the default branch for this repository. + */ + default_branch?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; + /** + * `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. + */ + archived?: boolean; +}; +type ReposUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListAssigneesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListAssigneesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCheckAssigneeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * assignee parameter + */ + assignee: string; +}; +type IssuesCheckAssigneeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposEnableAutomatedSecurityFixesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposEnableAutomatedSecurityFixesRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDisableAutomatedSecurityFixesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposDisableAutomatedSecurityFixesRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListBranchesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. + */ + protected?: boolean; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListBranchesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetBranchProtectionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetBranchProtectionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateBranchProtectionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * Require status checks to pass before merging. Set to `null` to disable. + */ + required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null; + /** + * Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + */ + enforce_admins: boolean | null; + /** + * Require at least one approving review on a pull request, before merging. Set to `null` to disable. + */ + required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null; + /** + * Restrict who can push to this branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + */ + restrictions: ReposUpdateBranchProtectionParamsRestrictions | null; +}; +type ReposUpdateBranchProtectionRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveBranchProtectionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveBranchProtectionRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchAdminEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchAdminEnforcementRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchAdminEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposAddProtectedBranchAdminEnforcementRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchAdminEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchAdminEnforcementRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. + */ + dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions; + /** + * Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. + */ + dismiss_stale_reviews?: boolean; + /** + * Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed. + */ + require_code_owner_reviews?: boolean; + /** + * Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6. + */ + required_approving_review_count?: number; +}; +type ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchRequiredSignaturesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchRequiredSignaturesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchRequiredSignaturesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposAddProtectedBranchRequiredSignaturesRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchRequiredSignaturesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchRequiredSignaturesRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchRequiredStatusChecksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchRequiredStatusChecksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateProtectedBranchRequiredStatusChecksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * Require branches to be up to date before merging. + */ + strict?: boolean; + /** + * The list of status checks to require in order to merge into this branch + */ + contexts?: string[]; +}; +type ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchRequiredStatusChecksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListProtectedBranchRequiredStatusChecksContextsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +type ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +type ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +type ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchRestrictionsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchRestrictionsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetAppsWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetAppsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListAppsWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListAppsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceProtectedBranchAppRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +type ReposReplaceProtectedBranchAppRestrictionsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchAppRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +type ReposAddProtectedBranchAppRestrictionsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchAppRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +type ReposRemoveProtectedBranchAppRestrictionsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetTeamsWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetTeamsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListProtectedBranchTeamRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListProtectedBranchTeamRestrictionsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListTeamsWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListTeamsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceProtectedBranchTeamRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +type ReposReplaceProtectedBranchTeamRestrictionsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchTeamRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +type ReposAddProtectedBranchTeamRestrictionsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchTeamRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +type ReposRemoveProtectedBranchTeamRestrictionsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetUsersWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetUsersWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListProtectedBranchUserRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListProtectedBranchUserRestrictionsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListUsersWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListUsersWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceProtectedBranchUserRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * users parameter + */ + users: string[]; +}; +type ReposReplaceProtectedBranchUserRestrictionsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchUserRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * users parameter + */ + users: string[]; +}; +type ReposAddProtectedBranchUserRestrictionsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchUserRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * users parameter + */ + users: string[]; +}; +type ReposRemoveProtectedBranchUserRestrictionsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksCreateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the check. For example, "code-coverage". + */ + name: string; + /** + * The SHA of the commit. + */ + head_sha: string; + /** + * The URL of the integrator's site that has the full details of the check. + */ + details_url?: string; + /** + * A reference for the run on the integrator's system. + */ + external_id?: string; + /** + * The current status. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. + */ + conclusion?: + | "success" + | "failure" + | "neutral" + | "cancelled" + | "timed_out" + | "action_required"; + /** + * The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** + * Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description. + */ + output?: ChecksCreateParamsOutput; + /** + * Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + */ + actions?: ChecksCreateParamsActions[]; +}; +type ChecksCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksUpdateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_run_id parameter + */ + check_run_id: number; + /** + * The name of the check. For example, "code-coverage". + */ + name?: string; + /** + * The URL of the integrator's site that has the full details of the check. + */ + details_url?: string; + /** + * A reference for the run on the integrator's system. + */ + external_id?: string; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * The current status. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. + */ + conclusion?: + | "success" + | "failure" + | "neutral" + | "cancelled" + | "timed_out" + | "action_required"; + /** + * The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** + * Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description. + */ + output?: ChecksUpdateParamsOutput; + /** + * Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + */ + actions?: ChecksUpdateParamsActions[]; +}; +type ChecksUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksGetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_run_id parameter + */ + check_run_id: number; +}; +type ChecksGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksListAnnotationsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_run_id parameter + */ + check_run_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ChecksListAnnotationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksCreateSuiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The sha of the head commit. + */ + head_sha: string; +}; +type ChecksCreateSuiteRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksSetSuitesPreferencesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details. + */ + auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]; +}; +type ChecksSetSuitesPreferencesRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksGetSuiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_suite_id parameter + */ + check_suite_id: number; +}; +type ChecksGetSuiteRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksListForSuiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_suite_id parameter + */ + check_suite_id: number; + /** + * Returns check runs with the specified `name`. + */ + check_name?: string; + /** + * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ChecksListForSuiteRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksRerequestSuiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_suite_id parameter + */ + check_suite_id: number; +}; +type ChecksRerequestSuiteRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListCollaboratorsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Filter collaborators returned by their affiliation. Can be one of: + * \* `outside`: All outside collaborators of an organization-owned repository. + * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListCollaboratorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCheckCollaboratorEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * username parameter + */ + username: string; +}; +type ReposCheckCollaboratorRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddCollaboratorEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * username parameter + */ + username: string; + /** + * The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: + * \* `pull` - can pull, but not push to or administer this repository. + * \* `push` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push and administer this repository. + */ + permission?: "pull" | "push" | "admin"; +}; +type ReposAddCollaboratorRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveCollaboratorEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * username parameter + */ + username: string; +}; +type ReposRemoveCollaboratorRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCollaboratorPermissionLevelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * username parameter + */ + username: string; +}; +type ReposGetCollaboratorPermissionLevelRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListCommitCommentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListCommitCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type ReposGetCommitCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The contents of the comment + */ + body: string; +}; +type ReposUpdateCommitCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type ReposDeleteCommitCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForCommitCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForCommitCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListCommitsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). + */ + sha?: string; + /** + * Only commits containing this file path will be returned. + */ + path?: string; + /** + * GitHub login or email address by which to filter by commit author. + */ + author?: string; + /** + * Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + until?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListBranchesForHeadCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; +}; +type ReposListBranchesForHeadCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListCommentsForCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListCommentsForCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; + /** + * The contents of the comment. + */ + body: string; + /** + * Relative path of the file to comment on. + */ + path?: string; + /** + * Line index in the diff to comment on. + */ + position?: number; + /** + * **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. + */ + line?: number; +}; +type ReposCreateCommitCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListPullRequestsAssociatedWithCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListPullRequestsAssociatedWithCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; +}; +type ReposGetCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksListForRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * Returns check runs with the specified `name`. + */ + check_name?: string; + /** + * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ChecksListForRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksListSuitesForRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * Filters check suites by GitHub App `id`. + */ + app_id?: number; + /** + * Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/). + */ + check_name?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ChecksListSuitesForRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCombinedStatusForRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; +}; +type ReposGetCombinedStatusForRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListStatusesForRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListStatusesForRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type CodesOfConductGetForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type CodesOfConductGetForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRetrieveCommunityProfileMetricsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposRetrieveCommunityProfileMetricsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCompareCommitsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * base parameter + */ + base: string; + /** + * head parameter + */ + head: string; +}; +type ReposCompareCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetContentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) + */ + ref?: string; +}; +type ReposGetContentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateOrUpdateFileEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The commit message. + */ + message: string; + /** + * The new file content, using Base64 encoding. + */ + content: string; + /** + * **Required if you are updating a file**. The blob SHA of the file being replaced. + */ + sha?: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * The person that committed the file. Default: the authenticated user. + */ + committer?: ReposCreateOrUpdateFileParamsCommitter; + /** + * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. + */ + author?: ReposCreateOrUpdateFileParamsAuthor; +}; +type ReposCreateOrUpdateFileRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateFileEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The commit message. + */ + message: string; + /** + * The new file content, using Base64 encoding. + */ + content: string; + /** + * **Required if you are updating a file**. The blob SHA of the file being replaced. + */ + sha?: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * The person that committed the file. Default: the authenticated user. + */ + committer?: ReposCreateFileParamsCommitter; + /** + * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. + */ + author?: ReposCreateFileParamsAuthor; +}; +type ReposCreateFileRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateFileEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The commit message. + */ + message: string; + /** + * The new file content, using Base64 encoding. + */ + content: string; + /** + * **Required if you are updating a file**. The blob SHA of the file being replaced. + */ + sha?: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * The person that committed the file. Default: the authenticated user. + */ + committer?: ReposUpdateFileParamsCommitter; + /** + * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. + */ + author?: ReposUpdateFileParamsAuthor; +}; +type ReposUpdateFileRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteFileEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The commit message. + */ + message: string; + /** + * The blob SHA of the file being replaced. + */ + sha: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * object containing information about the committer. + */ + committer?: ReposDeleteFileParamsCommitter; + /** + * object containing information about the author. + */ + author?: ReposDeleteFileParamsAuthor; +}; +type ReposDeleteFileRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListContributorsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Set to `1` or `true` to include anonymous contributors in results. + */ + anon?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListContributorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListDeploymentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The SHA recorded at creation time. + */ + sha?: string; + /** + * The name of the ref. This can be a branch, tag, or SHA. + */ + ref?: string; + /** + * The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). + */ + task?: string; + /** + * The name of the environment that was deployed to (e.g., `staging` or `production`). + */ + environment?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListDeploymentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateDeploymentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The ref to deploy. This can be a branch, tag, or SHA. + */ + ref: string; + /** + * Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). + */ + task?: string; + /** + * Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. + */ + auto_merge?: boolean; + /** + * The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. + */ + required_contexts?: string[]; + /** + * JSON payload with extra information about the deployment. + */ + payload?: string; + /** + * Name for the target deployment environment (e.g., `production`, `staging`, `qa`). + */ + environment?: string; + /** + * Short description of the deployment. + */ + description?: string; + /** + * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + transient_environment?: boolean; + /** + * Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + production_environment?: boolean; +}; +type ReposCreateDeploymentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetDeploymentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; +}; +type ReposGetDeploymentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListDeploymentStatusesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListDeploymentStatusesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateDeploymentStatusEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; + /** + * The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + */ + state: + | "error" + | "failure" + | "inactive" + | "in_progress" + | "queued" + | "pending" + | "success"; + /** + * The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + */ + target_url?: string; + /** + * The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + log_url?: string; + /** + * A short description of the status. The maximum description length is 140 characters. + */ + description?: string; + /** + * Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + */ + environment?: "production" | "staging" | "qa"; + /** + * Sets the URL for accessing your environment. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + environment_url?: string; + /** + * Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` + * **Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + auto_inactive?: boolean; +}; +type ReposCreateDeploymentStatusRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetDeploymentStatusEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; + /** + * status_id parameter + */ + status_id: number; +}; +type ReposGetDeploymentStatusRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateDispatchEventEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * **Required:** A custom webhook event name. + */ + event_type?: string; +}; +type ReposCreateDispatchEventRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListDownloadsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListDownloadsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetDownloadEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * download_id parameter + */ + download_id: number; +}; +type ReposGetDownloadRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteDownloadEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * download_id parameter + */ + download_id: number; +}; +type ReposDeleteDownloadRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListRepoEventsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListRepoEventsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListForksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The sort order. Can be either `newest`, `oldest`, or `stargazers`. + */ + sort?: "newest" | "oldest" | "stargazers"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListForksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateForkEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Optional parameter to specify the organization name if forking into an organization. + */ + organization?: string; +}; +type ReposCreateForkRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateBlobEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The new blob's content. + */ + content: string; + /** + * The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + */ + encoding?: string; +}; +type GitCreateBlobRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetBlobEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * file_sha parameter + */ + file_sha: string; +}; +type GitGetBlobRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The commit message + */ + message: string; + /** + * The SHA of the tree object this commit points to + */ + tree: string; + /** + * The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. + */ + parents: string[]; + /** + * Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. + */ + author?: GitCreateCommitParamsAuthor; + /** + * Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. + */ + committer?: GitCreateCommitParamsCommitter; + /** + * The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. + */ + signature?: string; +}; +type GitCreateCommitRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; +}; +type GitGetCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitListMatchingRefsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GitListMatchingRefsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; +}; +type GitGetRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. + */ + ref: string; + /** + * The SHA1 value for this reference. + */ + sha: string; +}; +type GitCreateRefRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitUpdateRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * The SHA1 value to set this reference to + */ + sha: string; + /** + * Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. + */ + force?: boolean; +}; +type GitUpdateRefRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitDeleteRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; +}; +type GitDeleteRefRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateTagEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The tag's name. This is typically a version (e.g., "v0.0.1"). + */ + tag: string; + /** + * The tag message. + */ + message: string; + /** + * The SHA of the git object this is tagging. + */ + object: string; + /** + * The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. + */ + type: "commit" | "tree" | "blob"; + /** + * An object with information about the individual creating the tag. + */ + tagger?: GitCreateTagParamsTagger; +}; +type GitCreateTagRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetTagEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * tag_sha parameter + */ + tag_sha: string; +}; +type GitGetTagRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateTreeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. + */ + tree: GitCreateTreeParamsTree[]; + /** + * The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted. + */ + base_tree?: string; +}; +type GitCreateTreeRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetTreeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * tree_sha parameter + */ + tree_sha: string; + /** + * recursive parameter + */ + recursive?: "1"; +}; +type GitGetTreeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListHooksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListHooksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. + */ + name?: string; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). + */ + config: ReposCreateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +type ReposCreateHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type ReposGetHookRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). + */ + config?: ReposUpdateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events. + */ + events?: string[]; + /** + * Determines a list of events to be added to the list of events that the Hook triggers for. + */ + add_events?: string[]; + /** + * Determines a list of events to be removed from the list of events that the Hook triggers for. + */ + remove_events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +type ReposUpdateHookRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type ReposDeleteHookRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposPingHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type ReposPingHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposTestPushHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type ReposTestPushHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsStartImportEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The URL of the originating repository. + */ + vcs_url: string; + /** + * The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. + */ + vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + /** + * If authentication is required, the username to provide to `vcs_url`. + */ + vcs_username?: string; + /** + * If authentication is required, the password to provide to `vcs_url`. + */ + vcs_password?: string; + /** + * For a tfvc import, the name of the project that is being imported. + */ + tfvc_project?: string; +}; +type MigrationsStartImportRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetImportProgressEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type MigrationsGetImportProgressRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsUpdateImportEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The username to provide to the originating repository. + */ + vcs_username?: string; + /** + * The password to provide to the originating repository. + */ + vcs_password?: string; +}; +type MigrationsUpdateImportRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsCancelImportEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type MigrationsCancelImportRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetCommitAuthorsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step. + */ + since?: string; +}; +type MigrationsGetCommitAuthorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsMapCommitAuthorEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * author_id parameter + */ + author_id: number; + /** + * The new Git author email. + */ + email?: string; + /** + * The new Git author name. + */ + name?: string; +}; +type MigrationsMapCommitAuthorRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetLargeFilesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type MigrationsGetLargeFilesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsSetLfsPreferenceEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import). + */ + use_lfs: "opt_in" | "opt_out"; +}; +type MigrationsSetLfsPreferenceRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetRepoInstallationEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type AppsGetRepoInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsFindRepoInstallationEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type AppsFindRepoInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsGetRestrictionsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type InteractionsGetRestrictionsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsAddOrUpdateRestrictionsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`. + */ + limit: "existing_users" | "contributors_only" | "collaborators_only"; +}; +type InteractionsAddOrUpdateRestrictionsForRepoRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsRemoveRestrictionsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type InteractionsRemoveRestrictionsForRepoRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListInvitationsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListInvitationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteInvitationEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * invitation_id parameter + */ + invitation_id: number; +}; +type ReposDeleteInvitationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateInvitationEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * invitation_id parameter + */ + invitation_id: number; + /** + * The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`. + */ + permissions?: "read" | "write" | "admin"; +}; +type ReposUpdateInvitationRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. + */ + milestone?: string; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. + */ + assignee?: string; + /** + * The user that created the issue. + */ + creator?: string; + /** + * A user that's mentioned in the issue. + */ + mentioned?: string; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCreateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The title of the issue. + */ + title: string; + /** + * The contents of the issue. + */ + body?: string; + /** + * Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ + */ + assignee?: string; + /** + * The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._ + */ + milestone?: number; + /** + * Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ + */ + labels?: string[]; + /** + * Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + */ + assignees?: string[]; +}; +type IssuesCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListCommentsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Either `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * Either `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; +}; +type IssuesListCommentsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesGetCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUpdateCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The contents of the comment. + */ + body: string; +}; +type IssuesUpdateCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesDeleteCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type IssuesDeleteCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForIssueCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForIssueCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForIssueCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForIssueCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListEventsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListEventsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetEventEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * event_id parameter + */ + event_id: number; +}; +type IssuesGetEventRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; +}; +type IssuesGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUpdateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The title of the issue. + */ + title?: string; + /** + * The contents of the issue. + */ + body?: string; + /** + * Login for the user that this issue should be assigned to. **This field is deprecated.** + */ + assignee?: string; + /** + * State of the issue. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ + */ + milestone?: number | null; + /** + * Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ + */ + labels?: string[]; + /** + * Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + */ + assignees?: string[]; +}; +type IssuesUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesAddAssigneesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ + */ + assignees?: string[]; +}; +type IssuesAddAssigneesRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesRemoveAssigneesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ + */ + assignees?: string[]; +}; +type IssuesRemoveAssigneesRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListCommentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCreateCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The contents of the comment. + */ + body: string; +}; +type IssuesCreateCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListEventsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListEventsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListLabelsOnIssueEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListLabelsOnIssueRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesAddLabelsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. + */ + labels: string[]; +}; +type IssuesAddLabelsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesReplaceLabelsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. + */ + labels?: string[]; +}; +type IssuesReplaceLabelsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesRemoveLabelsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; +}; +type IssuesRemoveLabelsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesRemoveLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * name parameter + */ + name: string; +}; +type IssuesRemoveLabelRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesLockEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: + * \* `off-topic` + * \* `too heated` + * \* `resolved` + * \* `spam` + */ + lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; +}; +type IssuesLockRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUnlockEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; +}; +type IssuesUnlockRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForIssueEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForIssueRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForIssueEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForIssueRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListEventsForTimelineEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListEventsForTimelineRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListDeployKeysEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListDeployKeysRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddDeployKeyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * A name for the key. + */ + title?: string; + /** + * The contents of the key. + */ + key: string; + /** + * If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + * + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/)." + */ + read_only?: boolean; +}; +type ReposAddDeployKeyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetDeployKeyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * key_id parameter + */ + key_id: number; +}; +type ReposGetDeployKeyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveDeployKeyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * key_id parameter + */ + key_id: number; +}; +type ReposRemoveDeployKeyRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListLabelsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListLabelsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCreateLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). + */ + name: string; + /** + * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + */ + color: string; + /** + * A short description of the label. + */ + description?: string; +}; +type IssuesCreateLabelRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * name parameter + */ + name: string; +}; +type IssuesGetLabelRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUpdateLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * name parameter + */ + name: string; + /** + * The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). + */ + new_name?: string; + /** + * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + */ + color?: string; + /** + * A short description of the label. + */ + description?: string; +}; +type IssuesUpdateLabelRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesDeleteLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * name parameter + */ + name: string; +}; +type IssuesDeleteLabelRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListLanguagesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposListLanguagesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type LicensesGetForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type LicensesGetForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposMergeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the base branch that the head will be merged into. + */ + base: string; + /** + * The head to merge. This can be a branch name or a commit SHA1. + */ + head: string; + /** + * Commit message to use for the merge commit. If omitted, a default message will be used. + */ + commit_message?: string; +}; +type ReposMergeRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListMilestonesForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The state of the milestone. Either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * What to sort results by. Either `due_on` or `completeness`. + */ + sort?: "due_on" | "completeness"; + /** + * The direction of the sort. Either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListMilestonesForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCreateMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The title of the milestone. + */ + title: string; + /** + * The state of the milestone. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * A description of the milestone. + */ + description?: string; + /** + * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + due_on?: string; +}; +type IssuesCreateMilestoneRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * milestone_number parameter + */ + milestone_number: number; +}; +type IssuesGetMilestoneRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUpdateMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * milestone_number parameter + */ + milestone_number: number; + /** + * The title of the milestone. + */ + title?: string; + /** + * The state of the milestone. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * A description of the milestone. + */ + description?: string; + /** + * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + due_on?: string; +}; +type IssuesUpdateMilestoneRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesDeleteMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * milestone_number parameter + */ + milestone_number: number; +}; +type IssuesDeleteMilestoneRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListLabelsForMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * milestone_number parameter + */ + milestone_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListLabelsForMilestoneRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListNotificationsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * If `true`, show notifications marked as read. + */ + all?: boolean; + /** + * If `true`, only shows notifications in which the user is directly participating or mentioned. + */ + participating?: boolean; + /** + * Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + before?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListNotificationsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityMarkNotificationsAsReadForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; +}; +type ActivityMarkNotificationsAsReadForRepoRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetPagesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetPagesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposEnablePagesSiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * source parameter + */ + source?: ReposEnablePagesSiteParamsSource; +}; +type ReposEnablePagesSiteRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDisablePagesSiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposDisablePagesSiteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateInformationAboutPagesSiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/)." + */ + cname?: string; + /** + * Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `"gh-pages"`, `"master"`, and `"master /docs"`. + */ + source?: '"gh-pages"' | '"master"' | '"master /docs"'; +}; +type ReposUpdateInformationAboutPagesSiteRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRequestPageBuildEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposRequestPageBuildRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListPagesBuildsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListPagesBuildsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetLatestPagesBuildEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetLatestPagesBuildRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetPagesBuildEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * build_id parameter + */ + build_id: number; +}; +type ReposGetPagesBuildRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +}; +type ProjectsCreateForRepoRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Either `open`, `closed`, or `all` to filter by state. + */ + state?: "open" | "closed" | "all"; + /** + * Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. + */ + head?: string; + /** + * Filter pulls by base branch name. Example: `gh-pages`. + */ + base?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). + */ + sort?: "created" | "updated" | "popularity" | "long-running"; + /** + * The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The title of the new pull request. + */ + title: string; + /** + * The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. + */ + head: string; + /** + * The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. + */ + base: string; + /** + * The contents of the pull request. + */ + body?: string; + /** + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + */ + maintainer_can_modify?: boolean; + /** + * Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. + */ + draft?: boolean; +}; +type PullsCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListCommentsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Can be either `created` or `updated` comments. + */ + sort?: "created" | "updated"; + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListCommentsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsGetCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type PullsGetCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsUpdateCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The text of the reply to the review comment. + */ + body: string; +}; +type PullsUpdateCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsDeleteCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type PullsDeleteCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForPullRequestReviewCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForPullRequestReviewCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForPullRequestReviewCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForPullRequestReviewCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsGetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; +}; +type PullsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsUpdateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The title of the pull request. + */ + title?: string; + /** + * The contents of the pull request. + */ + body?: string; + /** + * State of this Pull Request. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. + */ + base?: string; + /** + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + */ + maintainer_can_modify?: boolean; +}; +type PullsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListCommentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Can be either `created` or `updated` comments. + */ + sort?: "created" | "updated"; + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The text of the review comment. + */ + body: string; + /** + * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. + */ + commit_id: string; + /** + * The relative path to the file that necessitates a comment. + */ + path: string; + /** + * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + */ + position?: number; + /** + * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + */ + side?: "LEFT" | "RIGHT"; + /** + * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. + */ + line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. + */ + start_line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + */ + start_side?: "LEFT" | "RIGHT" | "side"; +}; +type PullsCreateCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateCommentReplyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The text of the review comment. + */ + body: string; + /** + * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. + */ + commit_id: string; + /** + * The relative path to the file that necessitates a comment. + */ + path: string; + /** + * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + */ + position?: number; + /** + * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + */ + side?: "LEFT" | "RIGHT"; + /** + * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. + */ + line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. + */ + start_line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + */ + start_side?: "LEFT" | "RIGHT" | "side"; +}; +type PullsCreateCommentReplyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateReviewCommentReplyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The text of the review comment. + */ + body: string; +}; +type PullsCreateReviewCommentReplyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListCommitsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListFilesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListFilesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCheckIfMergedEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; +}; +type PullsCheckIfMergedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsMergeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Title for the automatic commit message. + */ + commit_title?: string; + /** + * Extra detail to append to automatic commit message. + */ + commit_message?: string; + /** + * SHA that pull request head must match to allow merge. + */ + sha?: string; + /** + * Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. + */ + merge_method?: "merge" | "squash" | "rebase"; +}; +type PullsMergeRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListReviewRequestsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListReviewRequestsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateReviewRequestEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * An array of user `login`s that will be requested. + */ + reviewers?: string[]; + /** + * An array of team `slug`s that will be requested. + */ + team_reviewers?: string[]; +}; +type PullsCreateReviewRequestRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsDeleteReviewRequestEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * An array of user `login`s that will be removed. + */ + reviewers?: string[]; + /** + * An array of team `slug`s that will be removed. + */ + team_reviewers?: string[]; +}; +type PullsDeleteReviewRequestRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListReviewsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListReviewsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. + */ + commit_id?: string; + /** + * **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. + */ + body?: string; + /** + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready. + */ + event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + /** + * Use the following table to specify the location, destination, and contents of the draft review comment. + */ + comments?: PullsCreateReviewParamsComments[]; +}; +type PullsCreateReviewRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsGetReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; +}; +type PullsGetReviewRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsDeletePendingReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; +}; +type PullsDeletePendingReviewRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsUpdateReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; + /** + * The body text of the pull request review. + */ + body: string; +}; +type PullsUpdateReviewRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsGetCommentsForReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsGetCommentsForReviewRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsDismissReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; + /** + * The message for the pull request review dismissal + */ + message: string; +}; +type PullsDismissReviewRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsSubmitReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; + /** + * The body text of the pull request review + */ + body?: string; + /** + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. + */ + event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; +}; +type PullsSubmitReviewRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsUpdateBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. + */ + expected_head_sha?: string; +}; +type PullsUpdateBranchRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetReadmeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) + */ + ref?: string; +}; +type ReposGetReadmeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListReleasesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListReleasesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the tag. + */ + tag_name: string; + /** + * Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). + */ + target_commitish?: string; + /** + * The name of the release. + */ + name?: string; + /** + * Text describing the contents of the tag. + */ + body?: string; + /** + * `true` to create a draft (unpublished) release, `false` to create a published one. + */ + draft?: boolean; + /** + * `true` to identify the release as a prerelease. `false` to identify the release as a full release. + */ + prerelease?: boolean; +}; +type ReposCreateReleaseRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetReleaseAssetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * asset_id parameter + */ + asset_id: number; +}; +type ReposGetReleaseAssetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateReleaseAssetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * asset_id parameter + */ + asset_id: number; + /** + * The file name of the asset. + */ + name?: string; + /** + * An alternate short description of the asset. Used in place of the filename. + */ + label?: string; +}; +type ReposUpdateReleaseAssetRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteReleaseAssetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * asset_id parameter + */ + asset_id: number; +}; +type ReposDeleteReleaseAssetRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetLatestReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetLatestReleaseRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetReleaseByTagEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * tag parameter + */ + tag: string; +}; +type ReposGetReleaseByTagRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; +}; +type ReposGetReleaseRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; + /** + * The name of the tag. + */ + tag_name?: string; + /** + * Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). + */ + target_commitish?: string; + /** + * The name of the release. + */ + name?: string; + /** + * Text describing the contents of the tag. + */ + body?: string; + /** + * `true` makes the release a draft, and `false` publishes the release. + */ + draft?: boolean; + /** + * `true` to identify the release as a prerelease, `false` to identify the release as a full release. + */ + prerelease?: boolean; +}; +type ReposUpdateReleaseRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; +}; +type ReposDeleteReleaseRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListAssetsForReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListAssetsForReleaseRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListStargazersForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListStargazersForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCodeFrequencyStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetCodeFrequencyStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCommitActivityStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetCommitActivityStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetContributorsStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetContributorsStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetParticipationStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetParticipationStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetPunchCardStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetPunchCardStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateStatusEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * sha parameter + */ + sha: string; + /** + * The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. + */ + state: "error" | "failure" | "pending" | "success"; + /** + * The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` + */ + target_url?: string; + /** + * A short description of the status. + */ + description?: string; + /** + * A string label to differentiate this status from the status of other systems. + */ + context?: string; +}; +type ReposCreateStatusRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListWatchersForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListWatchersForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityGetRepoSubscriptionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityGetRepoSubscriptionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivitySetRepoSubscriptionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Determines if notifications should be received from this repository. + */ + subscribed?: boolean; + /** + * Determines if all notifications should be blocked from this repository. + */ + ignored?: boolean; +}; +type ActivitySetRepoSubscriptionRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityDeleteRepoSubscriptionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityDeleteRepoSubscriptionRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListTagsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListTagsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListTeamsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListTeamsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListTopicsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposListTopicsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceTopicsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. + */ + names: string[]; +}; +type ReposReplaceTopicsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetClonesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Must be one of: `day`, `week`. + */ + per?: "day" | "week"; +}; +type ReposGetClonesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetTopPathsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetTopPathsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetTopReferrersEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetTopReferrersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetViewsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Must be one of: `day`, `week`. + */ + per?: "day" | "week"; +}; +type ReposGetViewsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposTransferEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * **Required:** The username or organization name the repository will be transferred to. + */ + new_owner?: string; + /** + * ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. + */ + team_ids?: number[]; +}; +type ReposTransferRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCheckVulnerabilityAlertsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposCheckVulnerabilityAlertsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposEnableVulnerabilityAlertsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposEnableVulnerabilityAlertsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDisableVulnerabilityAlertsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposDisableVulnerabilityAlertsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetArchiveLinkEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * archive_format parameter + */ + archive_format: string; + /** + * ref parameter + */ + ref: string; +}; +type ReposGetArchiveLinkRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateUsingTemplateEndpoint = { + /** + * template_owner parameter + */ + template_owner: string; + /** + * template_repo parameter + */ + template_repo: string; + /** + * The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. + */ + owner?: string; + /** + * The name of the new repository. + */ + name: string; + /** + * A short description of the new repository. + */ + description?: string; + /** + * Either `true` to create a new private repository or `false` to create a new public one. + */ + private?: boolean; +}; +type ReposCreateUsingTemplateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListPublicEndpoint = { + /** + * The integer ID of the last Repository that you've seen. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListPublicRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimListProvisionedIdentitiesEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Used for pagination: the index of the first result to return. + */ + startIndex?: number; + /** + * Used for pagination: the number of results to return. + */ + count?: number; + /** + * Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: `?filter=userName%20eq%20\"Octocat\"`. + */ + filter?: string; +}; +type ScimListProvisionedIdentitiesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimProvisionAndInviteUsersEndpoint = { + /** + * org parameter + */ + org: string; +}; +type ScimProvisionAndInviteUsersRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimProvisionInviteUsersEndpoint = { + /** + * org parameter + */ + org: string; +}; +type ScimProvisionInviteUsersRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimGetProvisioningDetailsForUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimGetProvisioningDetailsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimReplaceProvisionedUserInformationEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimReplaceProvisionedUserInformationRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimUpdateProvisionedOrgMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimUpdateProvisionedOrgMembershipRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimUpdateUserAttributeEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimUpdateUserAttributeRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimRemoveUserFromOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimRemoveUserFromOrgRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchCodeEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching code](https://help.github.com/articles/searching-code/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "indexed"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchCodeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchCommitsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching commits](https://help.github.com/articles/searching-commits/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "author-date" | "committer-date"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchIssuesAndPullRequestsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: + | "comments" + | "reactions" + | "reactions-+1" + | "reactions--1" + | "reactions-smile" + | "reactions-thinking_face" + | "reactions-heart" + | "reactions-tada" + | "interactions" + | "created" + | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchIssuesAndPullRequestsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchIssuesEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: + | "comments" + | "reactions" + | "reactions-+1" + | "reactions--1" + | "reactions-smile" + | "reactions-thinking_face" + | "reactions-heart" + | "reactions-tada" + | "interactions" + | "created" + | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchIssuesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchLabelsEndpoint = { + /** + * The id of the repository. + */ + repository_id: number; + /** + * The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). + */ + q: string; + /** + * Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "created" | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; +}; +type SearchLabelsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchReposEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchReposRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchTopicsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). + */ + q: string; +}; +type SearchTopicsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchUsersEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching users](https://help.github.com/articles/searching-users/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "followers" | "repositories" | "joined"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchUsersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetEndpoint = { + /** + * team_id parameter + */ + team_id: number; +}; +type TeamsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsUpdateEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. + */ + parent_team_id?: number; +}; +type TeamsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsDeleteEndpoint = { + /** + * team_id parameter + */ + team_id: number; +}; +type TeamsDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListDiscussionsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListDiscussionsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * The discussion post's title. + */ + title: string; + /** + * The discussion post's body text. + */ + body: string; + /** + * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + */ + private?: boolean; +}; +type TeamsCreateDiscussionRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; +}; +type TeamsGetDiscussionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsUpdateDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * The discussion post's title. + */ + title?: string; + /** + * The discussion post's body text. + */ + body?: string; +}; +type TeamsUpdateDiscussionRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsDeleteDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; +}; +type TeamsDeleteDiscussionRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListDiscussionCommentsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListDiscussionCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +type TeamsCreateDiscussionCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; +}; +type TeamsGetDiscussionCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsUpdateDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +type TeamsUpdateDiscussionCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsDeleteDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; +}; +type TeamsDeleteDiscussionCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForTeamDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForTeamDiscussionCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForTeamDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForTeamDiscussionCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForTeamDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForTeamDiscussionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForTeamDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForTeamDiscussionRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListPendingInvitationsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListPendingInvitationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListMembersEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListMembersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetMemberEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsGetMemberRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddMemberEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsAddMemberRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsRemoveMemberEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsRemoveMemberRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetMembershipEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsGetMembershipRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddOrUpdateMembershipEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; +}; +type TeamsAddOrUpdateMembershipRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsRemoveMembershipEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsRemoveMembershipRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListProjectsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListProjectsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsReviewProjectEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * project_id parameter + */ + project_id: number; +}; +type TeamsReviewProjectRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddOrUpdateProjectEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * project_id parameter + */ + project_id: number; + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team. + */ + permission?: "read" | "write" | "admin"; +}; +type TeamsAddOrUpdateProjectRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsRemoveProjectEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * project_id parameter + */ + project_id: number; +}; +type TeamsRemoveProjectRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListReposEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListReposRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCheckManagesRepoEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type TeamsCheckManagesRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddOrUpdateRepoEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team. + */ + permission?: "pull" | "push" | "admin"; +}; +type TeamsAddOrUpdateRepoRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsRemoveRepoEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type TeamsRemoveRepoRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListIdPGroupsEndpoint = { + /** + * team_id parameter + */ + team_id: number; +}; +type TeamsListIdPGroupsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateOrUpdateIdPGroupConnectionsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. + */ + groups: TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups[]; +}; +type TeamsCreateOrUpdateIdPGroupConnectionsRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListChildEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListChildRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetAuthenticatedEndpoint = {}; +type UsersGetAuthenticatedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersUpdateAuthenticatedEndpoint = { + /** + * The new name of the user. + */ + name?: string; + /** + * The publicly visible email address of the user. + */ + email?: string; + /** + * The new blog URL of the user. + */ + blog?: string; + /** + * The new company of the user. + */ + company?: string; + /** + * The new location of the user. + */ + location?: string; + /** + * The new hiring availability of the user. + */ + hireable?: boolean; + /** + * The new short biography of the user. + */ + bio?: string; +}; +type UsersUpdateAuthenticatedRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListBlockedEndpoint = {}; +type UsersListBlockedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCheckBlockedEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersCheckBlockedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersBlockEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersBlockRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersUnblockEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersUnblockRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersTogglePrimaryEmailVisibilityEndpoint = { + /** + * Specify the _primary_ email address that needs a visibility change. + */ + email: string; + /** + * Use `public` to enable an authenticated user to view the specified email address, or use `private` so this primary email address cannot be seen publicly. + */ + visibility: string; +}; +type UsersTogglePrimaryEmailVisibilityRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListEmailsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListEmailsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersAddEmailsEndpoint = { + /** + * Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. + */ + emails: string[]; +}; +type UsersAddEmailsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersDeleteEmailsEndpoint = { + /** + * Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. + */ + emails: string[]; +}; +type UsersDeleteEmailsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListFollowersForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListFollowersForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListFollowingForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListFollowingForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCheckFollowingEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersCheckFollowingRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersFollowEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersFollowRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersUnfollowEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersUnfollowRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListGpgKeysEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListGpgKeysRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCreateGpgKeyEndpoint = { + /** + * Your GPG key, generated in ASCII-armored format. See "[Generating a new GPG key](https://help.github.com/articles/generating-a-new-gpg-key/)" for help creating a GPG key. + */ + armored_public_key?: string; +}; +type UsersCreateGpgKeyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetGpgKeyEndpoint = { + /** + * gpg_key_id parameter + */ + gpg_key_id: number; +}; +type UsersGetGpgKeyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersDeleteGpgKeyEndpoint = { + /** + * gpg_key_id parameter + */ + gpg_key_id: number; +}; +type UsersDeleteGpgKeyRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListInstallationsForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListInstallationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListInstallationReposForAuthenticatedUserEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListInstallationReposForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsAddRepoToInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; + /** + * repository_id parameter + */ + repository_id: number; +}; +type AppsAddRepoToInstallationRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsRemoveRepoFromInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; + /** + * repository_id parameter + */ + repository_id: number; +}; +type AppsRemoveRepoFromInstallationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListForAuthenticatedUserEndpoint = { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListPublicKeysEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListPublicKeysRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCreatePublicKeyEndpoint = { + /** + * A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air". + */ + title?: string; + /** + * The public SSH key to add to your GitHub account. See "[Generating a new SSH key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)" for guidance on how to create a public SSH key. + */ + key?: string; +}; +type UsersCreatePublicKeyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetPublicKeyEndpoint = { + /** + * key_id parameter + */ + key_id: number; +}; +type UsersGetPublicKeyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersDeletePublicKeyEndpoint = { + /** + * key_id parameter + */ + key_id: number; +}; +type UsersDeletePublicKeyRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListMarketplacePurchasesForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListMarketplacePurchasesForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListMarketplacePurchasesForAuthenticatedUserStubbedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListMembershipsEndpoint = { + /** + * Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. + */ + state?: "active" | "pending"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListMembershipsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsGetMembershipForAuthenticatedUserEndpoint = { + /** + * org parameter + */ + org: string; +}; +type OrgsGetMembershipForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsUpdateMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * The state that the membership should be in. Only `"active"` will be accepted. + */ + state: "active"; +}; +type OrgsUpdateMembershipRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsStartForAuthenticatedUserEndpoint = { + /** + * An array of repositories to include in the migration. + */ + repositories: string[]; + /** + * Locks the `repositories` to prevent changes during the migration when set to `true`. + */ + lock_repositories?: boolean; + /** + * Does not include attachments uploaded to GitHub.com in the migration data when set to `true`. Excluding attachments will reduce the migration archive file size. + */ + exclude_attachments?: boolean; +}; +type MigrationsStartForAuthenticatedUserRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type MigrationsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetStatusForAuthenticatedUserEndpoint = { + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsGetStatusForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetArchiveForAuthenticatedUserEndpoint = { + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsGetArchiveForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsDeleteArchiveForAuthenticatedUserEndpoint = { + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsDeleteArchiveForAuthenticatedUserRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsUnlockRepoForAuthenticatedUserEndpoint = { + /** + * migration_id parameter + */ + migration_id: number; + /** + * repo_name parameter + */ + repo_name: string; +}; +type MigrationsUnlockRepoForAuthenticatedUserRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateForAuthenticatedUserEndpoint = { + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +}; +type ProjectsCreateForAuthenticatedUserRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListPublicEmailsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListPublicEmailsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListEndpoint = { + /** + * Can be one of `all`, `public`, or `private`. + */ + visibility?: "all" | "public" | "private"; + /** + * Comma-separated list of values. Can include: + * \* `owner`: Repositories that are owned by the authenticated user. + * \* `collaborator`: Repositories that the user has been added to as a collaborator. + * \* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. + */ + affiliation?: string; + /** + * Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` + * + * Will cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. + */ + type?: "all" | "owner" | "public" | "private" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateForAuthenticatedUserEndpoint = { + /** + * The name of the repository. + */ + name: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account. + */ + private?: boolean; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + */ + team_id?: number; + /** + * Pass `true` to create an initial commit with empty README. + */ + auto_init?: boolean; + /** + * Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". + */ + gitignore_template?: string; + /** + * Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". + */ + license_template?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; +}; +type ReposCreateForAuthenticatedUserRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListInvitationsForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListInvitationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAcceptInvitationEndpoint = { + /** + * invitation_id parameter + */ + invitation_id: number; +}; +type ReposAcceptInvitationRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeclineInvitationEndpoint = { + /** + * invitation_id parameter + */ + invitation_id: number; +}; +type ReposDeclineInvitationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReposStarredByAuthenticatedUserEndpoint = { + /** + * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). + */ + sort?: "created" | "updated"; + /** + * One of `asc` (ascending) or `desc` (descending). + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReposStarredByAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityCheckStarringRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityCheckStarringRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityStarRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityStarRepoRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityUnstarRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityUnstarRepoRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListWatchedReposForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListWatchedReposForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityCheckWatchingRepoLegacyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityCheckWatchingRepoLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityWatchRepoLegacyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityWatchRepoLegacyRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityStopWatchingRepoLegacyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityStopWatchingRepoLegacyRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListEndpoint = { + /** + * The integer ID of the last User that you've seen. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetByUsernameEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersGetByUsernameRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListEventsForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListEventsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListEventsForOrgEndpoint = { + /** + * username parameter + */ + username: string; + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListEventsForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListPublicEventsForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListPublicEventsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListFollowersForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListFollowersForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListFollowingForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListFollowingForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCheckFollowingForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * target_user parameter + */ + target_user: string; +}; +type UsersCheckFollowingForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListPublicForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListPublicForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListGpgKeysForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListGpgKeysForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetContextForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. + */ + subject_type?: "organization" | "repository" | "issue" | "pull_request"; + /** + * Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. + */ + subject_id?: string; +}; +type UsersGetContextForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetUserInstallationEndpoint = { + /** + * username parameter + */ + username: string; +}; +type AppsGetUserInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsFindUserInstallationEndpoint = { + /** + * username parameter + */ + username: string; +}; +type AppsFindUserInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListPublicKeysForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListPublicKeysForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReceivedEventsForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReceivedEventsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReceivedPublicEventsForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReceivedPublicEventsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Can be one of `all`, `owner`, `member`. + */ + type?: "all" | "owner" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReposStarredByUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). + */ + sort?: "created" | "updated"; + /** + * One of `asc` (ascending) or `desc` (descending). + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReposStarredByUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReposWatchedByUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReposWatchedByUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +export type AppsCreateInstallationTokenParamsPermissions = {}; +export type GistsCreateParamsFiles = { + content?: string; +}; +export type GistsUpdateParamsFiles = { + content?: string; + filename?: string; +}; +export type OrgsCreateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +export type OrgsUpdateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +export type ReposUpdateBranchProtectionParamsRequiredStatusChecks = { + strict: boolean; + contexts: string[]; +}; +export type ReposUpdateBranchProtectionParamsRequiredPullRequestReviews = { + dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions; + dismiss_stale_reviews?: boolean; + require_code_owner_reviews?: boolean; + required_approving_review_count?: number; +}; +export type ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions = { + users?: string[]; + teams?: string[]; +}; +export type ReposUpdateBranchProtectionParamsRestrictions = { + users: string[]; + teams: string[]; + apps?: string[]; +}; +export type ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions = { + users?: string[]; + teams?: string[]; +}; +export type ChecksCreateParamsOutput = { + title: string; + summary: string; + text?: string; + annotations?: ChecksCreateParamsOutputAnnotations[]; + images?: ChecksCreateParamsOutputImages[]; +}; +export type ChecksCreateParamsOutputAnnotations = { + path: string; + start_line: number; + end_line: number; + start_column?: number; + end_column?: number; + annotation_level: "notice" | "warning" | "failure"; + message: string; + title?: string; + raw_details?: string; +}; +export type ChecksCreateParamsOutputImages = { + alt: string; + image_url: string; + caption?: string; +}; +export type ChecksCreateParamsActions = { + label: string; + description: string; + identifier: string; +}; +export type ChecksUpdateParamsOutput = { + title?: string; + summary: string; + text?: string; + annotations?: ChecksUpdateParamsOutputAnnotations[]; + images?: ChecksUpdateParamsOutputImages[]; +}; +export type ChecksUpdateParamsOutputAnnotations = { + path: string; + start_line: number; + end_line: number; + start_column?: number; + end_column?: number; + annotation_level: "notice" | "warning" | "failure"; + message: string; + title?: string; + raw_details?: string; +}; +export type ChecksUpdateParamsOutputImages = { + alt: string; + image_url: string; + caption?: string; +}; +export type ChecksUpdateParamsActions = { + label: string; + description: string; + identifier: string; +}; +export type ChecksSetSuitesPreferencesParamsAutoTriggerChecks = { + app_id: number; + setting: boolean; +}; +export type ReposCreateOrUpdateFileParamsCommitter = { + name: string; + email: string; +}; +export type ReposCreateOrUpdateFileParamsAuthor = { + name: string; + email: string; +}; +export type ReposCreateFileParamsCommitter = { + name: string; + email: string; +}; +export type ReposCreateFileParamsAuthor = { + name: string; + email: string; +}; +export type ReposUpdateFileParamsCommitter = { + name: string; + email: string; +}; +export type ReposUpdateFileParamsAuthor = { + name: string; + email: string; +}; +export type ReposDeleteFileParamsCommitter = { + name?: string; + email?: string; +}; +export type ReposDeleteFileParamsAuthor = { + name?: string; + email?: string; +}; +export type GitCreateCommitParamsAuthor = { + name?: string; + email?: string; + date?: string; +}; +export type GitCreateCommitParamsCommitter = { + name?: string; + email?: string; + date?: string; +}; +export type GitCreateTagParamsTagger = { + name?: string; + email?: string; + date?: string; +}; +export type GitCreateTreeParamsTree = { + path?: string; + mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + type?: "blob" | "tree" | "commit"; + sha?: string; + content?: string; +}; +export type ReposCreateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +export type ReposUpdateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +export type ReposEnablePagesSiteParamsSource = { + branch?: "master" | "gh-pages"; + path?: string; +}; +export type PullsCreateReviewParamsComments = { + path: string; + position: number; + body: string; +}; +export type TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups = { + group_id: string; + group_name: string; + group_description: string; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/generated/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/generated/README.md new file mode 100644 index 00000000..2bc90d20 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/generated/README.md @@ -0,0 +1,3 @@ +# ⚠️ Do not edit files in this folder + +All files are generated. Manual changes will be overwritten. If you find a problem, please look into how they are generated. When in doubt, please open a new issue. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/index.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/index.ts new file mode 100644 index 00000000..a0f51b31 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/node_modules/@octokit/types/src/index.ts @@ -0,0 +1,18 @@ +export { AuthInterface } from "./AuthInterface"; +export { EndpointDefaults } from "./EndpointDefaults"; +export { EndpointInterface } from "./EndpointInterface"; +export { EndpointOptions } from "./EndpointOptions"; +export { Fetch } from "./Fetch"; +export { OctokitResponse } from "./OctokitResponse"; +export { RequestHeaders } from "./RequestHeaders"; +export { RequestInterface } from "./RequestInterface"; +export { RequestMethod } from "./RequestMethod"; +export { RequestOptions } from "./RequestOptions"; +export { RequestParameters } from "./RequestParameters"; +export { RequestRequestOptions } from "./RequestRequestOptions"; +export { ResponseHeaders } from "./ResponseHeaders"; +export { Route } from "./Route"; +export { Signal } from "./Signal"; +export { StrategyInterface } from "./StrategyInterface"; +export { Url } from "./Url"; +export { VERSION } from "./VERSION"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request-error/package.json b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/package.json new file mode 100644 index 00000000..758d367a --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request-error/package.json @@ -0,0 +1,54 @@ +{ + "name": "@octokit/request-error", + "description": "Error class for Octokit request errors", + "version": "1.2.0", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "octokit", + "github", + "api", + "error" + ], + "homepage": "https://github.com/octokit/request-error.js#readme", + "bugs": { + "url": "https://github.com/octokit/request-error.js/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/octokit/request-error.js.git" + }, + "dependencies": { + "@octokit/types": "^2.0.0", + "deprecation": "^2.0.0", + "once": "^1.4.0" + }, + "devDependencies": { + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.7.0", + "@pika/plugin-build-web": "^0.7.0", + "@pika/plugin-bundle-web": "^0.7.0", + "@pika/plugin-ts-standard-pkg": "^0.7.0", + "@types/jest": "^24.0.12", + "@types/node": "^12.0.2", + "@types/once": "^1.4.0", + "jest": "^24.7.1", + "pika-plugin-unpkg-field": "^1.1.0", + "prettier": "^1.17.0", + "semantic-release": "^15.10.5", + "ts-jest": "^24.0.2", + "typescript": "^3.4.5" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "deno": "dist-web/index.js" +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/LICENSE b/node_modules/@octokit/graphql/node_modules/@octokit/request/LICENSE new file mode 100644 index 00000000..af5366d0 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2018 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/request/README.md new file mode 100644 index 00000000..db35e628 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/README.md @@ -0,0 +1,539 @@ +# request.js + +> Send parameterized requests to GitHub’s APIs with sensible defaults in browsers and Node + +[![@latest](https://img.shields.io/npm/v/@octokit/request.svg)](https://www.npmjs.com/package/@octokit/request) +[![Build Status](https://travis-ci.org/octokit/request.js.svg?branch=master)](https://travis-ci.org/octokit/request.js) +[![Greenkeeper](https://badges.greenkeeper.io/octokit/request.js.svg)](https://greenkeeper.io/) + +`@octokit/request` is a request library for browsers & node that makes it easier +to interact with [GitHub’s REST API](https://developer.github.com/v3/) and +[GitHub’s GraphQL API](https://developer.github.com/v4/guides/forming-calls/#the-graphql-endpoint). + +It uses [`@octokit/endpoint`](https://github.com/octokit/endpoint.js) to parse +the passed options and sends the request using [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) +([node-fetch](https://github.com/bitinn/node-fetch) in Node). + + + + + +- [Features](#features) +- [Usage](#usage) + - [REST API example](#rest-api-example) + - [GraphQL example](#graphql-example) + - [Alternative: pass `method` & `url` as part of options](#alternative-pass-method--url-as-part-of-options) +- [Authentication](#authentication) +- [request()](#request) +- [`request.defaults()`](#requestdefaults) +- [`request.endpoint`](#requestendpoint) +- [Special cases](#special-cases) + - [The `data` parameter – set request body directly](#the-data-parameter-%E2%80%93-set-request-body-directly) + - [Set parameters for both the URL/query and the request body](#set-parameters-for-both-the-urlquery-and-the-request-body) +- [LICENSE](#license) + + + +## Features + +🤩 1:1 mapping of REST API endpoint documentation, e.g. [Add labels to an issue](https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue) becomes + +```js +request("POST /repos/:owner/:repo/issues/:number/labels", { + mediaType: { + previews: ["symmetra"] + }, + owner: "octokit", + repo: "request.js", + number: 1, + labels: ["🐛 bug"] +}); +``` + +👶 [Small bundle size](https://bundlephobia.com/result?p=@octokit/request@5.0.3) (\<4kb minified + gzipped) + +😎 [Authenticate](#authentication) with any of [GitHubs Authentication Strategies](https://github.com/octokit/auth.js). + +👍 Sensible defaults + +- `baseUrl`: `https://api.github.com` +- `headers.accept`: `application/vnd.github.v3+json` +- `headers.agent`: `octokit-request.js/ `, e.g. `octokit-request.js/1.2.3 Node.js/10.15.0 (macOS Mojave; x64)` + +👌 Simple to test: mock requests by passing a custom fetch method. + +🧐 Simple to debug: Sets `error.request` to request options causing the error (with redacted credentials). + +## Usage + + + + + + +
+Browsers + +Load @octokit/request directly from cdn.pika.dev + +```html + +``` + +
+Node + + +Install with npm install @octokit/request + +```js +const { request } = require("@octokit/request"); +// or: import { request } from "@octokit/request"; +``` + +
+ +### REST API example + +```js +// Following GitHub docs formatting: +// https://developer.github.com/v3/repos/#list-organization-repositories +const result = await request("GET /orgs/:org/repos", { + headers: { + authorization: "token 0000000000000000000000000000000000000001" + }, + org: "octokit", + type: "private" +}); + +console.log(`${result.data.length} repos found.`); +``` + +### GraphQL example + +For GraphQL request we recommend using [`@octokit/graphql`](https://github.com/octokit/graphql.js#readme) + +```js +const result = await request("POST /graphql", { + headers: { + authorization: "token 0000000000000000000000000000000000000001" + }, + query: `query ($login: String!) { + organization(login: $login) { + repositories(privacy: PRIVATE) { + totalCount + } + } + }`, + variables: { + login: "octokit" + } +}); +``` + +### Alternative: pass `method` & `url` as part of options + +Alternatively, pass in a method and a url + +```js +const result = await request({ + method: "GET", + url: "/orgs/:org/repos", + headers: { + authorization: "token 0000000000000000000000000000000000000001" + }, + org: "octokit", + type: "private" +}); +``` + +## Authentication + +The simplest way to authenticate a request is to set the `Authorization` header directly, e.g. to a [personal access token](https://github.com/settings/tokens/). + +```js +const requestWithAuth = request.defaults({ + headers: { + authorization: "token 0000000000000000000000000000000000000001" + } +}); +const result = await request("GET /user"); +``` + +For more complex authentication strategies such as GitHub Apps or Basic, we recommend the according authentication library exported by [`@octokit/auth`](https://github.com/octokit/auth.js). + +```js +const { createAppAuth } = require("@octokit/auth-app"); +const auth = createAppAuth({ + id: process.env.APP_ID, + privateKey: process.env.PRIVATE_KEY, + installationId: 123 +}); +const requestWithAuth = request.defaults({ + request: { + hook: auth.hook + }, + mediaType: { + previews: ["machine-man"] + } +}); + +const { data: app } = await requestWithAuth("GET /app"); +const { data: app } = await requestWithAuth("POST /repos/:owner/:repo/issues", { + owner: "octocat", + repo: "hello-world", + title: "Hello from the engine room" +}); +``` + +## request() + +`request(route, options)` or `request(options)`. + +**Options** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ name + + type + + description +
+ route + + String + + If route is set it has to be a string consisting of the request method and URL, e.g. GET /orgs/:org +
+ options.baseUrl + + String + + Required. Any supported http verb, case insensitive. Defaults to https://api.github.com. +
+ options.headers + + Object + + Custom headers. Passed headers are merged with defaults:
+ headers['user-agent'] defaults to octokit-rest.js/1.2.3 (where 1.2.3 is the released version).
+ headers['accept'] defaults to application/vnd.github.v3+json.
Use options.mediaType.{format,previews} to request API previews and custom media types. +
+ options.mediaType.format + + String + + Media type param, such as `raw`, `html`, or `full`. See Media Types. +
+ options.mediaType.previews + + Array of strings + + Name of previews, such as `mercy`, `symmetra`, or `scarlet-witch`. See API Previews. +
+ options.method + + String + + Required. Any supported http verb, case insensitive. Defaults to Get. +
+ options.url + + String + + Required. A path or full URL which may contain :variable or {variable} placeholders, + e.g. /orgs/:org/repos. The url is parsed using url-template. +
+ options.data + + Any + + Set request body directly instead of setting it to JSON based on additional parameters. See "The `data` parameter" below. +
+ options.request.agent + + http(s).Agent instance + + Node only. Useful for custom proxy, certificate, or dns lookup. +
+ options.request.fetch + + Function + + Custom replacement for built-in fetch method. Useful for testing or request hooks. +
+ options.request.hook + + Function + + Function with the signature hook(request, endpointOptions), where endpointOptions are the parsed options as returned by endpoint.merge(), and request is request(). This option works great in conjuction with before-after-hook. +
+ options.request.signal + + new AbortController().signal + + Use an AbortController instance to cancel a request. In node you can only cancel streamed requests. +
+ options.request.timeout + + Number + + Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). options.request.signal is recommended instead. +
+ +All other options except `options.request.*` will be passed depending on the `method` and `url` options. + +1. If the option key is a placeholder in the `url`, it will be used as replacement. For example, if the passed options are `{url: '/orgs/:org/repos', org: 'foo'}` the returned `options.url` is `https://api.github.com/orgs/foo/repos` +2. If the `method` is `GET` or `HEAD`, the option is passed as query parameter +3. Otherwise the parameter is passed in the request body as JSON key. + +**Result** + +`request` returns a promise and resolves with 4 keys + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ key + + type + + description +
statusIntegerResponse status status
urlStringURL of response. If a request results in redirects, this is the final URL. You can send a HEAD request to retrieve it without loading the full response body.
headersObjectAll response headers
dataAnyThe response body as returned from server. If the response is JSON then it will be parsed into an object
+ +If an error occurs, the `error` instance has additional properties to help with debugging + +- `error.status` The http response status code +- `error.headers` The http response headers as an object +- `error.request` The request options such as `method`, `url` and `data` + +## `request.defaults()` + +Override or set default options. Example: + +```js +const myrequest = require("@octokit/request").defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", + headers: { + "user-agent": "myApp/1.2.3", + authorization: `token 0000000000000000000000000000000000000001` + }, + org: "my-project", + per_page: 100 +}); + +myrequest(`GET /orgs/:org/repos`); +``` + +You can call `.defaults()` again on the returned method, the defaults will cascade. + +```js +const myProjectRequest = request.defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", + headers: { + "user-agent": "myApp/1.2.3" + }, + org: "my-project" +}); +const myProjectRequestWithAuth = myProjectRequest.defaults({ + headers: { + authorization: `token 0000000000000000000000000000000000000001` + } +}); +``` + +`myProjectRequest` now defaults the `baseUrl`, `headers['user-agent']`, +`org` and `headers['authorization']` on top of `headers['accept']` that is set +by the global default. + +## `request.endpoint` + +See https://github.com/octokit/endpoint.js. Example + +```js +const options = request.endpoint("GET /orgs/:org/repos", { + org: "my-project", + type: "private" +}); + +// { +// method: 'GET', +// url: 'https://api.github.com/orgs/my-project/repos?type=private', +// headers: { +// accept: 'application/vnd.github.v3+json', +// authorization: 'token 0000000000000000000000000000000000000001', +// 'user-agent': 'octokit/endpoint.js v1.2.3' +// } +// } +``` + +All of the [`@octokit/endpoint`](https://github.com/octokit/endpoint.js) API can be used: + +- [`octokitRequest.endpoint()`](#endpoint) +- [`octokitRequest.endpoint.defaults()`](#endpointdefaults) +- [`octokitRequest.endpoint.merge()`](#endpointdefaults) +- [`octokitRequest.endpoint.parse()`](#endpointmerge) + +## Special cases + + + +### The `data` parameter – set request body directly + +Some endpoints such as [Render a Markdown document in raw mode](https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode) don’t have parameters that are sent as request body keys, instead the request body needs to be set directly. In these cases, set the `data` parameter. + +```js +const response = await request("POST /markdown/raw", { + data: "Hello world github/linguist#1 **cool**, and #1!", + headers: { + accept: "text/html;charset=utf-8", + "content-type": "text/plain" + } +}); + +// Request is sent as +// +// { +// method: 'post', +// url: 'https://api.github.com/markdown/raw', +// headers: { +// accept: 'text/html;charset=utf-8', +// 'content-type': 'text/plain', +// 'user-agent': userAgent +// }, +// body: 'Hello world github/linguist#1 **cool**, and #1!' +// } +// +// not as +// +// { +// ... +// body: '{"data": "Hello world github/linguist#1 **cool**, and #1!"}' +// } +``` + +### Set parameters for both the URL/query and the request body + +There are API endpoints that accept both query parameters as well as a body. In that case you need to add the query parameters as templates to `options.url`, as defined in the [RFC 6570 URI Template specification](https://tools.ietf.org/html/rfc6570). + +Example + +```js +request( + "POST https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", + { + name: "example.zip", + label: "short description", + headers: { + "content-type": "text/plain", + "content-length": 14, + authorization: `token 0000000000000000000000000000000000000001` + }, + data: "Hello, world!" + } +); +``` + +## LICENSE + +[MIT](LICENSE) diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-node/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-node/index.js new file mode 100644 index 00000000..19b227bf --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-node/index.js @@ -0,0 +1,148 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } + +var endpoint = require('@octokit/endpoint'); +var universalUserAgent = require('universal-user-agent'); +var isPlainObject = _interopDefault(require('is-plain-object')); +var nodeFetch = _interopDefault(require('node-fetch')); +var requestError = require('@octokit/request-error'); + +const VERSION = "5.3.1"; + +function getBufferResponse(response) { + return response.arrayBuffer(); +} + +function fetchWrapper(requestOptions) { + if (isPlainObject(requestOptions.body) || Array.isArray(requestOptions.body)) { + requestOptions.body = JSON.stringify(requestOptions.body); + } + + let headers = {}; + let status; + let url; + const fetch = requestOptions.request && requestOptions.request.fetch || nodeFetch; + return fetch(requestOptions.url, Object.assign({ + method: requestOptions.method, + body: requestOptions.body, + headers: requestOptions.headers, + redirect: requestOptions.redirect + }, requestOptions.request)).then(response => { + url = response.url; + status = response.status; + + for (const keyAndValue of response.headers) { + headers[keyAndValue[0]] = keyAndValue[1]; + } + + if (status === 204 || status === 205) { + return; + } // GitHub API returns 200 for HEAD requsets + + + if (requestOptions.method === "HEAD") { + if (status < 400) { + return; + } + + throw new requestError.RequestError(response.statusText, status, { + headers, + request: requestOptions + }); + } + + if (status === 304) { + throw new requestError.RequestError("Not modified", status, { + headers, + request: requestOptions + }); + } + + if (status >= 400) { + return response.text().then(message => { + const error = new requestError.RequestError(message, status, { + headers, + request: requestOptions + }); + + try { + let responseBody = JSON.parse(error.message); + Object.assign(error, responseBody); + let errors = responseBody.errors; // Assumption `errors` would always be in Array Fotmat + + error.message = error.message + ": " + errors.map(JSON.stringify).join(", "); + } catch (e) {// ignore, see octokit/rest.js#684 + } + + throw error; + }); + } + + const contentType = response.headers.get("content-type"); + + if (/application\/json/.test(contentType)) { + return response.json(); + } + + if (!contentType || /^text\/|charset=utf-8$/.test(contentType)) { + return response.text(); + } + + return getBufferResponse(response); + }).then(data => { + return { + status, + url, + headers, + data + }; + }).catch(error => { + if (error instanceof requestError.RequestError) { + throw error; + } + + throw new requestError.RequestError(error.message, 500, { + headers, + request: requestOptions + }); + }); +} + +function withDefaults(oldEndpoint, newDefaults) { + const endpoint = oldEndpoint.defaults(newDefaults); + + const newApi = function (route, parameters) { + const endpointOptions = endpoint.merge(route, parameters); + + if (!endpointOptions.request || !endpointOptions.request.hook) { + return fetchWrapper(endpoint.parse(endpointOptions)); + } + + const request = (route, parameters) => { + return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters))); + }; + + Object.assign(request, { + endpoint, + defaults: withDefaults.bind(null, endpoint) + }); + return endpointOptions.request.hook(request, endpointOptions); + }; + + return Object.assign(newApi, { + endpoint, + defaults: withDefaults.bind(null, endpoint) + }); +} + +const request = withDefaults(endpoint.endpoint, { + headers: { + "user-agent": `octokit-request.js/${VERSION} ${universalUserAgent.getUserAgent()}` + } +}); + +exports.request = request; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-node/index.js.map b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-node/index.js.map new file mode 100644 index 00000000..b0ffb707 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/get-buffer-response.js","../dist-src/fetch-wrapper.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.3.1\";\n","export default function getBufferResponse(response) {\n return response.arrayBuffer();\n}\n","import isPlainObject from \"is-plain-object\";\nimport nodeFetch from \"node-fetch\";\nimport { RequestError } from \"@octokit/request-error\";\nimport getBuffer from \"./get-buffer-response\";\nexport default function fetchWrapper(requestOptions) {\n if (isPlainObject(requestOptions.body) ||\n Array.isArray(requestOptions.body)) {\n requestOptions.body = JSON.stringify(requestOptions.body);\n }\n let headers = {};\n let status;\n let url;\n const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch;\n return fetch(requestOptions.url, Object.assign({\n method: requestOptions.method,\n body: requestOptions.body,\n headers: requestOptions.headers,\n redirect: requestOptions.redirect\n }, requestOptions.request))\n .then(response => {\n url = response.url;\n status = response.status;\n for (const keyAndValue of response.headers) {\n headers[keyAndValue[0]] = keyAndValue[1];\n }\n if (status === 204 || status === 205) {\n return;\n }\n // GitHub API returns 200 for HEAD requsets\n if (requestOptions.method === \"HEAD\") {\n if (status < 400) {\n return;\n }\n throw new RequestError(response.statusText, status, {\n headers,\n request: requestOptions\n });\n }\n if (status === 304) {\n throw new RequestError(\"Not modified\", status, {\n headers,\n request: requestOptions\n });\n }\n if (status >= 400) {\n return response\n .text()\n .then(message => {\n const error = new RequestError(message, status, {\n headers,\n request: requestOptions\n });\n try {\n let responseBody = JSON.parse(error.message);\n Object.assign(error, responseBody);\n let errors = responseBody.errors;\n // Assumption `errors` would always be in Array Fotmat\n error.message =\n error.message + \": \" + errors.map(JSON.stringify).join(\", \");\n }\n catch (e) {\n // ignore, see octokit/rest.js#684\n }\n throw error;\n });\n }\n const contentType = response.headers.get(\"content-type\");\n if (/application\\/json/.test(contentType)) {\n return response.json();\n }\n if (!contentType || /^text\\/|charset=utf-8$/.test(contentType)) {\n return response.text();\n }\n return getBuffer(response);\n })\n .then(data => {\n return {\n status,\n url,\n headers,\n data\n };\n })\n .catch(error => {\n if (error instanceof RequestError) {\n throw error;\n }\n throw new RequestError(error.message, 500, {\n headers,\n request: requestOptions\n });\n });\n}\n","import fetchWrapper from \"./fetch-wrapper\";\nexport default function withDefaults(oldEndpoint, newDefaults) {\n const endpoint = oldEndpoint.defaults(newDefaults);\n const newApi = function (route, parameters) {\n const endpointOptions = endpoint.merge(route, parameters);\n if (!endpointOptions.request || !endpointOptions.request.hook) {\n return fetchWrapper(endpoint.parse(endpointOptions));\n }\n const request = (route, parameters) => {\n return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters)));\n };\n Object.assign(request, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint)\n });\n return endpointOptions.request.hook(request, endpointOptions);\n };\n return Object.assign(newApi, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint)\n });\n}\n","import { endpoint } from \"@octokit/endpoint\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport withDefaults from \"./with-defaults\";\nexport const request = withDefaults(endpoint, {\n headers: {\n \"user-agent\": `octokit-request.js/${VERSION} ${getUserAgent()}`\n }\n});\n"],"names":["VERSION","getBufferResponse","response","arrayBuffer","fetchWrapper","requestOptions","isPlainObject","body","Array","isArray","JSON","stringify","headers","status","url","fetch","request","nodeFetch","Object","assign","method","redirect","then","keyAndValue","RequestError","statusText","text","message","error","responseBody","parse","errors","map","join","e","contentType","get","test","json","getBuffer","data","catch","withDefaults","oldEndpoint","newDefaults","endpoint","defaults","newApi","route","parameters","endpointOptions","merge","hook","bind","getUserAgent"],"mappings":";;;;;;;;;;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACAQ,SAASC,iBAAT,CAA2BC,QAA3B,EAAqC;SACzCA,QAAQ,CAACC,WAAT,EAAP;;;ACGW,SAASC,YAAT,CAAsBC,cAAtB,EAAsC;MAC7CC,aAAa,CAACD,cAAc,CAACE,IAAhB,CAAb,IACAC,KAAK,CAACC,OAAN,CAAcJ,cAAc,CAACE,IAA7B,CADJ,EACwC;IACpCF,cAAc,CAACE,IAAf,GAAsBG,IAAI,CAACC,SAAL,CAAeN,cAAc,CAACE,IAA9B,CAAtB;;;MAEAK,OAAO,GAAG,EAAd;MACIC,MAAJ;MACIC,GAAJ;QACMC,KAAK,GAAIV,cAAc,CAACW,OAAf,IAA0BX,cAAc,CAACW,OAAf,CAAuBD,KAAlD,IAA4DE,SAA1E;SACOF,KAAK,CAACV,cAAc,CAACS,GAAhB,EAAqBI,MAAM,CAACC,MAAP,CAAc;IAC3CC,MAAM,EAAEf,cAAc,CAACe,MADoB;IAE3Cb,IAAI,EAAEF,cAAc,CAACE,IAFsB;IAG3CK,OAAO,EAAEP,cAAc,CAACO,OAHmB;IAI3CS,QAAQ,EAAEhB,cAAc,CAACgB;GAJI,EAK9BhB,cAAc,CAACW,OALe,CAArB,CAAL,CAMFM,IANE,CAMGpB,QAAQ,IAAI;IAClBY,GAAG,GAAGZ,QAAQ,CAACY,GAAf;IACAD,MAAM,GAAGX,QAAQ,CAACW,MAAlB;;SACK,MAAMU,WAAX,IAA0BrB,QAAQ,CAACU,OAAnC,EAA4C;MACxCA,OAAO,CAACW,WAAW,CAAC,CAAD,CAAZ,CAAP,GAA0BA,WAAW,CAAC,CAAD,CAArC;;;QAEAV,MAAM,KAAK,GAAX,IAAkBA,MAAM,KAAK,GAAjC,EAAsC;;KANpB;;;QAUdR,cAAc,CAACe,MAAf,KAA0B,MAA9B,EAAsC;UAC9BP,MAAM,GAAG,GAAb,EAAkB;;;;YAGZ,IAAIW,yBAAJ,CAAiBtB,QAAQ,CAACuB,UAA1B,EAAsCZ,MAAtC,EAA8C;QAChDD,OADgD;QAEhDI,OAAO,EAAEX;OAFP,CAAN;;;QAKAQ,MAAM,KAAK,GAAf,EAAoB;YACV,IAAIW,yBAAJ,CAAiB,cAAjB,EAAiCX,MAAjC,EAAyC;QAC3CD,OAD2C;QAE3CI,OAAO,EAAEX;OAFP,CAAN;;;QAKAQ,MAAM,IAAI,GAAd,EAAmB;aACRX,QAAQ,CACVwB,IADE,GAEFJ,IAFE,CAEGK,OAAO,IAAI;cACXC,KAAK,GAAG,IAAIJ,yBAAJ,CAAiBG,OAAjB,EAA0Bd,MAA1B,EAAkC;UAC5CD,OAD4C;UAE5CI,OAAO,EAAEX;SAFC,CAAd;;YAII;cACIwB,YAAY,GAAGnB,IAAI,CAACoB,KAAL,CAAWF,KAAK,CAACD,OAAjB,CAAnB;UACAT,MAAM,CAACC,MAAP,CAAcS,KAAd,EAAqBC,YAArB;cACIE,MAAM,GAAGF,YAAY,CAACE,MAA1B,CAHA;;UAKAH,KAAK,CAACD,OAAN,GACIC,KAAK,CAACD,OAAN,GAAgB,IAAhB,GAAuBI,MAAM,CAACC,GAAP,CAAWtB,IAAI,CAACC,SAAhB,EAA2BsB,IAA3B,CAAgC,IAAhC,CAD3B;SALJ,CAQA,OAAOC,CAAP,EAAU;;;cAGJN,KAAN;OAlBG,CAAP;;;UAqBEO,WAAW,GAAGjC,QAAQ,CAACU,OAAT,CAAiBwB,GAAjB,CAAqB,cAArB,CAApB;;QACI,oBAAoBC,IAApB,CAAyBF,WAAzB,CAAJ,EAA2C;aAChCjC,QAAQ,CAACoC,IAAT,EAAP;;;QAEA,CAACH,WAAD,IAAgB,yBAAyBE,IAAzB,CAA8BF,WAA9B,CAApB,EAAgE;aACrDjC,QAAQ,CAACwB,IAAT,EAAP;;;WAEGa,iBAAS,CAACrC,QAAD,CAAhB;GA5DG,EA8DFoB,IA9DE,CA8DGkB,IAAI,IAAI;WACP;MACH3B,MADG;MAEHC,GAFG;MAGHF,OAHG;MAIH4B;KAJJ;GA/DG,EAsEFC,KAtEE,CAsEIb,KAAK,IAAI;QACZA,KAAK,YAAYJ,yBAArB,EAAmC;YACzBI,KAAN;;;UAEE,IAAIJ,yBAAJ,CAAiBI,KAAK,CAACD,OAAvB,EAAgC,GAAhC,EAAqC;MACvCf,OADuC;MAEvCI,OAAO,EAAEX;KAFP,CAAN;GA1EG,CAAP;;;ACZW,SAASqC,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;QACrDC,QAAQ,GAAGF,WAAW,CAACG,QAAZ,CAAqBF,WAArB,CAAjB;;QACMG,MAAM,GAAG,UAAUC,KAAV,EAAiBC,UAAjB,EAA6B;UAClCC,eAAe,GAAGL,QAAQ,CAACM,KAAT,CAAeH,KAAf,EAAsBC,UAAtB,CAAxB;;QACI,CAACC,eAAe,CAAClC,OAAjB,IAA4B,CAACkC,eAAe,CAAClC,OAAhB,CAAwBoC,IAAzD,EAA+D;aACpDhD,YAAY,CAACyC,QAAQ,CAACf,KAAT,CAAeoB,eAAf,CAAD,CAAnB;;;UAEElC,OAAO,GAAG,CAACgC,KAAD,EAAQC,UAAR,KAAuB;aAC5B7C,YAAY,CAACyC,QAAQ,CAACf,KAAT,CAAee,QAAQ,CAACM,KAAT,CAAeH,KAAf,EAAsBC,UAAtB,CAAf,CAAD,CAAnB;KADJ;;IAGA/B,MAAM,CAACC,MAAP,CAAcH,OAAd,EAAuB;MACnB6B,QADmB;MAEnBC,QAAQ,EAAEJ,YAAY,CAACW,IAAb,CAAkB,IAAlB,EAAwBR,QAAxB;KAFd;WAIOK,eAAe,CAAClC,OAAhB,CAAwBoC,IAAxB,CAA6BpC,OAA7B,EAAsCkC,eAAtC,CAAP;GAZJ;;SAcOhC,MAAM,CAACC,MAAP,CAAc4B,MAAd,EAAsB;IACzBF,QADyB;IAEzBC,QAAQ,EAAEJ,YAAY,CAACW,IAAb,CAAkB,IAAlB,EAAwBR,QAAxB;GAFP,CAAP;;;MCbS7B,OAAO,GAAG0B,YAAY,CAACG,iBAAD,EAAW;EAC1CjC,OAAO,EAAE;kBACU,sBAAqBZ,OAAQ,IAAGsD,+BAAY,EAAG;;CAFnC,CAA5B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/fetch-wrapper.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/fetch-wrapper.js new file mode 100644 index 00000000..f2b80d7e --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/fetch-wrapper.js @@ -0,0 +1,93 @@ +import isPlainObject from "is-plain-object"; +import nodeFetch from "node-fetch"; +import { RequestError } from "@octokit/request-error"; +import getBuffer from "./get-buffer-response"; +export default function fetchWrapper(requestOptions) { + if (isPlainObject(requestOptions.body) || + Array.isArray(requestOptions.body)) { + requestOptions.body = JSON.stringify(requestOptions.body); + } + let headers = {}; + let status; + let url; + const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch; + return fetch(requestOptions.url, Object.assign({ + method: requestOptions.method, + body: requestOptions.body, + headers: requestOptions.headers, + redirect: requestOptions.redirect + }, requestOptions.request)) + .then(response => { + url = response.url; + status = response.status; + for (const keyAndValue of response.headers) { + headers[keyAndValue[0]] = keyAndValue[1]; + } + if (status === 204 || status === 205) { + return; + } + // GitHub API returns 200 for HEAD requsets + if (requestOptions.method === "HEAD") { + if (status < 400) { + return; + } + throw new RequestError(response.statusText, status, { + headers, + request: requestOptions + }); + } + if (status === 304) { + throw new RequestError("Not modified", status, { + headers, + request: requestOptions + }); + } + if (status >= 400) { + return response + .text() + .then(message => { + const error = new RequestError(message, status, { + headers, + request: requestOptions + }); + try { + let responseBody = JSON.parse(error.message); + Object.assign(error, responseBody); + let errors = responseBody.errors; + // Assumption `errors` would always be in Array Fotmat + error.message = + error.message + ": " + errors.map(JSON.stringify).join(", "); + } + catch (e) { + // ignore, see octokit/rest.js#684 + } + throw error; + }); + } + const contentType = response.headers.get("content-type"); + if (/application\/json/.test(contentType)) { + return response.json(); + } + if (!contentType || /^text\/|charset=utf-8$/.test(contentType)) { + return response.text(); + } + return getBuffer(response); + }) + .then(data => { + return { + status, + url, + headers, + data + }; + }) + .catch(error => { + if (error instanceof RequestError) { + throw error; + } + throw new RequestError(error.message, 500, { + headers, + request: requestOptions + }); + }); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/get-buffer-response.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/get-buffer-response.js new file mode 100644 index 00000000..845a3947 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/get-buffer-response.js @@ -0,0 +1,3 @@ +export default function getBufferResponse(response) { + return response.arrayBuffer(); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/index.js new file mode 100644 index 00000000..6a36142d --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/index.js @@ -0,0 +1,9 @@ +import { endpoint } from "@octokit/endpoint"; +import { getUserAgent } from "universal-user-agent"; +import { VERSION } from "./version"; +import withDefaults from "./with-defaults"; +export const request = withDefaults(endpoint, { + headers: { + "user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}` + } +}); diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/version.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/version.js new file mode 100644 index 00000000..6250d76e --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "5.3.1"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/with-defaults.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/with-defaults.js new file mode 100644 index 00000000..8e44f46e --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-src/with-defaults.js @@ -0,0 +1,22 @@ +import fetchWrapper from "./fetch-wrapper"; +export default function withDefaults(oldEndpoint, newDefaults) { + const endpoint = oldEndpoint.defaults(newDefaults); + const newApi = function (route, parameters) { + const endpointOptions = endpoint.merge(route, parameters); + if (!endpointOptions.request || !endpointOptions.request.hook) { + return fetchWrapper(endpoint.parse(endpointOptions)); + } + const request = (route, parameters) => { + return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters))); + }; + Object.assign(request, { + endpoint, + defaults: withDefaults.bind(null, endpoint) + }); + return endpointOptions.request.hook(request, endpointOptions); + }; + return Object.assign(newApi, { + endpoint, + defaults: withDefaults.bind(null, endpoint) + }); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/fetch-wrapper.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/fetch-wrapper.d.ts new file mode 100644 index 00000000..594bce61 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/fetch-wrapper.d.ts @@ -0,0 +1,11 @@ +import { EndpointInterface } from "@octokit/types"; +export default function fetchWrapper(requestOptions: ReturnType & { + redirect?: string; +}): Promise<{ + status: number; + url: string; + headers: { + [header: string]: string; + }; + data: any; +}>; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/get-buffer-response.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/get-buffer-response.d.ts new file mode 100644 index 00000000..915b7057 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/get-buffer-response.d.ts @@ -0,0 +1,2 @@ +import { Response } from "node-fetch"; +export default function getBufferResponse(response: Response): Promise; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/index.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/index.d.ts new file mode 100644 index 00000000..cb9c9bad --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/index.d.ts @@ -0,0 +1 @@ +export declare const request: import("@octokit/types").RequestInterface; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/version.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/version.d.ts new file mode 100644 index 00000000..c32c7ab0 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "5.3.1"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/with-defaults.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/with-defaults.d.ts new file mode 100644 index 00000000..00804693 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-types/with-defaults.d.ts @@ -0,0 +1,2 @@ +import { EndpointInterface, RequestInterface, RequestParameters } from "@octokit/types"; +export default function withDefaults(oldEndpoint: EndpointInterface, newDefaults: RequestParameters): RequestInterface; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-web/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-web/index.js new file mode 100644 index 00000000..3f51926e --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-web/index.js @@ -0,0 +1,132 @@ +import { endpoint } from '@octokit/endpoint'; +import { getUserAgent } from 'universal-user-agent'; +import isPlainObject from 'is-plain-object'; +import nodeFetch from 'node-fetch'; +import { RequestError } from '@octokit/request-error'; + +const VERSION = "5.3.1"; + +function getBufferResponse(response) { + return response.arrayBuffer(); +} + +function fetchWrapper(requestOptions) { + if (isPlainObject(requestOptions.body) || + Array.isArray(requestOptions.body)) { + requestOptions.body = JSON.stringify(requestOptions.body); + } + let headers = {}; + let status; + let url; + const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch; + return fetch(requestOptions.url, Object.assign({ + method: requestOptions.method, + body: requestOptions.body, + headers: requestOptions.headers, + redirect: requestOptions.redirect + }, requestOptions.request)) + .then(response => { + url = response.url; + status = response.status; + for (const keyAndValue of response.headers) { + headers[keyAndValue[0]] = keyAndValue[1]; + } + if (status === 204 || status === 205) { + return; + } + // GitHub API returns 200 for HEAD requsets + if (requestOptions.method === "HEAD") { + if (status < 400) { + return; + } + throw new RequestError(response.statusText, status, { + headers, + request: requestOptions + }); + } + if (status === 304) { + throw new RequestError("Not modified", status, { + headers, + request: requestOptions + }); + } + if (status >= 400) { + return response + .text() + .then(message => { + const error = new RequestError(message, status, { + headers, + request: requestOptions + }); + try { + let responseBody = JSON.parse(error.message); + Object.assign(error, responseBody); + let errors = responseBody.errors; + // Assumption `errors` would always be in Array Fotmat + error.message = + error.message + ": " + errors.map(JSON.stringify).join(", "); + } + catch (e) { + // ignore, see octokit/rest.js#684 + } + throw error; + }); + } + const contentType = response.headers.get("content-type"); + if (/application\/json/.test(contentType)) { + return response.json(); + } + if (!contentType || /^text\/|charset=utf-8$/.test(contentType)) { + return response.text(); + } + return getBufferResponse(response); + }) + .then(data => { + return { + status, + url, + headers, + data + }; + }) + .catch(error => { + if (error instanceof RequestError) { + throw error; + } + throw new RequestError(error.message, 500, { + headers, + request: requestOptions + }); + }); +} + +function withDefaults(oldEndpoint, newDefaults) { + const endpoint = oldEndpoint.defaults(newDefaults); + const newApi = function (route, parameters) { + const endpointOptions = endpoint.merge(route, parameters); + if (!endpointOptions.request || !endpointOptions.request.hook) { + return fetchWrapper(endpoint.parse(endpointOptions)); + } + const request = (route, parameters) => { + return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters))); + }; + Object.assign(request, { + endpoint, + defaults: withDefaults.bind(null, endpoint) + }); + return endpointOptions.request.hook(request, endpointOptions); + }; + return Object.assign(newApi, { + endpoint, + defaults: withDefaults.bind(null, endpoint) + }); +} + +const request = withDefaults(endpoint, { + headers: { + "user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}` + } +}); + +export { request }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-web/index.js.map b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-web/index.js.map new file mode 100644 index 00000000..f4c30849 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/get-buffer-response.js","../dist-src/fetch-wrapper.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.3.1\";\n","export default function getBufferResponse(response) {\n return response.arrayBuffer();\n}\n","import isPlainObject from \"is-plain-object\";\nimport nodeFetch from \"node-fetch\";\nimport { RequestError } from \"@octokit/request-error\";\nimport getBuffer from \"./get-buffer-response\";\nexport default function fetchWrapper(requestOptions) {\n if (isPlainObject(requestOptions.body) ||\n Array.isArray(requestOptions.body)) {\n requestOptions.body = JSON.stringify(requestOptions.body);\n }\n let headers = {};\n let status;\n let url;\n const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch;\n return fetch(requestOptions.url, Object.assign({\n method: requestOptions.method,\n body: requestOptions.body,\n headers: requestOptions.headers,\n redirect: requestOptions.redirect\n }, requestOptions.request))\n .then(response => {\n url = response.url;\n status = response.status;\n for (const keyAndValue of response.headers) {\n headers[keyAndValue[0]] = keyAndValue[1];\n }\n if (status === 204 || status === 205) {\n return;\n }\n // GitHub API returns 200 for HEAD requsets\n if (requestOptions.method === \"HEAD\") {\n if (status < 400) {\n return;\n }\n throw new RequestError(response.statusText, status, {\n headers,\n request: requestOptions\n });\n }\n if (status === 304) {\n throw new RequestError(\"Not modified\", status, {\n headers,\n request: requestOptions\n });\n }\n if (status >= 400) {\n return response\n .text()\n .then(message => {\n const error = new RequestError(message, status, {\n headers,\n request: requestOptions\n });\n try {\n let responseBody = JSON.parse(error.message);\n Object.assign(error, responseBody);\n let errors = responseBody.errors;\n // Assumption `errors` would always be in Array Fotmat\n error.message =\n error.message + \": \" + errors.map(JSON.stringify).join(\", \");\n }\n catch (e) {\n // ignore, see octokit/rest.js#684\n }\n throw error;\n });\n }\n const contentType = response.headers.get(\"content-type\");\n if (/application\\/json/.test(contentType)) {\n return response.json();\n }\n if (!contentType || /^text\\/|charset=utf-8$/.test(contentType)) {\n return response.text();\n }\n return getBuffer(response);\n })\n .then(data => {\n return {\n status,\n url,\n headers,\n data\n };\n })\n .catch(error => {\n if (error instanceof RequestError) {\n throw error;\n }\n throw new RequestError(error.message, 500, {\n headers,\n request: requestOptions\n });\n });\n}\n","import fetchWrapper from \"./fetch-wrapper\";\nexport default function withDefaults(oldEndpoint, newDefaults) {\n const endpoint = oldEndpoint.defaults(newDefaults);\n const newApi = function (route, parameters) {\n const endpointOptions = endpoint.merge(route, parameters);\n if (!endpointOptions.request || !endpointOptions.request.hook) {\n return fetchWrapper(endpoint.parse(endpointOptions));\n }\n const request = (route, parameters) => {\n return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters)));\n };\n Object.assign(request, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint)\n });\n return endpointOptions.request.hook(request, endpointOptions);\n };\n return Object.assign(newApi, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint)\n });\n}\n","import { endpoint } from \"@octokit/endpoint\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport withDefaults from \"./with-defaults\";\nexport const request = withDefaults(endpoint, {\n headers: {\n \"user-agent\": `octokit-request.js/${VERSION} ${getUserAgent()}`\n }\n});\n"],"names":["getBuffer"],"mappings":";;;;;;AAAO,MAAM,OAAO,GAAG,mBAAmB,CAAC;;ACA5B,SAAS,iBAAiB,CAAC,QAAQ,EAAE;IAChD,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;CACjC;;ACEc,SAAS,YAAY,CAAC,cAAc,EAAE;IACjD,IAAI,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC;QAClC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;QACpC,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;KAC7D;IACD,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,MAAM,CAAC;IACX,IAAI,GAAG,CAAC;IACR,MAAM,KAAK,GAAG,CAAC,cAAc,CAAC,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC;IACpF,OAAO,KAAK,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC;QAC3C,MAAM,EAAE,cAAc,CAAC,MAAM;QAC7B,IAAI,EAAE,cAAc,CAAC,IAAI;QACzB,OAAO,EAAE,cAAc,CAAC,OAAO;QAC/B,QAAQ,EAAE,cAAc,CAAC,QAAQ;KACpC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;SACtB,IAAI,CAAC,QAAQ,IAAI;QAClB,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACnB,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QACzB,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,OAAO,EAAE;YACxC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;SAC5C;QACD,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE;YAClC,OAAO;SACV;;QAED,IAAI,cAAc,CAAC,MAAM,KAAK,MAAM,EAAE;YAClC,IAAI,MAAM,GAAG,GAAG,EAAE;gBACd,OAAO;aACV;YACD,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE;gBAChD,OAAO;gBACP,OAAO,EAAE,cAAc;aAC1B,CAAC,CAAC;SACN;QACD,IAAI,MAAM,KAAK,GAAG,EAAE;YAChB,MAAM,IAAI,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE;gBAC3C,OAAO;gBACP,OAAO,EAAE,cAAc;aAC1B,CAAC,CAAC;SACN;QACD,IAAI,MAAM,IAAI,GAAG,EAAE;YACf,OAAO,QAAQ;iBACV,IAAI,EAAE;iBACN,IAAI,CAAC,OAAO,IAAI;gBACjB,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE;oBAC5C,OAAO;oBACP,OAAO,EAAE,cAAc;iBAC1B,CAAC,CAAC;gBACH,IAAI;oBACA,IAAI,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;oBAC7C,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;oBACnC,IAAI,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;;oBAEjC,KAAK,CAAC,OAAO;wBACT,KAAK,CAAC,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACpE;gBACD,OAAO,CAAC,EAAE;;iBAET;gBACD,MAAM,KAAK,CAAC;aACf,CAAC,CAAC;SACN;QACD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACzD,IAAI,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YACvC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC1B;QACD,IAAI,CAAC,WAAW,IAAI,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YAC5D,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC1B;QACD,OAAOA,iBAAS,CAAC,QAAQ,CAAC,CAAC;KAC9B,CAAC;SACG,IAAI,CAAC,IAAI,IAAI;QACd,OAAO;YACH,MAAM;YACN,GAAG;YACH,OAAO;YACP,IAAI;SACP,CAAC;KACL,CAAC;SACG,KAAK,CAAC,KAAK,IAAI;QAChB,IAAI,KAAK,YAAY,YAAY,EAAE;YAC/B,MAAM,KAAK,CAAC;SACf;QACD,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE;YACvC,OAAO;YACP,OAAO,EAAE,cAAc;SAC1B,CAAC,CAAC;KACN,CAAC,CAAC;CACN;;AC3Fc,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;IAC3D,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,UAAU,KAAK,EAAE,UAAU,EAAE;QACxC,MAAM,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC1D,IAAI,CAAC,eAAe,CAAC,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE;YAC3D,OAAO,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;SACxD;QACD,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK;YACnC,OAAO,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;SAC1E,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YACnB,QAAQ;YACR,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;SAC9C,CAAC,CAAC;QACH,OAAO,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;KACjE,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;QACzB,QAAQ;QACR,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;KAC9C,CAAC,CAAC;CACN;;ACjBW,MAAC,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE;IAC1C,OAAO,EAAE;QACL,YAAY,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;KAClE;CACJ,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md new file mode 100644 index 00000000..b5185152 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/01_help.md @@ -0,0 +1,5 @@ +--- +name: "🆘 Help" +about: "How does this even work 🤷‍♂️" +labels: support +--- diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md new file mode 100644 index 00000000..d7e83250 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/02_bug.md @@ -0,0 +1,19 @@ +--- +name: "🐛 Bug Report" +about: "If something isn't working as expected 🤔" +labels: bug +--- + + + +**What happened?** + + + +**What did you expect to happen?** + + + +**What the problem might be** + + diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md new file mode 100644 index 00000000..89a54819 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/03_feature_request.md @@ -0,0 +1,19 @@ +--- +name: "🧚‍♂️ Feature Request" +about: "Wouldn’t it be nice if 💭" +labels: feature +--- + + + +**What’s missing?** + + + +**Why?** + + + +**Alternatives you tried** + + diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md new file mode 100644 index 00000000..c67ce83b --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/ISSUE_TEMPLATE/04_thanks.md @@ -0,0 +1,19 @@ +--- +name: "💝 Thank you" +about: "@octokit/types is awesome 🙌" +labels: thanks +--- + + + +**How do you use @octokit/types?** + + + +**What do you love about it?** + + + +**How did you learn about it?** + + diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/workflows/release.yml b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/workflows/release.yml new file mode 100644 index 00000000..e47f42cb --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/workflows/release.yml @@ -0,0 +1,25 @@ +name: Release +on: + push: + branches: + - master + +jobs: + release: + name: release + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: actions/setup-node@v1 + with: + node-version: "12.x" + - run: npm ci + - run: npx semantic-release + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + - run: npm run docs + - uses: maxheld83/ghpages@master + env: + BUILD_DIR: docs/ + GH_PAT: ${{ secrets.OCTOKIT_PAT }} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/workflows/routes-update.yml b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/workflows/routes-update.yml new file mode 100644 index 00000000..f1639d90 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/workflows/routes-update.yml @@ -0,0 +1,37 @@ +name: octokit/routes update +on: + repository_dispatch: + types: [octokit-routes-release] + +jobs: + update_routes: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: actions/setup-node@v1 + with: + node-version: "12.x" + # try checking out routes-update branch. Ignore error if it does not exist + - run: git checkout routes-update || true + - run: npm ci + - run: npm run update-endpoints + - name: Create Pull Request + uses: gr2m/create-or-update-pull-request-action@v1.x + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + title: "🚧 GitHub REST Endpoints changed" + body: | + See what changed at https://github.com/octokit/routes/releases/latest. + + Make sure to update the commits so that the merge results in helpful release notes, see [Merging the Pull Request & releasing a new version](https://github.com/octokit/rest.js/blob/master/CONTRIBUTING.md#merging-the-pull-request--releasing-a-new-version). + + In general + + - Avoid breaking changes at all costs + - If there are no typescript or code changes, use a `docs` prefix + - If there are typescript changes but no code changes, use `fix(typescript)` prefix + - If there are code changes, use `fix` if a problem was resolved, `feat` if new endpoints / parameters were added, and `feat(deprecation)` if a method was deprecated. + branch: "routes-update" + commit-message: "WIP octokit/routes updated" + author: "Octokit Bot <33075676+octokitbot@users.noreply.github.com>" diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/workflows/test.yml b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/workflows/test.yml new file mode 100644 index 00000000..702220fd --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/.github/workflows/test.yml @@ -0,0 +1,19 @@ +name: Test +on: + push: + branches: + - master + - "greenkeeper/*" + pull_request: + types: [opened, synchronize] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: actions/setup-node@v1 + with: + node-version: 12 + - run: npm ci + - run: npm test diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/CODE_OF_CONDUCT.md b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..8392e63e --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/CODE_OF_CONDUCT.md @@ -0,0 +1,75 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at opensource+octokit@github.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [https://contributor-covenant.org/version/1/4][version] + +[homepage]: https://contributor-covenant.org +[version]: https://contributor-covenant.org/version/1/4/ + diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/CONTRIBUTING.md b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/CONTRIBUTING.md new file mode 100644 index 00000000..6b275990 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/CONTRIBUTING.md @@ -0,0 +1,59 @@ +# How to contribute + +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). +By participating in this project you agree to abide by its terms. + +## Creating an Issue + +Before you create a new Issue: + +1. Please make sure there is no [open issue](https://github.com/octokit/plugin-paginate-rest/issues?utf8=%E2%9C%93&q=is%3Aissue) yet. +2. If it is a bug report, include the steps to reproduce the issue and please create a reproducible test case on [runkit.com](https://runkit.com/). Example: https://runkit.com/gr2m/5aa034f1440b420012a6eebf +3. If it is a feature request, please share the motivation for the new feature, what alternatives you tried, and how you would implement it. +4. Please include links to the corresponding github documentation. + +## Setup the repository locally + +First, fork the repository. + +Setup the repository locally. Replace `` with the name of the account you forked to. + +```shell +git clone https://github.com//plugin-paginate-rest.js.git +cd plugin-paginate-rest.js +npm install +``` + +Run the tests before making changes to make sure the local setup is working as expected + +```shell +npm test +``` + +## Submitting the Pull Request + +- Create a new branch locally. +- Make your changes in that branch to your fork repository +- Submit a pull request from your topic branch to the master branch on the `octokit/plugin-paginate-rest.js` repository. +- Be sure to tag any issues your pull request is taking care of / contributing to. Adding "Closes #123" to a pull request description will automatically close the issue once the pull request is merged in. + +## Testing a pull request from github repo locally: + +You can install `@octokit/plugin-paginate-rest` from each pull request. Replace `[PULL REQUEST NUMBER]` + +Once you are done testing, you can revert back to the default module `@octokit/plugin-paginate-rest` from npm with `npm install @octokit/plugin-paginate-rest` + +## Merging the Pull Request & releasing a new version + +Releases are automated using [semantic-release](https://github.com/semantic-release/semantic-release). +The following commit message conventions determine which version is released: + +1. `fix: ...` or `fix(scope name): ...` prefix in subject: bumps fix version, e.g. `1.2.3` → `1.2.4` +2. `feat: ...` or `feat(scope name): ...` prefix in subject: bumps feature version, e.g. `1.2.3` → `1.3.0` +3. `BREAKING CHANGE:` in body: bumps breaking version, e.g. `1.2.3` → `2.0.0` + +Only one version number is bumped at a time, the highest version change trumps the others. +Besides publishing a new version to npm, semantic-release also creates a git tag and release +on GitHub, generates changelogs from the commit messages and puts them into the release notes. +s +If the pull request looks good but does not follow the commit conventions, use the Squash & merge button. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/LICENSE b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/LICENSE new file mode 100644 index 00000000..57bee5f1 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/LICENSE @@ -0,0 +1,7 @@ +MIT License Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/README.md new file mode 100644 index 00000000..482dae00 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/README.md @@ -0,0 +1,19 @@ +# types.ts + +> Shared TypeScript definitions for Octokit projects + +[![@latest](https://img.shields.io/npm/v/@octokit/types.svg)](https://www.npmjs.com/package/@octokit/types) +[![Build Status](https://github.com/octokit/types.ts/workflows/Test/badge.svg)](https://github.com/octokit/types.ts/actions?workflow=Test) +[![Greenkeeper](https://badges.greenkeeper.io/octokit/types.ts.svg)](https://greenkeeper.io/) + +## Usage + +See https://octokit.github.io/types.ts for all exported types + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/package.json b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/package.json new file mode 100644 index 00000000..7f014514 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/package.json @@ -0,0 +1,62 @@ +{ + "name": "@octokit/types", + "version": "2.0.1", + "publishConfig": { + "access": "public" + }, + "description": "Shared TypeScript definitions for Octokit projects", + "main": "src/index.ts", + "scripts": { + "docs": "typedoc --module commonjs --readme none --out docs src/", + "lint": "prettier --check '{src,test}/**/*' README.md package.json !src/generated/*", + "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json !src/generated/*", + "pretest": "npm run -s lint", + "test": "./node_modules/.bin/tsc --noEmit --declaration src/index.ts", + "update-endpoints": "npm-run-all update-endpoints:*", + "update-endpoints:fetch-json": "node scripts/update-endpoints/fetch-json", + "update-endpoints:typescript": "node scripts/update-endpoints/typescript" + }, + "repository": "https://github.com/octokit/types.ts", + "keywords": [ + "github", + "api", + "sdk", + "toolkit", + "typescript" + ], + "author": "Gregor Martynus (https://twitter.com/gr2m)", + "license": "MIT", + "devDependencies": { + "@octokit/graphql": "^4.2.2", + "handlebars": "^4.4.5", + "lodash.set": "^4.3.2", + "npm-run-all": "^4.1.5", + "pascal-case": "^2.0.1", + "prettier": "^1.18.2", + "semantic-release": "^15.13.24", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "sort-keys": "^4.0.0", + "string-to-jsdoc-comment": "^1.0.0", + "typedoc": "^0.15.0", + "typescript": "^3.6.4" + }, + "release": { + "plugins": [ + "@semantic-release/commit-analyzer", + "@semantic-release/release-notes-generator", + "@semantic-release/github", + "@semantic-release/npm", + [ + "semantic-release-plugin-update-version-in-files", + { + "files": [ + "src/VERSION.ts" + ] + } + ] + ] + }, + "dependencies": { + "@types/node": ">= 8" + } +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js new file mode 100644 index 00000000..6bca9300 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/fetch-json.js @@ -0,0 +1,41 @@ +const { writeFileSync } = require("fs"); +const path = require("path"); + +const { graphql } = require("@octokit/graphql"); +const prettier = require("prettier"); + +const QUERY = ` + { + endpoints { + name + scope(format: CAMELCASE) + id(format: CAMELCASE) + method + url + parameters { + alias + allowNull + deprecated + description + enum + name + type + required + } + } + }`; + +main(); + +async function main() { + const { endpoints } = await graphql(QUERY, { + url: "https://octokit-routes-graphql-server.now.sh/" + }); + + writeFileSync( + path.resolve(__dirname, "generated", "endpoints.json"), + prettier.format(JSON.stringify(endpoints), { + parser: "json" + }) + ); +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md new file mode 100644 index 00000000..6beaf58e --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/generated/README.md @@ -0,0 +1,3 @@ +# DO NOT EDIT FILES IN THIS DIRECTORY + +All files are generated automatically and will be overwritten next time [octokit/routes](https://github.com/octokit/routes/) has a new release. If you find a problem, please file an issue. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json new file mode 100644 index 00000000..6c3d62a3 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/generated/endpoints.json @@ -0,0 +1,25258 @@ +[ + { + "name": "Get the authenticated GitHub App", + "scope": "apps", + "id": "getAuthenticated", + "method": "GET", + "url": "/app", + "parameters": [] + }, + { + "name": "Create a GitHub App from a manifest", + "scope": "apps", + "id": "createFromManifest", + "method": "POST", + "url": "/app-manifests/{code}/conversions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "code parameter", + "enum": null, + "name": "code", + "type": "string", + "required": true + } + ] + }, + { + "name": "List installations", + "scope": "apps", + "id": "listInstallations", + "method": "GET", + "url": "/app/installations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get an installation", + "scope": "apps", + "id": "getInstallation", + "method": "GET", + "url": "/app/installations/{installation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete an installation", + "scope": "apps", + "id": "deleteInstallation", + "method": "DELETE", + "url": "/app/installations/{installation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Create a new installation token", + "scope": "apps", + "id": "createInstallationToken", + "method": "POST", + "url": "/app/installations/{installation_id}/access_tokens", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the \"[List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)\" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.", + "enum": null, + "name": "repository_ids", + "type": "integer[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see \"[GitHub App permissions](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions).\"", + "enum": null, + "name": "permissions", + "type": "object", + "required": false + } + ] + }, + { + "name": "List your grants", + "scope": "oauthAuthorizations", + "id": "listGrants", + "method": "GET", + "url": "/applications/grants", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single grant", + "scope": "oauthAuthorizations", + "id": "getGrant", + "method": "GET", + "url": "/applications/grants/{grant_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "grant_id parameter", + "enum": null, + "name": "grant_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a grant", + "scope": "oauthAuthorizations", + "id": "deleteGrant", + "method": "DELETE", + "url": "/applications/grants/{grant_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "grant_id parameter", + "enum": null, + "name": "grant_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Revoke a grant for an application", + "scope": "oauthAuthorizations", + "id": "revokeGrantForApplication", + "method": "DELETE", + "url": "/applications/{client_id}/grants/{access_token}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "access_token parameter", + "enum": null, + "name": "access_token", + "type": "string", + "required": true + } + ] + }, + { + "name": "Check an authorization", + "scope": "oauthAuthorizations", + "id": "checkAuthorization", + "method": "GET", + "url": "/applications/{client_id}/tokens/{access_token}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "access_token parameter", + "enum": null, + "name": "access_token", + "type": "string", + "required": true + } + ] + }, + { + "name": "Reset an authorization", + "scope": "oauthAuthorizations", + "id": "resetAuthorization", + "method": "POST", + "url": "/applications/{client_id}/tokens/{access_token}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "access_token parameter", + "enum": null, + "name": "access_token", + "type": "string", + "required": true + } + ] + }, + { + "name": "Revoke an authorization for an application", + "scope": "oauthAuthorizations", + "id": "revokeAuthorizationForApplication", + "method": "DELETE", + "url": "/applications/{client_id}/tokens/{access_token}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "access_token parameter", + "enum": null, + "name": "access_token", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single GitHub App", + "scope": "apps", + "id": "getBySlug", + "method": "GET", + "url": "/apps/{app_slug}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "app_slug parameter", + "enum": null, + "name": "app_slug", + "type": "string", + "required": true + } + ] + }, + { + "name": "List your authorizations", + "scope": "oauthAuthorizations", + "id": "listAuthorizations", + "method": "GET", + "url": "/authorizations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a new authorization", + "scope": "oauthAuthorizations", + "id": "createAuthorization", + "method": "POST", + "url": "/authorizations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes that this authorization is in.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.", + "enum": null, + "name": "note", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 20 character OAuth app client key for which to create the token.", + "enum": null, + "name": "client_id", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 40 character OAuth app client secret for which to create the token.", + "enum": null, + "name": "client_secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get-or-create an authorization for a specific app", + "scope": "oauthAuthorizations", + "id": "getOrCreateAuthorizationForApp", + "method": "PUT", + "url": "/authorizations/clients/{client_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", + "enum": null, + "name": "client_secret", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes that this authorization is in.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get-or-create an authorization for a specific app and fingerprint", + "scope": "oauthAuthorizations", + "id": "getOrCreateAuthorizationForAppAndFingerprint", + "method": "PUT", + "url": "/authorizations/clients/{client_id}/{fingerprint}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "fingerprint parameter", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", + "enum": null, + "name": "client_secret", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes that this authorization is in.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get-or-create an authorization for a specific app and fingerprint", + "scope": "oauthAuthorizations", + "id": "getOrCreateAuthorizationForAppFingerprint", + "method": "PUT", + "url": "/authorizations/clients/{client_id}/{fingerprint}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "client_id parameter", + "enum": null, + "name": "client_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "fingerprint parameter", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", + "enum": null, + "name": "client_secret", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes that this authorization is in.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single authorization", + "scope": "oauthAuthorizations", + "id": "getAuthorization", + "method": "GET", + "url": "/authorizations/{authorization_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "authorization_id parameter", + "enum": null, + "name": "authorization_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update an existing authorization", + "scope": "oauthAuthorizations", + "id": "updateAuthorization", + "method": "PATCH", + "url": "/authorizations/{authorization_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "authorization_id parameter", + "enum": null, + "name": "authorization_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Replaces the authorization scopes with these.", + "enum": null, + "name": "scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes to add to this authorization.", + "enum": null, + "name": "add_scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of scopes to remove from this authorization.", + "enum": null, + "name": "remove_scopes", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL to remind you what app the OAuth token is for.", + "enum": null, + "name": "note_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", + "enum": null, + "name": "fingerprint", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete an authorization", + "scope": "oauthAuthorizations", + "id": "deleteAuthorization", + "method": "DELETE", + "url": "/authorizations/{authorization_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "authorization_id parameter", + "enum": null, + "name": "authorization_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List all codes of conduct", + "scope": "codesOfConduct", + "id": "listConductCodes", + "method": "GET", + "url": "/codes_of_conduct", + "parameters": [] + }, + { + "name": "Get an individual code of conduct", + "scope": "codesOfConduct", + "id": "getConductCode", + "method": "GET", + "url": "/codes_of_conduct/{key}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key parameter", + "enum": null, + "name": "key", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a content attachment", + "scope": "apps", + "id": "createContentAttachment", + "method": "POST", + "url": "/content_references/{content_reference_id}/attachments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "content_reference_id parameter", + "enum": null, + "name": "content_reference_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the content attachment displayed in the body or comment of an issue or pull request.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get", + "scope": "emojis", + "id": "get", + "method": "GET", + "url": "/emojis", + "parameters": [] + }, + { + "name": "List public events", + "scope": "activity", + "id": "listPublicEvents", + "method": "GET", + "url": "/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List feeds", + "scope": "activity", + "id": "listFeeds", + "method": "GET", + "url": "/feeds", + "parameters": [] + }, + { + "name": "List the authenticated user's gists or if called anonymously, this will return all public gists", + "scope": "gists", + "id": "list", + "method": "GET", + "url": "/gists", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a gist", + "scope": "gists", + "id": "create", + "method": "POST", + "url": "/gists", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`.", + "enum": null, + "name": "files", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The content of the file.", + "enum": null, + "name": "files.content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A descriptive name for this gist.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "When `true`, the gist will be public and available for anyone to see.", + "enum": null, + "name": "public", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List all public gists", + "scope": "gists", + "id": "listPublic", + "method": "GET", + "url": "/gists/public", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List starred gists", + "scope": "gists", + "id": "listStarred", + "method": "GET", + "url": "/gists/starred", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single gist", + "scope": "gists", + "id": "get", + "method": "GET", + "url": "/gists/{gist_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "Edit a gist", + "scope": "gists", + "id": "update", + "method": "PATCH", + "url": "/gists/{gist_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A descriptive name for this gist.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The filenames and content that make up this gist.", + "enum": null, + "name": "files", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The updated content of the file.", + "enum": null, + "name": "files.content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new name for this file. To delete a file, set the value of the filename to `null`.", + "enum": null, + "name": "files.filename", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete a gist", + "scope": "gists", + "id": "delete", + "method": "DELETE", + "url": "/gists/{gist_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "List comments on a gist", + "scope": "gists", + "id": "listComments", + "method": "GET", + "url": "/gists/{gist_id}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a comment", + "scope": "gists", + "id": "createComment", + "method": "POST", + "url": "/gists/{gist_id}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The comment text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single comment", + "scope": "gists", + "id": "getComment", + "method": "GET", + "url": "/gists/{gist_id}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a comment", + "scope": "gists", + "id": "updateComment", + "method": "PATCH", + "url": "/gists/{gist_id}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The comment text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a comment", + "scope": "gists", + "id": "deleteComment", + "method": "DELETE", + "url": "/gists/{gist_id}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List gist commits", + "scope": "gists", + "id": "listCommits", + "method": "GET", + "url": "/gists/{gist_id}/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Fork a gist", + "scope": "gists", + "id": "fork", + "method": "POST", + "url": "/gists/{gist_id}/forks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "List gist forks", + "scope": "gists", + "id": "listForks", + "method": "GET", + "url": "/gists/{gist_id}/forks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Star a gist", + "scope": "gists", + "id": "star", + "method": "PUT", + "url": "/gists/{gist_id}/star", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unstar a gist", + "scope": "gists", + "id": "unstar", + "method": "DELETE", + "url": "/gists/{gist_id}/star", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "Check if a gist is starred", + "scope": "gists", + "id": "checkIsStarred", + "method": "GET", + "url": "/gists/{gist_id}/star", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a specific revision of a gist", + "scope": "gists", + "id": "getRevision", + "method": "GET", + "url": "/gists/{gist_id}/{sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gist_id parameter", + "enum": null, + "name": "gist_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "sha parameter", + "enum": null, + "name": "sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Listing available templates", + "scope": "gitignore", + "id": "listTemplates", + "method": "GET", + "url": "/gitignore/templates", + "parameters": [] + }, + { + "name": "Get a single template", + "scope": "gitignore", + "id": "getTemplate", + "method": "GET", + "url": "/gitignore/templates/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "List repositories", + "scope": "apps", + "id": "listRepos", + "method": "GET", + "url": "/installation/repositories", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories", + "scope": "issues", + "id": "list", + "method": "GET", + "url": "/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "enum": null, + "name": "labels", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "enum": ["created", "updated", "comments"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search issues", + "scope": "search", + "id": "issuesLegacy", + "method": "GET", + "url": "/legacy/issues/search/{owner}/{repository}/{state}/{keyword}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repository parameter", + "enum": null, + "name": "repository", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The search term.", + "enum": null, + "name": "keyword", + "type": "string", + "required": true + } + ] + }, + { + "name": "Search repositories", + "scope": "search", + "id": "reposLegacy", + "method": "GET", + "url": "/legacy/repos/search/{keyword}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The search term.", + "enum": null, + "name": "keyword", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter results by language.", + "enum": null, + "name": "language", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The page number to fetch.", + "enum": null, + "name": "start_page", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", + "enum": ["stars", "forks", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "order", + "type": "string", + "required": false + } + ] + }, + { + "name": "Email search", + "scope": "search", + "id": "emailLegacy", + "method": "GET", + "url": "/legacy/user/email/{email}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email address.", + "enum": null, + "name": "email", + "type": "string", + "required": true + } + ] + }, + { + "name": "Search users", + "scope": "search", + "id": "usersLegacy", + "method": "GET", + "url": "/legacy/user/search/{keyword}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The search term.", + "enum": null, + "name": "keyword", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The page number to fetch.", + "enum": null, + "name": "start_page", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", + "enum": ["stars", "forks", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "order", + "type": "string", + "required": false + } + ] + }, + { + "name": "List commonly used licenses", + "scope": "licenses", + "id": "listCommonlyUsed", + "method": "GET", + "url": "/licenses", + "parameters": [] + }, + { + "name": "List commonly used licenses", + "scope": "licenses", + "id": "list", + "method": "GET", + "url": "/licenses", + "parameters": [] + }, + { + "name": "Get an individual license", + "scope": "licenses", + "id": "get", + "method": "GET", + "url": "/licenses/{license}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "license parameter", + "enum": null, + "name": "license", + "type": "string", + "required": true + } + ] + }, + { + "name": "Render an arbitrary Markdown document", + "scope": "markdown", + "id": "render", + "method": "POST", + "url": "/markdown", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.", + "enum": null, + "name": "text", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The rendering mode. Can be either: \n\\* `markdown` to render a document in plain Markdown, just like README.md files are rendered. \n\\* `gfm` to render a document in [GitHub Flavored Markdown](https://github.github.com/gfm/), which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.", + "enum": ["markdown", "gfm"], + "name": "mode", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.", + "enum": null, + "name": "context", + "type": "string", + "required": false + } + ] + }, + { + "name": "Render a Markdown document in raw mode", + "scope": "markdown", + "id": "renderRaw", + "method": "POST", + "url": "/markdown/raw", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "data parameter", + "enum": null, + "name": "data", + "type": "string", + "required": true + } + ] + }, + { + "name": "Check if a GitHub account is associated with any Marketplace listing", + "scope": "apps", + "id": "checkAccountIsAssociatedWithAny", + "method": "GET", + "url": "/marketplace_listing/accounts/{account_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "account_id parameter", + "enum": null, + "name": "account_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all plans for your Marketplace listing", + "scope": "apps", + "id": "listPlans", + "method": "GET", + "url": "/marketplace_listing/plans", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all GitHub accounts (user or organization) on a specific plan", + "scope": "apps", + "id": "listAccountsUserOrOrgOnPlan", + "method": "GET", + "url": "/marketplace_listing/plans/{plan_id}/accounts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "plan_id parameter", + "enum": null, + "name": "plan_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if a GitHub account is associated with any Marketplace listing (stubbed)", + "scope": "apps", + "id": "checkAccountIsAssociatedWithAnyStubbed", + "method": "GET", + "url": "/marketplace_listing/stubbed/accounts/{account_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "account_id parameter", + "enum": null, + "name": "account_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all plans for your Marketplace listing (stubbed)", + "scope": "apps", + "id": "listPlansStubbed", + "method": "GET", + "url": "/marketplace_listing/stubbed/plans", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all GitHub accounts (user or organization) on a specific plan (stubbed)", + "scope": "apps", + "id": "listAccountsUserOrOrgOnPlanStubbed", + "method": "GET", + "url": "/marketplace_listing/stubbed/plans/{plan_id}/accounts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "plan_id parameter", + "enum": null, + "name": "plan_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get", + "scope": "meta", + "id": "get", + "method": "GET", + "url": "/meta", + "parameters": [] + }, + { + "name": "List public events for a network of repositories", + "scope": "activity", + "id": "listPublicEventsForRepoNetwork", + "method": "GET", + "url": "/networks/{owner}/{repo}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List your notifications", + "scope": "activity", + "id": "listNotifications", + "method": "GET", + "url": "/notifications", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, show notifications marked as read.", + "enum": null, + "name": "all", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", + "enum": null, + "name": "participating", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "before", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Mark as read", + "scope": "activity", + "id": "markAsRead", + "method": "PUT", + "url": "/notifications", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", + "enum": null, + "name": "last_read_at", + "type": "string", + "required": false + } + ] + }, + { + "name": "View a single thread", + "scope": "activity", + "id": "getThread", + "method": "GET", + "url": "/notifications/threads/{thread_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Mark a thread as read", + "scope": "activity", + "id": "markThreadAsRead", + "method": "PATCH", + "url": "/notifications/threads/{thread_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get a thread subscription", + "scope": "activity", + "id": "getThreadSubscription", + "method": "GET", + "url": "/notifications/threads/{thread_id}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Set a thread subscription", + "scope": "activity", + "id": "setThreadSubscription", + "method": "PUT", + "url": "/notifications/threads/{thread_id}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.", + "enum": null, + "name": "ignored", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a thread subscription", + "scope": "activity", + "id": "deleteThreadSubscription", + "method": "DELETE", + "url": "/notifications/threads/{thread_id}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "thread_id parameter", + "enum": null, + "name": "thread_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List all organizations", + "scope": "orgs", + "id": "list", + "method": "GET", + "url": "/organizations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The integer ID of the last Organization that you've seen.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get an organization", + "scope": "orgs", + "id": "get", + "method": "GET", + "url": "/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Edit an organization", + "scope": "orgs", + "id": "update", + "method": "PATCH", + "url": "/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Billing email address. This address is not publicized.", + "enum": null, + "name": "billing_email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The company name.", + "enum": null, + "name": "company", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The publicly visible email address.", + "enum": null, + "name": "email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The location.", + "enum": null, + "name": "location", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The shorthand name of the company.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the company.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Toggles whether organization projects are enabled for the organization.", + "enum": null, + "name": "has_organization_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Toggles whether repository projects are enabled for repositories that belong to the organization.", + "enum": null, + "name": "has_repository_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.", + "enum": ["read", "write", "admin", "none"], + "name": "default_repository_permission", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only admin members can create repositories. \nDefault: `true` \n**Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", + "enum": null, + "name": "members_can_create_repositories", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). \n\\* `none` - only admin members can create repositories. \n**Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", + "enum": ["all", "private", "none"], + "name": "members_allowed_repository_creation_type", + "type": "string", + "required": false + } + ] + }, + { + "name": "List blocked users", + "scope": "orgs", + "id": "listBlockedUsers", + "method": "GET", + "url": "/orgs/{org}/blocks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Check whether a user is blocked from an organization", + "scope": "orgs", + "id": "checkBlockedUser", + "method": "GET", + "url": "/orgs/{org}/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Block a user", + "scope": "orgs", + "id": "blockUser", + "method": "PUT", + "url": "/orgs/{org}/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unblock a user", + "scope": "orgs", + "id": "unblockUser", + "method": "DELETE", + "url": "/orgs/{org}/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List credential authorizations for an organization", + "scope": "orgs", + "id": "listCredentialAuthorizations", + "method": "GET", + "url": "/orgs/{org}/credential-authorizations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove a credential authorization for an organization", + "scope": "orgs", + "id": "removeCredentialAuthorization", + "method": "DELETE", + "url": "/orgs/{org}/credential-authorizations/{credential_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "credential_id parameter", + "enum": null, + "name": "credential_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List public events for an organization", + "scope": "activity", + "id": "listPublicEventsForOrg", + "method": "GET", + "url": "/orgs/{org}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List hooks", + "scope": "orgs", + "id": "listHooks", + "method": "GET", + "url": "/orgs/{org}/hooks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a hook", + "scope": "orgs", + "id": "createHook", + "method": "POST", + "url": "/orgs/{org}/hooks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Must be passed as \"web\".", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params).", + "enum": null, + "name": "config", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL to which the payloads will be delivered.", + "enum": null, + "name": "config.url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "enum": null, + "name": "config.content_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "enum": null, + "name": "config.secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "enum": null, + "name": "config.insecure_ssl", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", + "enum": null, + "name": "events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "enum": null, + "name": "active", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get single hook", + "scope": "orgs", + "id": "getHook", + "method": "GET", + "url": "/orgs/{org}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a hook", + "scope": "orgs", + "id": "updateHook", + "method": "PATCH", + "url": "/orgs/{org}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params).", + "enum": null, + "name": "config", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL to which the payloads will be delivered.", + "enum": null, + "name": "config.url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "enum": null, + "name": "config.content_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "enum": null, + "name": "config.secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "enum": null, + "name": "config.insecure_ssl", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", + "enum": null, + "name": "events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "enum": null, + "name": "active", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a hook", + "scope": "orgs", + "id": "deleteHook", + "method": "DELETE", + "url": "/orgs/{org}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Ping a hook", + "scope": "orgs", + "id": "pingHook", + "method": "POST", + "url": "/orgs/{org}/hooks/{hook_id}/pings", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get an organization installation", + "scope": "apps", + "id": "getOrgInstallation", + "method": "GET", + "url": "/orgs/{org}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get an organization installation", + "scope": "apps", + "id": "findOrgInstallation", + "method": "GET", + "url": "/orgs/{org}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get interaction restrictions for an organization", + "scope": "interactions", + "id": "getRestrictionsForOrg", + "method": "GET", + "url": "/orgs/{org}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update interaction restrictions for an organization", + "scope": "interactions", + "id": "addOrUpdateRestrictionsForOrg", + "method": "PUT", + "url": "/orgs/{org}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", + "enum": ["existing_users", "contributors_only", "collaborators_only"], + "name": "limit", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove interaction restrictions for an organization", + "scope": "interactions", + "id": "removeRestrictionsForOrg", + "method": "DELETE", + "url": "/orgs/{org}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "List pending organization invitations", + "scope": "orgs", + "id": "listPendingInvitations", + "method": "GET", + "url": "/orgs/{org}/invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create organization invitation", + "scope": "orgs", + "id": "createInvitation", + "method": "POST", + "url": "/orgs/{org}/invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting.", + "enum": null, + "name": "invitee_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.", + "enum": null, + "name": "email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify role for new member. Can be one of: \n\\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n\\* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n\\* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.", + "enum": ["admin", "direct_member", "billing_manager"], + "name": "role", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify IDs for the teams you want to invite new members to.", + "enum": null, + "name": "team_ids", + "type": "integer[]", + "required": false + } + ] + }, + { + "name": "List organization invitation teams", + "scope": "orgs", + "id": "listInvitationTeams", + "method": "GET", + "url": "/orgs/{org}/invitations/{invitation_id}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all issues for a given organization assigned to the authenticated user", + "scope": "issues", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "enum": null, + "name": "labels", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "enum": ["created", "updated", "comments"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Members list", + "scope": "orgs", + "id": "listMembers", + "method": "GET", + "url": "/orgs/{org}/members", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", + "enum": ["2fa_disabled", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", + "enum": ["all", "admin", "member"], + "name": "role", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check membership", + "scope": "orgs", + "id": "checkMembership", + "method": "GET", + "url": "/orgs/{org}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove a member", + "scope": "orgs", + "id": "removeMember", + "method": "DELETE", + "url": "/orgs/{org}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get organization membership", + "scope": "orgs", + "id": "getMembership", + "method": "GET", + "url": "/orgs/{org}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update organization membership", + "scope": "orgs", + "id": "addOrUpdateMembership", + "method": "PUT", + "url": "/orgs/{org}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", + "enum": ["admin", "member"], + "name": "role", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove organization membership", + "scope": "orgs", + "id": "removeMembership", + "method": "DELETE", + "url": "/orgs/{org}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Start an organization migration", + "scope": "migrations", + "id": "startForOrg", + "method": "POST", + "url": "/orgs/{org}/migrations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of arrays indicating which repositories should be migrated.", + "enum": null, + "name": "repositories", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", + "enum": null, + "name": "lock_repositories", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", + "enum": null, + "name": "exclude_attachments", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a list of organization migrations", + "scope": "migrations", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/migrations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the status of an organization migration", + "scope": "migrations", + "id": "getStatusForOrg", + "method": "GET", + "url": "/orgs/{org}/migrations/{migration_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Download an organization migration archive", + "scope": "migrations", + "id": "getArchiveForOrg", + "method": "GET", + "url": "/orgs/{org}/migrations/{migration_id}/archive", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete an organization migration archive", + "scope": "migrations", + "id": "deleteArchiveForOrg", + "method": "DELETE", + "url": "/orgs/{org}/migrations/{migration_id}/archive", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Unlock an organization repository", + "scope": "migrations", + "id": "unlockRepoForOrg", + "method": "DELETE", + "url": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo_name parameter", + "enum": null, + "name": "repo_name", + "type": "string", + "required": true + } + ] + }, + { + "name": "List outside collaborators", + "scope": "orgs", + "id": "listOutsideCollaborators", + "method": "GET", + "url": "/orgs/{org}/outside_collaborators", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", + "enum": ["2fa_disabled", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Remove outside collaborator", + "scope": "orgs", + "id": "removeOutsideCollaborator", + "method": "DELETE", + "url": "/orgs/{org}/outside_collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Convert member to outside collaborator", + "scope": "orgs", + "id": "convertMemberToOutsideCollaborator", + "method": "PUT", + "url": "/orgs/{org}/outside_collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List organization projects", + "scope": "projects", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create an organization project", + "scope": "projects", + "id": "createForOrg", + "method": "POST", + "url": "/orgs/{org}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the project.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the project.", + "enum": null, + "name": "body", + "type": "string", + "required": false + } + ] + }, + { + "name": "Public members list", + "scope": "orgs", + "id": "listPublicMembers", + "method": "GET", + "url": "/orgs/{org}/public_members", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check public membership", + "scope": "orgs", + "id": "checkPublicMembership", + "method": "GET", + "url": "/orgs/{org}/public_members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Publicize a user's membership", + "scope": "orgs", + "id": "publicizeMembership", + "method": "PUT", + "url": "/orgs/{org}/public_members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Conceal a user's membership", + "scope": "orgs", + "id": "concealMembership", + "method": "DELETE", + "url": "/orgs/{org}/public_members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List organization repositories", + "scope": "repos", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`.", + "enum": ["all", "public", "private", "forks", "sources", "member"], + "name": "type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "enum": ["created", "updated", "pushed", "full_name"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Creates a new repository in the specified organization", + "scope": "repos", + "id": "createInOrg", + "method": "POST", + "url": "/orgs/{org}/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the repository.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the repository.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL with more information about the repository.", + "enum": null, + "name": "homepage", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "enum": null, + "name": "has_issues", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "enum": null, + "name": "has_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "enum": null, + "name": "has_wiki", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "enum": null, + "name": "is_template", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", + "enum": null, + "name": "team_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Pass `true` to create an initial commit with empty README.", + "enum": null, + "name": "auto_init", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", + "enum": null, + "name": "gitignore_template", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", + "enum": null, + "name": "license_template", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "enum": null, + "name": "allow_squash_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "enum": null, + "name": "allow_merge_commit", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "enum": null, + "name": "allow_rebase_merge", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List IdP groups in an organization", + "scope": "teams", + "id": "listIdPGroupsForOrg", + "method": "GET", + "url": "/orgs/{org}/team-sync/groups", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List teams", + "scope": "teams", + "id": "list", + "method": "GET", + "url": "/orgs/{org}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create team", + "scope": "teams", + "id": "create", + "method": "POST", + "url": "/orgs/{org}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the team.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the team.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The logins of organization members to add as maintainers of the team.", + "enum": null, + "name": "maintainers", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", + "enum": null, + "name": "repo_names", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed` \n**Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams.", + "enum": ["secret", "closed"], + "name": "privacy", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "enum": ["pull", "push", "admin"], + "name": "permission", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.", + "enum": null, + "name": "parent_team_id", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get team by name", + "scope": "teams", + "id": "getByName", + "method": "GET", + "url": "/orgs/{org}/teams/{team_slug}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_slug parameter", + "enum": null, + "name": "team_slug", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a project card", + "scope": "projects", + "id": "getCard", + "method": "GET", + "url": "/projects/columns/cards/{card_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "card_id parameter", + "enum": null, + "name": "card_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update a project card", + "scope": "projects", + "id": "updateCard", + "method": "PATCH", + "url": "/projects/columns/cards/{card_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "card_id parameter", + "enum": null, + "name": "card_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card.", + "enum": null, + "name": "archived", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a project card", + "scope": "projects", + "id": "deleteCard", + "method": "DELETE", + "url": "/projects/columns/cards/{card_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "card_id parameter", + "enum": null, + "name": "card_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Move a project card", + "scope": "projects", + "id": "moveCard", + "method": "POST", + "url": "/projects/columns/cards/{card_id}/moves", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "card_id parameter", + "enum": null, + "name": "card_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `top`, `bottom`, or `after:`, where `` is the `id` value of a card in the same column, or in the new column specified by `column_id`.", + "enum": null, + "name": "position", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The `id` value of a column in the same project.", + "enum": null, + "name": "column_id", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a project column", + "scope": "projects", + "id": "getColumn", + "method": "GET", + "url": "/projects/columns/{column_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update a project column", + "scope": "projects", + "id": "updateColumn", + "method": "PATCH", + "url": "/projects/columns/{column_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new name of the column.", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a project column", + "scope": "projects", + "id": "deleteColumn", + "method": "DELETE", + "url": "/projects/columns/{column_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List project cards", + "scope": "projects", + "id": "listCards", + "method": "GET", + "url": "/projects/columns/{column_id}/cards", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", + "enum": ["all", "archived", "not_archived"], + "name": "archived_state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a project card", + "scope": "projects", + "id": "createCard", + "method": "POST", + "url": "/projects/columns/{column_id}/cards", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The card's note content. Only valid for cards without another type of content, so you must omit when specifying `content_id` and `content_type`.", + "enum": null, + "name": "note", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. \n**Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`.", + "enum": null, + "name": "content_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id.", + "enum": null, + "name": "content_type", + "type": "string", + "required": false + } + ] + }, + { + "name": "Move a project column", + "scope": "projects", + "id": "moveColumn", + "method": "POST", + "url": "/projects/columns/{column_id}/moves", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "column_id parameter", + "enum": null, + "name": "column_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project.", + "enum": null, + "name": "position", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a project", + "scope": "projects", + "id": "get", + "method": "GET", + "url": "/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Update a project", + "scope": "projects", + "id": "update", + "method": "PATCH", + "url": "/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the project.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the project.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "State of the project. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project](https://developer.github.com/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). \n \n**Note:** Updating a project's `organization_permission` requires `admin` access to the project. \n \nCan be one of: \n\\* `read` - Organization members can read, but not write to or administer this project. \n\\* `write` - Organization members can read and write, but not administer this project. \n\\* `admin` - Organization members can read, write and administer this project. \n\\* `none` - Organization members can only see this project if it is public.", + "enum": null, + "name": "organization_permission", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. \n \nCan be one of: \n\\* `false` - Anyone can see the project. \n\\* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a project", + "scope": "projects", + "id": "delete", + "method": "DELETE", + "url": "/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List collaborators", + "scope": "projects", + "id": "listCollaborators", + "method": "GET", + "url": "/projects/{project_id}/collaborators", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", + "enum": ["outside", "direct", "all"], + "name": "affiliation", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Add user as a collaborator", + "scope": "projects", + "id": "addCollaborator", + "method": "PUT", + "url": "/projects/{project_id}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\" Can be one of: \n\\* `read` - can read, but not write to or administer this project. \n\\* `write` - can read and write, but not administer this project. \n\\* `admin` - can read, write and administer this project.", + "enum": ["read", "write", "admin"], + "name": "permission", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove user as a collaborator", + "scope": "projects", + "id": "removeCollaborator", + "method": "DELETE", + "url": "/projects/{project_id}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Review a user's permission level", + "scope": "projects", + "id": "reviewUserPermissionLevel", + "method": "GET", + "url": "/projects/{project_id}/collaborators/{username}/permission", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List project columns", + "scope": "projects", + "id": "listColumns", + "method": "GET", + "url": "/projects/{project_id}/columns", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a project column", + "scope": "projects", + "id": "createColumn", + "method": "POST", + "url": "/projects/{project_id}/columns", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the column.", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get your current rate limit status", + "scope": "rateLimit", + "id": "get", + "method": "GET", + "url": "/rate_limit", + "parameters": [] + }, + { + "name": "Delete a reaction", + "scope": "reactions", + "id": "delete", + "method": "DELETE", + "url": "/reactions/{reaction_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "reaction_id parameter", + "enum": null, + "name": "reaction_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get", + "scope": "repos", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Edit", + "scope": "repos", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the repository.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the repository.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL with more information about the repository.", + "enum": null, + "name": "homepage", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "enum": null, + "name": "has_issues", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "enum": null, + "name": "has_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "enum": null, + "name": "has_wiki", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "enum": null, + "name": "is_template", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Updates the default branch for this repository.", + "enum": null, + "name": "default_branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "enum": null, + "name": "allow_squash_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "enum": null, + "name": "allow_merge_commit", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "enum": null, + "name": "allow_rebase_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "enum": null, + "name": "archived", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a repository", + "scope": "repos", + "id": "delete", + "method": "DELETE", + "url": "/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List assignees", + "scope": "issues", + "id": "listAssignees", + "method": "GET", + "url": "/repos/{owner}/{repo}/assignees", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check assignee", + "scope": "issues", + "id": "checkAssignee", + "method": "GET", + "url": "/repos/{owner}/{repo}/assignees/{assignee}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "assignee parameter", + "enum": null, + "name": "assignee", + "type": "string", + "required": true + } + ] + }, + { + "name": "Enable automated security fixes", + "scope": "repos", + "id": "enableAutomatedSecurityFixes", + "method": "PUT", + "url": "/repos/{owner}/{repo}/automated-security-fixes", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Disable automated security fixes", + "scope": "repos", + "id": "disableAutomatedSecurityFixes", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/automated-security-fixes", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List branches", + "scope": "repos", + "id": "listBranches", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", + "enum": null, + "name": "protected", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get branch", + "scope": "repos", + "id": "getBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get branch protection", + "scope": "repos", + "id": "getBranchProtection", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update branch protection", + "scope": "repos", + "id": "updateBranchProtection", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "Require status checks to pass before merging. Set to `null` to disable.", + "enum": null, + "name": "required_status_checks", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Require branches to be up to date before merging.", + "enum": null, + "name": "required_status_checks.strict", + "type": "boolean", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of status checks to require in order to merge into this branch", + "enum": null, + "name": "required_status_checks.contexts", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", + "enum": null, + "name": "enforce_admins", + "type": "boolean", + "required": true + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", + "enum": null, + "name": "required_pull_request_reviews", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "enum": null, + "name": "required_pull_request_reviews.dismissal_restrictions", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of user `login`s with dismissal access", + "enum": null, + "name": "required_pull_request_reviews.dismissal_restrictions.users", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of team `slug`s with dismissal access", + "enum": null, + "name": "required_pull_request_reviews.dismissal_restrictions.teams", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "enum": null, + "name": "required_pull_request_reviews.dismiss_stale_reviews", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", + "enum": null, + "name": "required_pull_request_reviews.require_code_owner_reviews", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "enum": null, + "name": "required_pull_request_reviews.required_approving_review_count", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "Restrict who can push to this branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", + "enum": null, + "name": "restrictions", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of user `login`s with push access", + "enum": null, + "name": "restrictions.users", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of team `slug`s with push access", + "enum": null, + "name": "restrictions.teams", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of app `slug`s with push access", + "enum": null, + "name": "restrictions.apps", + "type": "string[]", + "required": false + } + ] + }, + { + "name": "Remove branch protection", + "scope": "repos", + "id": "removeBranchProtection", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get admin enforcement of protected branch", + "scope": "repos", + "id": "getProtectedBranchAdminEnforcement", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add admin enforcement of protected branch", + "scope": "repos", + "id": "addProtectedBranchAdminEnforcement", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove admin enforcement of protected branch", + "scope": "repos", + "id": "removeProtectedBranchAdminEnforcement", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get pull request review enforcement of protected branch", + "scope": "repos", + "id": "getProtectedBranchPullRequestReviewEnforcement", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update pull request review enforcement of protected branch", + "scope": "repos", + "id": "updateProtectedBranchPullRequestReviewEnforcement", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "enum": null, + "name": "dismissal_restrictions", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of user `login`s with dismissal access", + "enum": null, + "name": "dismissal_restrictions.users", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of team `slug`s with dismissal access", + "enum": null, + "name": "dismissal_restrictions.teams", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "enum": null, + "name": "dismiss_stale_reviews", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", + "enum": null, + "name": "require_code_owner_reviews", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "enum": null, + "name": "required_approving_review_count", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Remove pull request review enforcement of protected branch", + "scope": "repos", + "id": "removeProtectedBranchPullRequestReviewEnforcement", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get required signatures of protected branch", + "scope": "repos", + "id": "getProtectedBranchRequiredSignatures", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add required signatures of protected branch", + "scope": "repos", + "id": "addProtectedBranchRequiredSignatures", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove required signatures of protected branch", + "scope": "repos", + "id": "removeProtectedBranchRequiredSignatures", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get required status checks of protected branch", + "scope": "repos", + "id": "getProtectedBranchRequiredStatusChecks", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update required status checks of protected branch", + "scope": "repos", + "id": "updateProtectedBranchRequiredStatusChecks", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Require branches to be up to date before merging.", + "enum": null, + "name": "strict", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The list of status checks to require in order to merge into this branch", + "enum": null, + "name": "contexts", + "type": "string[]", + "required": false + } + ] + }, + { + "name": "Remove required status checks of protected branch", + "scope": "repos", + "id": "removeProtectedBranchRequiredStatusChecks", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "List required status checks contexts of protected branch", + "scope": "repos", + "id": "listProtectedBranchRequiredStatusChecksContexts", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace required status checks contexts of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchRequiredStatusChecksContexts", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "contexts parameter", + "enum": null, + "name": "contexts", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Add required status checks contexts of protected branch", + "scope": "repos", + "id": "addProtectedBranchRequiredStatusChecksContexts", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "contexts parameter", + "enum": null, + "name": "contexts", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Remove required status checks contexts of protected branch", + "scope": "repos", + "id": "removeProtectedBranchRequiredStatusChecksContexts", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "contexts parameter", + "enum": null, + "name": "contexts", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Get restrictions of protected branch", + "scope": "repos", + "id": "getProtectedBranchRestrictions", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get apps with access to protected branch", + "scope": "repos", + "id": "getAppsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get apps with access to protected branch", + "scope": "repos", + "id": "listAppsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace app restrictions of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchAppRestrictions", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "apps parameter", + "enum": null, + "name": "apps", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Add app restrictions of protected branch", + "scope": "repos", + "id": "addProtectedBranchAppRestrictions", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "apps parameter", + "enum": null, + "name": "apps", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Remove app restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchAppRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "apps parameter", + "enum": null, + "name": "apps", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Get teams with access to protected branch", + "scope": "repos", + "id": "getTeamsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get teams with access to protected branch", + "scope": "repos", + "id": "listProtectedBranchTeamRestrictions", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get teams with access to protected branch", + "scope": "repos", + "id": "listTeamsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace team restrictions of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchTeamRestrictions", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "teams parameter", + "enum": null, + "name": "teams", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Add team restrictions of protected branch", + "scope": "repos", + "id": "addProtectedBranchTeamRestrictions", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "teams parameter", + "enum": null, + "name": "teams", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Remove team restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchTeamRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "teams parameter", + "enum": null, + "name": "teams", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Get users with access to protected branch", + "scope": "repos", + "id": "getUsersWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get users with access to protected branch", + "scope": "repos", + "id": "listProtectedBranchUserRestrictions", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get users with access to protected branch", + "scope": "repos", + "id": "listUsersWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace user restrictions of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchUserRestrictions", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "users parameter", + "enum": null, + "name": "users", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Add user restrictions of protected branch", + "scope": "repos", + "id": "addProtectedBranchUserRestrictions", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "users parameter", + "enum": null, + "name": "users", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Remove user restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchUserRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "branch parameter", + "enum": null, + "name": "branch", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "users parameter", + "enum": null, + "name": "users", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Create a check run", + "scope": "checks", + "id": "create", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-runs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the check. For example, \"code-coverage\".", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the commit.", + "enum": null, + "name": "head_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL of the integrator's site that has the full details of the check.", + "enum": null, + "name": "details_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A reference for the run on the integrator's system.", + "enum": null, + "name": "external_id", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "name": "status", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "started_at", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`.", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required" + ], + "name": "conclusion", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "completed_at", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description.", + "enum": null, + "name": "output", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the check run.", + "enum": null, + "name": "output.title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The summary of the check run. This parameter supports Markdown.", + "enum": null, + "name": "output.summary", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The details of the check run. This parameter supports Markdown.", + "enum": null, + "name": "output.text", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", + "enum": null, + "name": "output.annotations", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", + "enum": null, + "name": "output.annotations[].path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The start line of the annotation.", + "enum": null, + "name": "output.annotations[].start_line", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The end line of the annotation.", + "enum": null, + "name": "output.annotations[].end_line", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "enum": null, + "name": "output.annotations[].start_column", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "enum": null, + "name": "output.annotations[].end_column", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", + "enum": ["notice", "warning", "failure"], + "name": "output.annotations[].annotation_level", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", + "enum": null, + "name": "output.annotations[].message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title that represents the annotation. The maximum size is 255 characters.", + "enum": null, + "name": "output.annotations[].title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Details about this annotation. The maximum size is 64 KB.", + "enum": null, + "name": "output.annotations[].raw_details", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#images-object) description for details.", + "enum": null, + "name": "output.images", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The alternative text for the image.", + "enum": null, + "name": "output.images[].alt", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The full URL of the image.", + "enum": null, + "name": "output.images[].image_url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short image description.", + "enum": null, + "name": "output.images[].caption", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", + "enum": null, + "name": "actions", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", + "enum": null, + "name": "actions[].label", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short explanation of what this action would do. The maximum size is 40 characters.", + "enum": null, + "name": "actions[].description", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", + "enum": null, + "name": "actions[].identifier", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update a check run", + "scope": "checks", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_run_id parameter", + "enum": null, + "name": "check_run_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the check. For example, \"code-coverage\".", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL of the integrator's site that has the full details of the check.", + "enum": null, + "name": "details_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A reference for the run on the integrator's system.", + "enum": null, + "name": "external_id", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "started_at", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "name": "status", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`.", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required" + ], + "name": "conclusion", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "completed_at", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description.", + "enum": null, + "name": "output", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required**.", + "enum": null, + "name": "output.title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can contain Markdown.", + "enum": null, + "name": "output.summary", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can contain Markdown.", + "enum": null, + "name": "output.text", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", + "enum": null, + "name": "output.annotations", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", + "enum": null, + "name": "output.annotations[].path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The start line of the annotation.", + "enum": null, + "name": "output.annotations[].start_line", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The end line of the annotation.", + "enum": null, + "name": "output.annotations[].end_line", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "enum": null, + "name": "output.annotations[].start_column", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "enum": null, + "name": "output.annotations[].end_column", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", + "enum": ["notice", "warning", "failure"], + "name": "output.annotations[].annotation_level", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", + "enum": null, + "name": "output.annotations[].message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title that represents the annotation. The maximum size is 255 characters.", + "enum": null, + "name": "output.annotations[].title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Details about this annotation. The maximum size is 64 KB.", + "enum": null, + "name": "output.annotations[].raw_details", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", + "enum": null, + "name": "output.images", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The alternative text for the image.", + "enum": null, + "name": "output.images[].alt", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The full URL of the image.", + "enum": null, + "name": "output.images[].image_url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short image description.", + "enum": null, + "name": "output.images[].caption", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", + "enum": null, + "name": "actions", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", + "enum": null, + "name": "actions[].label", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short explanation of what this action would do. The maximum size is 40 characters.", + "enum": null, + "name": "actions[].description", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", + "enum": null, + "name": "actions[].identifier", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single check run", + "scope": "checks", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_run_id parameter", + "enum": null, + "name": "check_run_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List annotations for a check run", + "scope": "checks", + "id": "listAnnotations", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_run_id parameter", + "enum": null, + "name": "check_run_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a check suite", + "scope": "checks", + "id": "createSuite", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-suites", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sha of the head commit.", + "enum": null, + "name": "head_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Set preferences for check suites on a repository", + "scope": "checks", + "id": "setSuitesPreferences", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/check-suites/preferences", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details.", + "enum": null, + "name": "auto_trigger_checks", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The `id` of the GitHub App.", + "enum": null, + "name": "auto_trigger_checks[].app_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", + "enum": null, + "name": "auto_trigger_checks[].setting", + "type": "boolean", + "required": true + } + ] + }, + { + "name": "Get a single check suite", + "scope": "checks", + "id": "getSuite", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_suite_id parameter", + "enum": null, + "name": "check_suite_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List check runs in a check suite", + "scope": "checks", + "id": "listForSuite", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_suite_id parameter", + "enum": null, + "name": "check_suite_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns check runs with the specified `name`.", + "enum": null, + "name": "check_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "name": "status", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", + "enum": ["latest", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Rerequest check suite", + "scope": "checks", + "id": "rerequestSuite", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "check_suite_id parameter", + "enum": null, + "name": "check_suite_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List collaborators", + "scope": "repos", + "id": "listCollaborators", + "method": "GET", + "url": "/repos/{owner}/{repo}/collaborators", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", + "enum": ["outside", "direct", "all"], + "name": "affiliation", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if a user is a collaborator", + "scope": "repos", + "id": "checkCollaborator", + "method": "GET", + "url": "/repos/{owner}/{repo}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add user as a collaborator", + "scope": "repos", + "id": "addCollaborator", + "method": "PUT", + "url": "/repos/{owner}/{repo}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository.", + "enum": ["pull", "push", "admin"], + "name": "permission", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove user as a collaborator", + "scope": "repos", + "id": "removeCollaborator", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/collaborators/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Review a user's permission level", + "scope": "repos", + "id": "getCollaboratorPermissionLevel", + "method": "GET", + "url": "/repos/{owner}/{repo}/collaborators/{username}/permission", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List commit comments for a repository", + "scope": "repos", + "id": "listCommitComments", + "method": "GET", + "url": "/repos/{owner}/{repo}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single commit comment", + "scope": "repos", + "id": "getCommitComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update a commit comment", + "scope": "repos", + "id": "updateCommitComment", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the comment", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a commit comment", + "scope": "repos", + "id": "deleteCommitComment", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List reactions for a commit comment", + "scope": "reactions", + "id": "listForCommitComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for a commit comment", + "scope": "reactions", + "id": "createForCommitComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "List commits on a repository", + "scope": "repos", + "id": "listCommits", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only commits containing this file path will be returned.", + "enum": null, + "name": "path", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "GitHub login or email address by which to filter by commit author.", + "enum": null, + "name": "author", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "until", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List branches for HEAD commit", + "scope": "repos", + "id": "listBranchesForHeadCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "List comments for a single commit", + "scope": "repos", + "id": "listCommentsForCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "commit_sha", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "ref", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a commit comment", + "scope": "repos", + "id": "createCommitComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Relative path of the file to comment on.", + "enum": null, + "name": "path", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Line index in the diff to comment on.", + "enum": null, + "name": "position", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", + "enum": null, + "name": "line", + "type": "integer", + "required": false + }, + { + "alias": "commit_sha", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "sha", + "type": null, + "required": null + } + ] + }, + { + "name": "List pull requests associated with commit", + "scope": "repos", + "id": "listPullRequestsAssociatedWithCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single commit", + "scope": "repos", + "id": "getCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": "ref", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "sha", + "type": null, + "required": null + }, + { + "alias": "ref", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "commit_sha", + "type": null, + "required": null + } + ] + }, + { + "name": "List check runs for a specific ref", + "scope": "checks", + "id": "listForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns check runs with the specified `name`.", + "enum": null, + "name": "check_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", + "enum": ["queued", "in_progress", "completed"], + "name": "status", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", + "enum": ["latest", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List check suites for a specific ref", + "scope": "checks", + "id": "listSuitesForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters check suites by GitHub App `id`.", + "enum": null, + "name": "app_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/).", + "enum": null, + "name": "check_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the combined status for a specific ref", + "scope": "repos", + "id": "getCombinedStatusForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/status", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + } + ] + }, + { + "name": "List statuses for a specific ref", + "scope": "repos", + "id": "listStatusesForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/statuses", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the contents of a repository's code of conduct", + "scope": "codesOfConduct", + "id": "getForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/community/code_of_conduct", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Retrieve community profile metrics", + "scope": "repos", + "id": "retrieveCommunityProfileMetrics", + "method": "GET", + "url": "/repos/{owner}/{repo}/community/profile", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Compare two commits", + "scope": "repos", + "id": "compareCommits", + "method": "GET", + "url": "/repos/{owner}/{repo}/compare/{base}...{head}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "base parameter", + "enum": null, + "name": "base", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "head parameter", + "enum": null, + "name": "head", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get contents", + "scope": "repos", + "id": "getContents", + "method": "GET", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "ref", + "type": "string", + "required": false + } + ] + }, + { + "name": "Create or update a file", + "scope": "repos", + "id": "createOrUpdateFile", + "method": "PUT", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new file content, using Base64 encoding.", + "enum": null, + "name": "content", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The person that committed the file. Default: the authenticated user.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.email", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.email", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create or update a file", + "scope": "repos", + "id": "createFile", + "method": "PUT", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new file content, using Base64 encoding.", + "enum": null, + "name": "content", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The person that committed the file. Default: the authenticated user.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.email", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.email", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create or update a file", + "scope": "repos", + "id": "updateFile", + "method": "PUT", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new file content, using Base64 encoding.", + "enum": null, + "name": "content", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The person that committed the file. Default: the authenticated user.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "committer.email", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "enum": null, + "name": "author.email", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a file", + "scope": "repos", + "id": "deleteFile", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/contents/{path}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "path parameter", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The blob SHA of the file being replaced.", + "enum": null, + "name": "sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "object containing information about the committer.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author (or committer) of the commit", + "enum": null, + "name": "committer.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author (or committer) of the commit", + "enum": null, + "name": "committer.email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "object containing information about the author.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author (or committer) of the commit", + "enum": null, + "name": "author.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author (or committer) of the commit", + "enum": null, + "name": "author.email", + "type": "string", + "required": false + } + ] + }, + { + "name": "List contributors", + "scope": "repos", + "id": "listContributors", + "method": "GET", + "url": "/repos/{owner}/{repo}/contributors", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Set to `1` or `true` to include anonymous contributors in results.", + "enum": null, + "name": "anon", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List deployments", + "scope": "repos", + "id": "listDeployments", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA recorded at creation time.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the ref. This can be a branch, tag, or SHA.", + "enum": null, + "name": "ref", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", + "enum": null, + "name": "task", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", + "enum": null, + "name": "environment", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a deployment", + "scope": "repos", + "id": "createDeployment", + "method": "POST", + "url": "/repos/{owner}/{repo}/deployments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The ref to deploy. This can be a branch, tag, or SHA.", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", + "enum": null, + "name": "task", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", + "enum": null, + "name": "auto_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", + "enum": null, + "name": "required_contexts", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "JSON payload with extra information about the deployment.", + "enum": null, + "name": "payload", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", + "enum": null, + "name": "environment", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Short description of the deployment.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "transient_environment", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "production_environment", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a single deployment", + "scope": "repos", + "id": "getDeployment", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "deployment_id parameter", + "enum": null, + "name": "deployment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List deployment statuses", + "scope": "repos", + "id": "listDeploymentStatuses", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "deployment_id parameter", + "enum": null, + "name": "deployment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a deployment status", + "scope": "repos", + "id": "createDeploymentStatus", + "method": "POST", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "deployment_id parameter", + "enum": null, + "name": "deployment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", + "enum": [ + "error", + "failure", + "inactive", + "in_progress", + "queued", + "pending", + "success" + ], + "name": "state", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", + "enum": null, + "name": "target_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "log_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the status. The maximum description length is 140 characters.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", + "enum": ["production", "staging", "qa"], + "name": "environment", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "environment_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "enum": null, + "name": "auto_inactive", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a single deployment status", + "scope": "repos", + "id": "getDeploymentStatus", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "deployment_id parameter", + "enum": null, + "name": "deployment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "status_id parameter", + "enum": null, + "name": "status_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Create a repository dispatch event", + "scope": "repos", + "id": "createDispatchEvent", + "method": "POST", + "url": "/repos/{owner}/{repo}/dispatches", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required:** A custom webhook event name.", + "enum": null, + "name": "event_type", + "type": "string", + "required": false + } + ] + }, + { + "name": "List downloads for a repository", + "scope": "repos", + "id": "listDownloads", + "method": "GET", + "url": "/repos/{owner}/{repo}/downloads", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single download", + "scope": "repos", + "id": "getDownload", + "method": "GET", + "url": "/repos/{owner}/{repo}/downloads/{download_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "download_id parameter", + "enum": null, + "name": "download_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a download", + "scope": "repos", + "id": "deleteDownload", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/downloads/{download_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "download_id parameter", + "enum": null, + "name": "download_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List repository events", + "scope": "activity", + "id": "listRepoEvents", + "method": "GET", + "url": "/repos/{owner}/{repo}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List forks", + "scope": "repos", + "id": "listForks", + "method": "GET", + "url": "/repos/{owner}/{repo}/forks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", + "enum": ["newest", "oldest", "stargazers"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a fork", + "scope": "repos", + "id": "createFork", + "method": "POST", + "url": "/repos/{owner}/{repo}/forks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Optional parameter to specify the organization name if forking into an organization.", + "enum": null, + "name": "organization", + "type": "string", + "required": false + } + ] + }, + { + "name": "Create a blob", + "scope": "git", + "id": "createBlob", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/blobs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new blob's content.", + "enum": null, + "name": "content", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "enum": null, + "name": "encoding", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a blob", + "scope": "git", + "id": "getBlob", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/blobs/{file_sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "file_sha parameter", + "enum": null, + "name": "file_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a commit", + "scope": "git", + "id": "createCommit", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The commit message", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the tree object this commit points to", + "enum": null, + "name": "tree", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "enum": null, + "name": "parents", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", + "enum": null, + "name": "author", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author (or committer) of the commit", + "enum": null, + "name": "author.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author (or committer) of the commit", + "enum": null, + "name": "author.email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "author.date", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", + "enum": null, + "name": "committer", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author (or committer) of the commit", + "enum": null, + "name": "committer.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author (or committer) of the commit", + "enum": null, + "name": "committer.email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "committer.date", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", + "enum": null, + "name": "signature", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a commit", + "scope": "git", + "id": "getCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/commits/{commit_sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "commit_sha parameter", + "enum": null, + "name": "commit_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "List matching references", + "scope": "git", + "id": "listMatchingRefs", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/matching-refs/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single reference", + "scope": "git", + "id": "getRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/ref/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a reference", + "scope": "git", + "id": "createRef", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/refs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA1 value for this reference.", + "enum": null, + "name": "sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update a reference", + "scope": "git", + "id": "updateRef", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/git/refs/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA1 value to set this reference to", + "enum": null, + "name": "sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", + "enum": null, + "name": "force", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a reference", + "scope": "git", + "id": "deleteRef", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/git/refs/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a tag object", + "scope": "git", + "id": "createTag", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/tags", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", + "enum": null, + "name": "tag", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The tag message.", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the git object this is tagging.", + "enum": null, + "name": "object", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", + "enum": ["commit", "tree", "blob"], + "name": "type", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An object with information about the individual creating the tag.", + "enum": null, + "name": "tagger", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the author of the tag", + "enum": null, + "name": "tagger.name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The email of the author of the tag", + "enum": null, + "name": "tagger.email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "tagger.date", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a tag", + "scope": "git", + "id": "getTag", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/tags/{tag_sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "tag_sha parameter", + "enum": null, + "name": "tag_sha", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a tree", + "scope": "git", + "id": "createTree", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/trees", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", + "enum": null, + "name": "tree", + "type": "object[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The file referenced in the tree.", + "enum": null, + "name": "tree[].path", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", + "enum": ["100644", "100755", "040000", "160000", "120000"], + "name": "tree[].mode", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `blob`, `tree`, or `commit`.", + "enum": ["blob", "tree", "commit"], + "name": "tree[].type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", + "enum": null, + "name": "tree[].sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", + "enum": null, + "name": "tree[].content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.", + "enum": null, + "name": "base_tree", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a tree", + "scope": "git", + "id": "getTree", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/trees/{tree_sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "tree_sha parameter", + "enum": null, + "name": "tree_sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "recursive parameter", + "enum": ["1"], + "name": "recursive", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List hooks", + "scope": "repos", + "id": "listHooks", + "method": "GET", + "url": "/repos/{owner}/{repo}/hooks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a hook", + "scope": "repos", + "id": "createHook", + "method": "POST", + "url": "/repos/{owner}/{repo}/hooks", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", + "enum": null, + "name": "config", + "type": "object", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL to which the payloads will be delivered.", + "enum": null, + "name": "config.url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "enum": null, + "name": "config.content_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "enum": null, + "name": "config.secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "enum": null, + "name": "config.insecure_ssl", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", + "enum": null, + "name": "events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "enum": null, + "name": "active", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get single hook", + "scope": "repos", + "id": "getHook", + "method": "GET", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a hook", + "scope": "repos", + "id": "updateHook", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", + "enum": null, + "name": "config", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL to which the payloads will be delivered.", + "enum": null, + "name": "config.url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "enum": null, + "name": "config.content_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "enum": null, + "name": "config.secret", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "enum": null, + "name": "config.insecure_ssl", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", + "enum": null, + "name": "events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", + "enum": null, + "name": "add_events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", + "enum": null, + "name": "remove_events", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "enum": null, + "name": "active", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a hook", + "scope": "repos", + "id": "deleteHook", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Ping a hook", + "scope": "repos", + "id": "pingHook", + "method": "POST", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Test a push hook", + "scope": "repos", + "id": "testPushHook", + "method": "POST", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "hook_id parameter", + "enum": null, + "name": "hook_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Start an import", + "scope": "migrations", + "id": "startImport", + "method": "PUT", + "url": "/repos/{owner}/{repo}/import", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The URL of the originating repository.", + "enum": null, + "name": "vcs_url", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", + "enum": ["subversion", "git", "mercurial", "tfvc"], + "name": "vcs", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If authentication is required, the username to provide to `vcs_url`.", + "enum": null, + "name": "vcs_username", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If authentication is required, the password to provide to `vcs_url`.", + "enum": null, + "name": "vcs_password", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "For a tfvc import, the name of the project that is being imported.", + "enum": null, + "name": "tfvc_project", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get import progress", + "scope": "migrations", + "id": "getImportProgress", + "method": "GET", + "url": "/repos/{owner}/{repo}/import", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update existing import", + "scope": "migrations", + "id": "updateImport", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/import", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The username to provide to the originating repository.", + "enum": null, + "name": "vcs_username", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The password to provide to the originating repository.", + "enum": null, + "name": "vcs_password", + "type": "string", + "required": false + } + ] + }, + { + "name": "Cancel an import", + "scope": "migrations", + "id": "cancelImport", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/import", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get commit authors", + "scope": "migrations", + "id": "getCommitAuthors", + "method": "GET", + "url": "/repos/{owner}/{repo}/import/authors", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step.", + "enum": null, + "name": "since", + "type": "string", + "required": false + } + ] + }, + { + "name": "Map a commit author", + "scope": "migrations", + "id": "mapCommitAuthor", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/import/authors/{author_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "author_id parameter", + "enum": null, + "name": "author_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new Git author email.", + "enum": null, + "name": "email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new Git author name.", + "enum": null, + "name": "name", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get large files", + "scope": "migrations", + "id": "getLargeFiles", + "method": "GET", + "url": "/repos/{owner}/{repo}/import/large_files", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Set Git LFS preference", + "scope": "migrations", + "id": "setLfsPreference", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/import/lfs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import).", + "enum": ["opt_in", "opt_out"], + "name": "use_lfs", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a repository installation", + "scope": "apps", + "id": "getRepoInstallation", + "method": "GET", + "url": "/repos/{owner}/{repo}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a repository installation", + "scope": "apps", + "id": "findRepoInstallation", + "method": "GET", + "url": "/repos/{owner}/{repo}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get interaction restrictions for a repository", + "scope": "interactions", + "id": "getRestrictionsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update interaction restrictions for a repository", + "scope": "interactions", + "id": "addOrUpdateRestrictionsForRepo", + "method": "PUT", + "url": "/repos/{owner}/{repo}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", + "enum": ["existing_users", "contributors_only", "collaborators_only"], + "name": "limit", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove interaction restrictions for a repository", + "scope": "interactions", + "id": "removeRestrictionsForRepo", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/interaction-limits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List invitations for a repository", + "scope": "repos", + "id": "listInvitations", + "method": "GET", + "url": "/repos/{owner}/{repo}/invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Delete a repository invitation", + "scope": "repos", + "id": "deleteInvitation", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Update a repository invitation", + "scope": "repos", + "id": "updateInvitation", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.", + "enum": ["read", "write", "admin"], + "name": "permissions", + "type": "string", + "required": false + } + ] + }, + { + "name": "List issues for a repository", + "scope": "issues", + "id": "listForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", + "enum": null, + "name": "milestone", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", + "enum": null, + "name": "assignee", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The user that created the issue.", + "enum": null, + "name": "creator", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A user that's mentioned in the issue.", + "enum": null, + "name": "mentioned", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "enum": null, + "name": "labels", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "enum": ["created", "updated", "comments"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create an issue", + "scope": "issues", + "id": "create", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the issue.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the issue.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", + "enum": null, + "name": "assignee", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._", + "enum": null, + "name": "milestone", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", + "enum": null, + "name": "labels", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", + "enum": null, + "name": "assignees", + "type": "string[]", + "required": false + } + ] + }, + { + "name": "List comments in a repository", + "scope": "issues", + "id": "listCommentsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `created` or `updated`.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single comment", + "scope": "issues", + "id": "getComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Edit a comment", + "scope": "issues", + "id": "updateComment", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a comment", + "scope": "issues", + "id": "deleteComment", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List reactions for an issue comment", + "scope": "reactions", + "id": "listForIssueComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for an issue comment", + "scope": "reactions", + "id": "createForIssueComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "List events for a repository", + "scope": "issues", + "id": "listEventsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single event", + "scope": "issues", + "id": "getEvent", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/events/{event_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "event_id parameter", + "enum": null, + "name": "event_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get a single issue", + "scope": "issues", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Edit an issue", + "scope": "issues", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/issues/{issue_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the issue.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the issue.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", + "enum": null, + "name": "assignee", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "State of the issue. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": true, + "deprecated": null, + "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._", + "enum": null, + "name": "milestone", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", + "enum": null, + "name": "labels", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", + "enum": null, + "name": "assignees", + "type": "string[]", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Add assignees to an issue", + "scope": "issues", + "id": "addAssignees", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", + "enum": null, + "name": "assignees", + "type": "string[]", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Remove assignees from an issue", + "scope": "issues", + "id": "removeAssignees", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", + "enum": null, + "name": "assignees", + "type": "string[]", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List comments on an issue", + "scope": "issues", + "id": "listComments", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a comment", + "scope": "issues", + "id": "createComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List events for an issue", + "scope": "issues", + "id": "listEvents", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List labels on an issue", + "scope": "issues", + "id": "listLabelsOnIssue", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Add labels to an issue", + "scope": "issues", + "id": "addLabels", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "enum": null, + "name": "labels", + "type": "string[]", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Replace all labels for an issue", + "scope": "issues", + "id": "replaceLabels", + "method": "PUT", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "enum": null, + "name": "labels", + "type": "string[]", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Remove all labels from an issue", + "scope": "issues", + "id": "removeLabels", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Remove a label from an issue", + "scope": "issues", + "id": "removeLabel", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Lock an issue", + "scope": "issues", + "id": "lock", + "method": "PUT", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", + "enum": ["off-topic", "too heated", "resolved", "spam"], + "name": "lock_reason", + "type": "string", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Unlock an issue", + "scope": "issues", + "id": "unlock", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List reactions for an issue", + "scope": "reactions", + "id": "listForIssue", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create reaction for an issue", + "scope": "reactions", + "id": "createForIssue", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List events for an issue", + "scope": "issues", + "id": "listEventsForTimeline", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "issue_number parameter", + "enum": null, + "name": "issue_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "issue_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List deploy keys", + "scope": "repos", + "id": "listDeployKeys", + "method": "GET", + "url": "/repos/{owner}/{repo}/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Add a new deploy key", + "scope": "repos", + "id": "addDeployKey", + "method": "POST", + "url": "/repos/{owner}/{repo}/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A name for the key.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the key.", + "enum": null, + "name": "key", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/).\"", + "enum": null, + "name": "read_only", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a deploy key", + "scope": "repos", + "id": "getDeployKey", + "method": "GET", + "url": "/repos/{owner}/{repo}/keys/{key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key_id parameter", + "enum": null, + "name": "key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Remove a deploy key", + "scope": "repos", + "id": "removeDeployKey", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/keys/{key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key_id parameter", + "enum": null, + "name": "key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List all labels for this repository", + "scope": "issues", + "id": "listLabelsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a label", + "scope": "issues", + "id": "createLabel", + "method": "POST", + "url": "/repos/{owner}/{repo}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", + "enum": null, + "name": "color", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the label.", + "enum": null, + "name": "description", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single label", + "scope": "issues", + "id": "getLabel", + "method": "GET", + "url": "/repos/{owner}/{repo}/labels/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update a label", + "scope": "issues", + "id": "updateLabel", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/labels/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", + "enum": null, + "name": "new_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", + "enum": null, + "name": "color", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the label.", + "enum": null, + "name": "description", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete a label", + "scope": "issues", + "id": "deleteLabel", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/labels/{name}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "name parameter", + "enum": null, + "name": "name", + "type": "string", + "required": true + } + ] + }, + { + "name": "List languages", + "scope": "repos", + "id": "listLanguages", + "method": "GET", + "url": "/repos/{owner}/{repo}/languages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get the contents of a repository's license", + "scope": "licenses", + "id": "getForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/license", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Perform a merge", + "scope": "repos", + "id": "merge", + "method": "POST", + "url": "/repos/{owner}/{repo}/merges", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the base branch that the head will be merged into.", + "enum": null, + "name": "base", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The head to merge. This can be a branch name or a commit SHA1.", + "enum": null, + "name": "head", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", + "enum": null, + "name": "commit_message", + "type": "string", + "required": false + } + ] + }, + { + "name": "List milestones for a repository", + "scope": "issues", + "id": "listMilestonesForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/milestones", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the milestone. Either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Either `due_on` or `completeness`.", + "enum": ["due_on", "completeness"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a milestone", + "scope": "issues", + "id": "createMilestone", + "method": "POST", + "url": "/repos/{owner}/{repo}/milestones", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the milestone.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the milestone. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A description of the milestone.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "due_on", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single milestone", + "scope": "issues", + "id": "getMilestone", + "method": "GET", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "milestone_number parameter", + "enum": null, + "name": "milestone_number", + "type": "integer", + "required": true + }, + { + "alias": "milestone_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a milestone", + "scope": "issues", + "id": "updateMilestone", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "milestone_number parameter", + "enum": null, + "name": "milestone_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the milestone.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the milestone. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A description of the milestone.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "due_on", + "type": "string", + "required": false + }, + { + "alias": "milestone_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Delete a milestone", + "scope": "issues", + "id": "deleteMilestone", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "milestone_number parameter", + "enum": null, + "name": "milestone_number", + "type": "integer", + "required": true + }, + { + "alias": "milestone_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Get labels for every issue in a milestone", + "scope": "issues", + "id": "listLabelsForMilestone", + "method": "GET", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "milestone_number parameter", + "enum": null, + "name": "milestone_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "milestone_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List your notifications in a repository", + "scope": "activity", + "id": "listNotificationsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/notifications", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, show notifications marked as read.", + "enum": null, + "name": "all", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", + "enum": null, + "name": "participating", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "before", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Mark notifications as read in a repository", + "scope": "activity", + "id": "markNotificationsAsReadForRepo", + "method": "PUT", + "url": "/repos/{owner}/{repo}/notifications", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", + "enum": null, + "name": "last_read_at", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get information about a Pages site", + "scope": "repos", + "id": "getPages", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Enable a Pages site", + "scope": "repos", + "id": "enablePagesSite", + "method": "POST", + "url": "/repos/{owner}/{repo}/pages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "source parameter", + "enum": null, + "name": "source", + "type": "object", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The repository branch used to publish your [site's source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.", + "enum": ["master", "gh-pages"], + "name": "source.branch", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.", + "enum": null, + "name": "source.path", + "type": "string", + "required": false + } + ] + }, + { + "name": "Disable a Pages site", + "scope": "repos", + "id": "disablePagesSite", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Update information about a Pages site", + "scope": "repos", + "id": "updateInformationAboutPagesSite", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pages", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"", + "enum": null, + "name": "cname", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", + "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""], + "name": "source", + "type": "string", + "required": false + } + ] + }, + { + "name": "Request a page build", + "scope": "repos", + "id": "requestPageBuild", + "method": "POST", + "url": "/repos/{owner}/{repo}/pages/builds", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List Pages builds", + "scope": "repos", + "id": "listPagesBuilds", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages/builds", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get latest Pages build", + "scope": "repos", + "id": "getLatestPagesBuild", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages/builds/latest", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a specific Pages build", + "scope": "repos", + "id": "getPagesBuild", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages/builds/{build_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "build_id parameter", + "enum": null, + "name": "build_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List repository projects", + "scope": "projects", + "id": "listForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a repository project", + "scope": "projects", + "id": "createForRepo", + "method": "POST", + "url": "/repos/{owner}/{repo}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the project.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the project.", + "enum": null, + "name": "body", + "type": "string", + "required": false + } + ] + }, + { + "name": "List pull requests", + "scope": "pulls", + "id": "list", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `open`, `closed`, or `all` to filter by state.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", + "enum": null, + "name": "head", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filter pulls by base branch name. Example: `gh-pages`.", + "enum": null, + "name": "base", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", + "enum": ["created", "updated", "popularity", "long-running"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a pull request", + "scope": "pulls", + "id": "create", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the new pull request.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", + "enum": null, + "name": "head", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", + "enum": null, + "name": "base", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the pull request.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "enum": null, + "name": "maintainer_can_modify", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", + "enum": null, + "name": "draft", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List comments in a repository", + "scope": "pulls", + "id": "listCommentsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be either `created` or `updated` comments.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single comment", + "scope": "pulls", + "id": "getComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a comment", + "scope": "pulls", + "id": "updateComment", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text of the reply to the review comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a comment", + "scope": "pulls", + "id": "deleteComment", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List reactions for a pull request review comment", + "scope": "reactions", + "id": "listForPullRequestReviewComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for a pull request review comment", + "scope": "reactions", + "id": "createForPullRequestReviewComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single pull request", + "scope": "pulls", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a pull request", + "scope": "pulls", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The title of the pull request.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The contents of the pull request.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "State of this Pull Request. Either `open` or `closed`.", + "enum": ["open", "closed"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", + "enum": null, + "name": "base", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "enum": null, + "name": "maintainer_can_modify", + "type": "boolean", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List comments on a pull request", + "scope": "pulls", + "id": "listComments", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be either `created` or `updated` comments.", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a comment", + "scope": "pulls", + "id": "createComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text of the review comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", + "enum": null, + "name": "commit_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The relative path to the file that necessitates a comment.", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "enum": null, + "name": "position", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "enum": ["LEFT", "RIGHT"], + "name": "side", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "enum": null, + "name": "line", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "enum": null, + "name": "start_line", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "enum": ["LEFT", "RIGHT", "side"], + "name": "start_side", + "type": "string", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + }, + { + "alias": null, + "allowNull": null, + "deprecated": true, + "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", + "enum": null, + "name": "in_reply_to", + "type": "integer", + "required": null + } + ] + }, + { + "name": "Create a comment", + "scope": "pulls", + "id": "createCommentReply", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text of the review comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", + "enum": null, + "name": "commit_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The relative path to the file that necessitates a comment.", + "enum": null, + "name": "path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "enum": null, + "name": "position", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "enum": ["LEFT", "RIGHT"], + "name": "side", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "enum": null, + "name": "line", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "enum": null, + "name": "start_line", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "enum": ["LEFT", "RIGHT", "side"], + "name": "start_side", + "type": "string", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + }, + { + "alias": null, + "allowNull": null, + "deprecated": true, + "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", + "enum": null, + "name": "in_reply_to", + "type": "integer", + "required": null + } + ] + }, + { + "name": "Create a review comment reply", + "scope": "pulls", + "id": "createReviewCommentReply", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_id parameter", + "enum": null, + "name": "comment_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The text of the review comment.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "List commits on a pull request", + "scope": "pulls", + "id": "listCommits", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List pull requests files", + "scope": "pulls", + "id": "listFiles", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Get if a pull request has been merged", + "scope": "pulls", + "id": "checkIfMerged", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Merge a pull request (Merge Button)", + "scope": "pulls", + "id": "merge", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Title for the automatic commit message.", + "enum": null, + "name": "commit_title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Extra detail to append to automatic commit message.", + "enum": null, + "name": "commit_message", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "SHA that pull request head must match to allow merge.", + "enum": null, + "name": "sha", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", + "enum": ["merge", "squash", "rebase"], + "name": "merge_method", + "type": "string", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List review requests", + "scope": "pulls", + "id": "listReviewRequests", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a review request", + "scope": "pulls", + "id": "createReviewRequest", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of user `login`s that will be requested.", + "enum": null, + "name": "reviewers", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of team `slug`s that will be requested.", + "enum": null, + "name": "team_reviewers", + "type": "string[]", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Delete a review request", + "scope": "pulls", + "id": "deleteReviewRequest", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of user `login`s that will be removed.", + "enum": null, + "name": "reviewers", + "type": "string[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of team `slug`s that will be removed.", + "enum": null, + "name": "team_reviewers", + "type": "string[]", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "List reviews on a pull request", + "scope": "pulls", + "id": "listReviews", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Create a pull request review", + "scope": "pulls", + "id": "createReview", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", + "enum": null, + "name": "commit_id", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", + "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], + "name": "event", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", + "enum": null, + "name": "comments", + "type": "object[]", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The relative path to the file that necessitates a review comment.", + "enum": null, + "name": "comments[].path", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", + "enum": null, + "name": "comments[].position", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Text of the review comment.", + "enum": null, + "name": "comments[].body", + "type": "string", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Get a single review", + "scope": "pulls", + "id": "getReview", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Delete a pending review", + "scope": "pulls", + "id": "deletePendingReview", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a pull request review", + "scope": "pulls", + "id": "updateReview", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The body text of the pull request review.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Get comments for a single review", + "scope": "pulls", + "id": "getCommentsForReview", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Dismiss a pull request review", + "scope": "pulls", + "id": "dismissReview", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The message for the pull request review dismissal", + "enum": null, + "name": "message", + "type": "string", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Submit a pull request review", + "scope": "pulls", + "id": "submitReview", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "review_id parameter", + "enum": null, + "name": "review_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The body text of the pull request review", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", + "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], + "name": "event", + "type": "string", + "required": true + }, + { + "alias": "pull_number", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "number", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a pull request branch", + "scope": "pulls", + "id": "updateBranch", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "pull_number parameter", + "enum": null, + "name": "pull_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", + "enum": null, + "name": "expected_head_sha", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get the README", + "scope": "repos", + "id": "getReadme", + "method": "GET", + "url": "/repos/{owner}/{repo}/readme", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "enum": null, + "name": "ref", + "type": "string", + "required": false + } + ] + }, + { + "name": "List releases for a repository", + "scope": "repos", + "id": "listReleases", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a release", + "scope": "repos", + "id": "createRelease", + "method": "POST", + "url": "/repos/{owner}/{repo}/releases", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the tag.", + "enum": null, + "name": "tag_name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", + "enum": null, + "name": "target_commitish", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the release.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Text describing the contents of the tag.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", + "enum": null, + "name": "draft", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", + "enum": null, + "name": "prerelease", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a single release asset", + "scope": "repos", + "id": "getReleaseAsset", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "asset_id parameter", + "enum": null, + "name": "asset_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a release asset", + "scope": "repos", + "id": "updateReleaseAsset", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "asset_id parameter", + "enum": null, + "name": "asset_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The file name of the asset.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An alternate short description of the asset. Used in place of the filename.", + "enum": null, + "name": "label", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete a release asset", + "scope": "repos", + "id": "deleteReleaseAsset", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "asset_id parameter", + "enum": null, + "name": "asset_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get the latest release", + "scope": "repos", + "id": "getLatestRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/latest", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a release by tag name", + "scope": "repos", + "id": "getReleaseByTag", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/tags/{tag}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "tag parameter", + "enum": null, + "name": "tag", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single release", + "scope": "repos", + "id": "getRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "release_id parameter", + "enum": null, + "name": "release_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a release", + "scope": "repos", + "id": "updateRelease", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "release_id parameter", + "enum": null, + "name": "release_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the tag.", + "enum": null, + "name": "tag_name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", + "enum": null, + "name": "target_commitish", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the release.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Text describing the contents of the tag.", + "enum": null, + "name": "body", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` makes the release a draft, and `false` publishes the release.", + "enum": null, + "name": "draft", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", + "enum": null, + "name": "prerelease", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a release", + "scope": "repos", + "id": "deleteRelease", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "release_id parameter", + "enum": null, + "name": "release_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List assets for a release", + "scope": "repos", + "id": "listAssetsForRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/{release_id}/assets", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "release_id parameter", + "enum": null, + "name": "release_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List Stargazers", + "scope": "activity", + "id": "listStargazersForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/stargazers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the number of additions and deletions per week", + "scope": "repos", + "id": "getCodeFrequencyStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/code_frequency", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get the last year of commit activity data", + "scope": "repos", + "id": "getCommitActivityStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/commit_activity", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get contributors list with additions, deletions, and commit counts", + "scope": "repos", + "id": "getContributorsStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/contributors", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get the weekly commit count for the repository owner and everyone else", + "scope": "repos", + "id": "getParticipationStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/participation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get the number of commits per hour in each day", + "scope": "repos", + "id": "getPunchCardStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/punch_card", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create a status", + "scope": "repos", + "id": "createStatus", + "method": "POST", + "url": "/repos/{owner}/{repo}/statuses/{sha}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "sha parameter", + "enum": null, + "name": "sha", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", + "enum": ["error", "failure", "pending", "success"], + "name": "state", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", + "enum": null, + "name": "target_url", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the status.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A string label to differentiate this status from the status of other systems.", + "enum": null, + "name": "context", + "type": "string", + "required": false + } + ] + }, + { + "name": "List watchers", + "scope": "activity", + "id": "listWatchersForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/subscribers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a Repository Subscription", + "scope": "activity", + "id": "getRepoSubscription", + "method": "GET", + "url": "/repos/{owner}/{repo}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Set a Repository Subscription", + "scope": "activity", + "id": "setRepoSubscription", + "method": "PUT", + "url": "/repos/{owner}/{repo}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if notifications should be received from this repository.", + "enum": null, + "name": "subscribed", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines if all notifications should be blocked from this repository.", + "enum": null, + "name": "ignored", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Delete a Repository Subscription", + "scope": "activity", + "id": "deleteRepoSubscription", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/subscription", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List tags", + "scope": "repos", + "id": "listTags", + "method": "GET", + "url": "/repos/{owner}/{repo}/tags", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List teams", + "scope": "repos", + "id": "listTeams", + "method": "GET", + "url": "/repos/{owner}/{repo}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List all topics for a repository", + "scope": "repos", + "id": "listTopics", + "method": "GET", + "url": "/repos/{owner}/{repo}/topics", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Replace all topics for a repository", + "scope": "repos", + "id": "replaceTopics", + "method": "PUT", + "url": "/repos/{owner}/{repo}/topics", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", + "enum": null, + "name": "names", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Clones", + "scope": "repos", + "id": "getClones", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/clones", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Must be one of: `day`, `week`.", + "enum": ["day", "week"], + "name": "per", + "type": "string", + "required": false + } + ] + }, + { + "name": "List paths", + "scope": "repos", + "id": "getTopPaths", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/popular/paths", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List referrers", + "scope": "repos", + "id": "getTopReferrers", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/popular/referrers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Views", + "scope": "repos", + "id": "getViews", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/views", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Must be one of: `day`, `week`.", + "enum": ["day", "week"], + "name": "per", + "type": "string", + "required": false + } + ] + }, + { + "name": "Transfer a repository", + "scope": "repos", + "id": "transfer", + "method": "POST", + "url": "/repos/{owner}/{repo}/transfer", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Required:** The username or organization name the repository will be transferred to.", + "enum": null, + "name": "new_owner", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", + "enum": null, + "name": "team_ids", + "type": "integer[]", + "required": false + } + ] + }, + { + "name": "Check if vulnerability alerts are enabled for a repository", + "scope": "repos", + "id": "checkVulnerabilityAlerts", + "method": "GET", + "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Enable vulnerability alerts", + "scope": "repos", + "id": "enableVulnerabilityAlerts", + "method": "PUT", + "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Disable vulnerability alerts", + "scope": "repos", + "id": "disableVulnerabilityAlerts", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get archive link", + "scope": "repos", + "id": "getArchiveLink", + "method": "GET", + "url": "/repos/{owner}/{repo}/{archive_format}/{ref}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "archive_format parameter", + "enum": null, + "name": "archive_format", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ref parameter", + "enum": null, + "name": "ref", + "type": "string", + "required": true + } + ] + }, + { + "name": "Create repository using a repository template", + "scope": "repos", + "id": "createUsingTemplate", + "method": "POST", + "url": "/repos/{template_owner}/{template_repo}/generate", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "template_owner parameter", + "enum": null, + "name": "template_owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "template_repo parameter", + "enum": null, + "name": "template_repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", + "enum": null, + "name": "owner", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the new repository.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the new repository.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to create a new private repository or `false` to create a new public one.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List all public repositories", + "scope": "repos", + "id": "listPublic", + "method": "GET", + "url": "/repositories", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The integer ID of the last Repository that you've seen.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a list of provisioned identities", + "scope": "scim", + "id": "listProvisionedIdentities", + "method": "GET", + "url": "/scim/v2/organizations/{org}/Users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Used for pagination: the index of the first result to return.", + "enum": null, + "name": "startIndex", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Used for pagination: the number of results to return.", + "enum": null, + "name": "count", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: `?filter=userName%20eq%20\\\"Octocat\\\"`.", + "enum": null, + "name": "filter", + "type": "string", + "required": false + } + ] + }, + { + "name": "Provision and invite users", + "scope": "scim", + "id": "provisionAndInviteUsers", + "method": "POST", + "url": "/scim/v2/organizations/{org}/Users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Provision and invite users", + "scope": "scim", + "id": "provisionInviteUsers", + "method": "POST", + "url": "/scim/v2/organizations/{org}/Users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get provisioning details for a single user", + "scope": "scim", + "id": "getProvisioningDetailsForUser", + "method": "GET", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Replace a provisioned user's information", + "scope": "scim", + "id": "replaceProvisionedUserInformation", + "method": "PUT", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Replace a provisioned user's information", + "scope": "scim", + "id": "updateProvisionedOrgMembership", + "method": "PUT", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Update a user attribute", + "scope": "scim", + "id": "updateUserAttribute", + "method": "PATCH", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Remove a user from the organization", + "scope": "scim", + "id": "removeUserFromOrg", + "method": "DELETE", + "url": "/scim/v2/organizations/{org}/Users/{scim_user_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "scim_user_id parameter", + "enum": null, + "name": "scim_user_id", + "type": "integer", + "required": true + }, + { + "alias": "scim_user_id", + "allowNull": null, + "deprecated": true, + "description": null, + "enum": null, + "name": "external_identity_guid", + "type": null, + "required": null + } + ] + }, + { + "name": "Search code", + "scope": "search", + "id": "code", + "method": "GET", + "url": "/search/code", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["indexed"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search commits", + "scope": "search", + "id": "commits", + "method": "GET", + "url": "/search/commits", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["author-date", "committer-date"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search issues and pull requests", + "scope": "search", + "id": "issuesAndPullRequests", + "method": "GET", + "url": "/search/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": [ + "comments", + "reactions", + "reactions-+1", + "reactions--1", + "reactions-smile", + "reactions-thinking_face", + "reactions-heart", + "reactions-tada", + "interactions", + "created", + "updated" + ], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search issues and pull requests", + "scope": "search", + "id": "issues", + "method": "GET", + "url": "/search/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": [ + "comments", + "reactions", + "reactions-+1", + "reactions--1", + "reactions-smile", + "reactions-thinking_face", + "reactions-heart", + "reactions-tada", + "interactions", + "created", + "updated" + ], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search labels", + "scope": "search", + "id": "labels", + "method": "GET", + "url": "/search/labels", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The id of the repository.", + "enum": null, + "name": "repository_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + } + ] + }, + { + "name": "Search repositories", + "scope": "search", + "id": "repos", + "method": "GET", + "url": "/search/repositories", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["stars", "forks", "help-wanted-issues", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Search topics", + "scope": "search", + "id": "topics", + "method": "GET", + "url": "/search/topics", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", + "enum": null, + "name": "q", + "type": "string", + "required": true + } + ] + }, + { + "name": "Search users", + "scope": "search", + "id": "users", + "method": "GET", + "url": "/search/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.", + "enum": null, + "name": "q", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "enum": ["followers", "repositories", "joined"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "enum": ["desc", "asc"], + "name": "order", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get team", + "scope": "teams", + "id": "get", + "method": "GET", + "url": "/teams/{team_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit team", + "scope": "teams", + "id": "update", + "method": "PATCH", + "url": "/teams/{team_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the team.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the team.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "enum": ["secret", "closed"], + "name": "privacy", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "enum": ["pull", "push", "admin"], + "name": "permission", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.", + "enum": null, + "name": "parent_team_id", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Delete team", + "scope": "teams", + "id": "delete", + "method": "DELETE", + "url": "/teams/{team_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List discussions", + "scope": "teams", + "id": "listDiscussions", + "method": "GET", + "url": "/teams/{team_id}/discussions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a discussion", + "scope": "teams", + "id": "createDiscussion", + "method": "POST", + "url": "/teams/{team_id}/discussions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion post's title.", + "enum": null, + "name": "title", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion post's body text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a single discussion", + "scope": "teams", + "id": "getDiscussion", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a discussion", + "scope": "teams", + "id": "updateDiscussion", + "method": "PATCH", + "url": "/teams/{team_id}/discussions/{discussion_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion post's title.", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion post's body text.", + "enum": null, + "name": "body", + "type": "string", + "required": false + } + ] + }, + { + "name": "Delete a discussion", + "scope": "teams", + "id": "deleteDiscussion", + "method": "DELETE", + "url": "/teams/{team_id}/discussions/{discussion_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List comments", + "scope": "teams", + "id": "listDiscussionComments", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a comment", + "scope": "teams", + "id": "createDiscussionComment", + "method": "POST", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion comment's body text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a single comment", + "scope": "teams", + "id": "getDiscussionComment", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Edit a comment", + "scope": "teams", + "id": "updateDiscussionComment", + "method": "PATCH", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The discussion comment's body text.", + "enum": null, + "name": "body", + "type": "string", + "required": true + } + ] + }, + { + "name": "Delete a comment", + "scope": "teams", + "id": "deleteDiscussionComment", + "method": "DELETE", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List reactions for a team discussion comment", + "scope": "reactions", + "id": "listForTeamDiscussionComment", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for a team discussion comment", + "scope": "reactions", + "id": "createForTeamDiscussionComment", + "method": "POST", + "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "comment_number parameter", + "enum": null, + "name": "comment_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "List reactions for a team discussion", + "scope": "reactions", + "id": "listForTeamDiscussion", + "method": "GET", + "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create reaction for a team discussion", + "scope": "reactions", + "id": "createForTeamDiscussion", + "method": "POST", + "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "discussion_number parameter", + "enum": null, + "name": "discussion_number", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "type": "string", + "required": true + } + ] + }, + { + "name": "List pending team invitations", + "scope": "teams", + "id": "listPendingInvitations", + "method": "GET", + "url": "/teams/{team_id}/invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List team members", + "scope": "teams", + "id": "listMembers", + "method": "GET", + "url": "/teams/{team_id}/members", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", + "enum": ["member", "maintainer", "all"], + "name": "role", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get team member", + "scope": "teams", + "id": "getMember", + "method": "GET", + "url": "/teams/{team_id}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add team member", + "scope": "teams", + "id": "addMember", + "method": "PUT", + "url": "/teams/{team_id}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Remove team member", + "scope": "teams", + "id": "removeMember", + "method": "DELETE", + "url": "/teams/{team_id}/members/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get team membership", + "scope": "teams", + "id": "getMembership", + "method": "GET", + "url": "/teams/{team_id}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update team membership", + "scope": "teams", + "id": "addOrUpdateMembership", + "method": "PUT", + "url": "/teams/{team_id}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", + "enum": ["member", "maintainer"], + "name": "role", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove team membership", + "scope": "teams", + "id": "removeMembership", + "method": "DELETE", + "url": "/teams/{team_id}/memberships/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List team projects", + "scope": "teams", + "id": "listProjects", + "method": "GET", + "url": "/teams/{team_id}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Review a team project", + "scope": "teams", + "id": "reviewProject", + "method": "GET", + "url": "/teams/{team_id}/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Add or update team project", + "scope": "teams", + "id": "addOrUpdateProject", + "method": "PUT", + "url": "/teams/{team_id}/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.", + "enum": ["read", "write", "admin"], + "name": "permission", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove team project", + "scope": "teams", + "id": "removeProject", + "method": "DELETE", + "url": "/teams/{team_id}/projects/{project_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "project_id parameter", + "enum": null, + "name": "project_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List team repos", + "scope": "teams", + "id": "listRepos", + "method": "GET", + "url": "/teams/{team_id}/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if a team manages a repository", + "scope": "teams", + "id": "checkManagesRepo", + "method": "GET", + "url": "/teams/{team_id}/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Add or update team repository", + "scope": "teams", + "id": "addOrUpdateRepo", + "method": "PUT", + "url": "/teams/{team_id}/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team.", + "enum": ["pull", "push", "admin"], + "name": "permission", + "type": "string", + "required": false + } + ] + }, + { + "name": "Remove team repository", + "scope": "teams", + "id": "removeRepo", + "method": "DELETE", + "url": "/teams/{team_id}/repos/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List IdP groups for a team", + "scope": "teams", + "id": "listIdPGroups", + "method": "GET", + "url": "/teams/{team_id}/team-sync/group-mappings", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Create or update IdP group connections", + "scope": "teams", + "id": "createOrUpdateIdPGroupConnections", + "method": "PATCH", + "url": "/teams/{team_id}/team-sync/group-mappings", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", + "enum": null, + "name": "groups", + "type": "object[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "ID of the IdP group.", + "enum": null, + "name": "groups[].group_id", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Name of the IdP group.", + "enum": null, + "name": "groups[].group_name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Description of the IdP group.", + "enum": null, + "name": "groups[].group_description", + "type": "string", + "required": true + } + ] + }, + { + "name": "List child teams", + "scope": "teams", + "id": "listChild", + "method": "GET", + "url": "/teams/{team_id}/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "team_id parameter", + "enum": null, + "name": "team_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the authenticated user", + "scope": "users", + "id": "getAuthenticated", + "method": "GET", + "url": "/user", + "parameters": [] + }, + { + "name": "Update the authenticated user", + "scope": "users", + "id": "updateAuthenticated", + "method": "PATCH", + "url": "/user", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new name of the user.", + "enum": null, + "name": "name", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The publicly visible email address of the user.", + "enum": null, + "name": "email", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new blog URL of the user.", + "enum": null, + "name": "blog", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new company of the user.", + "enum": null, + "name": "company", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new location of the user.", + "enum": null, + "name": "location", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new hiring availability of the user.", + "enum": null, + "name": "hireable", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The new short biography of the user.", + "enum": null, + "name": "bio", + "type": "string", + "required": false + } + ] + }, + { + "name": "List blocked users", + "scope": "users", + "id": "listBlocked", + "method": "GET", + "url": "/user/blocks", + "parameters": [] + }, + { + "name": "Check whether you've blocked a user", + "scope": "users", + "id": "checkBlocked", + "method": "GET", + "url": "/user/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Block a user", + "scope": "users", + "id": "block", + "method": "PUT", + "url": "/user/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unblock a user", + "scope": "users", + "id": "unblock", + "method": "DELETE", + "url": "/user/blocks/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Toggle primary email visibility", + "scope": "users", + "id": "togglePrimaryEmailVisibility", + "method": "PATCH", + "url": "/user/email/visibility", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Specify the _primary_ email address that needs a visibility change.", + "enum": null, + "name": "email", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Use `public` to enable an authenticated user to view the specified email address, or use `private` so this primary email address cannot be seen publicly.", + "enum": null, + "name": "visibility", + "type": "string", + "required": true + } + ] + }, + { + "name": "List email addresses for a user", + "scope": "users", + "id": "listEmails", + "method": "GET", + "url": "/user/emails", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Add email address(es)", + "scope": "users", + "id": "addEmails", + "method": "POST", + "url": "/user/emails", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "enum": null, + "name": "emails", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "Delete email address(es)", + "scope": "users", + "id": "deleteEmails", + "method": "DELETE", + "url": "/user/emails", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "enum": null, + "name": "emails", + "type": "string[]", + "required": true + } + ] + }, + { + "name": "List the authenticated user's followers", + "scope": "users", + "id": "listFollowersForAuthenticatedUser", + "method": "GET", + "url": "/user/followers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List who the authenticated user is following", + "scope": "users", + "id": "listFollowingForAuthenticatedUser", + "method": "GET", + "url": "/user/following", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if you are following a user", + "scope": "users", + "id": "checkFollowing", + "method": "GET", + "url": "/user/following/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Follow a user", + "scope": "users", + "id": "follow", + "method": "PUT", + "url": "/user/following/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unfollow a user", + "scope": "users", + "id": "unfollow", + "method": "DELETE", + "url": "/user/following/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List your GPG keys", + "scope": "users", + "id": "listGpgKeys", + "method": "GET", + "url": "/user/gpg_keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a GPG key", + "scope": "users", + "id": "createGpgKey", + "method": "POST", + "url": "/user/gpg_keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Your GPG key, generated in ASCII-armored format. See \"[Generating a new GPG key](https://help.github.com/articles/generating-a-new-gpg-key/)\" for help creating a GPG key.", + "enum": null, + "name": "armored_public_key", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single GPG key", + "scope": "users", + "id": "getGpgKey", + "method": "GET", + "url": "/user/gpg_keys/{gpg_key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gpg_key_id parameter", + "enum": null, + "name": "gpg_key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a GPG key", + "scope": "users", + "id": "deleteGpgKey", + "method": "DELETE", + "url": "/user/gpg_keys/{gpg_key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "gpg_key_id parameter", + "enum": null, + "name": "gpg_key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List installations for a user", + "scope": "apps", + "id": "listInstallationsForAuthenticatedUser", + "method": "GET", + "url": "/user/installations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List repositories accessible to the user for an installation", + "scope": "apps", + "id": "listInstallationReposForAuthenticatedUser", + "method": "GET", + "url": "/user/installations/{installation_id}/repositories", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Add repository to installation", + "scope": "apps", + "id": "addRepoToInstallation", + "method": "PUT", + "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repository_id parameter", + "enum": null, + "name": "repository_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Remove repository from installation", + "scope": "apps", + "id": "removeRepoFromInstallation", + "method": "DELETE", + "url": "/user/installations/{installation_id}/repositories/{repository_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "installation_id parameter", + "enum": null, + "name": "installation_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repository_id parameter", + "enum": null, + "name": "repository_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List all issues across owned and member repositories assigned to the authenticated user", + "scope": "issues", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/issues", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "name": "filter", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "enum": null, + "name": "labels", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "enum": ["created", "updated", "comments"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List your public keys", + "scope": "users", + "id": "listPublicKeys", + "method": "GET", + "url": "/user/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a public key", + "scope": "users", + "id": "createPublicKey", + "method": "POST", + "url": "/user/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key \"Personal MacBook Air\".", + "enum": null, + "name": "title", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The public SSH key to add to your GitHub account. See \"[Generating a new SSH key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)\" for guidance on how to create a public SSH key.", + "enum": null, + "name": "key", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a single public key", + "scope": "users", + "id": "getPublicKey", + "method": "GET", + "url": "/user/keys/{key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key_id parameter", + "enum": null, + "name": "key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a public key", + "scope": "users", + "id": "deletePublicKey", + "method": "DELETE", + "url": "/user/keys/{key_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "key_id parameter", + "enum": null, + "name": "key_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Get a user's Marketplace purchases", + "scope": "apps", + "id": "listMarketplacePurchasesForAuthenticatedUser", + "method": "GET", + "url": "/user/marketplace_purchases", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a user's Marketplace purchases (stubbed)", + "scope": "apps", + "id": "listMarketplacePurchasesForAuthenticatedUserStubbed", + "method": "GET", + "url": "/user/marketplace_purchases/stubbed", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List your organization memberships", + "scope": "orgs", + "id": "listMemberships", + "method": "GET", + "url": "/user/memberships/orgs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.", + "enum": ["active", "pending"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get your organization membership", + "scope": "orgs", + "id": "getMembershipForAuthenticatedUser", + "method": "GET", + "url": "/user/memberships/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + } + ] + }, + { + "name": "Edit your organization membership", + "scope": "orgs", + "id": "updateMembership", + "method": "PATCH", + "url": "/user/memberships/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", + "enum": ["active"], + "name": "state", + "type": "string", + "required": true + } + ] + }, + { + "name": "Start a user migration", + "scope": "migrations", + "id": "startForAuthenticatedUser", + "method": "POST", + "url": "/user/migrations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "An array of repositories to include in the migration.", + "enum": null, + "name": "repositories", + "type": "string[]", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Locks the `repositories` to prevent changes during the migration when set to `true`.", + "enum": null, + "name": "lock_repositories", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Does not include attachments uploaded to GitHub.com in the migration data when set to `true`. Excluding attachments will reduce the migration archive file size.", + "enum": null, + "name": "exclude_attachments", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "Get a list of user migrations", + "scope": "migrations", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/migrations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get the status of a user migration", + "scope": "migrations", + "id": "getStatusForAuthenticatedUser", + "method": "GET", + "url": "/user/migrations/{migration_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Download a user migration archive", + "scope": "migrations", + "id": "getArchiveForAuthenticatedUser", + "method": "GET", + "url": "/user/migrations/{migration_id}/archive", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Delete a user migration archive", + "scope": "migrations", + "id": "deleteArchiveForAuthenticatedUser", + "method": "DELETE", + "url": "/user/migrations/{migration_id}/archive", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Unlock a user repository", + "scope": "migrations", + "id": "unlockRepoForAuthenticatedUser", + "method": "DELETE", + "url": "/user/migrations/{migration_id}/repos/{repo_name}/lock", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "migration_id parameter", + "enum": null, + "name": "migration_id", + "type": "integer", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo_name parameter", + "enum": null, + "name": "repo_name", + "type": "string", + "required": true + } + ] + }, + { + "name": "List your organizations", + "scope": "orgs", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/orgs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Create a user project", + "scope": "projects", + "id": "createForAuthenticatedUser", + "method": "POST", + "url": "/user/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the project.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The description of the project.", + "enum": null, + "name": "body", + "type": "string", + "required": false + } + ] + }, + { + "name": "List public email addresses for a user", + "scope": "users", + "id": "listPublicEmails", + "method": "GET", + "url": "/user/public_emails", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List your repositories", + "scope": "repos", + "id": "list", + "method": "GET", + "url": "/user/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `all`, `public`, or `private`.", + "enum": ["all", "public", "private"], + "name": "visibility", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", + "enum": null, + "name": "affiliation", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "enum": ["all", "owner", "public", "private", "member"], + "name": "type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "enum": ["created", "updated", "pushed", "full_name"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Creates a new repository for the authenticated user", + "scope": "repos", + "id": "createForAuthenticatedUser", + "method": "POST", + "url": "/user/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The name of the repository.", + "enum": null, + "name": "name", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A short description of the repository.", + "enum": null, + "name": "description", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "A URL with more information about the repository.", + "enum": null, + "name": "homepage", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", + "enum": null, + "name": "private", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "enum": null, + "name": "has_issues", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "enum": null, + "name": "has_projects", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "enum": null, + "name": "has_wiki", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "enum": null, + "name": "is_template", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", + "enum": null, + "name": "team_id", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Pass `true` to create an initial commit with empty README.", + "enum": null, + "name": "auto_init", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", + "enum": null, + "name": "gitignore_template", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", + "enum": null, + "name": "license_template", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "enum": null, + "name": "allow_squash_merge", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "enum": null, + "name": "allow_merge_commit", + "type": "boolean", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "enum": null, + "name": "allow_rebase_merge", + "type": "boolean", + "required": false + } + ] + }, + { + "name": "List a user's repository invitations", + "scope": "repos", + "id": "listInvitationsForAuthenticatedUser", + "method": "GET", + "url": "/user/repository_invitations", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Accept a repository invitation", + "scope": "repos", + "id": "acceptInvitation", + "method": "PATCH", + "url": "/user/repository_invitations/{invitation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "Decline a repository invitation", + "scope": "repos", + "id": "declineInvitation", + "method": "DELETE", + "url": "/user/repository_invitations/{invitation_id}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "invitation_id parameter", + "enum": null, + "name": "invitation_id", + "type": "integer", + "required": true + } + ] + }, + { + "name": "List repositories being starred by the authenticated user", + "scope": "activity", + "id": "listReposStarredByAuthenticatedUser", + "method": "GET", + "url": "/user/starred", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "One of `asc` (ascending) or `desc` (descending).", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if you are starring a repository", + "scope": "activity", + "id": "checkStarringRepo", + "method": "GET", + "url": "/user/starred/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Star a repository", + "scope": "activity", + "id": "starRepo", + "method": "PUT", + "url": "/user/starred/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Unstar a repository", + "scope": "activity", + "id": "unstarRepo", + "method": "DELETE", + "url": "/user/starred/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List repositories being watched by the authenticated user", + "scope": "activity", + "id": "listWatchedReposForAuthenticatedUser", + "method": "GET", + "url": "/user/subscriptions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if you are watching a repository (LEGACY)", + "scope": "activity", + "id": "checkWatchingRepoLegacy", + "method": "GET", + "url": "/user/subscriptions/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Watch a repository (LEGACY)", + "scope": "activity", + "id": "watchRepoLegacy", + "method": "PUT", + "url": "/user/subscriptions/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "Stop watching a repository (LEGACY)", + "scope": "activity", + "id": "stopWatchingRepoLegacy", + "method": "DELETE", + "url": "/user/subscriptions/{owner}/{repo}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "owner parameter", + "enum": null, + "name": "owner", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "repo parameter", + "enum": null, + "name": "repo", + "type": "string", + "required": true + } + ] + }, + { + "name": "List user teams", + "scope": "teams", + "id": "listForAuthenticatedUser", + "method": "GET", + "url": "/user/teams", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get all users", + "scope": "users", + "id": "list", + "method": "GET", + "url": "/users", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "The integer ID of the last User that you've seen.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get a single user", + "scope": "users", + "id": "getByUsername", + "method": "GET", + "url": "/users/{username}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List events performed by a user", + "scope": "activity", + "id": "listEventsForUser", + "method": "GET", + "url": "/users/{username}/events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List events for an organization", + "scope": "activity", + "id": "listEventsForOrg", + "method": "GET", + "url": "/users/{username}/events/orgs/{org}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "org parameter", + "enum": null, + "name": "org", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List public events performed by a user", + "scope": "activity", + "id": "listPublicEventsForUser", + "method": "GET", + "url": "/users/{username}/events/public", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List a user's followers", + "scope": "users", + "id": "listFollowersForUser", + "method": "GET", + "url": "/users/{username}/followers", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List who a user is following", + "scope": "users", + "id": "listFollowingForUser", + "method": "GET", + "url": "/users/{username}/following", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Check if one user follows another", + "scope": "users", + "id": "checkFollowingForUser", + "method": "GET", + "url": "/users/{username}/following/{target_user}", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "target_user parameter", + "enum": null, + "name": "target_user", + "type": "string", + "required": true + } + ] + }, + { + "name": "List public gists for the specified user", + "scope": "gists", + "id": "listPublicForUser", + "method": "GET", + "url": "/users/{username}/gists", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "enum": null, + "name": "since", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List GPG keys for a user", + "scope": "users", + "id": "listGpgKeysForUser", + "method": "GET", + "url": "/users/{username}/gpg_keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "Get contextual information about a user", + "scope": "users", + "id": "getContextForUser", + "method": "GET", + "url": "/users/{username}/hovercard", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.", + "enum": ["organization", "repository", "issue", "pull_request"], + "name": "subject_type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", + "enum": null, + "name": "subject_id", + "type": "string", + "required": false + } + ] + }, + { + "name": "Get a user installation", + "scope": "apps", + "id": "getUserInstallation", + "method": "GET", + "url": "/users/{username}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "Get a user installation", + "scope": "apps", + "id": "findUserInstallation", + "method": "GET", + "url": "/users/{username}/installation", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + } + ] + }, + { + "name": "List public keys for a user", + "scope": "users", + "id": "listPublicKeysForUser", + "method": "GET", + "url": "/users/{username}/keys", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List user organizations", + "scope": "orgs", + "id": "listForUser", + "method": "GET", + "url": "/users/{username}/orgs", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List user projects", + "scope": "projects", + "id": "listForUser", + "method": "GET", + "url": "/users/{username}/projects", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "enum": ["open", "closed", "all"], + "name": "state", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List events that a user has received", + "scope": "activity", + "id": "listReceivedEventsForUser", + "method": "GET", + "url": "/users/{username}/received_events", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List public events that a user has received", + "scope": "activity", + "id": "listReceivedPublicEventsForUser", + "method": "GET", + "url": "/users/{username}/received_events/public", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List user repositories", + "scope": "repos", + "id": "listForUser", + "method": "GET", + "url": "/users/{username}/repos", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `all`, `owner`, `member`.", + "enum": ["all", "owner", "member"], + "name": "type", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "enum": ["created", "updated", "pushed", "full_name"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List repositories being starred by a user", + "scope": "activity", + "id": "listReposStarredByUser", + "method": "GET", + "url": "/users/{username}/starred", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", + "enum": ["created", "updated"], + "name": "sort", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "One of `asc` (ascending) or `desc` (descending).", + "enum": ["asc", "desc"], + "name": "direction", + "type": "string", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + }, + { + "name": "List repositories being watched by a user", + "scope": "activity", + "id": "listReposWatchedByUser", + "method": "GET", + "url": "/users/{username}/subscriptions", + "parameters": [ + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "username parameter", + "enum": null, + "name": "username", + "type": "string", + "required": true + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Results per page (max 100)", + "enum": null, + "name": "per_page", + "type": "integer", + "required": false + }, + { + "alias": null, + "allowNull": false, + "deprecated": null, + "description": "Page number of the results to fetch.", + "enum": null, + "name": "page", + "type": "integer", + "required": false + } + ] + } +] diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template new file mode 100644 index 00000000..2eceb2f9 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/templates/endpoints.ts.template @@ -0,0 +1,33 @@ +// DO NOT EDIT THIS FILE +import { RequestHeaders } from "../RequestHeaders"; +import { RequestRequestOptions } from "../RequestRequestOptions"; +import { Url } from "../Url"; + +export interface Endpoints { + {{#each endpointsByRoute}} + "{{@key}}": [{{union this "optionsTypeName"}}, {{union this "requestOptionsTypeName"}}] + {{/each}} +} + +{{#each options}} +type {{in.name}} = { +{{#each in.parameters}} + {{&jsdoc}} + {{{name this}}}: {{{type this}}} +{{/each}} +} +type {{out.name}} = { + method: "{{out.method}}", + url: Url, + headers: RequestHeaders, + request: RequestRequestOptions +} +{{/each}} + +{{#childParams}} +export type {{paramTypeName}} = { +{{#params}} + {{{name this}}}: {{{type this}}} +{{/params}} +}; +{{/childParams}} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/typescript.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/typescript.js new file mode 100644 index 00000000..2095c6c2 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/scripts/update-endpoints/typescript.js @@ -0,0 +1,179 @@ +const { readFileSync, writeFileSync } = require("fs"); +const { resolve } = require("path"); + +const Handlebars = require("handlebars"); +const set = require("lodash.set"); +const pascalCase = require("pascal-case"); +const prettier = require("prettier"); +const { stringToJsdocComment } = require("string-to-jsdoc-comment"); +const sortKeys = require("sort-keys"); + +const ENDPOINTS = require("./generated/Endpoints.json"); +const ENDPOINTS_PATH = resolve( + process.cwd(), + "src", + "generated", + "Endpoints.ts" +); +const ENDPOINTS_TEMPLATE_PATH = resolve( + process.cwd(), + "scripts", + "update-endpoints", + "templates", + "endpoints.ts.template" +); + +Handlebars.registerHelper("union", function(endpoints, key) { + return endpoints.map(endpoint => endpoint[key]).join(" | "); +}); +Handlebars.registerHelper("name", function(parameter) { + let name = parameter.key; + + if (/[.\[]/.test(name)) { + name = `"${name}"`; + } + + if (parameter.required) { + return name; + } + + return `${name}?`; +}); + +Handlebars.registerHelper("type", function(parameter) { + const type = typeMap[parameter.type] || parameter.type; + + if (parameter.allowNull) { + return `${type} | null`; + } + + return type; +}); +const template = Handlebars.compile( + readFileSync(ENDPOINTS_TEMPLATE_PATH, "utf8") +); + +const endpointsByRoute = {}; + +const typeMap = { + integer: "number", + "integer[]": "number[]" +}; + +for (const endpoint of ENDPOINTS) { + const route = `${endpoint.method} ${endpoint.url.replace( + /\{([^}]+)}/g, + ":$1" + )}`; + + if (!endpointsByRoute[route]) { + endpointsByRoute[route] = []; + } + + endpointsByRoute[route].push({ + optionsTypeName: + pascalCase(`${endpoint.scope} ${endpoint.id}`) + "Endpoint", + requestOptionsTypeName: + pascalCase(`${endpoint.scope} ${endpoint.id}`) + "RequestOptions" + }); +} + +const options = []; +const childParams = {}; + +for (const endpoint of ENDPOINTS) { + const { method, parameters } = endpoint; + + const optionsTypeName = + pascalCase(`${endpoint.scope} ${endpoint.id}`) + "Endpoint"; + const requestOptionsTypeName = + pascalCase(`${endpoint.scope} ${endpoint.id}`) + "RequestOptions"; + + options.push({ + in: { + name: optionsTypeName, + parameters: parameters + .map(parameterize) + // handle "object" & "object[]" types + .map(parameter => { + if (parameter.deprecated) { + return; + } + + const namespacedParamsName = pascalCase( + `${endpoint.scope}.${endpoint.id}.Params` + ); + + if (parameter.type === "object" || parameter.type === "object[]") { + const childParamsName = pascalCase( + `${namespacedParamsName}.${parameter.key}` + ); + + parameter.type = parameter.type.replace("object", childParamsName); + + if (!childParams[childParamsName]) { + childParams[childParamsName] = {}; + } + } + + if (!/\./.test(parameter.key)) { + return parameter; + } + + const childKey = parameter.key.split(".").pop(); + const parentKey = parameter.key.replace(/\.[^.]+$/, ""); + + parameter.key = childKey; + + const childParamsName = pascalCase( + `${namespacedParamsName}.${parentKey}` + ); + set(childParams, `${childParamsName}.${childKey}`, parameter); + }) + .filter(Boolean) + }, + out: { + name: requestOptionsTypeName, + method + } + }); +} + +const result = template({ + endpointsByRoute: sortKeys(endpointsByRoute, { deep: true }), + options, + childParams: Object.keys(childParams).map(key => { + if (key === "GistsCreateParamsFiles") { + debugger; + } + return { + paramTypeName: key, + params: Object.values(childParams[key]) + }; + }) +}); + +writeFileSync( + ENDPOINTS_PATH, + prettier.format(result, { parser: "typescript" }) +); +console.log(`${ENDPOINTS_PATH} updated.`); + +function parameterize(parameter) { + const key = parameter.name; + const type = typeMap[parameter.type] || parameter.type; + const enums = parameter.enum + ? parameter.enum.map(JSON.stringify).join("|") + : null; + + return { + name: pascalCase(key), + key: key, + required: parameter.required, + type: enums || type, + alias: parameter.alias, + deprecated: parameter.deprecated, + allowNull: parameter.allowNull, + jsdoc: stringToJsdocComment(parameter.description) + }; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/AuthInterface.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/AuthInterface.ts new file mode 100644 index 00000000..8f587436 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/AuthInterface.ts @@ -0,0 +1,43 @@ +import { EndpointOptions } from "./EndpointOptions"; +import { OctokitResponse } from "./OctokitResponse"; +import { RequestInterface } from "./RequestInterface"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; + +/** + * Interface to implement complex authentication strategies for Octokit. + * An object Implementing the AuthInterface can directly be passed as the + * `auth` option in the Octokit constructor. + * + * For the official implementations of the most common authentication + * strategies, see https://github.com/octokit/auth.js + */ +export interface AuthInterface< + AuthOptions extends any[], + Authentication extends any +> { + (...args: AuthOptions): Promise; + + hook: { + /** + * Sends a request using the passed `request` instance + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: RequestInterface, options: EndpointOptions): Promise< + OctokitResponse + >; + + /** + * Sends a request using the passed `request` instance + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + ( + request: RequestInterface, + route: Route, + parameters?: RequestParameters + ): Promise>; + }; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/EndpointDefaults.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/EndpointDefaults.ts new file mode 100644 index 00000000..024f6ebb --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/EndpointDefaults.ts @@ -0,0 +1,22 @@ +import { RequestHeaders } from "./RequestHeaders"; +import { RequestMethod } from "./RequestMethod"; +import { RequestParameters } from "./RequestParameters"; +import { Url } from "./Url"; + +/** + * The `.endpoint()` method is guaranteed to set all keys defined by RequestParameters + * as well as the method property. + */ +export type EndpointDefaults = RequestParameters & { + baseUrl: Url; + method: RequestMethod; + url?: Url; + headers: RequestHeaders & { + accept: string; + "user-agent": string; + }; + mediaType: { + format: string; + previews: string[]; + }; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/EndpointInterface.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/EndpointInterface.ts new file mode 100644 index 00000000..fee78d61 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/EndpointInterface.ts @@ -0,0 +1,74 @@ +import { EndpointDefaults } from "./EndpointDefaults"; +import { EndpointOptions } from "./EndpointOptions"; +import { RequestOptions } from "./RequestOptions"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; + +import { Endpoints } from "./generated/Endpoints"; + +export interface EndpointInterface { + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: EndpointOptions): RequestOptions; + + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + ( + route: keyof Endpoints | R, + options?: R extends keyof Endpoints + ? Endpoints[R][0] & RequestParameters + : RequestParameters + ): R extends keyof Endpoints ? Endpoints[R][1] : RequestOptions; + + /** + * Object with current default route and parameters + */ + DEFAULTS: EndpointDefaults; + + /** + * Returns a new `endpoint` with updated route and parameters + */ + defaults: (newDefaults: RequestParameters) => EndpointInterface; + + merge: { + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * + */ + (route: Route, parameters?: RequestParameters): EndpointDefaults; + + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: RequestParameters): EndpointDefaults; + + /** + * Returns current default options. + * + * @deprecated use endpoint.DEFAULTS instead + */ + (): EndpointDefaults; + }; + + /** + * Stateless method to turn endpoint options into request options. + * Calling `endpoint(options)` is the same as calling `endpoint.parse(endpoint.merge(options))`. + * + * @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + parse: (options: EndpointDefaults) => RequestOptions; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/EndpointOptions.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/EndpointOptions.ts new file mode 100644 index 00000000..01706049 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/EndpointOptions.ts @@ -0,0 +1,8 @@ +import { RequestMethod } from "./RequestMethod"; +import { Url } from "./Url"; +import { RequestParameters } from "./RequestParameters"; + +export type EndpointOptions = RequestParameters & { + method: RequestMethod; + url: Url; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Fetch.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Fetch.ts new file mode 100644 index 00000000..983c79be --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Fetch.ts @@ -0,0 +1,4 @@ +/** + * Browser's fetch method (or compatible such as fetch-mock) + */ +export type Fetch = any; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/OctokitResponse.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/OctokitResponse.ts new file mode 100644 index 00000000..4cec20d9 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/OctokitResponse.ts @@ -0,0 +1,18 @@ +import { ResponseHeaders } from "./ResponseHeaders"; +import { Url } from "./Url"; + +export type OctokitResponse = { + headers: ResponseHeaders; + /** + * http response code + */ + status: number; + /** + * URL of response after all redirects + */ + url: Url; + /** + * This is the data you would see in https://developer.Octokit.com/v3/ + */ + data: T; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestHeaders.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestHeaders.ts new file mode 100644 index 00000000..0df66361 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestHeaders.ts @@ -0,0 +1,15 @@ +export type RequestHeaders = { + /** + * Avoid setting `headers.accept`, use `mediaType.{format|previews}` option instead. + */ + accept?: string; + /** + * Use `authorization` to send authenticated request, remember `token ` / `bearer ` prefixes. Example: `token 1234567890abcdef1234567890abcdef12345678` + */ + authorization?: string; + /** + * `user-agent` is set do a default and can be overwritten as needed. + */ + "user-agent"?: string; + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestInterface.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestInterface.ts new file mode 100644 index 00000000..21bd0876 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestInterface.ts @@ -0,0 +1,51 @@ +import { EndpointInterface } from "./EndpointInterface"; +import { EndpointOptions } from "./EndpointOptions"; +import { RequestParameters } from "./RequestParameters"; +import { ResponseHeaders } from "./ResponseHeaders"; +import { Route } from "./Route"; +import { Url } from "./Url"; + +export interface RequestInterface { + /** + * Sends a request based on endpoint options + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: EndpointOptions): Promise>; + + /** + * Sends a request based on endpoint options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: Route, parameters?: RequestParameters): Promise< + OctokitResponse + >; + + /** + * Returns a new `endpoint` with updated route and parameters + */ + defaults: (newDefaults: RequestParameters) => RequestInterface; + + /** + * Octokit endpoint API, see {@link https://github.com/octokit/endpoint.js|@octokit/endpoint} + */ + endpoint: EndpointInterface; +} + +export type OctokitResponse = { + headers: ResponseHeaders; + /** + * http response code + */ + status: number; + /** + * URL of response after all redirects + */ + url: Url; + /** + * This is the data you would see in https://developer.Octokit.com/v3/ + */ + data: T; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestMethod.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestMethod.ts new file mode 100644 index 00000000..2910435a --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestMethod.ts @@ -0,0 +1,10 @@ +/** + * HTTP Verb supported by GitHub's REST API + */ +export type RequestMethod = + | "DELETE" + | "GET" + | "HEAD" + | "PATCH" + | "POST" + | "PUT"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestOptions.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestOptions.ts new file mode 100644 index 00000000..4d765c09 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestOptions.ts @@ -0,0 +1,15 @@ +import { RequestHeaders } from "./RequestHeaders"; +import { RequestMethod } from "./RequestMethod"; +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { Url } from "./Url"; + +/** + * Generic request options as they are returned by the `endpoint()` method + */ +export type RequestOptions = { + method: RequestMethod; + url: Url; + headers: RequestHeaders; + body?: any; + request?: RequestRequestOptions; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestParameters.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestParameters.ts new file mode 100644 index 00000000..9766be00 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestParameters.ts @@ -0,0 +1,46 @@ +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { RequestHeaders } from "./RequestHeaders"; +import { Url } from "./Url"; + +/** + * Parameters that can be passed into `request(route, parameters)` or `endpoint(route, parameters)` methods + */ +export type RequestParameters = { + /** + * Base URL to be used when a relative URL is passed, such as `/orgs/:org`. + * If `baseUrl` is `https://enterprise.acme-inc.com/api/v3`, then the request + * will be sent to `https://enterprise.acme-inc.com/api/v3/orgs/:org`. + */ + baseUrl?: Url; + /** + * HTTP headers. Use lowercase keys. + */ + headers?: RequestHeaders; + /** + * Media type options, see {@link https://developer.github.com/v3/media/|GitHub Developer Guide} + */ + mediaType?: { + /** + * `json` by default. Can be `raw`, `text`, `html`, `full`, `diff`, `patch`, `sha`, `base64`. Depending on endpoint + */ + format?: string; + /** + * Custom media type names of {@link https://developer.github.com/v3/media/|API Previews} without the `-preview` suffix. + * Example for single preview: `['squirrel-girl']`. + * Example for multiple previews: `['squirrel-girl', 'mister-fantastic']`. + */ + previews?: string[]; + }; + /** + * Pass custom meta information for the request. The `request` object will be returned as is. + */ + request?: RequestRequestOptions; + /** + * Any additional parameter will be passed as follows + * 1. URL parameter if `':parameter'` or `{parameter}` is part of `url` + * 2. Query parameter if `method` is `'GET'` or `'HEAD'` + * 3. Request body if `parameter` is `'data'` + * 4. JSON in the request body in the form of `body[parameter]` unless `parameter` key is `'data'` + */ + [parameter: string]: any; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestRequestOptions.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestRequestOptions.ts new file mode 100644 index 00000000..028d6f72 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/RequestRequestOptions.ts @@ -0,0 +1,27 @@ +import { Agent } from "http"; +import { Fetch } from "./Fetch"; +import { Signal } from "./Signal"; + +/** + * Octokit-specific request options which are ignored for the actual request, but can be used by Octokit or plugins to manipulate how the request is sent or how a response is handled + */ +export type RequestRequestOptions = { + /** + * Node only. Useful for custom proxy, certificate, or dns lookup. + */ + agent?: Agent; + /** + * Custom replacement for built-in fetch method. Useful for testing or request hooks. + */ + fetch?: Fetch; + /** + * Use an `AbortController` instance to cancel a request. In node you can only cancel streamed requests. + */ + signal?: Signal; + /** + * Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). `options.request.signal` is recommended instead. + */ + timeout?: number; + + [option: string]: any; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/ResponseHeaders.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/ResponseHeaders.ts new file mode 100644 index 00000000..17267b60 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/ResponseHeaders.ts @@ -0,0 +1,21 @@ +export type ResponseHeaders = { + "cache-control"?: string; + "content-length"?: number; + "content-type"?: string; + date?: string; + etag?: string; + "last-modified"?: string; + link?: string; + location?: string; + server?: string; + status?: string; + vary?: string; + "x-github-mediatype"?: string; + "x-github-request-id"?: string; + "x-oauth-scopes"?: string; + "x-ratelimit-limit"?: string; + "x-ratelimit-remaining"?: string; + "x-ratelimit-reset"?: string; + + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Route.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Route.ts new file mode 100644 index 00000000..c5229a8b --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Route.ts @@ -0,0 +1,4 @@ +/** + * String consisting of an optional HTTP method and relative path or absolute URL. Examples: `'/orgs/:org'`, `'PUT /orgs/:org'`, `GET https://example.com/foo/bar` + */ +export type Route = string; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Signal.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Signal.ts new file mode 100644 index 00000000..bdf97001 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Signal.ts @@ -0,0 +1,6 @@ +/** + * Abort signal + * + * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal + */ +export type Signal = any; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/StrategyInterface.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/StrategyInterface.ts new file mode 100644 index 00000000..60a55add --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/StrategyInterface.ts @@ -0,0 +1,9 @@ +import { AuthInterface } from "./AuthInterface"; + +export interface StrategyInterface< + StrategyOptions extends any[], + AuthOptions extends any[], + Authentication extends object +> { + (...args: StrategyOptions): AuthInterface; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Url.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Url.ts new file mode 100644 index 00000000..9d228cbf --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/Url.ts @@ -0,0 +1,4 @@ +/** + * Relative or absolute URL. Examples: `'/orgs/:org'`, `https://example.com/foo/bar` + */ +export type Url = string; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/VERSION.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/VERSION.ts new file mode 100644 index 00000000..4652f248 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/VERSION.ts @@ -0,0 +1 @@ +export const VERSION = "2.0.1"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/generated/Endpoints.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/generated/Endpoints.ts new file mode 100644 index 00000000..3aec9145 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/generated/Endpoints.ts @@ -0,0 +1,14190 @@ +// DO NOT EDIT THIS FILE +import { RequestHeaders } from "../RequestHeaders"; +import { RequestRequestOptions } from "../RequestRequestOptions"; +import { Url } from "../Url"; + +export interface Endpoints { + "DELETE /app/installations/:installation_id": [ + AppsDeleteInstallationEndpoint, + AppsDeleteInstallationRequestOptions + ]; + "DELETE /applications/:client_id/grants/:access_token": [ + OauthAuthorizationsRevokeGrantForApplicationEndpoint, + OauthAuthorizationsRevokeGrantForApplicationRequestOptions + ]; + "DELETE /applications/:client_id/tokens/:access_token": [ + OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint, + OauthAuthorizationsRevokeAuthorizationForApplicationRequestOptions + ]; + "DELETE /applications/grants/:grant_id": [ + OauthAuthorizationsDeleteGrantEndpoint, + OauthAuthorizationsDeleteGrantRequestOptions + ]; + "DELETE /authorizations/:authorization_id": [ + OauthAuthorizationsDeleteAuthorizationEndpoint, + OauthAuthorizationsDeleteAuthorizationRequestOptions + ]; + "DELETE /gists/:gist_id": [GistsDeleteEndpoint, GistsDeleteRequestOptions]; + "DELETE /gists/:gist_id/comments/:comment_id": [ + GistsDeleteCommentEndpoint, + GistsDeleteCommentRequestOptions + ]; + "DELETE /gists/:gist_id/star": [ + GistsUnstarEndpoint, + GistsUnstarRequestOptions + ]; + "DELETE /notifications/threads/:thread_id/subscription": [ + ActivityDeleteThreadSubscriptionEndpoint, + ActivityDeleteThreadSubscriptionRequestOptions + ]; + "DELETE /orgs/:org/blocks/:username": [ + OrgsUnblockUserEndpoint, + OrgsUnblockUserRequestOptions + ]; + "DELETE /orgs/:org/credential-authorizations/:credential_id": [ + OrgsRemoveCredentialAuthorizationEndpoint, + OrgsRemoveCredentialAuthorizationRequestOptions + ]; + "DELETE /orgs/:org/hooks/:hook_id": [ + OrgsDeleteHookEndpoint, + OrgsDeleteHookRequestOptions + ]; + "DELETE /orgs/:org/interaction-limits": [ + InteractionsRemoveRestrictionsForOrgEndpoint, + InteractionsRemoveRestrictionsForOrgRequestOptions + ]; + "DELETE /orgs/:org/members/:username": [ + OrgsRemoveMemberEndpoint, + OrgsRemoveMemberRequestOptions + ]; + "DELETE /orgs/:org/memberships/:username": [ + OrgsRemoveMembershipEndpoint, + OrgsRemoveMembershipRequestOptions + ]; + "DELETE /orgs/:org/migrations/:migration_id/archive": [ + MigrationsDeleteArchiveForOrgEndpoint, + MigrationsDeleteArchiveForOrgRequestOptions + ]; + "DELETE /orgs/:org/migrations/:migration_id/repos/:repo_name/lock": [ + MigrationsUnlockRepoForOrgEndpoint, + MigrationsUnlockRepoForOrgRequestOptions + ]; + "DELETE /orgs/:org/outside_collaborators/:username": [ + OrgsRemoveOutsideCollaboratorEndpoint, + OrgsRemoveOutsideCollaboratorRequestOptions + ]; + "DELETE /orgs/:org/public_members/:username": [ + OrgsConcealMembershipEndpoint, + OrgsConcealMembershipRequestOptions + ]; + "DELETE /projects/:project_id": [ + ProjectsDeleteEndpoint, + ProjectsDeleteRequestOptions + ]; + "DELETE /projects/:project_id/collaborators/:username": [ + ProjectsRemoveCollaboratorEndpoint, + ProjectsRemoveCollaboratorRequestOptions + ]; + "DELETE /projects/columns/:column_id": [ + ProjectsDeleteColumnEndpoint, + ProjectsDeleteColumnRequestOptions + ]; + "DELETE /projects/columns/cards/:card_id": [ + ProjectsDeleteCardEndpoint, + ProjectsDeleteCardRequestOptions + ]; + "DELETE /reactions/:reaction_id": [ + ReactionsDeleteEndpoint, + ReactionsDeleteRequestOptions + ]; + "DELETE /repos/:owner/:repo": [ + ReposDeleteEndpoint, + ReposDeleteRequestOptions + ]; + "DELETE /repos/:owner/:repo/automated-security-fixes": [ + ReposDisableAutomatedSecurityFixesEndpoint, + ReposDisableAutomatedSecurityFixesRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection": [ + ReposRemoveBranchProtectionEndpoint, + ReposRemoveBranchProtectionRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ + ReposRemoveProtectedBranchAdminEnforcementEndpoint, + ReposRemoveProtectedBranchAdminEnforcementRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ + ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint, + ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ + ReposRemoveProtectedBranchRequiredSignaturesEndpoint, + ReposRemoveProtectedBranchRequiredSignaturesRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ + ReposRemoveProtectedBranchRequiredStatusChecksEndpoint, + ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ + ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint, + ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions": [ + ReposRemoveProtectedBranchRestrictionsEndpoint, + ReposRemoveProtectedBranchRestrictionsRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ + ReposRemoveProtectedBranchAppRestrictionsEndpoint, + ReposRemoveProtectedBranchAppRestrictionsRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ + ReposRemoveProtectedBranchTeamRestrictionsEndpoint, + ReposRemoveProtectedBranchTeamRestrictionsRequestOptions + ]; + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ + ReposRemoveProtectedBranchUserRestrictionsEndpoint, + ReposRemoveProtectedBranchUserRestrictionsRequestOptions + ]; + "DELETE /repos/:owner/:repo/collaborators/:username": [ + ReposRemoveCollaboratorEndpoint, + ReposRemoveCollaboratorRequestOptions + ]; + "DELETE /repos/:owner/:repo/comments/:comment_id": [ + ReposDeleteCommitCommentEndpoint, + ReposDeleteCommitCommentRequestOptions + ]; + "DELETE /repos/:owner/:repo/contents/:path": [ + ReposDeleteFileEndpoint, + ReposDeleteFileRequestOptions + ]; + "DELETE /repos/:owner/:repo/downloads/:download_id": [ + ReposDeleteDownloadEndpoint, + ReposDeleteDownloadRequestOptions + ]; + "DELETE /repos/:owner/:repo/git/refs/:ref": [ + GitDeleteRefEndpoint, + GitDeleteRefRequestOptions + ]; + "DELETE /repos/:owner/:repo/hooks/:hook_id": [ + ReposDeleteHookEndpoint, + ReposDeleteHookRequestOptions + ]; + "DELETE /repos/:owner/:repo/import": [ + MigrationsCancelImportEndpoint, + MigrationsCancelImportRequestOptions + ]; + "DELETE /repos/:owner/:repo/interaction-limits": [ + InteractionsRemoveRestrictionsForRepoEndpoint, + InteractionsRemoveRestrictionsForRepoRequestOptions + ]; + "DELETE /repos/:owner/:repo/invitations/:invitation_id": [ + ReposDeleteInvitationEndpoint, + ReposDeleteInvitationRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/:issue_number/assignees": [ + IssuesRemoveAssigneesEndpoint, + IssuesRemoveAssigneesRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/:issue_number/labels": [ + IssuesRemoveLabelsEndpoint, + IssuesRemoveLabelsRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name": [ + IssuesRemoveLabelEndpoint, + IssuesRemoveLabelRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/:issue_number/lock": [ + IssuesUnlockEndpoint, + IssuesUnlockRequestOptions + ]; + "DELETE /repos/:owner/:repo/issues/comments/:comment_id": [ + IssuesDeleteCommentEndpoint, + IssuesDeleteCommentRequestOptions + ]; + "DELETE /repos/:owner/:repo/keys/:key_id": [ + ReposRemoveDeployKeyEndpoint, + ReposRemoveDeployKeyRequestOptions + ]; + "DELETE /repos/:owner/:repo/labels/:name": [ + IssuesDeleteLabelEndpoint, + IssuesDeleteLabelRequestOptions + ]; + "DELETE /repos/:owner/:repo/milestones/:milestone_number": [ + IssuesDeleteMilestoneEndpoint, + IssuesDeleteMilestoneRequestOptions + ]; + "DELETE /repos/:owner/:repo/pages": [ + ReposDisablePagesSiteEndpoint, + ReposDisablePagesSiteRequestOptions + ]; + "DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ + PullsDeleteReviewRequestEndpoint, + PullsDeleteReviewRequestRequestOptions + ]; + "DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ + PullsDeletePendingReviewEndpoint, + PullsDeletePendingReviewRequestOptions + ]; + "DELETE /repos/:owner/:repo/pulls/comments/:comment_id": [ + PullsDeleteCommentEndpoint, + PullsDeleteCommentRequestOptions + ]; + "DELETE /repos/:owner/:repo/releases/:release_id": [ + ReposDeleteReleaseEndpoint, + ReposDeleteReleaseRequestOptions + ]; + "DELETE /repos/:owner/:repo/releases/assets/:asset_id": [ + ReposDeleteReleaseAssetEndpoint, + ReposDeleteReleaseAssetRequestOptions + ]; + "DELETE /repos/:owner/:repo/subscription": [ + ActivityDeleteRepoSubscriptionEndpoint, + ActivityDeleteRepoSubscriptionRequestOptions + ]; + "DELETE /repos/:owner/:repo/vulnerability-alerts": [ + ReposDisableVulnerabilityAlertsEndpoint, + ReposDisableVulnerabilityAlertsRequestOptions + ]; + "DELETE /scim/v2/organizations/:org/Users/:scim_user_id": [ + ScimRemoveUserFromOrgEndpoint, + ScimRemoveUserFromOrgRequestOptions + ]; + "DELETE /teams/:team_id": [TeamsDeleteEndpoint, TeamsDeleteRequestOptions]; + "DELETE /teams/:team_id/discussions/:discussion_number": [ + TeamsDeleteDiscussionEndpoint, + TeamsDeleteDiscussionRequestOptions + ]; + "DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ + TeamsDeleteDiscussionCommentEndpoint, + TeamsDeleteDiscussionCommentRequestOptions + ]; + "DELETE /teams/:team_id/members/:username": [ + TeamsRemoveMemberEndpoint, + TeamsRemoveMemberRequestOptions + ]; + "DELETE /teams/:team_id/memberships/:username": [ + TeamsRemoveMembershipEndpoint, + TeamsRemoveMembershipRequestOptions + ]; + "DELETE /teams/:team_id/projects/:project_id": [ + TeamsRemoveProjectEndpoint, + TeamsRemoveProjectRequestOptions + ]; + "DELETE /teams/:team_id/repos/:owner/:repo": [ + TeamsRemoveRepoEndpoint, + TeamsRemoveRepoRequestOptions + ]; + "DELETE /user/blocks/:username": [ + UsersUnblockEndpoint, + UsersUnblockRequestOptions + ]; + "DELETE /user/emails": [ + UsersDeleteEmailsEndpoint, + UsersDeleteEmailsRequestOptions + ]; + "DELETE /user/following/:username": [ + UsersUnfollowEndpoint, + UsersUnfollowRequestOptions + ]; + "DELETE /user/gpg_keys/:gpg_key_id": [ + UsersDeleteGpgKeyEndpoint, + UsersDeleteGpgKeyRequestOptions + ]; + "DELETE /user/installations/:installation_id/repositories/:repository_id": [ + AppsRemoveRepoFromInstallationEndpoint, + AppsRemoveRepoFromInstallationRequestOptions + ]; + "DELETE /user/keys/:key_id": [ + UsersDeletePublicKeyEndpoint, + UsersDeletePublicKeyRequestOptions + ]; + "DELETE /user/migrations/:migration_id/archive": [ + MigrationsDeleteArchiveForAuthenticatedUserEndpoint, + MigrationsDeleteArchiveForAuthenticatedUserRequestOptions + ]; + "DELETE /user/migrations/:migration_id/repos/:repo_name/lock": [ + MigrationsUnlockRepoForAuthenticatedUserEndpoint, + MigrationsUnlockRepoForAuthenticatedUserRequestOptions + ]; + "DELETE /user/repository_invitations/:invitation_id": [ + ReposDeclineInvitationEndpoint, + ReposDeclineInvitationRequestOptions + ]; + "DELETE /user/starred/:owner/:repo": [ + ActivityUnstarRepoEndpoint, + ActivityUnstarRepoRequestOptions + ]; + "DELETE /user/subscriptions/:owner/:repo": [ + ActivityStopWatchingRepoLegacyEndpoint, + ActivityStopWatchingRepoLegacyRequestOptions + ]; + "GET /app": [ + AppsGetAuthenticatedEndpoint, + AppsGetAuthenticatedRequestOptions + ]; + "GET /app/installations": [ + AppsListInstallationsEndpoint, + AppsListInstallationsRequestOptions + ]; + "GET /app/installations/:installation_id": [ + AppsGetInstallationEndpoint, + AppsGetInstallationRequestOptions + ]; + "GET /applications/:client_id/tokens/:access_token": [ + OauthAuthorizationsCheckAuthorizationEndpoint, + OauthAuthorizationsCheckAuthorizationRequestOptions + ]; + "GET /applications/grants": [ + OauthAuthorizationsListGrantsEndpoint, + OauthAuthorizationsListGrantsRequestOptions + ]; + "GET /applications/grants/:grant_id": [ + OauthAuthorizationsGetGrantEndpoint, + OauthAuthorizationsGetGrantRequestOptions + ]; + "GET /apps/:app_slug": [AppsGetBySlugEndpoint, AppsGetBySlugRequestOptions]; + "GET /authorizations": [ + OauthAuthorizationsListAuthorizationsEndpoint, + OauthAuthorizationsListAuthorizationsRequestOptions + ]; + "GET /authorizations/:authorization_id": [ + OauthAuthorizationsGetAuthorizationEndpoint, + OauthAuthorizationsGetAuthorizationRequestOptions + ]; + "GET /codes_of_conduct": [ + CodesOfConductListConductCodesEndpoint, + CodesOfConductListConductCodesRequestOptions + ]; + "GET /codes_of_conduct/:key": [ + CodesOfConductGetConductCodeEndpoint, + CodesOfConductGetConductCodeRequestOptions + ]; + "GET /emojis": [EmojisGetEndpoint, EmojisGetRequestOptions]; + "GET /events": [ + ActivityListPublicEventsEndpoint, + ActivityListPublicEventsRequestOptions + ]; + "GET /feeds": [ActivityListFeedsEndpoint, ActivityListFeedsRequestOptions]; + "GET /gists": [GistsListEndpoint, GistsListRequestOptions]; + "GET /gists/:gist_id": [GistsGetEndpoint, GistsGetRequestOptions]; + "GET /gists/:gist_id/:sha": [ + GistsGetRevisionEndpoint, + GistsGetRevisionRequestOptions + ]; + "GET /gists/:gist_id/comments": [ + GistsListCommentsEndpoint, + GistsListCommentsRequestOptions + ]; + "GET /gists/:gist_id/comments/:comment_id": [ + GistsGetCommentEndpoint, + GistsGetCommentRequestOptions + ]; + "GET /gists/:gist_id/commits": [ + GistsListCommitsEndpoint, + GistsListCommitsRequestOptions + ]; + "GET /gists/:gist_id/forks": [ + GistsListForksEndpoint, + GistsListForksRequestOptions + ]; + "GET /gists/:gist_id/star": [ + GistsCheckIsStarredEndpoint, + GistsCheckIsStarredRequestOptions + ]; + "GET /gists/public": [GistsListPublicEndpoint, GistsListPublicRequestOptions]; + "GET /gists/starred": [ + GistsListStarredEndpoint, + GistsListStarredRequestOptions + ]; + "GET /gitignore/templates": [ + GitignoreListTemplatesEndpoint, + GitignoreListTemplatesRequestOptions + ]; + "GET /gitignore/templates/:name": [ + GitignoreGetTemplateEndpoint, + GitignoreGetTemplateRequestOptions + ]; + "GET /installation/repositories": [ + AppsListReposEndpoint, + AppsListReposRequestOptions + ]; + "GET /issues": [IssuesListEndpoint, IssuesListRequestOptions]; + "GET /legacy/issues/search/:owner/:repository/:state/:keyword": [ + SearchIssuesLegacyEndpoint, + SearchIssuesLegacyRequestOptions + ]; + "GET /legacy/repos/search/:keyword": [ + SearchReposLegacyEndpoint, + SearchReposLegacyRequestOptions + ]; + "GET /legacy/user/email/:email": [ + SearchEmailLegacyEndpoint, + SearchEmailLegacyRequestOptions + ]; + "GET /legacy/user/search/:keyword": [ + SearchUsersLegacyEndpoint, + SearchUsersLegacyRequestOptions + ]; + "GET /licenses": [ + LicensesListCommonlyUsedEndpoint | LicensesListEndpoint, + LicensesListCommonlyUsedRequestOptions | LicensesListRequestOptions + ]; + "GET /licenses/:license": [LicensesGetEndpoint, LicensesGetRequestOptions]; + "GET /marketplace_listing/accounts/:account_id": [ + AppsCheckAccountIsAssociatedWithAnyEndpoint, + AppsCheckAccountIsAssociatedWithAnyRequestOptions + ]; + "GET /marketplace_listing/plans": [ + AppsListPlansEndpoint, + AppsListPlansRequestOptions + ]; + "GET /marketplace_listing/plans/:plan_id/accounts": [ + AppsListAccountsUserOrOrgOnPlanEndpoint, + AppsListAccountsUserOrOrgOnPlanRequestOptions + ]; + "GET /marketplace_listing/stubbed/accounts/:account_id": [ + AppsCheckAccountIsAssociatedWithAnyStubbedEndpoint, + AppsCheckAccountIsAssociatedWithAnyStubbedRequestOptions + ]; + "GET /marketplace_listing/stubbed/plans": [ + AppsListPlansStubbedEndpoint, + AppsListPlansStubbedRequestOptions + ]; + "GET /marketplace_listing/stubbed/plans/:plan_id/accounts": [ + AppsListAccountsUserOrOrgOnPlanStubbedEndpoint, + AppsListAccountsUserOrOrgOnPlanStubbedRequestOptions + ]; + "GET /meta": [MetaGetEndpoint, MetaGetRequestOptions]; + "GET /networks/:owner/:repo/events": [ + ActivityListPublicEventsForRepoNetworkEndpoint, + ActivityListPublicEventsForRepoNetworkRequestOptions + ]; + "GET /notifications": [ + ActivityListNotificationsEndpoint, + ActivityListNotificationsRequestOptions + ]; + "GET /notifications/threads/:thread_id": [ + ActivityGetThreadEndpoint, + ActivityGetThreadRequestOptions + ]; + "GET /notifications/threads/:thread_id/subscription": [ + ActivityGetThreadSubscriptionEndpoint, + ActivityGetThreadSubscriptionRequestOptions + ]; + "GET /organizations": [OrgsListEndpoint, OrgsListRequestOptions]; + "GET /orgs/:org": [OrgsGetEndpoint, OrgsGetRequestOptions]; + "GET /orgs/:org/blocks": [ + OrgsListBlockedUsersEndpoint, + OrgsListBlockedUsersRequestOptions + ]; + "GET /orgs/:org/blocks/:username": [ + OrgsCheckBlockedUserEndpoint, + OrgsCheckBlockedUserRequestOptions + ]; + "GET /orgs/:org/credential-authorizations": [ + OrgsListCredentialAuthorizationsEndpoint, + OrgsListCredentialAuthorizationsRequestOptions + ]; + "GET /orgs/:org/events": [ + ActivityListPublicEventsForOrgEndpoint, + ActivityListPublicEventsForOrgRequestOptions + ]; + "GET /orgs/:org/hooks": [OrgsListHooksEndpoint, OrgsListHooksRequestOptions]; + "GET /orgs/:org/hooks/:hook_id": [ + OrgsGetHookEndpoint, + OrgsGetHookRequestOptions + ]; + "GET /orgs/:org/installation": [ + AppsGetOrgInstallationEndpoint | AppsFindOrgInstallationEndpoint, + AppsGetOrgInstallationRequestOptions | AppsFindOrgInstallationRequestOptions + ]; + "GET /orgs/:org/interaction-limits": [ + InteractionsGetRestrictionsForOrgEndpoint, + InteractionsGetRestrictionsForOrgRequestOptions + ]; + "GET /orgs/:org/invitations": [ + OrgsListPendingInvitationsEndpoint, + OrgsListPendingInvitationsRequestOptions + ]; + "GET /orgs/:org/invitations/:invitation_id/teams": [ + OrgsListInvitationTeamsEndpoint, + OrgsListInvitationTeamsRequestOptions + ]; + "GET /orgs/:org/issues": [ + IssuesListForOrgEndpoint, + IssuesListForOrgRequestOptions + ]; + "GET /orgs/:org/members": [ + OrgsListMembersEndpoint, + OrgsListMembersRequestOptions + ]; + "GET /orgs/:org/members/:username": [ + OrgsCheckMembershipEndpoint, + OrgsCheckMembershipRequestOptions + ]; + "GET /orgs/:org/memberships/:username": [ + OrgsGetMembershipEndpoint, + OrgsGetMembershipRequestOptions + ]; + "GET /orgs/:org/migrations": [ + MigrationsListForOrgEndpoint, + MigrationsListForOrgRequestOptions + ]; + "GET /orgs/:org/migrations/:migration_id": [ + MigrationsGetStatusForOrgEndpoint, + MigrationsGetStatusForOrgRequestOptions + ]; + "GET /orgs/:org/migrations/:migration_id/archive": [ + MigrationsGetArchiveForOrgEndpoint, + MigrationsGetArchiveForOrgRequestOptions + ]; + "GET /orgs/:org/outside_collaborators": [ + OrgsListOutsideCollaboratorsEndpoint, + OrgsListOutsideCollaboratorsRequestOptions + ]; + "GET /orgs/:org/projects": [ + ProjectsListForOrgEndpoint, + ProjectsListForOrgRequestOptions + ]; + "GET /orgs/:org/public_members": [ + OrgsListPublicMembersEndpoint, + OrgsListPublicMembersRequestOptions + ]; + "GET /orgs/:org/public_members/:username": [ + OrgsCheckPublicMembershipEndpoint, + OrgsCheckPublicMembershipRequestOptions + ]; + "GET /orgs/:org/repos": [ + ReposListForOrgEndpoint, + ReposListForOrgRequestOptions + ]; + "GET /orgs/:org/team-sync/groups": [ + TeamsListIdPGroupsForOrgEndpoint, + TeamsListIdPGroupsForOrgRequestOptions + ]; + "GET /orgs/:org/teams": [TeamsListEndpoint, TeamsListRequestOptions]; + "GET /orgs/:org/teams/:team_slug": [ + TeamsGetByNameEndpoint, + TeamsGetByNameRequestOptions + ]; + "GET /projects/:project_id": [ProjectsGetEndpoint, ProjectsGetRequestOptions]; + "GET /projects/:project_id/collaborators": [ + ProjectsListCollaboratorsEndpoint, + ProjectsListCollaboratorsRequestOptions + ]; + "GET /projects/:project_id/collaborators/:username/permission": [ + ProjectsReviewUserPermissionLevelEndpoint, + ProjectsReviewUserPermissionLevelRequestOptions + ]; + "GET /projects/:project_id/columns": [ + ProjectsListColumnsEndpoint, + ProjectsListColumnsRequestOptions + ]; + "GET /projects/columns/:column_id": [ + ProjectsGetColumnEndpoint, + ProjectsGetColumnRequestOptions + ]; + "GET /projects/columns/:column_id/cards": [ + ProjectsListCardsEndpoint, + ProjectsListCardsRequestOptions + ]; + "GET /projects/columns/cards/:card_id": [ + ProjectsGetCardEndpoint, + ProjectsGetCardRequestOptions + ]; + "GET /rate_limit": [RateLimitGetEndpoint, RateLimitGetRequestOptions]; + "GET /repos/:owner/:repo": [ReposGetEndpoint, ReposGetRequestOptions]; + "GET /repos/:owner/:repo/:archive_format/:ref": [ + ReposGetArchiveLinkEndpoint, + ReposGetArchiveLinkRequestOptions + ]; + "GET /repos/:owner/:repo/assignees": [ + IssuesListAssigneesEndpoint, + IssuesListAssigneesRequestOptions + ]; + "GET /repos/:owner/:repo/assignees/:assignee": [ + IssuesCheckAssigneeEndpoint, + IssuesCheckAssigneeRequestOptions + ]; + "GET /repos/:owner/:repo/branches": [ + ReposListBranchesEndpoint, + ReposListBranchesRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch": [ + ReposGetBranchEndpoint, + ReposGetBranchRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection": [ + ReposGetBranchProtectionEndpoint, + ReposGetBranchProtectionRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ + ReposGetProtectedBranchAdminEnforcementEndpoint, + ReposGetProtectedBranchAdminEnforcementRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ + ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint, + ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ + ReposGetProtectedBranchRequiredSignaturesEndpoint, + ReposGetProtectedBranchRequiredSignaturesRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ + ReposGetProtectedBranchRequiredStatusChecksEndpoint, + ReposGetProtectedBranchRequiredStatusChecksRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ + ReposListProtectedBranchRequiredStatusChecksContextsEndpoint, + ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions": [ + ReposGetProtectedBranchRestrictionsEndpoint, + ReposGetProtectedBranchRestrictionsRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ + + | ReposGetAppsWithAccessToProtectedBranchEndpoint + | ReposListAppsWithAccessToProtectedBranchEndpoint, + + | ReposGetAppsWithAccessToProtectedBranchRequestOptions + | ReposListAppsWithAccessToProtectedBranchRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ + + | ReposGetTeamsWithAccessToProtectedBranchEndpoint + | ReposListProtectedBranchTeamRestrictionsEndpoint + | ReposListTeamsWithAccessToProtectedBranchEndpoint, + + | ReposGetTeamsWithAccessToProtectedBranchRequestOptions + | ReposListProtectedBranchTeamRestrictionsRequestOptions + | ReposListTeamsWithAccessToProtectedBranchRequestOptions + ]; + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ + + | ReposGetUsersWithAccessToProtectedBranchEndpoint + | ReposListProtectedBranchUserRestrictionsEndpoint + | ReposListUsersWithAccessToProtectedBranchEndpoint, + + | ReposGetUsersWithAccessToProtectedBranchRequestOptions + | ReposListProtectedBranchUserRestrictionsRequestOptions + | ReposListUsersWithAccessToProtectedBranchRequestOptions + ]; + "GET /repos/:owner/:repo/check-runs/:check_run_id": [ + ChecksGetEndpoint, + ChecksGetRequestOptions + ]; + "GET /repos/:owner/:repo/check-runs/:check_run_id/annotations": [ + ChecksListAnnotationsEndpoint, + ChecksListAnnotationsRequestOptions + ]; + "GET /repos/:owner/:repo/check-suites/:check_suite_id": [ + ChecksGetSuiteEndpoint, + ChecksGetSuiteRequestOptions + ]; + "GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs": [ + ChecksListForSuiteEndpoint, + ChecksListForSuiteRequestOptions + ]; + "GET /repos/:owner/:repo/collaborators": [ + ReposListCollaboratorsEndpoint, + ReposListCollaboratorsRequestOptions + ]; + "GET /repos/:owner/:repo/collaborators/:username": [ + ReposCheckCollaboratorEndpoint, + ReposCheckCollaboratorRequestOptions + ]; + "GET /repos/:owner/:repo/collaborators/:username/permission": [ + ReposGetCollaboratorPermissionLevelEndpoint, + ReposGetCollaboratorPermissionLevelRequestOptions + ]; + "GET /repos/:owner/:repo/comments": [ + ReposListCommitCommentsEndpoint, + ReposListCommitCommentsRequestOptions + ]; + "GET /repos/:owner/:repo/comments/:comment_id": [ + ReposGetCommitCommentEndpoint, + ReposGetCommitCommentRequestOptions + ]; + "GET /repos/:owner/:repo/comments/:comment_id/reactions": [ + ReactionsListForCommitCommentEndpoint, + ReactionsListForCommitCommentRequestOptions + ]; + "GET /repos/:owner/:repo/commits": [ + ReposListCommitsEndpoint, + ReposListCommitsRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:commit_sha/branches-where-head": [ + ReposListBranchesForHeadCommitEndpoint, + ReposListBranchesForHeadCommitRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:commit_sha/comments": [ + ReposListCommentsForCommitEndpoint, + ReposListCommentsForCommitRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:commit_sha/pulls": [ + ReposListPullRequestsAssociatedWithCommitEndpoint, + ReposListPullRequestsAssociatedWithCommitRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref": [ + ReposGetCommitEndpoint, + ReposGetCommitRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref/check-runs": [ + ChecksListForRefEndpoint, + ChecksListForRefRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref/check-suites": [ + ChecksListSuitesForRefEndpoint, + ChecksListSuitesForRefRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref/status": [ + ReposGetCombinedStatusForRefEndpoint, + ReposGetCombinedStatusForRefRequestOptions + ]; + "GET /repos/:owner/:repo/commits/:ref/statuses": [ + ReposListStatusesForRefEndpoint, + ReposListStatusesForRefRequestOptions + ]; + "GET /repos/:owner/:repo/community/code_of_conduct": [ + CodesOfConductGetForRepoEndpoint, + CodesOfConductGetForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/community/profile": [ + ReposRetrieveCommunityProfileMetricsEndpoint, + ReposRetrieveCommunityProfileMetricsRequestOptions + ]; + "GET /repos/:owner/:repo/compare/:base...:head": [ + ReposCompareCommitsEndpoint, + ReposCompareCommitsRequestOptions + ]; + "GET /repos/:owner/:repo/contents/:path": [ + ReposGetContentsEndpoint, + ReposGetContentsRequestOptions + ]; + "GET /repos/:owner/:repo/contributors": [ + ReposListContributorsEndpoint, + ReposListContributorsRequestOptions + ]; + "GET /repos/:owner/:repo/deployments": [ + ReposListDeploymentsEndpoint, + ReposListDeploymentsRequestOptions + ]; + "GET /repos/:owner/:repo/deployments/:deployment_id": [ + ReposGetDeploymentEndpoint, + ReposGetDeploymentRequestOptions + ]; + "GET /repos/:owner/:repo/deployments/:deployment_id/statuses": [ + ReposListDeploymentStatusesEndpoint, + ReposListDeploymentStatusesRequestOptions + ]; + "GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id": [ + ReposGetDeploymentStatusEndpoint, + ReposGetDeploymentStatusRequestOptions + ]; + "GET /repos/:owner/:repo/downloads": [ + ReposListDownloadsEndpoint, + ReposListDownloadsRequestOptions + ]; + "GET /repos/:owner/:repo/downloads/:download_id": [ + ReposGetDownloadEndpoint, + ReposGetDownloadRequestOptions + ]; + "GET /repos/:owner/:repo/events": [ + ActivityListRepoEventsEndpoint, + ActivityListRepoEventsRequestOptions + ]; + "GET /repos/:owner/:repo/forks": [ + ReposListForksEndpoint, + ReposListForksRequestOptions + ]; + "GET /repos/:owner/:repo/git/blobs/:file_sha": [ + GitGetBlobEndpoint, + GitGetBlobRequestOptions + ]; + "GET /repos/:owner/:repo/git/commits/:commit_sha": [ + GitGetCommitEndpoint, + GitGetCommitRequestOptions + ]; + "GET /repos/:owner/:repo/git/matching-refs/:ref": [ + GitListMatchingRefsEndpoint, + GitListMatchingRefsRequestOptions + ]; + "GET /repos/:owner/:repo/git/ref/:ref": [ + GitGetRefEndpoint, + GitGetRefRequestOptions + ]; + "GET /repos/:owner/:repo/git/tags/:tag_sha": [ + GitGetTagEndpoint, + GitGetTagRequestOptions + ]; + "GET /repos/:owner/:repo/git/trees/:tree_sha": [ + GitGetTreeEndpoint, + GitGetTreeRequestOptions + ]; + "GET /repos/:owner/:repo/hooks": [ + ReposListHooksEndpoint, + ReposListHooksRequestOptions + ]; + "GET /repos/:owner/:repo/hooks/:hook_id": [ + ReposGetHookEndpoint, + ReposGetHookRequestOptions + ]; + "GET /repos/:owner/:repo/import": [ + MigrationsGetImportProgressEndpoint, + MigrationsGetImportProgressRequestOptions + ]; + "GET /repos/:owner/:repo/import/authors": [ + MigrationsGetCommitAuthorsEndpoint, + MigrationsGetCommitAuthorsRequestOptions + ]; + "GET /repos/:owner/:repo/import/large_files": [ + MigrationsGetLargeFilesEndpoint, + MigrationsGetLargeFilesRequestOptions + ]; + "GET /repos/:owner/:repo/installation": [ + AppsGetRepoInstallationEndpoint | AppsFindRepoInstallationEndpoint, + + | AppsGetRepoInstallationRequestOptions + | AppsFindRepoInstallationRequestOptions + ]; + "GET /repos/:owner/:repo/interaction-limits": [ + InteractionsGetRestrictionsForRepoEndpoint, + InteractionsGetRestrictionsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/invitations": [ + ReposListInvitationsEndpoint, + ReposListInvitationsRequestOptions + ]; + "GET /repos/:owner/:repo/issues": [ + IssuesListForRepoEndpoint, + IssuesListForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number": [ + IssuesGetEndpoint, + IssuesGetRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/comments": [ + IssuesListCommentsEndpoint, + IssuesListCommentsRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/events": [ + IssuesListEventsEndpoint, + IssuesListEventsRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/labels": [ + IssuesListLabelsOnIssueEndpoint, + IssuesListLabelsOnIssueRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/reactions": [ + ReactionsListForIssueEndpoint, + ReactionsListForIssueRequestOptions + ]; + "GET /repos/:owner/:repo/issues/:issue_number/timeline": [ + IssuesListEventsForTimelineEndpoint, + IssuesListEventsForTimelineRequestOptions + ]; + "GET /repos/:owner/:repo/issues/comments": [ + IssuesListCommentsForRepoEndpoint, + IssuesListCommentsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/issues/comments/:comment_id": [ + IssuesGetCommentEndpoint, + IssuesGetCommentRequestOptions + ]; + "GET /repos/:owner/:repo/issues/comments/:comment_id/reactions": [ + ReactionsListForIssueCommentEndpoint, + ReactionsListForIssueCommentRequestOptions + ]; + "GET /repos/:owner/:repo/issues/events": [ + IssuesListEventsForRepoEndpoint, + IssuesListEventsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/issues/events/:event_id": [ + IssuesGetEventEndpoint, + IssuesGetEventRequestOptions + ]; + "GET /repos/:owner/:repo/keys": [ + ReposListDeployKeysEndpoint, + ReposListDeployKeysRequestOptions + ]; + "GET /repos/:owner/:repo/keys/:key_id": [ + ReposGetDeployKeyEndpoint, + ReposGetDeployKeyRequestOptions + ]; + "GET /repos/:owner/:repo/labels": [ + IssuesListLabelsForRepoEndpoint, + IssuesListLabelsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/labels/:name": [ + IssuesGetLabelEndpoint, + IssuesGetLabelRequestOptions + ]; + "GET /repos/:owner/:repo/languages": [ + ReposListLanguagesEndpoint, + ReposListLanguagesRequestOptions + ]; + "GET /repos/:owner/:repo/license": [ + LicensesGetForRepoEndpoint, + LicensesGetForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/milestones": [ + IssuesListMilestonesForRepoEndpoint, + IssuesListMilestonesForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/milestones/:milestone_number": [ + IssuesGetMilestoneEndpoint, + IssuesGetMilestoneRequestOptions + ]; + "GET /repos/:owner/:repo/milestones/:milestone_number/labels": [ + IssuesListLabelsForMilestoneEndpoint, + IssuesListLabelsForMilestoneRequestOptions + ]; + "GET /repos/:owner/:repo/notifications": [ + ActivityListNotificationsForRepoEndpoint, + ActivityListNotificationsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/pages": [ + ReposGetPagesEndpoint, + ReposGetPagesRequestOptions + ]; + "GET /repos/:owner/:repo/pages/builds": [ + ReposListPagesBuildsEndpoint, + ReposListPagesBuildsRequestOptions + ]; + "GET /repos/:owner/:repo/pages/builds/:build_id": [ + ReposGetPagesBuildEndpoint, + ReposGetPagesBuildRequestOptions + ]; + "GET /repos/:owner/:repo/pages/builds/latest": [ + ReposGetLatestPagesBuildEndpoint, + ReposGetLatestPagesBuildRequestOptions + ]; + "GET /repos/:owner/:repo/projects": [ + ProjectsListForRepoEndpoint, + ProjectsListForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/pulls": [PullsListEndpoint, PullsListRequestOptions]; + "GET /repos/:owner/:repo/pulls/:pull_number": [ + PullsGetEndpoint, + PullsGetRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/comments": [ + PullsListCommentsEndpoint, + PullsListCommentsRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/commits": [ + PullsListCommitsEndpoint, + PullsListCommitsRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/files": [ + PullsListFilesEndpoint, + PullsListFilesRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/merge": [ + PullsCheckIfMergedEndpoint, + PullsCheckIfMergedRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ + PullsListReviewRequestsEndpoint, + PullsListReviewRequestsRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/reviews": [ + PullsListReviewsEndpoint, + PullsListReviewsRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ + PullsGetReviewEndpoint, + PullsGetReviewRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments": [ + PullsGetCommentsForReviewEndpoint, + PullsGetCommentsForReviewRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/comments": [ + PullsListCommentsForRepoEndpoint, + PullsListCommentsForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/comments/:comment_id": [ + PullsGetCommentEndpoint, + PullsGetCommentRequestOptions + ]; + "GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions": [ + ReactionsListForPullRequestReviewCommentEndpoint, + ReactionsListForPullRequestReviewCommentRequestOptions + ]; + "GET /repos/:owner/:repo/readme": [ + ReposGetReadmeEndpoint, + ReposGetReadmeRequestOptions + ]; + "GET /repos/:owner/:repo/releases": [ + ReposListReleasesEndpoint, + ReposListReleasesRequestOptions + ]; + "GET /repos/:owner/:repo/releases/:release_id": [ + ReposGetReleaseEndpoint, + ReposGetReleaseRequestOptions + ]; + "GET /repos/:owner/:repo/releases/:release_id/assets": [ + ReposListAssetsForReleaseEndpoint, + ReposListAssetsForReleaseRequestOptions + ]; + "GET /repos/:owner/:repo/releases/assets/:asset_id": [ + ReposGetReleaseAssetEndpoint, + ReposGetReleaseAssetRequestOptions + ]; + "GET /repos/:owner/:repo/releases/latest": [ + ReposGetLatestReleaseEndpoint, + ReposGetLatestReleaseRequestOptions + ]; + "GET /repos/:owner/:repo/releases/tags/:tag": [ + ReposGetReleaseByTagEndpoint, + ReposGetReleaseByTagRequestOptions + ]; + "GET /repos/:owner/:repo/stargazers": [ + ActivityListStargazersForRepoEndpoint, + ActivityListStargazersForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/stats/code_frequency": [ + ReposGetCodeFrequencyStatsEndpoint, + ReposGetCodeFrequencyStatsRequestOptions + ]; + "GET /repos/:owner/:repo/stats/commit_activity": [ + ReposGetCommitActivityStatsEndpoint, + ReposGetCommitActivityStatsRequestOptions + ]; + "GET /repos/:owner/:repo/stats/contributors": [ + ReposGetContributorsStatsEndpoint, + ReposGetContributorsStatsRequestOptions + ]; + "GET /repos/:owner/:repo/stats/participation": [ + ReposGetParticipationStatsEndpoint, + ReposGetParticipationStatsRequestOptions + ]; + "GET /repos/:owner/:repo/stats/punch_card": [ + ReposGetPunchCardStatsEndpoint, + ReposGetPunchCardStatsRequestOptions + ]; + "GET /repos/:owner/:repo/subscribers": [ + ActivityListWatchersForRepoEndpoint, + ActivityListWatchersForRepoRequestOptions + ]; + "GET /repos/:owner/:repo/subscription": [ + ActivityGetRepoSubscriptionEndpoint, + ActivityGetRepoSubscriptionRequestOptions + ]; + "GET /repos/:owner/:repo/tags": [ + ReposListTagsEndpoint, + ReposListTagsRequestOptions + ]; + "GET /repos/:owner/:repo/teams": [ + ReposListTeamsEndpoint, + ReposListTeamsRequestOptions + ]; + "GET /repos/:owner/:repo/topics": [ + ReposListTopicsEndpoint, + ReposListTopicsRequestOptions + ]; + "GET /repos/:owner/:repo/traffic/clones": [ + ReposGetClonesEndpoint, + ReposGetClonesRequestOptions + ]; + "GET /repos/:owner/:repo/traffic/popular/paths": [ + ReposGetTopPathsEndpoint, + ReposGetTopPathsRequestOptions + ]; + "GET /repos/:owner/:repo/traffic/popular/referrers": [ + ReposGetTopReferrersEndpoint, + ReposGetTopReferrersRequestOptions + ]; + "GET /repos/:owner/:repo/traffic/views": [ + ReposGetViewsEndpoint, + ReposGetViewsRequestOptions + ]; + "GET /repos/:owner/:repo/vulnerability-alerts": [ + ReposCheckVulnerabilityAlertsEndpoint, + ReposCheckVulnerabilityAlertsRequestOptions + ]; + "GET /repositories": [ReposListPublicEndpoint, ReposListPublicRequestOptions]; + "GET /scim/v2/organizations/:org/Users": [ + ScimListProvisionedIdentitiesEndpoint, + ScimListProvisionedIdentitiesRequestOptions + ]; + "GET /scim/v2/organizations/:org/Users/:scim_user_id": [ + ScimGetProvisioningDetailsForUserEndpoint, + ScimGetProvisioningDetailsForUserRequestOptions + ]; + "GET /search/code": [SearchCodeEndpoint, SearchCodeRequestOptions]; + "GET /search/commits": [SearchCommitsEndpoint, SearchCommitsRequestOptions]; + "GET /search/issues": [ + SearchIssuesAndPullRequestsEndpoint | SearchIssuesEndpoint, + SearchIssuesAndPullRequestsRequestOptions | SearchIssuesRequestOptions + ]; + "GET /search/labels": [SearchLabelsEndpoint, SearchLabelsRequestOptions]; + "GET /search/repositories": [SearchReposEndpoint, SearchReposRequestOptions]; + "GET /search/topics": [SearchTopicsEndpoint, SearchTopicsRequestOptions]; + "GET /search/users": [SearchUsersEndpoint, SearchUsersRequestOptions]; + "GET /teams/:team_id": [TeamsGetEndpoint, TeamsGetRequestOptions]; + "GET /teams/:team_id/discussions": [ + TeamsListDiscussionsEndpoint, + TeamsListDiscussionsRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number": [ + TeamsGetDiscussionEndpoint, + TeamsGetDiscussionRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number/comments": [ + TeamsListDiscussionCommentsEndpoint, + TeamsListDiscussionCommentsRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ + TeamsGetDiscussionCommentEndpoint, + TeamsGetDiscussionCommentRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": [ + ReactionsListForTeamDiscussionCommentEndpoint, + ReactionsListForTeamDiscussionCommentRequestOptions + ]; + "GET /teams/:team_id/discussions/:discussion_number/reactions": [ + ReactionsListForTeamDiscussionEndpoint, + ReactionsListForTeamDiscussionRequestOptions + ]; + "GET /teams/:team_id/invitations": [ + TeamsListPendingInvitationsEndpoint, + TeamsListPendingInvitationsRequestOptions + ]; + "GET /teams/:team_id/members": [ + TeamsListMembersEndpoint, + TeamsListMembersRequestOptions + ]; + "GET /teams/:team_id/members/:username": [ + TeamsGetMemberEndpoint, + TeamsGetMemberRequestOptions + ]; + "GET /teams/:team_id/memberships/:username": [ + TeamsGetMembershipEndpoint, + TeamsGetMembershipRequestOptions + ]; + "GET /teams/:team_id/projects": [ + TeamsListProjectsEndpoint, + TeamsListProjectsRequestOptions + ]; + "GET /teams/:team_id/projects/:project_id": [ + TeamsReviewProjectEndpoint, + TeamsReviewProjectRequestOptions + ]; + "GET /teams/:team_id/repos": [ + TeamsListReposEndpoint, + TeamsListReposRequestOptions + ]; + "GET /teams/:team_id/repos/:owner/:repo": [ + TeamsCheckManagesRepoEndpoint, + TeamsCheckManagesRepoRequestOptions + ]; + "GET /teams/:team_id/team-sync/group-mappings": [ + TeamsListIdPGroupsEndpoint, + TeamsListIdPGroupsRequestOptions + ]; + "GET /teams/:team_id/teams": [ + TeamsListChildEndpoint, + TeamsListChildRequestOptions + ]; + "GET /user": [ + UsersGetAuthenticatedEndpoint, + UsersGetAuthenticatedRequestOptions + ]; + "GET /user/blocks": [ + UsersListBlockedEndpoint, + UsersListBlockedRequestOptions + ]; + "GET /user/blocks/:username": [ + UsersCheckBlockedEndpoint, + UsersCheckBlockedRequestOptions + ]; + "GET /user/emails": [UsersListEmailsEndpoint, UsersListEmailsRequestOptions]; + "GET /user/followers": [ + UsersListFollowersForAuthenticatedUserEndpoint, + UsersListFollowersForAuthenticatedUserRequestOptions + ]; + "GET /user/following": [ + UsersListFollowingForAuthenticatedUserEndpoint, + UsersListFollowingForAuthenticatedUserRequestOptions + ]; + "GET /user/following/:username": [ + UsersCheckFollowingEndpoint, + UsersCheckFollowingRequestOptions + ]; + "GET /user/gpg_keys": [ + UsersListGpgKeysEndpoint, + UsersListGpgKeysRequestOptions + ]; + "GET /user/gpg_keys/:gpg_key_id": [ + UsersGetGpgKeyEndpoint, + UsersGetGpgKeyRequestOptions + ]; + "GET /user/installations": [ + AppsListInstallationsForAuthenticatedUserEndpoint, + AppsListInstallationsForAuthenticatedUserRequestOptions + ]; + "GET /user/installations/:installation_id/repositories": [ + AppsListInstallationReposForAuthenticatedUserEndpoint, + AppsListInstallationReposForAuthenticatedUserRequestOptions + ]; + "GET /user/issues": [ + IssuesListForAuthenticatedUserEndpoint, + IssuesListForAuthenticatedUserRequestOptions + ]; + "GET /user/keys": [ + UsersListPublicKeysEndpoint, + UsersListPublicKeysRequestOptions + ]; + "GET /user/keys/:key_id": [ + UsersGetPublicKeyEndpoint, + UsersGetPublicKeyRequestOptions + ]; + "GET /user/marketplace_purchases": [ + AppsListMarketplacePurchasesForAuthenticatedUserEndpoint, + AppsListMarketplacePurchasesForAuthenticatedUserRequestOptions + ]; + "GET /user/marketplace_purchases/stubbed": [ + AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint, + AppsListMarketplacePurchasesForAuthenticatedUserStubbedRequestOptions + ]; + "GET /user/memberships/orgs": [ + OrgsListMembershipsEndpoint, + OrgsListMembershipsRequestOptions + ]; + "GET /user/memberships/orgs/:org": [ + OrgsGetMembershipForAuthenticatedUserEndpoint, + OrgsGetMembershipForAuthenticatedUserRequestOptions + ]; + "GET /user/migrations": [ + MigrationsListForAuthenticatedUserEndpoint, + MigrationsListForAuthenticatedUserRequestOptions + ]; + "GET /user/migrations/:migration_id": [ + MigrationsGetStatusForAuthenticatedUserEndpoint, + MigrationsGetStatusForAuthenticatedUserRequestOptions + ]; + "GET /user/migrations/:migration_id/archive": [ + MigrationsGetArchiveForAuthenticatedUserEndpoint, + MigrationsGetArchiveForAuthenticatedUserRequestOptions + ]; + "GET /user/orgs": [ + OrgsListForAuthenticatedUserEndpoint, + OrgsListForAuthenticatedUserRequestOptions + ]; + "GET /user/public_emails": [ + UsersListPublicEmailsEndpoint, + UsersListPublicEmailsRequestOptions + ]; + "GET /user/repos": [ReposListEndpoint, ReposListRequestOptions]; + "GET /user/repository_invitations": [ + ReposListInvitationsForAuthenticatedUserEndpoint, + ReposListInvitationsForAuthenticatedUserRequestOptions + ]; + "GET /user/starred": [ + ActivityListReposStarredByAuthenticatedUserEndpoint, + ActivityListReposStarredByAuthenticatedUserRequestOptions + ]; + "GET /user/starred/:owner/:repo": [ + ActivityCheckStarringRepoEndpoint, + ActivityCheckStarringRepoRequestOptions + ]; + "GET /user/subscriptions": [ + ActivityListWatchedReposForAuthenticatedUserEndpoint, + ActivityListWatchedReposForAuthenticatedUserRequestOptions + ]; + "GET /user/subscriptions/:owner/:repo": [ + ActivityCheckWatchingRepoLegacyEndpoint, + ActivityCheckWatchingRepoLegacyRequestOptions + ]; + "GET /user/teams": [ + TeamsListForAuthenticatedUserEndpoint, + TeamsListForAuthenticatedUserRequestOptions + ]; + "GET /users": [UsersListEndpoint, UsersListRequestOptions]; + "GET /users/:username": [ + UsersGetByUsernameEndpoint, + UsersGetByUsernameRequestOptions + ]; + "GET /users/:username/events": [ + ActivityListEventsForUserEndpoint, + ActivityListEventsForUserRequestOptions + ]; + "GET /users/:username/events/orgs/:org": [ + ActivityListEventsForOrgEndpoint, + ActivityListEventsForOrgRequestOptions + ]; + "GET /users/:username/events/public": [ + ActivityListPublicEventsForUserEndpoint, + ActivityListPublicEventsForUserRequestOptions + ]; + "GET /users/:username/followers": [ + UsersListFollowersForUserEndpoint, + UsersListFollowersForUserRequestOptions + ]; + "GET /users/:username/following": [ + UsersListFollowingForUserEndpoint, + UsersListFollowingForUserRequestOptions + ]; + "GET /users/:username/following/:target_user": [ + UsersCheckFollowingForUserEndpoint, + UsersCheckFollowingForUserRequestOptions + ]; + "GET /users/:username/gists": [ + GistsListPublicForUserEndpoint, + GistsListPublicForUserRequestOptions + ]; + "GET /users/:username/gpg_keys": [ + UsersListGpgKeysForUserEndpoint, + UsersListGpgKeysForUserRequestOptions + ]; + "GET /users/:username/hovercard": [ + UsersGetContextForUserEndpoint, + UsersGetContextForUserRequestOptions + ]; + "GET /users/:username/installation": [ + AppsGetUserInstallationEndpoint | AppsFindUserInstallationEndpoint, + + | AppsGetUserInstallationRequestOptions + | AppsFindUserInstallationRequestOptions + ]; + "GET /users/:username/keys": [ + UsersListPublicKeysForUserEndpoint, + UsersListPublicKeysForUserRequestOptions + ]; + "GET /users/:username/orgs": [ + OrgsListForUserEndpoint, + OrgsListForUserRequestOptions + ]; + "GET /users/:username/projects": [ + ProjectsListForUserEndpoint, + ProjectsListForUserRequestOptions + ]; + "GET /users/:username/received_events": [ + ActivityListReceivedEventsForUserEndpoint, + ActivityListReceivedEventsForUserRequestOptions + ]; + "GET /users/:username/received_events/public": [ + ActivityListReceivedPublicEventsForUserEndpoint, + ActivityListReceivedPublicEventsForUserRequestOptions + ]; + "GET /users/:username/repos": [ + ReposListForUserEndpoint, + ReposListForUserRequestOptions + ]; + "GET /users/:username/starred": [ + ActivityListReposStarredByUserEndpoint, + ActivityListReposStarredByUserRequestOptions + ]; + "GET /users/:username/subscriptions": [ + ActivityListReposWatchedByUserEndpoint, + ActivityListReposWatchedByUserRequestOptions + ]; + "PATCH /authorizations/:authorization_id": [ + OauthAuthorizationsUpdateAuthorizationEndpoint, + OauthAuthorizationsUpdateAuthorizationRequestOptions + ]; + "PATCH /gists/:gist_id": [GistsUpdateEndpoint, GistsUpdateRequestOptions]; + "PATCH /gists/:gist_id/comments/:comment_id": [ + GistsUpdateCommentEndpoint, + GistsUpdateCommentRequestOptions + ]; + "PATCH /notifications/threads/:thread_id": [ + ActivityMarkThreadAsReadEndpoint, + ActivityMarkThreadAsReadRequestOptions + ]; + "PATCH /orgs/:org": [OrgsUpdateEndpoint, OrgsUpdateRequestOptions]; + "PATCH /orgs/:org/hooks/:hook_id": [ + OrgsUpdateHookEndpoint, + OrgsUpdateHookRequestOptions + ]; + "PATCH /projects/:project_id": [ + ProjectsUpdateEndpoint, + ProjectsUpdateRequestOptions + ]; + "PATCH /projects/columns/:column_id": [ + ProjectsUpdateColumnEndpoint, + ProjectsUpdateColumnRequestOptions + ]; + "PATCH /projects/columns/cards/:card_id": [ + ProjectsUpdateCardEndpoint, + ProjectsUpdateCardRequestOptions + ]; + "PATCH /repos/:owner/:repo": [ReposUpdateEndpoint, ReposUpdateRequestOptions]; + "PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": [ + ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint, + ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions + ]; + "PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks": [ + ReposUpdateProtectedBranchRequiredStatusChecksEndpoint, + ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions + ]; + "PATCH /repos/:owner/:repo/check-runs/:check_run_id": [ + ChecksUpdateEndpoint, + ChecksUpdateRequestOptions + ]; + "PATCH /repos/:owner/:repo/check-suites/preferences": [ + ChecksSetSuitesPreferencesEndpoint, + ChecksSetSuitesPreferencesRequestOptions + ]; + "PATCH /repos/:owner/:repo/comments/:comment_id": [ + ReposUpdateCommitCommentEndpoint, + ReposUpdateCommitCommentRequestOptions + ]; + "PATCH /repos/:owner/:repo/git/refs/:ref": [ + GitUpdateRefEndpoint, + GitUpdateRefRequestOptions + ]; + "PATCH /repos/:owner/:repo/hooks/:hook_id": [ + ReposUpdateHookEndpoint, + ReposUpdateHookRequestOptions + ]; + "PATCH /repos/:owner/:repo/import": [ + MigrationsUpdateImportEndpoint, + MigrationsUpdateImportRequestOptions + ]; + "PATCH /repos/:owner/:repo/import/authors/:author_id": [ + MigrationsMapCommitAuthorEndpoint, + MigrationsMapCommitAuthorRequestOptions + ]; + "PATCH /repos/:owner/:repo/import/lfs": [ + MigrationsSetLfsPreferenceEndpoint, + MigrationsSetLfsPreferenceRequestOptions + ]; + "PATCH /repos/:owner/:repo/invitations/:invitation_id": [ + ReposUpdateInvitationEndpoint, + ReposUpdateInvitationRequestOptions + ]; + "PATCH /repos/:owner/:repo/issues/:issue_number": [ + IssuesUpdateEndpoint, + IssuesUpdateRequestOptions + ]; + "PATCH /repos/:owner/:repo/issues/comments/:comment_id": [ + IssuesUpdateCommentEndpoint, + IssuesUpdateCommentRequestOptions + ]; + "PATCH /repos/:owner/:repo/labels/:name": [ + IssuesUpdateLabelEndpoint, + IssuesUpdateLabelRequestOptions + ]; + "PATCH /repos/:owner/:repo/milestones/:milestone_number": [ + IssuesUpdateMilestoneEndpoint, + IssuesUpdateMilestoneRequestOptions + ]; + "PATCH /repos/:owner/:repo/pulls/:pull_number": [ + PullsUpdateEndpoint, + PullsUpdateRequestOptions + ]; + "PATCH /repos/:owner/:repo/pulls/comments/:comment_id": [ + PullsUpdateCommentEndpoint, + PullsUpdateCommentRequestOptions + ]; + "PATCH /repos/:owner/:repo/releases/:release_id": [ + ReposUpdateReleaseEndpoint, + ReposUpdateReleaseRequestOptions + ]; + "PATCH /repos/:owner/:repo/releases/assets/:asset_id": [ + ReposUpdateReleaseAssetEndpoint, + ReposUpdateReleaseAssetRequestOptions + ]; + "PATCH /scim/v2/organizations/:org/Users/:scim_user_id": [ + ScimUpdateUserAttributeEndpoint, + ScimUpdateUserAttributeRequestOptions + ]; + "PATCH /teams/:team_id": [TeamsUpdateEndpoint, TeamsUpdateRequestOptions]; + "PATCH /teams/:team_id/discussions/:discussion_number": [ + TeamsUpdateDiscussionEndpoint, + TeamsUpdateDiscussionRequestOptions + ]; + "PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number": [ + TeamsUpdateDiscussionCommentEndpoint, + TeamsUpdateDiscussionCommentRequestOptions + ]; + "PATCH /teams/:team_id/team-sync/group-mappings": [ + TeamsCreateOrUpdateIdPGroupConnectionsEndpoint, + TeamsCreateOrUpdateIdPGroupConnectionsRequestOptions + ]; + "PATCH /user": [ + UsersUpdateAuthenticatedEndpoint, + UsersUpdateAuthenticatedRequestOptions + ]; + "PATCH /user/email/visibility": [ + UsersTogglePrimaryEmailVisibilityEndpoint, + UsersTogglePrimaryEmailVisibilityRequestOptions + ]; + "PATCH /user/memberships/orgs/:org": [ + OrgsUpdateMembershipEndpoint, + OrgsUpdateMembershipRequestOptions + ]; + "PATCH /user/repository_invitations/:invitation_id": [ + ReposAcceptInvitationEndpoint, + ReposAcceptInvitationRequestOptions + ]; + "POST /app-manifests/:code/conversions": [ + AppsCreateFromManifestEndpoint, + AppsCreateFromManifestRequestOptions + ]; + "POST /app/installations/:installation_id/access_tokens": [ + AppsCreateInstallationTokenEndpoint, + AppsCreateInstallationTokenRequestOptions + ]; + "POST /applications/:client_id/tokens/:access_token": [ + OauthAuthorizationsResetAuthorizationEndpoint, + OauthAuthorizationsResetAuthorizationRequestOptions + ]; + "POST /authorizations": [ + OauthAuthorizationsCreateAuthorizationEndpoint, + OauthAuthorizationsCreateAuthorizationRequestOptions + ]; + "POST /content_references/:content_reference_id/attachments": [ + AppsCreateContentAttachmentEndpoint, + AppsCreateContentAttachmentRequestOptions + ]; + "POST /gists": [GistsCreateEndpoint, GistsCreateRequestOptions]; + "POST /gists/:gist_id/comments": [ + GistsCreateCommentEndpoint, + GistsCreateCommentRequestOptions + ]; + "POST /gists/:gist_id/forks": [GistsForkEndpoint, GistsForkRequestOptions]; + "POST /markdown": [MarkdownRenderEndpoint, MarkdownRenderRequestOptions]; + "POST /markdown/raw": [ + MarkdownRenderRawEndpoint, + MarkdownRenderRawRequestOptions + ]; + "POST /orgs/:org/hooks": [ + OrgsCreateHookEndpoint, + OrgsCreateHookRequestOptions + ]; + "POST /orgs/:org/hooks/:hook_id/pings": [ + OrgsPingHookEndpoint, + OrgsPingHookRequestOptions + ]; + "POST /orgs/:org/invitations": [ + OrgsCreateInvitationEndpoint, + OrgsCreateInvitationRequestOptions + ]; + "POST /orgs/:org/migrations": [ + MigrationsStartForOrgEndpoint, + MigrationsStartForOrgRequestOptions + ]; + "POST /orgs/:org/projects": [ + ProjectsCreateForOrgEndpoint, + ProjectsCreateForOrgRequestOptions + ]; + "POST /orgs/:org/repos": [ + ReposCreateInOrgEndpoint, + ReposCreateInOrgRequestOptions + ]; + "POST /orgs/:org/teams": [TeamsCreateEndpoint, TeamsCreateRequestOptions]; + "POST /projects/:project_id/columns": [ + ProjectsCreateColumnEndpoint, + ProjectsCreateColumnRequestOptions + ]; + "POST /projects/columns/:column_id/cards": [ + ProjectsCreateCardEndpoint, + ProjectsCreateCardRequestOptions + ]; + "POST /projects/columns/:column_id/moves": [ + ProjectsMoveColumnEndpoint, + ProjectsMoveColumnRequestOptions + ]; + "POST /projects/columns/cards/:card_id/moves": [ + ProjectsMoveCardEndpoint, + ProjectsMoveCardRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins": [ + ReposAddProtectedBranchAdminEnforcementEndpoint, + ReposAddProtectedBranchAdminEnforcementRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/required_signatures": [ + ReposAddProtectedBranchRequiredSignaturesEndpoint, + ReposAddProtectedBranchRequiredSignaturesRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ + ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint, + ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ + ReposAddProtectedBranchAppRestrictionsEndpoint, + ReposAddProtectedBranchAppRestrictionsRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ + ReposAddProtectedBranchTeamRestrictionsEndpoint, + ReposAddProtectedBranchTeamRestrictionsRequestOptions + ]; + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ + ReposAddProtectedBranchUserRestrictionsEndpoint, + ReposAddProtectedBranchUserRestrictionsRequestOptions + ]; + "POST /repos/:owner/:repo/check-runs": [ + ChecksCreateEndpoint, + ChecksCreateRequestOptions + ]; + "POST /repos/:owner/:repo/check-suites": [ + ChecksCreateSuiteEndpoint, + ChecksCreateSuiteRequestOptions + ]; + "POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest": [ + ChecksRerequestSuiteEndpoint, + ChecksRerequestSuiteRequestOptions + ]; + "POST /repos/:owner/:repo/comments/:comment_id/reactions": [ + ReactionsCreateForCommitCommentEndpoint, + ReactionsCreateForCommitCommentRequestOptions + ]; + "POST /repos/:owner/:repo/commits/:commit_sha/comments": [ + ReposCreateCommitCommentEndpoint, + ReposCreateCommitCommentRequestOptions + ]; + "POST /repos/:owner/:repo/deployments": [ + ReposCreateDeploymentEndpoint, + ReposCreateDeploymentRequestOptions + ]; + "POST /repos/:owner/:repo/deployments/:deployment_id/statuses": [ + ReposCreateDeploymentStatusEndpoint, + ReposCreateDeploymentStatusRequestOptions + ]; + "POST /repos/:owner/:repo/dispatches": [ + ReposCreateDispatchEventEndpoint, + ReposCreateDispatchEventRequestOptions + ]; + "POST /repos/:owner/:repo/forks": [ + ReposCreateForkEndpoint, + ReposCreateForkRequestOptions + ]; + "POST /repos/:owner/:repo/git/blobs": [ + GitCreateBlobEndpoint, + GitCreateBlobRequestOptions + ]; + "POST /repos/:owner/:repo/git/commits": [ + GitCreateCommitEndpoint, + GitCreateCommitRequestOptions + ]; + "POST /repos/:owner/:repo/git/refs": [ + GitCreateRefEndpoint, + GitCreateRefRequestOptions + ]; + "POST /repos/:owner/:repo/git/tags": [ + GitCreateTagEndpoint, + GitCreateTagRequestOptions + ]; + "POST /repos/:owner/:repo/git/trees": [ + GitCreateTreeEndpoint, + GitCreateTreeRequestOptions + ]; + "POST /repos/:owner/:repo/hooks": [ + ReposCreateHookEndpoint, + ReposCreateHookRequestOptions + ]; + "POST /repos/:owner/:repo/hooks/:hook_id/pings": [ + ReposPingHookEndpoint, + ReposPingHookRequestOptions + ]; + "POST /repos/:owner/:repo/hooks/:hook_id/tests": [ + ReposTestPushHookEndpoint, + ReposTestPushHookRequestOptions + ]; + "POST /repos/:owner/:repo/issues": [ + IssuesCreateEndpoint, + IssuesCreateRequestOptions + ]; + "POST /repos/:owner/:repo/issues/:issue_number/assignees": [ + IssuesAddAssigneesEndpoint, + IssuesAddAssigneesRequestOptions + ]; + "POST /repos/:owner/:repo/issues/:issue_number/comments": [ + IssuesCreateCommentEndpoint, + IssuesCreateCommentRequestOptions + ]; + "POST /repos/:owner/:repo/issues/:issue_number/labels": [ + IssuesAddLabelsEndpoint, + IssuesAddLabelsRequestOptions + ]; + "POST /repos/:owner/:repo/issues/:issue_number/reactions": [ + ReactionsCreateForIssueEndpoint, + ReactionsCreateForIssueRequestOptions + ]; + "POST /repos/:owner/:repo/issues/comments/:comment_id/reactions": [ + ReactionsCreateForIssueCommentEndpoint, + ReactionsCreateForIssueCommentRequestOptions + ]; + "POST /repos/:owner/:repo/keys": [ + ReposAddDeployKeyEndpoint, + ReposAddDeployKeyRequestOptions + ]; + "POST /repos/:owner/:repo/labels": [ + IssuesCreateLabelEndpoint, + IssuesCreateLabelRequestOptions + ]; + "POST /repos/:owner/:repo/merges": [ + ReposMergeEndpoint, + ReposMergeRequestOptions + ]; + "POST /repos/:owner/:repo/milestones": [ + IssuesCreateMilestoneEndpoint, + IssuesCreateMilestoneRequestOptions + ]; + "POST /repos/:owner/:repo/pages": [ + ReposEnablePagesSiteEndpoint, + ReposEnablePagesSiteRequestOptions + ]; + "POST /repos/:owner/:repo/pages/builds": [ + ReposRequestPageBuildEndpoint, + ReposRequestPageBuildRequestOptions + ]; + "POST /repos/:owner/:repo/projects": [ + ProjectsCreateForRepoEndpoint, + ProjectsCreateForRepoRequestOptions + ]; + "POST /repos/:owner/:repo/pulls": [ + PullsCreateEndpoint, + PullsCreateRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/comments": [ + PullsCreateCommentEndpoint | PullsCreateCommentReplyEndpoint, + PullsCreateCommentRequestOptions | PullsCreateCommentReplyRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies": [ + PullsCreateReviewCommentReplyEndpoint, + PullsCreateReviewCommentReplyRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": [ + PullsCreateReviewRequestEndpoint, + PullsCreateReviewRequestRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/reviews": [ + PullsCreateReviewEndpoint, + PullsCreateReviewRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events": [ + PullsSubmitReviewEndpoint, + PullsSubmitReviewRequestOptions + ]; + "POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions": [ + ReactionsCreateForPullRequestReviewCommentEndpoint, + ReactionsCreateForPullRequestReviewCommentRequestOptions + ]; + "POST /repos/:owner/:repo/releases": [ + ReposCreateReleaseEndpoint, + ReposCreateReleaseRequestOptions + ]; + "POST /repos/:owner/:repo/statuses/:sha": [ + ReposCreateStatusEndpoint, + ReposCreateStatusRequestOptions + ]; + "POST /repos/:owner/:repo/transfer": [ + ReposTransferEndpoint, + ReposTransferRequestOptions + ]; + "POST /repos/:template_owner/:template_repo/generate": [ + ReposCreateUsingTemplateEndpoint, + ReposCreateUsingTemplateRequestOptions + ]; + "POST /scim/v2/organizations/:org/Users": [ + ScimProvisionAndInviteUsersEndpoint | ScimProvisionInviteUsersEndpoint, + + | ScimProvisionAndInviteUsersRequestOptions + | ScimProvisionInviteUsersRequestOptions + ]; + "POST /teams/:team_id/discussions": [ + TeamsCreateDiscussionEndpoint, + TeamsCreateDiscussionRequestOptions + ]; + "POST /teams/:team_id/discussions/:discussion_number/comments": [ + TeamsCreateDiscussionCommentEndpoint, + TeamsCreateDiscussionCommentRequestOptions + ]; + "POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": [ + ReactionsCreateForTeamDiscussionCommentEndpoint, + ReactionsCreateForTeamDiscussionCommentRequestOptions + ]; + "POST /teams/:team_id/discussions/:discussion_number/reactions": [ + ReactionsCreateForTeamDiscussionEndpoint, + ReactionsCreateForTeamDiscussionRequestOptions + ]; + "POST /user/emails": [UsersAddEmailsEndpoint, UsersAddEmailsRequestOptions]; + "POST /user/gpg_keys": [ + UsersCreateGpgKeyEndpoint, + UsersCreateGpgKeyRequestOptions + ]; + "POST /user/keys": [ + UsersCreatePublicKeyEndpoint, + UsersCreatePublicKeyRequestOptions + ]; + "POST /user/migrations": [ + MigrationsStartForAuthenticatedUserEndpoint, + MigrationsStartForAuthenticatedUserRequestOptions + ]; + "POST /user/projects": [ + ProjectsCreateForAuthenticatedUserEndpoint, + ProjectsCreateForAuthenticatedUserRequestOptions + ]; + "POST /user/repos": [ + ReposCreateForAuthenticatedUserEndpoint, + ReposCreateForAuthenticatedUserRequestOptions + ]; + "PUT /authorizations/clients/:client_id": [ + OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint, + OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions + ]; + "PUT /authorizations/clients/:client_id/:fingerprint": [ + + | OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint + | OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintEndpoint, + + | OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions + | OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintRequestOptions + ]; + "PUT /gists/:gist_id/star": [GistsStarEndpoint, GistsStarRequestOptions]; + "PUT /notifications": [ + ActivityMarkAsReadEndpoint, + ActivityMarkAsReadRequestOptions + ]; + "PUT /notifications/threads/:thread_id/subscription": [ + ActivitySetThreadSubscriptionEndpoint, + ActivitySetThreadSubscriptionRequestOptions + ]; + "PUT /orgs/:org/blocks/:username": [ + OrgsBlockUserEndpoint, + OrgsBlockUserRequestOptions + ]; + "PUT /orgs/:org/interaction-limits": [ + InteractionsAddOrUpdateRestrictionsForOrgEndpoint, + InteractionsAddOrUpdateRestrictionsForOrgRequestOptions + ]; + "PUT /orgs/:org/memberships/:username": [ + OrgsAddOrUpdateMembershipEndpoint, + OrgsAddOrUpdateMembershipRequestOptions + ]; + "PUT /orgs/:org/outside_collaborators/:username": [ + OrgsConvertMemberToOutsideCollaboratorEndpoint, + OrgsConvertMemberToOutsideCollaboratorRequestOptions + ]; + "PUT /orgs/:org/public_members/:username": [ + OrgsPublicizeMembershipEndpoint, + OrgsPublicizeMembershipRequestOptions + ]; + "PUT /projects/:project_id/collaborators/:username": [ + ProjectsAddCollaboratorEndpoint, + ProjectsAddCollaboratorRequestOptions + ]; + "PUT /repos/:owner/:repo/automated-security-fixes": [ + ReposEnableAutomatedSecurityFixesEndpoint, + ReposEnableAutomatedSecurityFixesRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection": [ + ReposUpdateBranchProtectionEndpoint, + ReposUpdateBranchProtectionRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": [ + ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint, + ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": [ + ReposReplaceProtectedBranchAppRestrictionsEndpoint, + ReposReplaceProtectedBranchAppRestrictionsRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": [ + ReposReplaceProtectedBranchTeamRestrictionsEndpoint, + ReposReplaceProtectedBranchTeamRestrictionsRequestOptions + ]; + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users": [ + ReposReplaceProtectedBranchUserRestrictionsEndpoint, + ReposReplaceProtectedBranchUserRestrictionsRequestOptions + ]; + "PUT /repos/:owner/:repo/collaborators/:username": [ + ReposAddCollaboratorEndpoint, + ReposAddCollaboratorRequestOptions + ]; + "PUT /repos/:owner/:repo/contents/:path": [ + + | ReposCreateOrUpdateFileEndpoint + | ReposCreateFileEndpoint + | ReposUpdateFileEndpoint, + + | ReposCreateOrUpdateFileRequestOptions + | ReposCreateFileRequestOptions + | ReposUpdateFileRequestOptions + ]; + "PUT /repos/:owner/:repo/import": [ + MigrationsStartImportEndpoint, + MigrationsStartImportRequestOptions + ]; + "PUT /repos/:owner/:repo/interaction-limits": [ + InteractionsAddOrUpdateRestrictionsForRepoEndpoint, + InteractionsAddOrUpdateRestrictionsForRepoRequestOptions + ]; + "PUT /repos/:owner/:repo/issues/:issue_number/labels": [ + IssuesReplaceLabelsEndpoint, + IssuesReplaceLabelsRequestOptions + ]; + "PUT /repos/:owner/:repo/issues/:issue_number/lock": [ + IssuesLockEndpoint, + IssuesLockRequestOptions + ]; + "PUT /repos/:owner/:repo/notifications": [ + ActivityMarkNotificationsAsReadForRepoEndpoint, + ActivityMarkNotificationsAsReadForRepoRequestOptions + ]; + "PUT /repos/:owner/:repo/pages": [ + ReposUpdateInformationAboutPagesSiteEndpoint, + ReposUpdateInformationAboutPagesSiteRequestOptions + ]; + "PUT /repos/:owner/:repo/pulls/:pull_number/merge": [ + PullsMergeEndpoint, + PullsMergeRequestOptions + ]; + "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": [ + PullsUpdateReviewEndpoint, + PullsUpdateReviewRequestOptions + ]; + "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals": [ + PullsDismissReviewEndpoint, + PullsDismissReviewRequestOptions + ]; + "PUT /repos/:owner/:repo/pulls/:pull_number/update-branch": [ + PullsUpdateBranchEndpoint, + PullsUpdateBranchRequestOptions + ]; + "PUT /repos/:owner/:repo/subscription": [ + ActivitySetRepoSubscriptionEndpoint, + ActivitySetRepoSubscriptionRequestOptions + ]; + "PUT /repos/:owner/:repo/topics": [ + ReposReplaceTopicsEndpoint, + ReposReplaceTopicsRequestOptions + ]; + "PUT /repos/:owner/:repo/vulnerability-alerts": [ + ReposEnableVulnerabilityAlertsEndpoint, + ReposEnableVulnerabilityAlertsRequestOptions + ]; + "PUT /scim/v2/organizations/:org/Users/:scim_user_id": [ + + | ScimReplaceProvisionedUserInformationEndpoint + | ScimUpdateProvisionedOrgMembershipEndpoint, + + | ScimReplaceProvisionedUserInformationRequestOptions + | ScimUpdateProvisionedOrgMembershipRequestOptions + ]; + "PUT /teams/:team_id/members/:username": [ + TeamsAddMemberEndpoint, + TeamsAddMemberRequestOptions + ]; + "PUT /teams/:team_id/memberships/:username": [ + TeamsAddOrUpdateMembershipEndpoint, + TeamsAddOrUpdateMembershipRequestOptions + ]; + "PUT /teams/:team_id/projects/:project_id": [ + TeamsAddOrUpdateProjectEndpoint, + TeamsAddOrUpdateProjectRequestOptions + ]; + "PUT /teams/:team_id/repos/:owner/:repo": [ + TeamsAddOrUpdateRepoEndpoint, + TeamsAddOrUpdateRepoRequestOptions + ]; + "PUT /user/blocks/:username": [UsersBlockEndpoint, UsersBlockRequestOptions]; + "PUT /user/following/:username": [ + UsersFollowEndpoint, + UsersFollowRequestOptions + ]; + "PUT /user/installations/:installation_id/repositories/:repository_id": [ + AppsAddRepoToInstallationEndpoint, + AppsAddRepoToInstallationRequestOptions + ]; + "PUT /user/starred/:owner/:repo": [ + ActivityStarRepoEndpoint, + ActivityStarRepoRequestOptions + ]; + "PUT /user/subscriptions/:owner/:repo": [ + ActivityWatchRepoLegacyEndpoint, + ActivityWatchRepoLegacyRequestOptions + ]; +} + +type AppsGetAuthenticatedEndpoint = {}; +type AppsGetAuthenticatedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCreateFromManifestEndpoint = { + /** + * code parameter + */ + code: string; +}; +type AppsCreateFromManifestRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListInstallationsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListInstallationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; +}; +type AppsGetInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsDeleteInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; +}; +type AppsDeleteInstallationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCreateInstallationTokenEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; + /** + * The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the "[List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token. + */ + repository_ids?: number[]; + /** + * The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see "[GitHub App permissions](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions)." + */ + permissions?: AppsCreateInstallationTokenParamsPermissions; +}; +type AppsCreateInstallationTokenRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsListGrantsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OauthAuthorizationsListGrantsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetGrantEndpoint = { + /** + * grant_id parameter + */ + grant_id: number; +}; +type OauthAuthorizationsGetGrantRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsDeleteGrantEndpoint = { + /** + * grant_id parameter + */ + grant_id: number; +}; +type OauthAuthorizationsDeleteGrantRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsRevokeGrantForApplicationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; +type OauthAuthorizationsRevokeGrantForApplicationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsCheckAuthorizationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; +type OauthAuthorizationsCheckAuthorizationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsResetAuthorizationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; +type OauthAuthorizationsResetAuthorizationRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * access_token parameter + */ + access_token: string; +}; +type OauthAuthorizationsRevokeAuthorizationForApplicationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetBySlugEndpoint = { + /** + * app_slug parameter + */ + app_slug: string; +}; +type AppsGetBySlugRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsListAuthorizationsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OauthAuthorizationsListAuthorizationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsCreateAuthorizationEndpoint = { + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. + */ + note: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * The 20 character OAuth app client key for which to create the token. + */ + client_id?: string; + /** + * The 40 character OAuth app client secret for which to create the token. + */ + client_secret?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; +}; +type OauthAuthorizationsCreateAuthorizationRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint). + */ + fingerprint?: string; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * fingerprint parameter + */ + fingerprint: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintEndpoint = { + /** + * client_id parameter + */ + client_id: string; + /** + * fingerprint parameter + */ + fingerprint: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; +}; +type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsGetAuthorizationEndpoint = { + /** + * authorization_id parameter + */ + authorization_id: number; +}; +type OauthAuthorizationsGetAuthorizationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsUpdateAuthorizationEndpoint = { + /** + * authorization_id parameter + */ + authorization_id: number; + /** + * Replaces the authorization scopes with these. + */ + scopes?: string[]; + /** + * A list of scopes to add to this authorization. + */ + add_scopes?: string[]; + /** + * A list of scopes to remove from this authorization. + */ + remove_scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; +}; +type OauthAuthorizationsUpdateAuthorizationRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OauthAuthorizationsDeleteAuthorizationEndpoint = { + /** + * authorization_id parameter + */ + authorization_id: number; +}; +type OauthAuthorizationsDeleteAuthorizationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type CodesOfConductListConductCodesEndpoint = {}; +type CodesOfConductListConductCodesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type CodesOfConductGetConductCodeEndpoint = { + /** + * key parameter + */ + key: string; +}; +type CodesOfConductGetConductCodeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCreateContentAttachmentEndpoint = { + /** + * content_reference_id parameter + */ + content_reference_id: number; + /** + * The title of the content attachment displayed in the body or comment of an issue or pull request. + */ + title: string; + /** + * The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown. + */ + body: string; +}; +type AppsCreateContentAttachmentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type EmojisGetEndpoint = {}; +type EmojisGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListPublicEventsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListPublicEventsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListFeedsEndpoint = {}; +type ActivityListFeedsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsCreateEndpoint = { + /** + * The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`. + */ + files: GistsCreateParamsFiles; + /** + * A descriptive name for this gist. + */ + description?: string; + /** + * When `true`, the gist will be public and available for anyone to see. + */ + public?: boolean; +}; +type GistsCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListPublicEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListPublicRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListStarredEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListStarredRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsGetEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsUpdateEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * A descriptive name for this gist. + */ + description?: string; + /** + * The filenames and content that make up this gist. + */ + files?: GistsUpdateParamsFiles; +}; +type GistsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsDeleteEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListCommentsEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsCreateCommentEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * The comment text. + */ + body: string; +}; +type GistsCreateCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsGetCommentEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type GistsGetCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsUpdateCommentEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The comment text. + */ + body: string; +}; +type GistsUpdateCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsDeleteCommentEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type GistsDeleteCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListCommitsEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsForkEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsForkRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListForksEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListForksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsStarEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsStarRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsUnstarEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsUnstarRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsCheckIsStarredEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; +}; +type GistsCheckIsStarredRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsGetRevisionEndpoint = { + /** + * gist_id parameter + */ + gist_id: string; + /** + * sha parameter + */ + sha: string; +}; +type GistsGetRevisionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitignoreListTemplatesEndpoint = {}; +type GitignoreListTemplatesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitignoreGetTemplateEndpoint = { + /** + * name parameter + */ + name: string; +}; +type GitignoreGetTemplateRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListReposEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListReposRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListEndpoint = { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchIssuesLegacyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repository parameter + */ + repository: string; + /** + * Indicates the state of the issues to return. Can be either `open` or `closed`. + */ + state: "open" | "closed"; + /** + * The search term. + */ + keyword: string; +}; +type SearchIssuesLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchReposLegacyEndpoint = { + /** + * The search term. + */ + keyword: string; + /** + * Filter results by language. + */ + language?: string; + /** + * The page number to fetch. + */ + start_page?: string; + /** + * The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. + */ + sort?: "stars" | "forks" | "updated"; + /** + * The sort field. if `sort` param is provided. Can be either `asc` or `desc`. + */ + order?: "asc" | "desc"; +}; +type SearchReposLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchEmailLegacyEndpoint = { + /** + * The email address. + */ + email: string; +}; +type SearchEmailLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchUsersLegacyEndpoint = { + /** + * The search term. + */ + keyword: string; + /** + * The page number to fetch. + */ + start_page?: string; + /** + * The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. + */ + sort?: "stars" | "forks" | "updated"; + /** + * The sort field. if `sort` param is provided. Can be either `asc` or `desc`. + */ + order?: "asc" | "desc"; +}; +type SearchUsersLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type LicensesListCommonlyUsedEndpoint = {}; +type LicensesListCommonlyUsedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type LicensesListEndpoint = {}; +type LicensesListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type LicensesGetEndpoint = { + /** + * license parameter + */ + license: string; +}; +type LicensesGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MarkdownRenderEndpoint = { + /** + * The Markdown text to render in HTML. Markdown content must be 400 KB or less. + */ + text: string; + /** + * The rendering mode. Can be either: + * \* `markdown` to render a document in plain Markdown, just like README.md files are rendered. + * \* `gfm` to render a document in [GitHub Flavored Markdown](https://github.github.com/gfm/), which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests. + */ + mode?: "markdown" | "gfm"; + /** + * The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode. + */ + context?: string; +}; +type MarkdownRenderRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MarkdownRenderRawEndpoint = { + /** + * data parameter + */ + data: string; +}; +type MarkdownRenderRawRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCheckAccountIsAssociatedWithAnyEndpoint = { + /** + * account_id parameter + */ + account_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsCheckAccountIsAssociatedWithAnyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListPlansEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListPlansRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListAccountsUserOrOrgOnPlanEndpoint = { + /** + * plan_id parameter + */ + plan_id: number; + /** + * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListAccountsUserOrOrgOnPlanRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsCheckAccountIsAssociatedWithAnyStubbedEndpoint = { + /** + * account_id parameter + */ + account_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsCheckAccountIsAssociatedWithAnyStubbedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListPlansStubbedEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListPlansStubbedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListAccountsUserOrOrgOnPlanStubbedEndpoint = { + /** + * plan_id parameter + */ + plan_id: number; + /** + * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListAccountsUserOrOrgOnPlanStubbedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MetaGetEndpoint = {}; +type MetaGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListPublicEventsForRepoNetworkEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListPublicEventsForRepoNetworkRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListNotificationsEndpoint = { + /** + * If `true`, show notifications marked as read. + */ + all?: boolean; + /** + * If `true`, only shows notifications in which the user is directly participating or mentioned. + */ + participating?: boolean; + /** + * Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + before?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListNotificationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityMarkAsReadEndpoint = { + /** + * Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; +}; +type ActivityMarkAsReadRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityGetThreadEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; +}; +type ActivityGetThreadRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityMarkThreadAsReadEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; +}; +type ActivityMarkThreadAsReadRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityGetThreadSubscriptionEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; +}; +type ActivityGetThreadSubscriptionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivitySetThreadSubscriptionEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; + /** + * Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread. + */ + ignored?: boolean; +}; +type ActivitySetThreadSubscriptionRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityDeleteThreadSubscriptionEndpoint = { + /** + * thread_id parameter + */ + thread_id: number; +}; +type ActivityDeleteThreadSubscriptionRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListEndpoint = { + /** + * The integer ID of the last Organization that you've seen. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsGetEndpoint = { + /** + * org parameter + */ + org: string; +}; +type OrgsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsUpdateEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Billing email address. This address is not publicized. + */ + billing_email?: string; + /** + * The company name. + */ + company?: string; + /** + * The publicly visible email address. + */ + email?: string; + /** + * The location. + */ + location?: string; + /** + * The shorthand name of the company. + */ + name?: string; + /** + * The description of the company. + */ + description?: string; + /** + * Toggles whether organization projects are enabled for the organization. + */ + has_organization_projects?: boolean; + /** + * Toggles whether repository projects are enabled for repositories that belong to the organization. + */ + has_repository_projects?: boolean; + /** + * Default permission level members have for organization repositories: + * \* `read` - can pull, but not push to or administer this repository. + * \* `write` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push, and administer this repository. + * \* `none` - no permissions granted by default. + */ + default_repository_permission?: "read" | "write" | "admin" | "none"; + /** + * Toggles the ability of non-admin organization members to create repositories. Can be one of: + * \* `true` - all organization members can create repositories. + * \* `false` - only admin members can create repositories. + * Default: `true` + * **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + */ + members_can_create_repositories?: boolean; + /** + * Specifies which types of repositories non-admin organization members can create. Can be one of: + * \* `all` - all organization members can create public and private repositories. + * \* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). + * \* `none` - only admin members can create repositories. + * **Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + */ + members_allowed_repository_creation_type?: "all" | "private" | "none"; +}; +type OrgsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListBlockedUsersEndpoint = { + /** + * org parameter + */ + org: string; +}; +type OrgsListBlockedUsersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCheckBlockedUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsCheckBlockedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsBlockUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsBlockUserRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsUnblockUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsUnblockUserRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListCredentialAuthorizationsEndpoint = { + /** + * org parameter + */ + org: string; +}; +type OrgsListCredentialAuthorizationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsRemoveCredentialAuthorizationEndpoint = { + /** + * org parameter + */ + org: string; + /** + * credential_id parameter + */ + credential_id: number; +}; +type OrgsRemoveCredentialAuthorizationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListPublicEventsForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListPublicEventsForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListHooksEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListHooksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCreateHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Must be passed as "web". + */ + name: string; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params). + */ + config: OrgsCreateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +type OrgsCreateHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsGetHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type OrgsGetHookRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsUpdateHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * hook_id parameter + */ + hook_id: number; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params). + */ + config?: OrgsUpdateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +type OrgsUpdateHookRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsDeleteHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type OrgsDeleteHookRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsPingHookEndpoint = { + /** + * org parameter + */ + org: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type OrgsPingHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetOrgInstallationEndpoint = { + /** + * org parameter + */ + org: string; +}; +type AppsGetOrgInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsFindOrgInstallationEndpoint = { + /** + * org parameter + */ + org: string; +}; +type AppsFindOrgInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsGetRestrictionsForOrgEndpoint = { + /** + * org parameter + */ + org: string; +}; +type InteractionsGetRestrictionsForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsAddOrUpdateRestrictionsForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`. + */ + limit: "existing_users" | "contributors_only" | "collaborators_only"; +}; +type InteractionsAddOrUpdateRestrictionsForOrgRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsRemoveRestrictionsForOrgEndpoint = { + /** + * org parameter + */ + org: string; +}; +type InteractionsRemoveRestrictionsForOrgRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListPendingInvitationsEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListPendingInvitationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCreateInvitationEndpoint = { + /** + * org parameter + */ + org: string; + /** + * **Required unless you provide `email`**. GitHub user ID for the person you are inviting. + */ + invitee_id?: number; + /** + * **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. + */ + email?: string; + /** + * Specify role for new member. Can be one of: + * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * \* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * \* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + */ + role?: "admin" | "direct_member" | "billing_manager"; + /** + * Specify IDs for the teams you want to invite new members to. + */ + team_ids?: number[]; +}; +type OrgsCreateInvitationRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListInvitationTeamsEndpoint = { + /** + * org parameter + */ + org: string; + /** + * invitation_id parameter + */ + invitation_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListInvitationTeamsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListMembersEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Filter members returned in the list. Can be one of: + * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. + * \* `all` - All members the authenticated user can see. + */ + filter?: "2fa_disabled" | "all"; + /** + * Filter members returned by their role. Can be one of: + * \* `all` - All members of the organization, regardless of role. + * \* `admin` - Organization owners. + * \* `member` - Non-owner organization members. + */ + role?: "all" | "admin" | "member"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListMembersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCheckMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsCheckMembershipRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsRemoveMemberEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsRemoveMemberRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsGetMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsGetMembershipRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsAddOrUpdateMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; + /** + * The role to give the user in the organization. Can be one of: + * \* `admin` - The user will become an owner of the organization. + * \* `member` - The user will become a non-owner member of the organization. + */ + role?: "admin" | "member"; +}; +type OrgsAddOrUpdateMembershipRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsRemoveMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsRemoveMembershipRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsStartForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * A list of arrays indicating which repositories should be migrated. + */ + repositories: string[]; + /** + * Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + */ + lock_repositories?: boolean; + /** + * Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + */ + exclude_attachments?: boolean; +}; +type MigrationsStartForOrgRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsListForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type MigrationsListForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetStatusForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsGetStatusForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetArchiveForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsGetArchiveForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsDeleteArchiveForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsDeleteArchiveForOrgRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsUnlockRepoForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * migration_id parameter + */ + migration_id: number; + /** + * repo_name parameter + */ + repo_name: string; +}; +type MigrationsUnlockRepoForOrgRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListOutsideCollaboratorsEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Filter the list of outside collaborators. Can be one of: + * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. + * \* `all`: All outside collaborators. + */ + filter?: "2fa_disabled" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListOutsideCollaboratorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsRemoveOutsideCollaboratorEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsRemoveOutsideCollaboratorRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsConvertMemberToOutsideCollaboratorEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsConvertMemberToOutsideCollaboratorRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +}; +type ProjectsCreateForOrgRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListPublicMembersEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListPublicMembersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsCheckPublicMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsCheckPublicMembershipRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsPublicizeMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsPublicizeMembershipRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsConcealMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * username parameter + */ + username: string; +}; +type OrgsConcealMembershipRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`. + */ + type?: "all" | "public" | "private" | "forks" | "sources" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateInOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * The name of the repository. + */ + name: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account. + */ + private?: boolean; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + */ + team_id?: number; + /** + * Pass `true` to create an initial commit with empty README. + */ + auto_init?: boolean; + /** + * Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". + */ + gitignore_template?: string; + /** + * Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". + */ + license_template?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; +}; +type ReposCreateInOrgRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListIdPGroupsForOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListIdPGroupsForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateEndpoint = { + /** + * org parameter + */ + org: string; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The logins of organization members to add as maintainers of the team. + */ + maintainers?: string[]; + /** + * The full name (e.g., "organization-name/repository-name") of repositories to add the team to. + */ + repo_names?: string[]; + /** + * The level of privacy this team should have. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + * Default for child team: `closed` + * **Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. + */ + parent_team_id?: number; +}; +type TeamsCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetByNameEndpoint = { + /** + * org parameter + */ + org: string; + /** + * team_slug parameter + */ + team_slug: string; +}; +type TeamsGetByNameRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsGetCardEndpoint = { + /** + * card_id parameter + */ + card_id: number; +}; +type ProjectsGetCardRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsUpdateCardEndpoint = { + /** + * card_id parameter + */ + card_id: number; + /** + * The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`. + */ + note?: string; + /** + * Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card. + */ + archived?: boolean; +}; +type ProjectsUpdateCardRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsDeleteCardEndpoint = { + /** + * card_id parameter + */ + card_id: number; +}; +type ProjectsDeleteCardRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsMoveCardEndpoint = { + /** + * card_id parameter + */ + card_id: number; + /** + * Can be one of `top`, `bottom`, or `after:`, where `` is the `id` value of a card in the same column, or in the new column specified by `column_id`. + */ + position: string; + /** + * The `id` value of a column in the same project. + */ + column_id?: number; +}; +type ProjectsMoveCardRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsGetColumnEndpoint = { + /** + * column_id parameter + */ + column_id: number; +}; +type ProjectsGetColumnRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsUpdateColumnEndpoint = { + /** + * column_id parameter + */ + column_id: number; + /** + * The new name of the column. + */ + name: string; +}; +type ProjectsUpdateColumnRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsDeleteColumnEndpoint = { + /** + * column_id parameter + */ + column_id: number; +}; +type ProjectsDeleteColumnRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListCardsEndpoint = { + /** + * column_id parameter + */ + column_id: number; + /** + * Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. + */ + archived_state?: "all" | "archived" | "not_archived"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListCardsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateCardEndpoint = { + /** + * column_id parameter + */ + column_id: number; + /** + * The card's note content. Only valid for cards without another type of content, so you must omit when specifying `content_id` and `content_type`. + */ + note?: string; + /** + * The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. + * **Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`. + */ + content_id?: number; + /** + * **Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id. + */ + content_type?: string; +}; +type ProjectsCreateCardRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsMoveColumnEndpoint = { + /** + * column_id parameter + */ + column_id: number; + /** + * Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project. + */ + position: string; +}; +type ProjectsMoveColumnRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsGetEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsUpdateEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * The name of the project. + */ + name?: string; + /** + * The description of the project. + */ + body?: string; + /** + * State of the project. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project](https://developer.github.com/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). + * + * **Note:** Updating a project's `organization_permission` requires `admin` access to the project. + * + * Can be one of: + * \* `read` - Organization members can read, but not write to or administer this project. + * \* `write` - Organization members can read and write, but not administer this project. + * \* `admin` - Organization members can read, write and administer this project. + * \* `none` - Organization members can only see this project if it is public. + */ + organization_permission?: string; + /** + * Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. + * + * Can be one of: + * \* `false` - Anyone can see the project. + * \* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account. + */ + private?: boolean; +}; +type ProjectsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsDeleteEndpoint = { + /** + * project_id parameter + */ + project_id: number; +}; +type ProjectsDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListCollaboratorsEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * Filters the collaborators by their affiliation. Can be one of: + * \* `outside`: Outside collaborators of a project that are not a member of the project's organization. + * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListCollaboratorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsAddCollaboratorEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * username parameter + */ + username: string; + /** + * The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." Can be one of: + * \* `read` - can read, but not write to or administer this project. + * \* `write` - can read and write, but not administer this project. + * \* `admin` - can read, write and administer this project. + */ + permission?: "read" | "write" | "admin"; +}; +type ProjectsAddCollaboratorRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsRemoveCollaboratorEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * username parameter + */ + username: string; +}; +type ProjectsRemoveCollaboratorRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsReviewUserPermissionLevelEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * username parameter + */ + username: string; +}; +type ProjectsReviewUserPermissionLevelRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListColumnsEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListColumnsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateColumnEndpoint = { + /** + * project_id parameter + */ + project_id: number; + /** + * The name of the column. + */ + name: string; +}; +type ProjectsCreateColumnRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type RateLimitGetEndpoint = {}; +type RateLimitGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsDeleteEndpoint = { + /** + * reaction_id parameter + */ + reaction_id: number; +}; +type ReactionsDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the repository. + */ + name?: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + */ + private?: boolean; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * Updates the default branch for this repository. + */ + default_branch?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; + /** + * `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. + */ + archived?: boolean; +}; +type ReposUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListAssigneesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListAssigneesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCheckAssigneeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * assignee parameter + */ + assignee: string; +}; +type IssuesCheckAssigneeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposEnableAutomatedSecurityFixesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposEnableAutomatedSecurityFixesRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDisableAutomatedSecurityFixesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposDisableAutomatedSecurityFixesRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListBranchesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. + */ + protected?: boolean; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListBranchesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetBranchProtectionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetBranchProtectionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateBranchProtectionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * Require status checks to pass before merging. Set to `null` to disable. + */ + required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null; + /** + * Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + */ + enforce_admins: boolean | null; + /** + * Require at least one approving review on a pull request, before merging. Set to `null` to disable. + */ + required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null; + /** + * Restrict who can push to this branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + */ + restrictions: ReposUpdateBranchProtectionParamsRestrictions | null; +}; +type ReposUpdateBranchProtectionRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveBranchProtectionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveBranchProtectionRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchAdminEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchAdminEnforcementRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchAdminEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposAddProtectedBranchAdminEnforcementRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchAdminEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchAdminEnforcementRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. + */ + dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions; + /** + * Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. + */ + dismiss_stale_reviews?: boolean; + /** + * Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed. + */ + require_code_owner_reviews?: boolean; + /** + * Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6. + */ + required_approving_review_count?: number; +}; +type ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchRequiredSignaturesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchRequiredSignaturesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchRequiredSignaturesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposAddProtectedBranchRequiredSignaturesRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchRequiredSignaturesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchRequiredSignaturesRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchRequiredStatusChecksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchRequiredStatusChecksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateProtectedBranchRequiredStatusChecksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * Require branches to be up to date before merging. + */ + strict?: boolean; + /** + * The list of status checks to require in order to merge into this branch + */ + contexts?: string[]; +}; +type ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchRequiredStatusChecksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListProtectedBranchRequiredStatusChecksContextsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +type ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +type ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +type ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetProtectedBranchRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetProtectedBranchRestrictionsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposRemoveProtectedBranchRestrictionsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetAppsWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetAppsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListAppsWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListAppsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceProtectedBranchAppRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +type ReposReplaceProtectedBranchAppRestrictionsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchAppRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +type ReposAddProtectedBranchAppRestrictionsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchAppRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +type ReposRemoveProtectedBranchAppRestrictionsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetTeamsWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetTeamsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListProtectedBranchTeamRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListProtectedBranchTeamRestrictionsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListTeamsWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListTeamsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceProtectedBranchTeamRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +type ReposReplaceProtectedBranchTeamRestrictionsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchTeamRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +type ReposAddProtectedBranchTeamRestrictionsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchTeamRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +type ReposRemoveProtectedBranchTeamRestrictionsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetUsersWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposGetUsersWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListProtectedBranchUserRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListProtectedBranchUserRestrictionsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListUsersWithAccessToProtectedBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; +}; +type ReposListUsersWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceProtectedBranchUserRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * users parameter + */ + users: string[]; +}; +type ReposReplaceProtectedBranchUserRestrictionsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddProtectedBranchUserRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * users parameter + */ + users: string[]; +}; +type ReposAddProtectedBranchUserRestrictionsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveProtectedBranchUserRestrictionsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * branch parameter + */ + branch: string; + /** + * users parameter + */ + users: string[]; +}; +type ReposRemoveProtectedBranchUserRestrictionsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksCreateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the check. For example, "code-coverage". + */ + name: string; + /** + * The SHA of the commit. + */ + head_sha: string; + /** + * The URL of the integrator's site that has the full details of the check. + */ + details_url?: string; + /** + * A reference for the run on the integrator's system. + */ + external_id?: string; + /** + * The current status. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. + */ + conclusion?: + | "success" + | "failure" + | "neutral" + | "cancelled" + | "timed_out" + | "action_required"; + /** + * The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** + * Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description. + */ + output?: ChecksCreateParamsOutput; + /** + * Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + */ + actions?: ChecksCreateParamsActions[]; +}; +type ChecksCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksUpdateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_run_id parameter + */ + check_run_id: number; + /** + * The name of the check. For example, "code-coverage". + */ + name?: string; + /** + * The URL of the integrator's site that has the full details of the check. + */ + details_url?: string; + /** + * A reference for the run on the integrator's system. + */ + external_id?: string; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * The current status. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. + */ + conclusion?: + | "success" + | "failure" + | "neutral" + | "cancelled" + | "timed_out" + | "action_required"; + /** + * The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** + * Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description. + */ + output?: ChecksUpdateParamsOutput; + /** + * Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + */ + actions?: ChecksUpdateParamsActions[]; +}; +type ChecksUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksGetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_run_id parameter + */ + check_run_id: number; +}; +type ChecksGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksListAnnotationsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_run_id parameter + */ + check_run_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ChecksListAnnotationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksCreateSuiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The sha of the head commit. + */ + head_sha: string; +}; +type ChecksCreateSuiteRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksSetSuitesPreferencesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details. + */ + auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]; +}; +type ChecksSetSuitesPreferencesRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksGetSuiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_suite_id parameter + */ + check_suite_id: number; +}; +type ChecksGetSuiteRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksListForSuiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_suite_id parameter + */ + check_suite_id: number; + /** + * Returns check runs with the specified `name`. + */ + check_name?: string; + /** + * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ChecksListForSuiteRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksRerequestSuiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * check_suite_id parameter + */ + check_suite_id: number; +}; +type ChecksRerequestSuiteRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListCollaboratorsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Filter collaborators returned by their affiliation. Can be one of: + * \* `outside`: All outside collaborators of an organization-owned repository. + * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListCollaboratorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCheckCollaboratorEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * username parameter + */ + username: string; +}; +type ReposCheckCollaboratorRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddCollaboratorEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * username parameter + */ + username: string; + /** + * The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: + * \* `pull` - can pull, but not push to or administer this repository. + * \* `push` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push and administer this repository. + */ + permission?: "pull" | "push" | "admin"; +}; +type ReposAddCollaboratorRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveCollaboratorEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * username parameter + */ + username: string; +}; +type ReposRemoveCollaboratorRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCollaboratorPermissionLevelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * username parameter + */ + username: string; +}; +type ReposGetCollaboratorPermissionLevelRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListCommitCommentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListCommitCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type ReposGetCommitCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The contents of the comment + */ + body: string; +}; +type ReposUpdateCommitCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type ReposDeleteCommitCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForCommitCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForCommitCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListCommitsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). + */ + sha?: string; + /** + * Only commits containing this file path will be returned. + */ + path?: string; + /** + * GitHub login or email address by which to filter by commit author. + */ + author?: string; + /** + * Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + until?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListBranchesForHeadCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; +}; +type ReposListBranchesForHeadCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListCommentsForCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListCommentsForCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateCommitCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; + /** + * The contents of the comment. + */ + body: string; + /** + * Relative path of the file to comment on. + */ + path?: string; + /** + * Line index in the diff to comment on. + */ + position?: number; + /** + * **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. + */ + line?: number; +}; +type ReposCreateCommitCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListPullRequestsAssociatedWithCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListPullRequestsAssociatedWithCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; +}; +type ReposGetCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksListForRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * Returns check runs with the specified `name`. + */ + check_name?: string; + /** + * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ChecksListForRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ChecksListSuitesForRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * Filters check suites by GitHub App `id`. + */ + app_id?: number; + /** + * Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/). + */ + check_name?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ChecksListSuitesForRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCombinedStatusForRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; +}; +type ReposGetCombinedStatusForRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListStatusesForRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListStatusesForRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type CodesOfConductGetForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type CodesOfConductGetForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRetrieveCommunityProfileMetricsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposRetrieveCommunityProfileMetricsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCompareCommitsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * base parameter + */ + base: string; + /** + * head parameter + */ + head: string; +}; +type ReposCompareCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetContentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) + */ + ref?: string; +}; +type ReposGetContentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateOrUpdateFileEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The commit message. + */ + message: string; + /** + * The new file content, using Base64 encoding. + */ + content: string; + /** + * **Required if you are updating a file**. The blob SHA of the file being replaced. + */ + sha?: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * The person that committed the file. Default: the authenticated user. + */ + committer?: ReposCreateOrUpdateFileParamsCommitter; + /** + * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. + */ + author?: ReposCreateOrUpdateFileParamsAuthor; +}; +type ReposCreateOrUpdateFileRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateFileEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The commit message. + */ + message: string; + /** + * The new file content, using Base64 encoding. + */ + content: string; + /** + * **Required if you are updating a file**. The blob SHA of the file being replaced. + */ + sha?: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * The person that committed the file. Default: the authenticated user. + */ + committer?: ReposCreateFileParamsCommitter; + /** + * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. + */ + author?: ReposCreateFileParamsAuthor; +}; +type ReposCreateFileRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateFileEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The commit message. + */ + message: string; + /** + * The new file content, using Base64 encoding. + */ + content: string; + /** + * **Required if you are updating a file**. The blob SHA of the file being replaced. + */ + sha?: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * The person that committed the file. Default: the authenticated user. + */ + committer?: ReposUpdateFileParamsCommitter; + /** + * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. + */ + author?: ReposUpdateFileParamsAuthor; +}; +type ReposUpdateFileRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteFileEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * path parameter + */ + path: string; + /** + * The commit message. + */ + message: string; + /** + * The blob SHA of the file being replaced. + */ + sha: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * object containing information about the committer. + */ + committer?: ReposDeleteFileParamsCommitter; + /** + * object containing information about the author. + */ + author?: ReposDeleteFileParamsAuthor; +}; +type ReposDeleteFileRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListContributorsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Set to `1` or `true` to include anonymous contributors in results. + */ + anon?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListContributorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListDeploymentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The SHA recorded at creation time. + */ + sha?: string; + /** + * The name of the ref. This can be a branch, tag, or SHA. + */ + ref?: string; + /** + * The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). + */ + task?: string; + /** + * The name of the environment that was deployed to (e.g., `staging` or `production`). + */ + environment?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListDeploymentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateDeploymentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The ref to deploy. This can be a branch, tag, or SHA. + */ + ref: string; + /** + * Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). + */ + task?: string; + /** + * Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. + */ + auto_merge?: boolean; + /** + * The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. + */ + required_contexts?: string[]; + /** + * JSON payload with extra information about the deployment. + */ + payload?: string; + /** + * Name for the target deployment environment (e.g., `production`, `staging`, `qa`). + */ + environment?: string; + /** + * Short description of the deployment. + */ + description?: string; + /** + * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + transient_environment?: boolean; + /** + * Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + production_environment?: boolean; +}; +type ReposCreateDeploymentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetDeploymentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; +}; +type ReposGetDeploymentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListDeploymentStatusesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListDeploymentStatusesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateDeploymentStatusEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; + /** + * The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + */ + state: + | "error" + | "failure" + | "inactive" + | "in_progress" + | "queued" + | "pending" + | "success"; + /** + * The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + */ + target_url?: string; + /** + * The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + log_url?: string; + /** + * A short description of the status. The maximum description length is 140 characters. + */ + description?: string; + /** + * Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + */ + environment?: "production" | "staging" | "qa"; + /** + * Sets the URL for accessing your environment. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + environment_url?: string; + /** + * Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` + * **Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + auto_inactive?: boolean; +}; +type ReposCreateDeploymentStatusRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetDeploymentStatusEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * deployment_id parameter + */ + deployment_id: number; + /** + * status_id parameter + */ + status_id: number; +}; +type ReposGetDeploymentStatusRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateDispatchEventEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * **Required:** A custom webhook event name. + */ + event_type?: string; +}; +type ReposCreateDispatchEventRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListDownloadsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListDownloadsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetDownloadEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * download_id parameter + */ + download_id: number; +}; +type ReposGetDownloadRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteDownloadEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * download_id parameter + */ + download_id: number; +}; +type ReposDeleteDownloadRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListRepoEventsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListRepoEventsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListForksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The sort order. Can be either `newest`, `oldest`, or `stargazers`. + */ + sort?: "newest" | "oldest" | "stargazers"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListForksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateForkEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Optional parameter to specify the organization name if forking into an organization. + */ + organization?: string; +}; +type ReposCreateForkRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateBlobEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The new blob's content. + */ + content: string; + /** + * The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + */ + encoding?: string; +}; +type GitCreateBlobRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetBlobEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * file_sha parameter + */ + file_sha: string; +}; +type GitGetBlobRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The commit message + */ + message: string; + /** + * The SHA of the tree object this commit points to + */ + tree: string; + /** + * The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. + */ + parents: string[]; + /** + * Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. + */ + author?: GitCreateCommitParamsAuthor; + /** + * Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. + */ + committer?: GitCreateCommitParamsCommitter; + /** + * The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. + */ + signature?: string; +}; +type GitCreateCommitRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetCommitEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * commit_sha parameter + */ + commit_sha: string; +}; +type GitGetCommitRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitListMatchingRefsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GitListMatchingRefsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; +}; +type GitGetRefRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. + */ + ref: string; + /** + * The SHA1 value for this reference. + */ + sha: string; +}; +type GitCreateRefRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitUpdateRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; + /** + * The SHA1 value to set this reference to + */ + sha: string; + /** + * Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. + */ + force?: boolean; +}; +type GitUpdateRefRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitDeleteRefEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * ref parameter + */ + ref: string; +}; +type GitDeleteRefRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateTagEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The tag's name. This is typically a version (e.g., "v0.0.1"). + */ + tag: string; + /** + * The tag message. + */ + message: string; + /** + * The SHA of the git object this is tagging. + */ + object: string; + /** + * The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. + */ + type: "commit" | "tree" | "blob"; + /** + * An object with information about the individual creating the tag. + */ + tagger?: GitCreateTagParamsTagger; +}; +type GitCreateTagRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetTagEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * tag_sha parameter + */ + tag_sha: string; +}; +type GitGetTagRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitCreateTreeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. + */ + tree: GitCreateTreeParamsTree[]; + /** + * The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted. + */ + base_tree?: string; +}; +type GitCreateTreeRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GitGetTreeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * tree_sha parameter + */ + tree_sha: string; + /** + * recursive parameter + */ + recursive?: "1"; +}; +type GitGetTreeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListHooksEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListHooksRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. + */ + name?: string; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). + */ + config: ReposCreateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +type ReposCreateHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type ReposGetHookRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). + */ + config?: ReposUpdateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events. + */ + events?: string[]; + /** + * Determines a list of events to be added to the list of events that the Hook triggers for. + */ + add_events?: string[]; + /** + * Determines a list of events to be removed from the list of events that the Hook triggers for. + */ + remove_events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +type ReposUpdateHookRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type ReposDeleteHookRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposPingHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type ReposPingHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposTestPushHookEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * hook_id parameter + */ + hook_id: number; +}; +type ReposTestPushHookRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsStartImportEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The URL of the originating repository. + */ + vcs_url: string; + /** + * The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. + */ + vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + /** + * If authentication is required, the username to provide to `vcs_url`. + */ + vcs_username?: string; + /** + * If authentication is required, the password to provide to `vcs_url`. + */ + vcs_password?: string; + /** + * For a tfvc import, the name of the project that is being imported. + */ + tfvc_project?: string; +}; +type MigrationsStartImportRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetImportProgressEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type MigrationsGetImportProgressRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsUpdateImportEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The username to provide to the originating repository. + */ + vcs_username?: string; + /** + * The password to provide to the originating repository. + */ + vcs_password?: string; +}; +type MigrationsUpdateImportRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsCancelImportEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type MigrationsCancelImportRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetCommitAuthorsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step. + */ + since?: string; +}; +type MigrationsGetCommitAuthorsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsMapCommitAuthorEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * author_id parameter + */ + author_id: number; + /** + * The new Git author email. + */ + email?: string; + /** + * The new Git author name. + */ + name?: string; +}; +type MigrationsMapCommitAuthorRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetLargeFilesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type MigrationsGetLargeFilesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsSetLfsPreferenceEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import). + */ + use_lfs: "opt_in" | "opt_out"; +}; +type MigrationsSetLfsPreferenceRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetRepoInstallationEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type AppsGetRepoInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsFindRepoInstallationEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type AppsFindRepoInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsGetRestrictionsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type InteractionsGetRestrictionsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsAddOrUpdateRestrictionsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`. + */ + limit: "existing_users" | "contributors_only" | "collaborators_only"; +}; +type InteractionsAddOrUpdateRestrictionsForRepoRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type InteractionsRemoveRestrictionsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type InteractionsRemoveRestrictionsForRepoRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListInvitationsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListInvitationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteInvitationEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * invitation_id parameter + */ + invitation_id: number; +}; +type ReposDeleteInvitationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateInvitationEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * invitation_id parameter + */ + invitation_id: number; + /** + * The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`. + */ + permissions?: "read" | "write" | "admin"; +}; +type ReposUpdateInvitationRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. + */ + milestone?: string; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. + */ + assignee?: string; + /** + * The user that created the issue. + */ + creator?: string; + /** + * A user that's mentioned in the issue. + */ + mentioned?: string; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCreateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The title of the issue. + */ + title: string; + /** + * The contents of the issue. + */ + body?: string; + /** + * Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ + */ + assignee?: string; + /** + * The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._ + */ + milestone?: number; + /** + * Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ + */ + labels?: string[]; + /** + * Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + */ + assignees?: string[]; +}; +type IssuesCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListCommentsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Either `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * Either `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; +}; +type IssuesListCommentsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesGetCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUpdateCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The contents of the comment. + */ + body: string; +}; +type IssuesUpdateCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesDeleteCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type IssuesDeleteCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForIssueCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForIssueCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForIssueCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForIssueCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListEventsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListEventsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetEventEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * event_id parameter + */ + event_id: number; +}; +type IssuesGetEventRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; +}; +type IssuesGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUpdateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The title of the issue. + */ + title?: string; + /** + * The contents of the issue. + */ + body?: string; + /** + * Login for the user that this issue should be assigned to. **This field is deprecated.** + */ + assignee?: string; + /** + * State of the issue. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ + */ + milestone?: number | null; + /** + * Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ + */ + labels?: string[]; + /** + * Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + */ + assignees?: string[]; +}; +type IssuesUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesAddAssigneesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ + */ + assignees?: string[]; +}; +type IssuesAddAssigneesRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesRemoveAssigneesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ + */ + assignees?: string[]; +}; +type IssuesRemoveAssigneesRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListCommentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCreateCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The contents of the comment. + */ + body: string; +}; +type IssuesCreateCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListEventsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListEventsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListLabelsOnIssueEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListLabelsOnIssueRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesAddLabelsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. + */ + labels: string[]; +}; +type IssuesAddLabelsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesReplaceLabelsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. + */ + labels?: string[]; +}; +type IssuesReplaceLabelsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesRemoveLabelsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; +}; +type IssuesRemoveLabelsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesRemoveLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * name parameter + */ + name: string; +}; +type IssuesRemoveLabelRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesLockEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: + * \* `off-topic` + * \* `too heated` + * \* `resolved` + * \* `spam` + */ + lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; +}; +type IssuesLockRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUnlockEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; +}; +type IssuesUnlockRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForIssueEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForIssueRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForIssueEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForIssueRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListEventsForTimelineEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * issue_number parameter + */ + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListEventsForTimelineRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListDeployKeysEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListDeployKeysRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAddDeployKeyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * A name for the key. + */ + title?: string; + /** + * The contents of the key. + */ + key: string; + /** + * If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + * + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/)." + */ + read_only?: boolean; +}; +type ReposAddDeployKeyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetDeployKeyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * key_id parameter + */ + key_id: number; +}; +type ReposGetDeployKeyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRemoveDeployKeyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * key_id parameter + */ + key_id: number; +}; +type ReposRemoveDeployKeyRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListLabelsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListLabelsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCreateLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). + */ + name: string; + /** + * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + */ + color: string; + /** + * A short description of the label. + */ + description?: string; +}; +type IssuesCreateLabelRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * name parameter + */ + name: string; +}; +type IssuesGetLabelRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUpdateLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * name parameter + */ + name: string; + /** + * The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). + */ + new_name?: string; + /** + * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + */ + color?: string; + /** + * A short description of the label. + */ + description?: string; +}; +type IssuesUpdateLabelRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesDeleteLabelEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * name parameter + */ + name: string; +}; +type IssuesDeleteLabelRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListLanguagesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposListLanguagesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type LicensesGetForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type LicensesGetForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposMergeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the base branch that the head will be merged into. + */ + base: string; + /** + * The head to merge. This can be a branch name or a commit SHA1. + */ + head: string; + /** + * Commit message to use for the merge commit. If omitted, a default message will be used. + */ + commit_message?: string; +}; +type ReposMergeRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListMilestonesForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The state of the milestone. Either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * What to sort results by. Either `due_on` or `completeness`. + */ + sort?: "due_on" | "completeness"; + /** + * The direction of the sort. Either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListMilestonesForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesCreateMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The title of the milestone. + */ + title: string; + /** + * The state of the milestone. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * A description of the milestone. + */ + description?: string; + /** + * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + due_on?: string; +}; +type IssuesCreateMilestoneRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesGetMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * milestone_number parameter + */ + milestone_number: number; +}; +type IssuesGetMilestoneRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesUpdateMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * milestone_number parameter + */ + milestone_number: number; + /** + * The title of the milestone. + */ + title?: string; + /** + * The state of the milestone. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * A description of the milestone. + */ + description?: string; + /** + * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + due_on?: string; +}; +type IssuesUpdateMilestoneRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesDeleteMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * milestone_number parameter + */ + milestone_number: number; +}; +type IssuesDeleteMilestoneRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListLabelsForMilestoneEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * milestone_number parameter + */ + milestone_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListLabelsForMilestoneRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListNotificationsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * If `true`, show notifications marked as read. + */ + all?: boolean; + /** + * If `true`, only shows notifications in which the user is directly participating or mentioned. + */ + participating?: boolean; + /** + * Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + before?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListNotificationsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityMarkNotificationsAsReadForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; +}; +type ActivityMarkNotificationsAsReadForRepoRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetPagesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetPagesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposEnablePagesSiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * source parameter + */ + source?: ReposEnablePagesSiteParamsSource; +}; +type ReposEnablePagesSiteRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDisablePagesSiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposDisablePagesSiteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateInformationAboutPagesSiteEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/)." + */ + cname?: string; + /** + * Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `"gh-pages"`, `"master"`, and `"master /docs"`. + */ + source?: '"gh-pages"' | '"master"' | '"master /docs"'; +}; +type ReposUpdateInformationAboutPagesSiteRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposRequestPageBuildEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposRequestPageBuildRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListPagesBuildsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListPagesBuildsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetLatestPagesBuildEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetLatestPagesBuildRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetPagesBuildEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * build_id parameter + */ + build_id: number; +}; +type ReposGetPagesBuildRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +}; +type ProjectsCreateForRepoRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Either `open`, `closed`, or `all` to filter by state. + */ + state?: "open" | "closed" | "all"; + /** + * Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. + */ + head?: string; + /** + * Filter pulls by base branch name. Example: `gh-pages`. + */ + base?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). + */ + sort?: "created" | "updated" | "popularity" | "long-running"; + /** + * The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The title of the new pull request. + */ + title: string; + /** + * The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. + */ + head: string; + /** + * The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. + */ + base: string; + /** + * The contents of the pull request. + */ + body?: string; + /** + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + */ + maintainer_can_modify?: boolean; + /** + * Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. + */ + draft?: boolean; +}; +type PullsCreateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListCommentsForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Can be either `created` or `updated` comments. + */ + sort?: "created" | "updated"; + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListCommentsForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsGetCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type PullsGetCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsUpdateCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The text of the reply to the review comment. + */ + body: string; +}; +type PullsUpdateCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsDeleteCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; +}; +type PullsDeleteCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForPullRequestReviewCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForPullRequestReviewCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForPullRequestReviewCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForPullRequestReviewCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsGetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; +}; +type PullsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsUpdateEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The title of the pull request. + */ + title?: string; + /** + * The contents of the pull request. + */ + body?: string; + /** + * State of this Pull Request. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. + */ + base?: string; + /** + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + */ + maintainer_can_modify?: boolean; +}; +type PullsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListCommentsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Can be either `created` or `updated` comments. + */ + sort?: "created" | "updated"; + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateCommentEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The text of the review comment. + */ + body: string; + /** + * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. + */ + commit_id: string; + /** + * The relative path to the file that necessitates a comment. + */ + path: string; + /** + * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + */ + position?: number; + /** + * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + */ + side?: "LEFT" | "RIGHT"; + /** + * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. + */ + line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. + */ + start_line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + */ + start_side?: "LEFT" | "RIGHT" | "side"; +}; +type PullsCreateCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateCommentReplyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The text of the review comment. + */ + body: string; + /** + * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. + */ + commit_id: string; + /** + * The relative path to the file that necessitates a comment. + */ + path: string; + /** + * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + */ + position?: number; + /** + * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + */ + side?: "LEFT" | "RIGHT"; + /** + * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. + */ + line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. + */ + start_line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + */ + start_side?: "LEFT" | "RIGHT" | "side"; +}; +type PullsCreateCommentReplyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateReviewCommentReplyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * comment_id parameter + */ + comment_id: number; + /** + * The text of the review comment. + */ + body: string; +}; +type PullsCreateReviewCommentReplyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListCommitsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListFilesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListFilesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCheckIfMergedEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; +}; +type PullsCheckIfMergedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsMergeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Title for the automatic commit message. + */ + commit_title?: string; + /** + * Extra detail to append to automatic commit message. + */ + commit_message?: string; + /** + * SHA that pull request head must match to allow merge. + */ + sha?: string; + /** + * Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. + */ + merge_method?: "merge" | "squash" | "rebase"; +}; +type PullsMergeRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListReviewRequestsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListReviewRequestsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateReviewRequestEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * An array of user `login`s that will be requested. + */ + reviewers?: string[]; + /** + * An array of team `slug`s that will be requested. + */ + team_reviewers?: string[]; +}; +type PullsCreateReviewRequestRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsDeleteReviewRequestEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * An array of user `login`s that will be removed. + */ + reviewers?: string[]; + /** + * An array of team `slug`s that will be removed. + */ + team_reviewers?: string[]; +}; +type PullsDeleteReviewRequestRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsListReviewsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsListReviewsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsCreateReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. + */ + commit_id?: string; + /** + * **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. + */ + body?: string; + /** + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready. + */ + event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + /** + * Use the following table to specify the location, destination, and contents of the draft review comment. + */ + comments?: PullsCreateReviewParamsComments[]; +}; +type PullsCreateReviewRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsGetReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; +}; +type PullsGetReviewRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsDeletePendingReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; +}; +type PullsDeletePendingReviewRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsUpdateReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; + /** + * The body text of the pull request review. + */ + body: string; +}; +type PullsUpdateReviewRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsGetCommentsForReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type PullsGetCommentsForReviewRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsDismissReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; + /** + * The message for the pull request review dismissal + */ + message: string; +}; +type PullsDismissReviewRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsSubmitReviewEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * review_id parameter + */ + review_id: number; + /** + * The body text of the pull request review + */ + body?: string; + /** + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. + */ + event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; +}; +type PullsSubmitReviewRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type PullsUpdateBranchEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * pull_number parameter + */ + pull_number: number; + /** + * The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. + */ + expected_head_sha?: string; +}; +type PullsUpdateBranchRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetReadmeEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) + */ + ref?: string; +}; +type ReposGetReadmeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListReleasesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListReleasesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The name of the tag. + */ + tag_name: string; + /** + * Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). + */ + target_commitish?: string; + /** + * The name of the release. + */ + name?: string; + /** + * Text describing the contents of the tag. + */ + body?: string; + /** + * `true` to create a draft (unpublished) release, `false` to create a published one. + */ + draft?: boolean; + /** + * `true` to identify the release as a prerelease. `false` to identify the release as a full release. + */ + prerelease?: boolean; +}; +type ReposCreateReleaseRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetReleaseAssetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * asset_id parameter + */ + asset_id: number; +}; +type ReposGetReleaseAssetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateReleaseAssetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * asset_id parameter + */ + asset_id: number; + /** + * The file name of the asset. + */ + name?: string; + /** + * An alternate short description of the asset. Used in place of the filename. + */ + label?: string; +}; +type ReposUpdateReleaseAssetRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteReleaseAssetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * asset_id parameter + */ + asset_id: number; +}; +type ReposDeleteReleaseAssetRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetLatestReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetLatestReleaseRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetReleaseByTagEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * tag parameter + */ + tag: string; +}; +type ReposGetReleaseByTagRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; +}; +type ReposGetReleaseRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposUpdateReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; + /** + * The name of the tag. + */ + tag_name?: string; + /** + * Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). + */ + target_commitish?: string; + /** + * The name of the release. + */ + name?: string; + /** + * Text describing the contents of the tag. + */ + body?: string; + /** + * `true` makes the release a draft, and `false` publishes the release. + */ + draft?: boolean; + /** + * `true` to identify the release as a prerelease, `false` to identify the release as a full release. + */ + prerelease?: boolean; +}; +type ReposUpdateReleaseRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeleteReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; +}; +type ReposDeleteReleaseRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListAssetsForReleaseEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListAssetsForReleaseRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListStargazersForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListStargazersForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCodeFrequencyStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetCodeFrequencyStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetCommitActivityStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetCommitActivityStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetContributorsStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetContributorsStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetParticipationStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetParticipationStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetPunchCardStatsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetPunchCardStatsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateStatusEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * sha parameter + */ + sha: string; + /** + * The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. + */ + state: "error" | "failure" | "pending" | "success"; + /** + * The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` + */ + target_url?: string; + /** + * A short description of the status. + */ + description?: string; + /** + * A string label to differentiate this status from the status of other systems. + */ + context?: string; +}; +type ReposCreateStatusRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListWatchersForRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListWatchersForRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityGetRepoSubscriptionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityGetRepoSubscriptionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivitySetRepoSubscriptionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Determines if notifications should be received from this repository. + */ + subscribed?: boolean; + /** + * Determines if all notifications should be blocked from this repository. + */ + ignored?: boolean; +}; +type ActivitySetRepoSubscriptionRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityDeleteRepoSubscriptionEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityDeleteRepoSubscriptionRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListTagsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListTagsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListTeamsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListTeamsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListTopicsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposListTopicsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposReplaceTopicsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. + */ + names: string[]; +}; +type ReposReplaceTopicsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetClonesEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Must be one of: `day`, `week`. + */ + per?: "day" | "week"; +}; +type ReposGetClonesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetTopPathsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetTopPathsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetTopReferrersEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposGetTopReferrersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetViewsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * Must be one of: `day`, `week`. + */ + per?: "day" | "week"; +}; +type ReposGetViewsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposTransferEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * **Required:** The username or organization name the repository will be transferred to. + */ + new_owner?: string; + /** + * ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. + */ + team_ids?: number[]; +}; +type ReposTransferRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCheckVulnerabilityAlertsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposCheckVulnerabilityAlertsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposEnableVulnerabilityAlertsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposEnableVulnerabilityAlertsRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDisableVulnerabilityAlertsEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ReposDisableVulnerabilityAlertsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposGetArchiveLinkEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * archive_format parameter + */ + archive_format: string; + /** + * ref parameter + */ + ref: string; +}; +type ReposGetArchiveLinkRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateUsingTemplateEndpoint = { + /** + * template_owner parameter + */ + template_owner: string; + /** + * template_repo parameter + */ + template_repo: string; + /** + * The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. + */ + owner?: string; + /** + * The name of the new repository. + */ + name: string; + /** + * A short description of the new repository. + */ + description?: string; + /** + * Either `true` to create a new private repository or `false` to create a new public one. + */ + private?: boolean; +}; +type ReposCreateUsingTemplateRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListPublicEndpoint = { + /** + * The integer ID of the last Repository that you've seen. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListPublicRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimListProvisionedIdentitiesEndpoint = { + /** + * org parameter + */ + org: string; + /** + * Used for pagination: the index of the first result to return. + */ + startIndex?: number; + /** + * Used for pagination: the number of results to return. + */ + count?: number; + /** + * Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: `?filter=userName%20eq%20\"Octocat\"`. + */ + filter?: string; +}; +type ScimListProvisionedIdentitiesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimProvisionAndInviteUsersEndpoint = { + /** + * org parameter + */ + org: string; +}; +type ScimProvisionAndInviteUsersRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimProvisionInviteUsersEndpoint = { + /** + * org parameter + */ + org: string; +}; +type ScimProvisionInviteUsersRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimGetProvisioningDetailsForUserEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimGetProvisioningDetailsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimReplaceProvisionedUserInformationEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimReplaceProvisionedUserInformationRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimUpdateProvisionedOrgMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimUpdateProvisionedOrgMembershipRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimUpdateUserAttributeEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimUpdateUserAttributeRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ScimRemoveUserFromOrgEndpoint = { + /** + * org parameter + */ + org: string; + /** + * scim_user_id parameter + */ + scim_user_id: number; +}; +type ScimRemoveUserFromOrgRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchCodeEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching code](https://help.github.com/articles/searching-code/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "indexed"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchCodeRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchCommitsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching commits](https://help.github.com/articles/searching-commits/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "author-date" | "committer-date"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchCommitsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchIssuesAndPullRequestsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: + | "comments" + | "reactions" + | "reactions-+1" + | "reactions--1" + | "reactions-smile" + | "reactions-thinking_face" + | "reactions-heart" + | "reactions-tada" + | "interactions" + | "created" + | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchIssuesAndPullRequestsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchIssuesEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: + | "comments" + | "reactions" + | "reactions-+1" + | "reactions--1" + | "reactions-smile" + | "reactions-thinking_face" + | "reactions-heart" + | "reactions-tada" + | "interactions" + | "created" + | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchIssuesRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchLabelsEndpoint = { + /** + * The id of the repository. + */ + repository_id: number; + /** + * The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). + */ + q: string; + /** + * Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "created" | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; +}; +type SearchLabelsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchReposEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchReposRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchTopicsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). + */ + q: string; +}; +type SearchTopicsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type SearchUsersEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching users](https://help.github.com/articles/searching-users/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "followers" | "repositories" | "joined"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type SearchUsersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetEndpoint = { + /** + * team_id parameter + */ + team_id: number; +}; +type TeamsGetRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsUpdateEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter. + */ + parent_team_id?: number; +}; +type TeamsUpdateRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsDeleteEndpoint = { + /** + * team_id parameter + */ + team_id: number; +}; +type TeamsDeleteRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListDiscussionsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListDiscussionsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * The discussion post's title. + */ + title: string; + /** + * The discussion post's body text. + */ + body: string; + /** + * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + */ + private?: boolean; +}; +type TeamsCreateDiscussionRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; +}; +type TeamsGetDiscussionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsUpdateDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * The discussion post's title. + */ + title?: string; + /** + * The discussion post's body text. + */ + body?: string; +}; +type TeamsUpdateDiscussionRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsDeleteDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; +}; +type TeamsDeleteDiscussionRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListDiscussionCommentsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListDiscussionCommentsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +type TeamsCreateDiscussionCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; +}; +type TeamsGetDiscussionCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsUpdateDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +type TeamsUpdateDiscussionCommentRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsDeleteDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; +}; +type TeamsDeleteDiscussionCommentRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForTeamDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForTeamDiscussionCommentRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForTeamDiscussionCommentEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * comment_number parameter + */ + comment_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForTeamDiscussionCommentRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsListForTeamDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. + */ + content?: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReactionsListForTeamDiscussionRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReactionsCreateForTeamDiscussionEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * discussion_number parameter + */ + discussion_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. + */ + content: + | "+1" + | "-1" + | "laugh" + | "confused" + | "heart" + | "hooray" + | "rocket" + | "eyes"; +}; +type ReactionsCreateForTeamDiscussionRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListPendingInvitationsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListPendingInvitationsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListMembersEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListMembersRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetMemberEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsGetMemberRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddMemberEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsAddMemberRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsRemoveMemberEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsRemoveMemberRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsGetMembershipEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsGetMembershipRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddOrUpdateMembershipEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; +}; +type TeamsAddOrUpdateMembershipRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsRemoveMembershipEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * username parameter + */ + username: string; +}; +type TeamsRemoveMembershipRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListProjectsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListProjectsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsReviewProjectEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * project_id parameter + */ + project_id: number; +}; +type TeamsReviewProjectRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddOrUpdateProjectEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * project_id parameter + */ + project_id: number; + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team. + */ + permission?: "read" | "write" | "admin"; +}; +type TeamsAddOrUpdateProjectRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsRemoveProjectEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * project_id parameter + */ + project_id: number; +}; +type TeamsRemoveProjectRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListReposEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListReposRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCheckManagesRepoEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type TeamsCheckManagesRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsAddOrUpdateRepoEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + * **Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team. + */ + permission?: "pull" | "push" | "admin"; +}; +type TeamsAddOrUpdateRepoRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsRemoveRepoEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type TeamsRemoveRepoRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListIdPGroupsEndpoint = { + /** + * team_id parameter + */ + team_id: number; +}; +type TeamsListIdPGroupsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsCreateOrUpdateIdPGroupConnectionsEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. + */ + groups: TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups[]; +}; +type TeamsCreateOrUpdateIdPGroupConnectionsRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListChildEndpoint = { + /** + * team_id parameter + */ + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListChildRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetAuthenticatedEndpoint = {}; +type UsersGetAuthenticatedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersUpdateAuthenticatedEndpoint = { + /** + * The new name of the user. + */ + name?: string; + /** + * The publicly visible email address of the user. + */ + email?: string; + /** + * The new blog URL of the user. + */ + blog?: string; + /** + * The new company of the user. + */ + company?: string; + /** + * The new location of the user. + */ + location?: string; + /** + * The new hiring availability of the user. + */ + hireable?: boolean; + /** + * The new short biography of the user. + */ + bio?: string; +}; +type UsersUpdateAuthenticatedRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListBlockedEndpoint = {}; +type UsersListBlockedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCheckBlockedEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersCheckBlockedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersBlockEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersBlockRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersUnblockEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersUnblockRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersTogglePrimaryEmailVisibilityEndpoint = { + /** + * Specify the _primary_ email address that needs a visibility change. + */ + email: string; + /** + * Use `public` to enable an authenticated user to view the specified email address, or use `private` so this primary email address cannot be seen publicly. + */ + visibility: string; +}; +type UsersTogglePrimaryEmailVisibilityRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListEmailsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListEmailsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersAddEmailsEndpoint = { + /** + * Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. + */ + emails: string[]; +}; +type UsersAddEmailsRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersDeleteEmailsEndpoint = { + /** + * Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. + */ + emails: string[]; +}; +type UsersDeleteEmailsRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListFollowersForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListFollowersForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListFollowingForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListFollowingForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCheckFollowingEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersCheckFollowingRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersFollowEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersFollowRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersUnfollowEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersUnfollowRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListGpgKeysEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListGpgKeysRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCreateGpgKeyEndpoint = { + /** + * Your GPG key, generated in ASCII-armored format. See "[Generating a new GPG key](https://help.github.com/articles/generating-a-new-gpg-key/)" for help creating a GPG key. + */ + armored_public_key?: string; +}; +type UsersCreateGpgKeyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetGpgKeyEndpoint = { + /** + * gpg_key_id parameter + */ + gpg_key_id: number; +}; +type UsersGetGpgKeyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersDeleteGpgKeyEndpoint = { + /** + * gpg_key_id parameter + */ + gpg_key_id: number; +}; +type UsersDeleteGpgKeyRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListInstallationsForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListInstallationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListInstallationReposForAuthenticatedUserEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListInstallationReposForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsAddRepoToInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; + /** + * repository_id parameter + */ + repository_id: number; +}; +type AppsAddRepoToInstallationRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsRemoveRepoFromInstallationEndpoint = { + /** + * installation_id parameter + */ + installation_id: number; + /** + * repository_id parameter + */ + repository_id: number; +}; +type AppsRemoveRepoFromInstallationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type IssuesListForAuthenticatedUserEndpoint = { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type IssuesListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListPublicKeysEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListPublicKeysRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCreatePublicKeyEndpoint = { + /** + * A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air". + */ + title?: string; + /** + * The public SSH key to add to your GitHub account. See "[Generating a new SSH key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)" for guidance on how to create a public SSH key. + */ + key?: string; +}; +type UsersCreatePublicKeyRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetPublicKeyEndpoint = { + /** + * key_id parameter + */ + key_id: number; +}; +type UsersGetPublicKeyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersDeletePublicKeyEndpoint = { + /** + * key_id parameter + */ + key_id: number; +}; +type UsersDeletePublicKeyRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListMarketplacePurchasesForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListMarketplacePurchasesForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type AppsListMarketplacePurchasesForAuthenticatedUserStubbedRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListMembershipsEndpoint = { + /** + * Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. + */ + state?: "active" | "pending"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListMembershipsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsGetMembershipForAuthenticatedUserEndpoint = { + /** + * org parameter + */ + org: string; +}; +type OrgsGetMembershipForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsUpdateMembershipEndpoint = { + /** + * org parameter + */ + org: string; + /** + * The state that the membership should be in. Only `"active"` will be accepted. + */ + state: "active"; +}; +type OrgsUpdateMembershipRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsStartForAuthenticatedUserEndpoint = { + /** + * An array of repositories to include in the migration. + */ + repositories: string[]; + /** + * Locks the `repositories` to prevent changes during the migration when set to `true`. + */ + lock_repositories?: boolean; + /** + * Does not include attachments uploaded to GitHub.com in the migration data when set to `true`. Excluding attachments will reduce the migration archive file size. + */ + exclude_attachments?: boolean; +}; +type MigrationsStartForAuthenticatedUserRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type MigrationsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetStatusForAuthenticatedUserEndpoint = { + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsGetStatusForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsGetArchiveForAuthenticatedUserEndpoint = { + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsGetArchiveForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsDeleteArchiveForAuthenticatedUserEndpoint = { + /** + * migration_id parameter + */ + migration_id: number; +}; +type MigrationsDeleteArchiveForAuthenticatedUserRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type MigrationsUnlockRepoForAuthenticatedUserEndpoint = { + /** + * migration_id parameter + */ + migration_id: number; + /** + * repo_name parameter + */ + repo_name: string; +}; +type MigrationsUnlockRepoForAuthenticatedUserRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsCreateForAuthenticatedUserEndpoint = { + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +}; +type ProjectsCreateForAuthenticatedUserRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListPublicEmailsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListPublicEmailsRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListEndpoint = { + /** + * Can be one of `all`, `public`, or `private`. + */ + visibility?: "all" | "public" | "private"; + /** + * Comma-separated list of values. Can include: + * \* `owner`: Repositories that are owned by the authenticated user. + * \* `collaborator`: Repositories that the user has been added to as a collaborator. + * \* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. + */ + affiliation?: string; + /** + * Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` + * + * Will cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. + */ + type?: "all" | "owner" | "public" | "private" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposCreateForAuthenticatedUserEndpoint = { + /** + * The name of the repository. + */ + name: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account. + */ + private?: boolean; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + */ + team_id?: number; + /** + * Pass `true` to create an initial commit with empty README. + */ + auto_init?: boolean; + /** + * Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". + */ + gitignore_template?: string; + /** + * Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". + */ + license_template?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; +}; +type ReposCreateForAuthenticatedUserRequestOptions = { + method: "POST"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListInvitationsForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListInvitationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposAcceptInvitationEndpoint = { + /** + * invitation_id parameter + */ + invitation_id: number; +}; +type ReposAcceptInvitationRequestOptions = { + method: "PATCH"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposDeclineInvitationEndpoint = { + /** + * invitation_id parameter + */ + invitation_id: number; +}; +type ReposDeclineInvitationRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReposStarredByAuthenticatedUserEndpoint = { + /** + * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). + */ + sort?: "created" | "updated"; + /** + * One of `asc` (ascending) or `desc` (descending). + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReposStarredByAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityCheckStarringRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityCheckStarringRepoRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityStarRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityStarRepoRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityUnstarRepoEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityUnstarRepoRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListWatchedReposForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListWatchedReposForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityCheckWatchingRepoLegacyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityCheckWatchingRepoLegacyRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityWatchRepoLegacyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityWatchRepoLegacyRequestOptions = { + method: "PUT"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityStopWatchingRepoLegacyEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; +}; +type ActivityStopWatchingRepoLegacyRequestOptions = { + method: "DELETE"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type TeamsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type TeamsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListEndpoint = { + /** + * The integer ID of the last User that you've seen. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetByUsernameEndpoint = { + /** + * username parameter + */ + username: string; +}; +type UsersGetByUsernameRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListEventsForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListEventsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListEventsForOrgEndpoint = { + /** + * username parameter + */ + username: string; + /** + * org parameter + */ + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListEventsForOrgRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListPublicEventsForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListPublicEventsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListFollowersForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListFollowersForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListFollowingForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListFollowingForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersCheckFollowingForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * target_user parameter + */ + target_user: string; +}; +type UsersCheckFollowingForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type GistsListPublicForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type GistsListPublicForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListGpgKeysForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListGpgKeysForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersGetContextForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. + */ + subject_type?: "organization" | "repository" | "issue" | "pull_request"; + /** + * Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. + */ + subject_id?: string; +}; +type UsersGetContextForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsGetUserInstallationEndpoint = { + /** + * username parameter + */ + username: string; +}; +type AppsGetUserInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type AppsFindUserInstallationEndpoint = { + /** + * username parameter + */ + username: string; +}; +type AppsFindUserInstallationRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type UsersListPublicKeysForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type UsersListPublicKeysForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type OrgsListForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type OrgsListForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ProjectsListForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ProjectsListForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReceivedEventsForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReceivedEventsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReceivedPublicEventsForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReceivedPublicEventsForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ReposListForUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Can be one of `all`, `owner`, `member`. + */ + type?: "all" | "owner" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ReposListForUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReposStarredByUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). + */ + sort?: "created" | "updated"; + /** + * One of `asc` (ascending) or `desc` (descending). + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReposStarredByUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +type ActivityListReposWatchedByUserEndpoint = { + /** + * username parameter + */ + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +type ActivityListReposWatchedByUserRequestOptions = { + method: "GET"; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; +}; + +export type AppsCreateInstallationTokenParamsPermissions = {}; +export type GistsCreateParamsFiles = { + content?: string; +}; +export type GistsUpdateParamsFiles = { + content?: string; + filename?: string; +}; +export type OrgsCreateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +export type OrgsUpdateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +export type ReposUpdateBranchProtectionParamsRequiredStatusChecks = { + strict: boolean; + contexts: string[]; +}; +export type ReposUpdateBranchProtectionParamsRequiredPullRequestReviews = { + dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions; + dismiss_stale_reviews?: boolean; + require_code_owner_reviews?: boolean; + required_approving_review_count?: number; +}; +export type ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions = { + users?: string[]; + teams?: string[]; +}; +export type ReposUpdateBranchProtectionParamsRestrictions = { + users: string[]; + teams: string[]; + apps?: string[]; +}; +export type ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions = { + users?: string[]; + teams?: string[]; +}; +export type ChecksCreateParamsOutput = { + title: string; + summary: string; + text?: string; + annotations?: ChecksCreateParamsOutputAnnotations[]; + images?: ChecksCreateParamsOutputImages[]; +}; +export type ChecksCreateParamsOutputAnnotations = { + path: string; + start_line: number; + end_line: number; + start_column?: number; + end_column?: number; + annotation_level: "notice" | "warning" | "failure"; + message: string; + title?: string; + raw_details?: string; +}; +export type ChecksCreateParamsOutputImages = { + alt: string; + image_url: string; + caption?: string; +}; +export type ChecksCreateParamsActions = { + label: string; + description: string; + identifier: string; +}; +export type ChecksUpdateParamsOutput = { + title?: string; + summary: string; + text?: string; + annotations?: ChecksUpdateParamsOutputAnnotations[]; + images?: ChecksUpdateParamsOutputImages[]; +}; +export type ChecksUpdateParamsOutputAnnotations = { + path: string; + start_line: number; + end_line: number; + start_column?: number; + end_column?: number; + annotation_level: "notice" | "warning" | "failure"; + message: string; + title?: string; + raw_details?: string; +}; +export type ChecksUpdateParamsOutputImages = { + alt: string; + image_url: string; + caption?: string; +}; +export type ChecksUpdateParamsActions = { + label: string; + description: string; + identifier: string; +}; +export type ChecksSetSuitesPreferencesParamsAutoTriggerChecks = { + app_id: number; + setting: boolean; +}; +export type ReposCreateOrUpdateFileParamsCommitter = { + name: string; + email: string; +}; +export type ReposCreateOrUpdateFileParamsAuthor = { + name: string; + email: string; +}; +export type ReposCreateFileParamsCommitter = { + name: string; + email: string; +}; +export type ReposCreateFileParamsAuthor = { + name: string; + email: string; +}; +export type ReposUpdateFileParamsCommitter = { + name: string; + email: string; +}; +export type ReposUpdateFileParamsAuthor = { + name: string; + email: string; +}; +export type ReposDeleteFileParamsCommitter = { + name?: string; + email?: string; +}; +export type ReposDeleteFileParamsAuthor = { + name?: string; + email?: string; +}; +export type GitCreateCommitParamsAuthor = { + name?: string; + email?: string; + date?: string; +}; +export type GitCreateCommitParamsCommitter = { + name?: string; + email?: string; + date?: string; +}; +export type GitCreateTagParamsTagger = { + name?: string; + email?: string; + date?: string; +}; +export type GitCreateTreeParamsTree = { + path?: string; + mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + type?: "blob" | "tree" | "commit"; + sha?: string; + content?: string; +}; +export type ReposCreateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +export type ReposUpdateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +export type ReposEnablePagesSiteParamsSource = { + branch?: "master" | "gh-pages"; + path?: string; +}; +export type PullsCreateReviewParamsComments = { + path: string; + position: number; + body: string; +}; +export type TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups = { + group_id: string; + group_name: string; + group_description: string; +}; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/generated/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/generated/README.md new file mode 100644 index 00000000..2bc90d20 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/generated/README.md @@ -0,0 +1,3 @@ +# ⚠️ Do not edit files in this folder + +All files are generated. Manual changes will be overwritten. If you find a problem, please look into how they are generated. When in doubt, please open a new issue. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/index.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/index.ts new file mode 100644 index 00000000..a0f51b31 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/@octokit/types/src/index.ts @@ -0,0 +1,18 @@ +export { AuthInterface } from "./AuthInterface"; +export { EndpointDefaults } from "./EndpointDefaults"; +export { EndpointInterface } from "./EndpointInterface"; +export { EndpointOptions } from "./EndpointOptions"; +export { Fetch } from "./Fetch"; +export { OctokitResponse } from "./OctokitResponse"; +export { RequestHeaders } from "./RequestHeaders"; +export { RequestInterface } from "./RequestInterface"; +export { RequestMethod } from "./RequestMethod"; +export { RequestOptions } from "./RequestOptions"; +export { RequestParameters } from "./RequestParameters"; +export { RequestRequestOptions } from "./RequestRequestOptions"; +export { ResponseHeaders } from "./ResponseHeaders"; +export { Route } from "./Route"; +export { Signal } from "./Signal"; +export { StrategyInterface } from "./StrategyInterface"; +export { Url } from "./Url"; +export { VERSION } from "./VERSION"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/LICENSE.md b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/LICENSE.md new file mode 100644 index 00000000..f105ab0c --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/LICENSE.md @@ -0,0 +1,7 @@ +# [ISC License](https://spdx.org/licenses/ISC) + +Copyright (c) 2018, Gregor Martynus (https://github.com/gr2m) + +Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/README.md b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/README.md new file mode 100644 index 00000000..d00d14c1 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/README.md @@ -0,0 +1,25 @@ +# universal-user-agent + +> Get a user agent string in both browser and node + +[![@latest](https://img.shields.io/npm/v/universal-user-agent.svg)](https://www.npmjs.com/package/universal-user-agent) +[![Build Status](https://travis-ci.com/gr2m/universal-user-agent.svg?branch=master)](https://travis-ci.com/gr2m/universal-user-agent) +[![Greenkeeper](https://badges.greenkeeper.io/gr2m/universal-user-agent.svg)](https://greenkeeper.io/) + +```js +const { getUserAgent } = require("universal-user-agent"); +// or import { getUserAgent } from "universal-user-agent"; + +const userAgent = getUserAgent(); +// userAgent will look like this +// in browser: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:61.0) Gecko/20100101 Firefox/61.0" +// in node: Node.js/v8.9.4 (macOS High Sierra; x64) +``` + +## Credits + +The Node implementation was originally inspired by [default-user-agent](https://www.npmjs.com/package/default-user-agent). + +## License + +[ISC](LICENSE.md) diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js new file mode 100644 index 00000000..80a07105 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js @@ -0,0 +1,22 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } + +var osName = _interopDefault(require('os-name')); + +function getUserAgent() { + try { + return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; + } catch (error) { + if (/wmic os get Caption/.test(error.message)) { + return "Windows "; + } + + throw error; + } +} + +exports.getUserAgent = getUserAgent; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js.map b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js.map new file mode 100644 index 00000000..aff09ec4 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/node.js"],"sourcesContent":["import osName from \"os-name\";\nexport function getUserAgent() {\n try {\n return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`;\n }\n catch (error) {\n if (/wmic os get Caption/.test(error.message)) {\n return \"Windows \";\n }\n throw error;\n }\n}\n"],"names":["getUserAgent","process","version","substr","osName","arch","error","test","message"],"mappings":";;;;;;;;AACO,SAASA,YAAT,GAAwB;MACvB;WACQ,WAAUC,OAAO,CAACC,OAAR,CAAgBC,MAAhB,CAAuB,CAAvB,CAA0B,KAAIC,MAAM,EAAG,KAAIH,OAAO,CAACI,IAAK,GAA1E;GADJ,CAGA,OAAOC,KAAP,EAAc;QACN,sBAAsBC,IAAtB,CAA2BD,KAAK,CAACE,OAAjC,CAAJ,EAA+C;aACpC,gCAAP;;;UAEEF,KAAN;;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/browser.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/browser.js new file mode 100644 index 00000000..6f52232c --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/browser.js @@ -0,0 +1,3 @@ +export function getUserAgent() { + return navigator.userAgent; +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/index.js new file mode 100644 index 00000000..c6253f5a --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/index.js @@ -0,0 +1 @@ +export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/node.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/node.js new file mode 100644 index 00000000..8b70a038 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-src/node.js @@ -0,0 +1,12 @@ +import osName from "os-name"; +export function getUserAgent() { + try { + return `Node.js/${process.version.substr(1)} (${osName()}; ${process.arch})`; + } + catch (error) { + if (/wmic os get Caption/.test(error.message)) { + return "Windows "; + } + throw error; + } +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/browser.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/browser.d.ts new file mode 100644 index 00000000..a7bb1c44 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/browser.d.ts @@ -0,0 +1 @@ +export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/index.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/index.d.ts new file mode 100644 index 00000000..c6253f5a --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/index.d.ts @@ -0,0 +1 @@ +export { getUserAgent } from "./node"; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/node.d.ts b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/node.d.ts new file mode 100644 index 00000000..a7bb1c44 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-types/node.d.ts @@ -0,0 +1 @@ +export declare function getUserAgent(): string; diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js new file mode 100644 index 00000000..11ec79b3 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js @@ -0,0 +1,6 @@ +function getUserAgent() { + return navigator.userAgent; +} + +export { getUserAgent }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js.map b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js.map new file mode 100644 index 00000000..549407ec --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/browser.js"],"sourcesContent":["export function getUserAgent() {\n return navigator.userAgent;\n}\n"],"names":[],"mappings":"AAAO,SAAS,YAAY,GAAG;IAC3B,OAAO,SAAS,CAAC,SAAS,CAAC;CAC9B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/package.json b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/package.json new file mode 100644 index 00000000..a65a2c55 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/node_modules/universal-user-agent/package.json @@ -0,0 +1,33 @@ +{ + "name": "universal-user-agent", + "description": "Get a user agent string in both browser and node", + "version": "4.0.0", + "license": "ISC", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [], + "repository": "https://github.com/gr2m/universal-user-agent.git", + "dependencies": { + "os-name": "^3.1.0" + }, + "devDependencies": { + "@gr2m/pika-plugin-build-web": "^0.6.0-issue-84.1", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.6.0", + "@pika/plugin-ts-standard-pkg": "^0.6.0", + "@types/jest": "^24.0.18", + "jest": "^24.9.0", + "prettier": "^1.18.2", + "semantic-release": "^15.9.15", + "ts-jest": "^24.0.2", + "typescript": "^3.6.2" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/graphql/node_modules/@octokit/request/package.json b/node_modules/@octokit/graphql/node_modules/@octokit/request/package.json new file mode 100644 index 00000000..299179f1 --- /dev/null +++ b/node_modules/@octokit/graphql/node_modules/@octokit/request/package.json @@ -0,0 +1,64 @@ +{ + "name": "@octokit/request", + "description": "Send parameterized requests to GitHub’s APIs with sensible defaults in browsers and Node", + "version": "5.3.1", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "octokit", + "github", + "api", + "request" + ], + "homepage": "https://github.com/octokit/request.js#readme", + "bugs": { + "url": "https://github.com/octokit/request.js/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/octokit/request.js.git" + }, + "dependencies": { + "@octokit/endpoint": "^5.5.0", + "@octokit/request-error": "^1.0.1", + "@octokit/types": "^2.0.0", + "deprecation": "^2.0.0", + "is-plain-object": "^3.0.0", + "node-fetch": "^2.3.0", + "once": "^1.4.0", + "universal-user-agent": "^4.0.0" + }, + "devDependencies": { + "@octokit/auth-app": "^2.1.2", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.7.0", + "@pika/plugin-build-web": "^0.7.0", + "@pika/plugin-ts-standard-pkg": "^0.7.0", + "@types/fetch-mock": "^7.2.4", + "@types/jest": "^24.0.12", + "@types/lolex": "^3.1.1", + "@types/node": "^12.0.3", + "@types/node-fetch": "^2.3.3", + "@types/once": "^1.4.0", + "fetch-mock": "^7.2.0", + "jest": "^24.7.1", + "lolex": "^5.0.0", + "prettier": "^1.17.0", + "semantic-release": "^15.13.27", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "ts-jest": "^24.0.2", + "typescript": "^3.4.5" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "deno": "dist-web/index.js" +} diff --git a/node_modules/@octokit/graphql/package.json b/node_modules/@octokit/graphql/package.json new file mode 100644 index 00000000..6b6df031 --- /dev/null +++ b/node_modules/@octokit/graphql/package.json @@ -0,0 +1,47 @@ +{ + "name": "@octokit/graphql", + "description": "GitHub GraphQL API client for browsers and Node", + "version": "4.6.2", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "octokit", + "github", + "api", + "graphql" + ], + "repository": "github:octokit/graphql.js", + "dependencies": { + "@octokit/request": "^5.3.0", + "@octokit/types": "^6.0.3", + "universal-user-agent": "^6.0.0" + }, + "devDependencies": { + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/fetch-mock": "^7.2.5", + "@types/jest": "^26.0.0", + "@types/node": "^14.0.4", + "fetch-mock": "^9.0.0", + "jest": "^26.0.0", + "prettier": "^2.0.0", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "ts-jest": "^26.0.0", + "typescript": "^4.0.0" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/openapi-types/LICENSE b/node_modules/@octokit/openapi-types/LICENSE new file mode 100644 index 00000000..c61fbbe5 --- /dev/null +++ b/node_modules/@octokit/openapi-types/LICENSE @@ -0,0 +1,7 @@ +Copyright 2020 Gregor Martynus + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/node_modules/@octokit/openapi-types/README.md b/node_modules/@octokit/openapi-types/README.md new file mode 100644 index 00000000..47acb127 --- /dev/null +++ b/node_modules/@octokit/openapi-types/README.md @@ -0,0 +1,9 @@ +# openapi-types.ts + +> Generated TypeScript definitions based on GitHub's OpenAPI spec + +This repository continously converts [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/) into TypeScript definitions and publishes them to npm as `@octokit/openapi-types` + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/openapi-types/dist-node/index.js b/node_modules/@octokit/openapi-types/dist-node/index.js new file mode 100644 index 00000000..58847f1f --- /dev/null +++ b/node_modules/@octokit/openapi-types/dist-node/index.js @@ -0,0 +1,8 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +const VERSION = "7.2.1"; + +exports.VERSION = VERSION; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/openapi-types/dist-node/index.js.map b/node_modules/@octokit/openapi-types/dist-node/index.js.map new file mode 100644 index 00000000..db15785b --- /dev/null +++ b/node_modules/@octokit/openapi-types/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js"],"sourcesContent":["export const VERSION = \"7.2.1\";\n"],"names":["VERSION"],"mappings":";;;;MAAaA,OAAO,GAAG;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/openapi-types/dist-src/generated/types.js b/node_modules/@octokit/openapi-types/dist-src/generated/types.js new file mode 100644 index 00000000..6738d94e --- /dev/null +++ b/node_modules/@octokit/openapi-types/dist-src/generated/types.js @@ -0,0 +1,5 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ +export {}; diff --git a/node_modules/@octokit/openapi-types/dist-src/index.js b/node_modules/@octokit/openapi-types/dist-src/index.js new file mode 100644 index 00000000..5d080663 --- /dev/null +++ b/node_modules/@octokit/openapi-types/dist-src/index.js @@ -0,0 +1,2 @@ +export * from "./generated/types"; +export * from "./version"; diff --git a/node_modules/@octokit/openapi-types/dist-src/version.js b/node_modules/@octokit/openapi-types/dist-src/version.js new file mode 100644 index 00000000..8debeaa4 --- /dev/null +++ b/node_modules/@octokit/openapi-types/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "7.2.1"; diff --git a/node_modules/@octokit/openapi-types/dist-types/generated/types.d.ts b/node_modules/@octokit/openapi-types/dist-types/generated/types.d.ts new file mode 100644 index 00000000..54a3dec2 --- /dev/null +++ b/node_modules/@octokit/openapi-types/dist-types/generated/types.d.ts @@ -0,0 +1,33562 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ +export interface paths { + "/": { + /** Get Hypermedia links to resources accessible in GitHub's REST API */ + get: operations["meta/root"]; + }; + "/app": { + /** + * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. + * + * 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. + */ + get: operations["apps/get-authenticated"]; + }; + "/app-manifests/{code}/conversions": { + /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ + post: operations["apps/create-from-manifest"]; + }; + "/app/hook/config": { + /** + * Returns 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)." + * + * 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. + */ + get: operations["apps/get-webhook-config-for-app"]; + /** + * 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)." + * + * 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. + */ + patch: operations["apps/update-webhook-config-for-app"]; + }; + "/app/installations": { + /** + * 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. + * + * The permissions the installation has are included under the `permissions` key. + */ + get: operations["apps/list-installations"]; + }; + "/app/installations/{installation_id}": { + /** + * Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to. + * + * 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. + */ + get: operations["apps/get-installation"]; + /** + * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. + * + * 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. + */ + delete: operations["apps/delete-installation"]; + }; + "/app/installations/{installation_id}/access_tokens": { + /** + * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + post: operations["apps/create-installation-access-token"]; + }; + "/app/installations/{installation_id}/suspended": { + /** + * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + * + * 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. + */ + put: operations["apps/suspend-installation"]; + /** + * Removes a GitHub App installation suspension. + * + * 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. + */ + delete: operations["apps/unsuspend-installation"]; + }; + "/applications/grants": { + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + */ + get: operations["oauth-authorizations/list-grants"]; + }; + "/applications/grants/{grant_id}": { + /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ + get: operations["oauth-authorizations/get-grant"]; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + */ + delete: operations["oauth-authorizations/delete-grant"]; + }; + "/applications/{client_id}/grant": { + /** + * OAuth application owners can revoke a grant for their OAuth 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. + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + */ + delete: operations["apps/delete-authorization"]; + }; + "/applications/{client_id}/grants/{access_token}": { + /** + * **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). + * + * OAuth application owners can revoke a grant for their OAuth 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 token as `:access_token` and the grant for the token's owner will be deleted. + * + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under "Authorized OAuth Apps" on GitHub](https://github.com/settings/applications#authorized). + */ + delete: operations["apps/revoke-grant-for-application"]; + }; + "/applications/{client_id}/token": { + /** OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ + post: operations["apps/check-token"]; + /** 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 OAuth application's `client_id` and `client_secret` as the username and password. */ + delete: operations["apps/delete-token"]; + /** 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 OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ + patch: operations["apps/reset-token"]; + }; + "/applications/{client_id}/token/scoped": { + /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth 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 OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ + post: operations["apps/scope-token"]; + }; + "/applications/{client_id}/tokens/{access_token}": { + /** + * **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). + * + * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://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. Invalid tokens will return `404 NOT FOUND`. + */ + get: operations["apps/check-authorization"]; + /** + * **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). + * + * 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 OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + */ + post: operations["apps/reset-authorization"]; + /** + * **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). + * + * 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 OAuth application's `client_id` and `client_secret` as the username and password. + */ + delete: operations["apps/revoke-authorization-for-application"]; + }; + "/apps/{app_slug}": { + /** + * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * + * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + get: operations["apps/get-by-slug"]; + }; + "/authorizations": { + /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ + get: operations["oauth-authorizations/list-authorizations"]; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * **Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * + * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. + * + * You can also create tokens on GitHub from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use). + * + * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). + */ + post: operations["oauth-authorizations/create-authorization"]; + }; + "/authorizations/clients/{client_id}": { + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * **Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * + * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + * + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + */ + put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; + }; + "/authorizations/clients/{client_id}/{fingerprint}": { + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * **Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * + * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + * + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + */ + put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; + }; + "/authorizations/{authorization_id}": { + /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ + get: operations["oauth-authorizations/get-authorization"]; + /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ + delete: operations["oauth-authorizations/delete-authorization"]; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * + * You can only send one of these scope keys at a time. + */ + patch: operations["oauth-authorizations/update-authorization"]; + }; + "/codes_of_conduct": { + get: operations["codes-of-conduct/get-all-codes-of-conduct"]; + }; + "/codes_of_conduct/{key}": { + get: operations["codes-of-conduct/get-conduct-code"]; + }; + "/emojis": { + /** Lists all the emojis available to use on GitHub. */ + get: operations["emojis/get"]; + }; + "/enterprises/{enterprise}/actions/permissions": { + /** + * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + get: operations["enterprise-admin/get-github-actions-permissions-enterprise"]; + /** + * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + put: operations["enterprise-admin/set-github-actions-permissions-enterprise"]; + }; + "/enterprises/{enterprise}/actions/permissions/organizations": { + /** + * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"]; + /** + * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"]; + }; + "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + /** + * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"]; + /** + * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"]; + }; + "/enterprises/{enterprise}/actions/permissions/selected-actions": { + /** + * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + get: operations["enterprise-admin/get-allowed-actions-enterprise"]; + /** + * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + put: operations["enterprise-admin/set-allowed-actions-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runner-groups": { + /** + * Lists all self-hosted runner groups for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; + /** + * Creates a new self-hosted runner group for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + /** + * Gets a specific self-hosted runner group for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; + /** + * Deletes a self-hosted runner group for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; + /** + * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + /** + * Lists the organizations with access to a self-hosted runner group. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; + /** + * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + /** + * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; + /** + * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + /** + * Lists the self-hosted runners that are in a specific enterprise group. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; + /** + * Replaces the list of self-hosted runners that are part of an enterprise runner group. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + /** + * Adds a self-hosted runner to a runner group configured in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` + * scope to use this endpoint. + */ + put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; + /** + * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runners": { + /** + * Lists all self-hosted runners configured for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runners/downloads": { + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runners/registration-token": { + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN + * ``` + */ + post: operations["enterprise-admin/create-registration-token-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runners/remove-token": { + /** + * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this + * endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + post: operations["enterprise-admin/create-remove-token-for-enterprise"]; + }; + "/enterprises/{enterprise}/actions/runners/{runner_id}": { + /** + * Gets a specific self-hosted runner configured in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; + /** + * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; + }; + "/enterprises/{enterprise}/audit-log": { + /** Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ + get: operations["enterprise-admin/get-audit-log"]; + }; + "/enterprises/{enterprise}/settings/billing/actions": { + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * 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 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * The authenticated user must be an enterprise admin. + */ + get: operations["billing/get-github-actions-billing-ghe"]; + }; + "/enterprises/{enterprise}/settings/billing/packages": { + /** + * Gets the free and paid storage used for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * The authenticated user must be an enterprise admin. + */ + get: operations["billing/get-github-packages-billing-ghe"]; + }; + "/enterprises/{enterprise}/settings/billing/shared-storage": { + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * The authenticated user must be an enterprise admin. + */ + get: operations["billing/get-shared-storage-billing-ghe"]; + }; + "/events": { + /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ + get: operations["activity/list-public-events"]; + }; + "/feeds": { + /** + * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + * + * * **Timeline**: The GitHub global public timeline + * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + * * **Current user public**: The public timeline for the authenticated user + * * **Current user**: The private timeline for the authenticated user + * * **Current user actor**: The private timeline for activity created by the authenticated user + * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. + * + * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + */ + get: operations["activity/get-feeds"]; + }; + "/gists": { + /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ + get: operations["gists/list"]; + /** + * Allows you to add a new gist with one or more files. + * + * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + */ + post: operations["gists/create"]; + }; + "/gists/public": { + /** + * List public gists sorted by most recently updated to least recently updated. + * + * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + */ + get: operations["gists/list-public"]; + }; + "/gists/starred": { + /** List the authenticated user's starred gists: */ + get: operations["gists/list-starred"]; + }; + "/gists/{gist_id}": { + get: operations["gists/get"]; + delete: operations["gists/delete"]; + /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */ + patch: operations["gists/update"]; + }; + "/gists/{gist_id}/comments": { + get: operations["gists/list-comments"]; + post: operations["gists/create-comment"]; + }; + "/gists/{gist_id}/comments/{comment_id}": { + get: operations["gists/get-comment"]; + delete: operations["gists/delete-comment"]; + patch: operations["gists/update-comment"]; + }; + "/gists/{gist_id}/commits": { + get: operations["gists/list-commits"]; + }; + "/gists/{gist_id}/forks": { + get: operations["gists/list-forks"]; + /** **Note**: This was previously `/gists/:gist_id/fork`. */ + post: operations["gists/fork"]; + }; + "/gists/{gist_id}/star": { + get: operations["gists/check-is-starred"]; + /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ + put: operations["gists/star"]; + delete: operations["gists/unstar"]; + }; + "/gists/{gist_id}/{sha}": { + get: operations["gists/get-revision"]; + }; + "/gitignore/templates": { + /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */ + get: operations["gitignore/get-all-templates"]; + }; + "/gitignore/templates/{name}": { + /** + * The API also allows fetching the source of a single template. + * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. + */ + get: operations["gitignore/get-template"]; + }; + "/installation/repositories": { + /** + * List repositories that an app installation can access. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + get: operations["apps/list-repos-accessible-to-installation"]; + }; + "/installation/token": { + /** + * Revokes the installation token you're using to authenticate as an installation and access this endpoint. + * + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + delete: operations["apps/revoke-installation-access-token"]; + }; + "/issues": { + /** + * List issues assigned to the authenticated user across all visible repositories including owned repositories, member + * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + * necessarily assigned to you. + * + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + get: operations["issues/list"]; + }; + "/licenses": { + get: operations["licenses/get-all-commonly-used"]; + }; + "/licenses/{license}": { + get: operations["licenses/get"]; + }; + "/markdown": { + post: operations["markdown/render"]; + }; + "/markdown/raw": { + /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ + post: operations["markdown/render-raw"]; + }; + "/marketplace_listing/accounts/{account_id}": { + /** + * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + get: operations["apps/get-subscription-plan-for-account"]; + }; + "/marketplace_listing/plans": { + /** + * Lists all plans that are part of your GitHub Marketplace listing. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + get: operations["apps/list-plans"]; + }; + "/marketplace_listing/plans/{plan_id}/accounts": { + /** + * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + get: operations["apps/list-accounts-for-plan"]; + }; + "/marketplace_listing/stubbed/accounts/{account_id}": { + /** + * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + get: operations["apps/get-subscription-plan-for-account-stubbed"]; + }; + "/marketplace_listing/stubbed/plans": { + /** + * Lists all plans that are part of your GitHub Marketplace listing. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + get: operations["apps/list-plans-stubbed"]; + }; + "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + /** + * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + get: operations["apps/list-accounts-for-plan-stubbed"]; + }; + "/meta": { + /** + * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)." + * + * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. + */ + get: operations["meta/get"]; + }; + "/networks/{owner}/{repo}/events": { + get: operations["activity/list-public-events-for-repo-network"]; + }; + "/notifications": { + /** List all notifications for the current user, sorted by most recently updated. */ + get: operations["activity/list-notifications-for-authenticated-user"]; + /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). 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`. */ + put: operations["activity/mark-notifications-as-read"]; + }; + "/notifications/threads/{thread_id}": { + get: operations["activity/get-thread"]; + patch: operations["activity/mark-thread-as-read"]; + }; + "/notifications/threads/{thread_id}/subscription": { + /** + * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). + * + * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + */ + get: operations["activity/get-thread-subscription-for-authenticated-user"]; + /** + * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. + * + * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. + * + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. + */ + put: operations["activity/set-thread-subscription"]; + /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ + delete: operations["activity/delete-thread-subscription"]; + }; + "/octocat": { + /** Get the octocat as ASCII art */ + get: operations["meta/get-octocat"]; + }; + "/organizations": { + /** + * Lists all organizations, in the order that they were created on GitHub. + * + * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. + */ + get: operations["orgs/list"]; + }; + "/orgs/{org}": { + /** + * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * + * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + */ + get: operations["orgs/get"]; + /** + * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * + * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. + */ + patch: operations["orgs/update"]; + }; + "/orgs/{org}/actions/permissions": { + /** + * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + * + * 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. + */ + get: operations["actions/get-github-actions-permissions-organization"]; + /** + * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + * + * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. + * + * 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. + */ + put: operations["actions/set-github-actions-permissions-organization"]; + }; + "/orgs/{org}/actions/permissions/repositories": { + /** + * 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)." + * + * 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. + */ + get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; + /** + * 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)." + * + * 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. + */ + put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; + }; + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + /** + * Adds a repository to 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 must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * 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. + */ + put: operations["actions/enable-selected-repository-github-actions-organization"]; + /** + * Removes a repository from 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)." + * + * 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. + */ + delete: operations["actions/disable-selected-repository-github-actions-organization"]; + }; + "/orgs/{org}/actions/permissions/selected-actions": { + /** + * Gets the selected actions 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)."" + * + * 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. + */ + get: operations["actions/get-allowed-actions-organization"]; + /** + * Sets the actions 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)." + * + * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + * + * 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. + * + * 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. + */ + put: operations["actions/set-allowed-actions-organization"]; + }; + "/orgs/{org}/actions/runner-groups": { + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runner-groups-for-org"]; + /** + * The self-hosted runner groups REST API is available with 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)." + * + * Creates a new self-hosted runner group for an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + post: operations["actions/create-self-hosted-runner-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Gets a specific self-hosted runner group for an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + get: operations["actions/get-self-hosted-runner-group-for-org"]; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Deletes a self-hosted runner group for an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Updates the `name` and `visibility` of a self-hosted runner group in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + patch: operations["actions/update-self-hosted-runner-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + /** + * The self-hosted runner groups REST API is available with 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)." + * + * Lists the repositories with access to a self-hosted runner group configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * + * Adds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` + * scope to use this endpoint. + */ + put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * + * Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Lists self-hosted runners that are in a specific organization group. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Replaces the list of self-hosted runners that are part of an organization runner group. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * + * Adds a self-hosted runner to a runner group configured in an organization. + * + * You must authenticate using an access token with the `admin:org` + * scope to use this endpoint. + */ + put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * + * Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + }; + "/orgs/{org}/actions/runners": { + /** + * Lists all self-hosted runners configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runners-for-org"]; + }; + "/orgs/{org}/actions/runners/downloads": { + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-runner-applications-for-org"]; + }; + "/orgs/{org}/actions/runners/registration-token": { + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` + */ + post: operations["actions/create-registration-token-for-org"]; + }; + "/orgs/{org}/actions/runners/remove-token": { + /** + * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this + * endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + post: operations["actions/create-remove-token-for-org"]; + }; + "/orgs/{org}/actions/runners/{runner_id}": { + /** + * Gets a specific self-hosted runner configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + get: operations["actions/get-self-hosted-runner-for-org"]; + /** + * 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. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/delete-self-hosted-runner-from-org"]; + }; + "/orgs/{org}/actions/secrets": { + /** 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 `secrets` organization permission to use this endpoint. */ + get: operations["actions/list-org-secrets"]; + }; + "/orgs/{org}/actions/secrets/public-key": { + /** 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 `secrets` organization permission to use this endpoint. */ + get: operations["actions/get-org-public-key"]; + }; + "/orgs/{org}/actions/secrets/{secret_name}": { + /** 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 `secrets` organization permission to use this endpoint. */ + get: operations["actions/get-org-secret"]; + /** + * Creates or updates an organization secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + put: operations["actions/create-or-update-org-secret"]; + /** 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. */ + delete: operations["actions/delete-org-secret"]; + }; + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + /** 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 `secrets` organization permission to use this endpoint. */ + get: operations["actions/list-selected-repos-for-org-secret"]; + /** 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/actions#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 `secrets` organization permission to use this endpoint. */ + put: operations["actions/set-selected-repos-for-org-secret"]; + }; + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + /** Adds a repository to 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/actions#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 `secrets` organization permission to use this endpoint. */ + put: operations["actions/add-selected-repo-to-org-secret"]; + /** 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/actions#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 `secrets` organization permission to use this endpoint. */ + delete: operations["actions/remove-selected-repo-from-org-secret"]; + }; + "/orgs/{org}/audit-log": { + /** + * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + * + * To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. + */ + get: operations["orgs/get-audit-log"]; + }; + "/orgs/{org}/blocks": { + /** List the users blocked by an organization. */ + get: operations["orgs/list-blocked-users"]; + }; + "/orgs/{org}/blocks/{username}": { + get: operations["orgs/check-blocked-user"]; + put: operations["orgs/block-user"]; + delete: operations["orgs/unblock-user"]; + }; + "/orgs/{org}/credential-authorizations": { + /** + * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products). + * + * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://help.github.com/en/articles/about-authentication-with-saml-single-sign-on). + */ + get: operations["orgs/list-saml-sso-authorizations"]; + }; + "/orgs/{org}/credential-authorizations/{credential_id}": { + /** + * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products). + * + * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. + */ + delete: operations["orgs/remove-saml-sso-authorization"]; + }; + "/orgs/{org}/events": { + get: operations["activity/list-public-org-events"]; + }; + "/orgs/{org}/failed_invitations": { + /** 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. */ + get: operations["orgs/list-failed-invitations"]; + }; + "/orgs/{org}/hooks": { + get: operations["orgs/list-webhooks"]; + /** Here's how you can create a hook that posts payloads in JSON format: */ + post: operations["orgs/create-webhook"]; + }; + "/orgs/{org}/hooks/{hook_id}": { + /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */ + get: operations["orgs/get-webhook"]; + delete: operations["orgs/delete-webhook"]; + /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */ + patch: operations["orgs/update-webhook"]; + }; + "/orgs/{org}/hooks/{hook_id}/config": { + /** + * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." + * + * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + */ + get: operations["orgs/get-webhook-config-for-org"]; + /** + * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." + * + * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + */ + patch: operations["orgs/update-webhook-config-for-org"]; + }; + "/orgs/{org}/hooks/{hook_id}/pings": { + /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ + post: operations["orgs/ping-webhook"]; + }; + "/orgs/{org}/installation": { + /** + * Enables an authenticated GitHub App to find the organization's installation information. + * + * 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. + */ + get: operations["apps/get-org-installation"]; + }; + "/orgs/{org}/installations": { + /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ + get: operations["orgs/list-app-installations"]; + }; + "/orgs/{org}/interaction-limits": { + /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ + get: operations["interactions/get-restrictions-for-org"]; + /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ + put: operations["interactions/set-restrictions-for-org"]; + /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ + delete: operations["interactions/remove-restrictions-for-org"]; + }; + "/orgs/{org}/invitations": { + /** The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ + get: operations["orgs/list-pending-invitations"]; + /** + * 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. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + post: operations["orgs/create-invitation"]; + }; + "/orgs/{org}/invitations/{invitation_id}": { + /** + * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). + */ + delete: operations["orgs/cancel-invitation"]; + }; + "/orgs/{org}/invitations/{invitation_id}/teams": { + /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ + get: operations["orgs/list-invitation-teams"]; + }; + "/orgs/{org}/issues": { + /** + * List issues in an organization assigned to the authenticated user. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + get: operations["issues/list-for-org"]; + }; + "/orgs/{org}/members": { + /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ + get: operations["orgs/list-members"]; + }; + "/orgs/{org}/members/{username}": { + /** Check if a user is, publicly or privately, a member of the organization. */ + get: operations["orgs/check-membership-for-user"]; + /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ + delete: operations["orgs/remove-member"]; + }; + "/orgs/{org}/memberships/{username}": { + /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ + get: operations["orgs/get-membership-for-user"]; + /** + * Only authenticated organization owners can add a member to the organization or update the member's role. + * + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * + * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. + * + * **Rate limits** + * + * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + */ + put: operations["orgs/set-membership-for-user"]; + /** + * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. + * + * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + */ + delete: operations["orgs/remove-membership-for-user"]; + }; + "/orgs/{org}/migrations": { + /** Lists the most recent migrations. */ + get: operations["migrations/list-for-org"]; + /** Initiates the generation of a migration archive. */ + post: operations["migrations/start-for-org"]; + }; + "/orgs/{org}/migrations/{migration_id}": { + /** + * Fetches the status of a migration. + * + * The `state` of a migration can be one of the following values: + * + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. + */ + get: operations["migrations/get-status-for-org"]; + }; + "/orgs/{org}/migrations/{migration_id}/archive": { + /** Fetches the URL to a migration archive. */ + get: operations["migrations/download-archive-for-org"]; + /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ + delete: operations["migrations/delete-archive-for-org"]; + }; + "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ + delete: operations["migrations/unlock-repo-for-org"]; + }; + "/orgs/{org}/migrations/{migration_id}/repositories": { + /** List all the repositories for this organization migration. */ + get: operations["migrations/list-repos-for-org"]; + }; + "/orgs/{org}/outside_collaborators": { + /** List all users who are outside collaborators of an organization. */ + get: operations["orgs/list-outside-collaborators"]; + }; + "/orgs/{org}/outside_collaborators/{username}": { + /** 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://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". */ + put: operations["orgs/convert-member-to-outside-collaborator"]; + /** Removing a user from this list will remove them from all the organization's repositories. */ + delete: operations["orgs/remove-outside-collaborator"]; + }; + "/orgs/{org}/packages/{package_type}/{package_name}": { + /** + * Gets a specific package in an organization. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + get: operations["packages/get-package-for-organization"]; + /** + * 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. + */ + delete: operations["packages/delete-package-for-org"]; + }; + "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + /** + * Restores an entire package in an organization. + * + * You can restore a deleted package under the following conditions: + * - The package was deleted within the last 30 days. + * - 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scope. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. + */ + post: operations["packages/restore-package-for-org"]; + }; + "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + /** + * Returns all package versions for a package owned by an organization. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; + }; + "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + /** + * Gets a specific package version in an organization. + * + * You must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + get: operations["packages/get-package-version-for-organization"]; + /** + * 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. + */ + delete: operations["packages/delete-package-version-for-org"]; + }; + "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + /** + * Restores a specific package version in an organization. + * + * You can restore a deleted package under the following conditions: + * - The package was deleted within the last 30 days. + * - 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scope. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. + */ + post: operations["packages/restore-package-version-for-org"]; + }; + "/orgs/{org}/projects": { + /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ + get: operations["projects/list-for-org"]; + /** Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ + post: operations["projects/create-for-org"]; + }; + "/orgs/{org}/public_members": { + /** Members of an organization can choose to have their membership publicized or not. */ + get: operations["orgs/list-public-members"]; + }; + "/orgs/{org}/public_members/{username}": { + get: operations["orgs/check-public-membership-for-user"]; + /** + * The user can publicize their own membership. (A user cannot publicize the membership for another user.) + * + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + put: operations["orgs/set-public-membership-for-authenticated-user"]; + delete: operations["orgs/remove-public-membership-for-authenticated-user"]; + }; + "/orgs/{org}/repos": { + /** Lists repositories for the specified organization. */ + get: operations["repos/list-for-org"]; + /** + * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. + * * `repo` scope to create a private repository + */ + post: operations["repos/create-in-org"]; + }; + "/orgs/{org}/settings/billing/actions": { + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + get: operations["billing/get-github-actions-billing-org"]; + }; + "/orgs/{org}/settings/billing/packages": { + /** + * Gets the free and paid storage usued for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + get: operations["billing/get-github-packages-billing-org"]; + }; + "/orgs/{org}/settings/billing/shared-storage": { + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + get: operations["billing/get-shared-storage-billing-org"]; + }; + "/orgs/{org}/team-sync/groups": { + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." + * + * The `per_page` parameter provides pagination for a list of IdP groups the authenticated user can access in an organization. For example, if the user `octocat` wants to see two groups per page in `octo-org` via cURL, it would look like this: + */ + get: operations["teams/list-idp-groups-for-org"]; + }; + "/orgs/{org}/teams": { + /** Lists all teams in an organization that are visible to the authenticated user. */ + get: operations["teams/list"]; + /** + * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." + * + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". + */ + post: operations["teams/create"]; + }; + "/orgs/{org}/teams/{team_slug}": { + /** + * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + */ + get: operations["teams/get-by-name"]; + /** + * To delete a team, the authenticated user must be an organization owner or team maintainer. + * + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + */ + delete: operations["teams/delete-in-org"]; + /** + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + */ + patch: operations["teams/update-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions": { + /** + * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + */ + get: operations["teams/list-discussions-in-org"]; + /** + * 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/). + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + */ + post: operations["teams/create-discussion-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + /** + * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + get: operations["teams/get-discussion-in-org"]; + /** + * Delete a discussion from 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/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + delete: operations["teams/delete-discussion-in-org"]; + /** + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + patch: operations["teams/update-discussion-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + /** + * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + */ + get: operations["teams/list-discussion-comments-in-org"]; + /** + * 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/). + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + */ + post: operations["teams/create-discussion-comment-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + /** + * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + get: operations["teams/get-discussion-comment-in-org"]; + /** + * Deletes a 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/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + delete: operations["teams/delete-discussion-comment-in-org"]; + /** + * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + patch: operations["teams/update-discussion-comment-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + /** + * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + */ + get: operations["reactions/list-for-team-discussion-comment-in-org"]; + /** + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + */ + post: operations["reactions/create-for-team-discussion-comment-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + /** + * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + delete: operations["reactions/delete-for-team-discussion-comment"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + /** + * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + */ + get: operations["reactions/list-for-team-discussion-in-org"]; + /** + * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + */ + post: operations["reactions/create-for-team-discussion-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + /** + * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * + * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + delete: operations["reactions/delete-for-team-discussion"]; + }; + "/orgs/{org}/teams/{team_slug}/invitations": { + /** + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + */ + get: operations["teams/list-pending-invitations-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/members": { + /** + * Team members will include the members of child teams. + * + * To list members in a team, the team must be visible to the authenticated user. + */ + get: operations["teams/list-members-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + /** + * Team members will include the members of child teams. + * + * To get a user's membership with a team, the team must be visible to the authenticated user. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * + * **Note:** + * The response contains the `state` of the membership and the member's `role`. + * + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). + */ + get: operations["teams/get-membership-for-user-in-org"]; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. + * + * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + */ + put: operations["teams/add-or-update-membership-for-user-in-org"]; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + */ + delete: operations["teams/remove-membership-for-user-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/projects": { + /** + * Lists the organization projects for a team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + */ + get: operations["teams/list-projects-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + /** + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + get: operations["teams/check-permissions-for-project-in-org"]; + /** + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + put: operations["teams/add-or-update-project-permissions-in-org"]; + /** + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + delete: operations["teams/remove-project-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/repos": { + /** + * Lists a team's repositories visible to the authenticated user. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + */ + get: operations["teams/list-repos-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + /** + * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. + * + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * + * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + */ + get: operations["teams/check-permissions-for-repo-in-org"]; + /** + * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * + * For more information about the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + */ + put: operations["teams/add-or-update-repo-permissions-in-org"]; + /** + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + */ + delete: operations["teams/remove-repo-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * List IdP groups connected to a team on GitHub. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. + */ + get: operations["teams/list-idp-groups-in-org"]; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. + */ + patch: operations["teams/create-or-update-idp-group-connections-in-org"]; + }; + "/orgs/{org}/teams/{team_slug}/teams": { + /** + * Lists the child teams of the team specified by `{team_slug}`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + */ + get: operations["teams/list-child-in-org"]; + }; + "/projects/columns/cards/{card_id}": { + get: operations["projects/get-card"]; + delete: operations["projects/delete-card"]; + patch: operations["projects/update-card"]; + }; + "/projects/columns/cards/{card_id}/moves": { + post: operations["projects/move-card"]; + }; + "/projects/columns/{column_id}": { + get: operations["projects/get-column"]; + delete: operations["projects/delete-column"]; + patch: operations["projects/update-column"]; + }; + "/projects/columns/{column_id}/cards": { + get: operations["projects/list-cards"]; + post: operations["projects/create-card"]; + }; + "/projects/columns/{column_id}/moves": { + post: operations["projects/move-column"]; + }; + "/projects/{project_id}": { + /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ + get: operations["projects/get"]; + /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ + delete: operations["projects/delete"]; + /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ + patch: operations["projects/update"]; + }; + "/projects/{project_id}/collaborators": { + /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ + get: operations["projects/list-collaborators"]; + }; + "/projects/{project_id}/collaborators/{username}": { + /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ + put: operations["projects/add-collaborator"]; + /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ + delete: operations["projects/remove-collaborator"]; + }; + "/projects/{project_id}/collaborators/{username}/permission": { + /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ + get: operations["projects/get-permission-for-user"]; + }; + "/projects/{project_id}/columns": { + get: operations["projects/list-columns"]; + post: operations["projects/create-column"]; + }; + "/rate_limit": { + /** + * **Note:** Accessing this endpoint does not count against your REST API rate limit. + * + * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + */ + get: operations["rate-limit/get"]; + }; + "/reactions/{reaction_id}": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). + * + * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). + */ + delete: operations["reactions/delete-legacy"]; + }; + "/repos/{owner}/{repo}": { + /** + * When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file. + * + * 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. + */ + get: operations["repos/get"]; + /** + * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + * + * If an organization owner has configured the organization to prevent members from deleting organization-owned + * repositories, you will get a `403 Forbidden` response. + */ + delete: operations["repos/delete"]; + /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */ + patch: operations["repos/update"]; + }; + "/repos/{owner}/{repo}/actions/artifacts": { + /** Lists all artifacts for 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. */ + get: operations["actions/list-artifacts-for-repo"]; + }; + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + /** Gets a specific artifact 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. */ + get: operations["actions/get-artifact"]; + /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ + delete: operations["actions/delete-artifact"]; + }; + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + /** + * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in + * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to + * the repository can use this endpoint. 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. + */ + get: operations["actions/download-artifact"]; + }; + "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + /** Gets a specific job in 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. */ + get: operations["actions/get-job-for-workflow-run"]; + }; + "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + /** + * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look + * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can + * use this endpoint. 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. + */ + get: operations["actions/download-job-logs-for-workflow-run"]; + }; + "/repos/{owner}/{repo}/actions/permissions": { + /** + * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. + * + * 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. + */ + get: operations["actions/get-github-actions-permissions-repository"]; + /** + * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. + * + * 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, then you cannot override them for the repository. + * + * 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. + */ + put: operations["actions/set-github-actions-permissions-repository"]; + }; + "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + /** + * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository 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)." + * + * 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. + */ + get: operations["actions/get-allowed-actions-repository"]; + /** + * Sets the actions 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)." + * + * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + * + * 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. + * + * 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. + */ + put: operations["actions/set-allowed-actions-repository"]; + }; + "/repos/{owner}/{repo}/actions/runners": { + /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */ + get: operations["actions/list-self-hosted-runners-for-repo"]; + }; + "/repos/{owner}/{repo}/actions/runners/downloads": { + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + */ + get: operations["actions/list-runner-applications-for-repo"]; + }; + "/repos/{owner}/{repo}/actions/runners/registration-token": { + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate + * using an access token with the `repo` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN + * ``` + */ + post: operations["actions/create-registration-token-for-repo"]; + }; + "/repos/{owner}/{repo}/actions/runners/remove-token": { + /** + * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + post: operations["actions/create-remove-token-for-repo"]; + }; + "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + /** + * Gets a specific self-hosted runner configured in a repository. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. + */ + get: operations["actions/get-self-hosted-runner-for-repo"]; + /** + * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + * + * You must authenticate using an access token with the `repo` + * scope to use this endpoint. + */ + delete: operations["actions/delete-self-hosted-runner-from-repo"]; + }; + "/repos/{owner}/{repo}/actions/runs": { + /** + * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * + * 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. + */ + get: operations["actions/list-workflow-runs-for-repo"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}": { + /** Gets a specific 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. */ + get: operations["actions/get-workflow-run"]; + /** + * Delete a specific workflow run. Anyone with write 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:write` permission to use + * this endpoint. + */ + delete: operations["actions/delete-workflow-run"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + /** 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. */ + get: operations["actions/get-reviews-for-run"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { + /** + * **Note:** This endpoint is currently in beta and is subject to change. + * + * 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)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + post: operations["actions/approve-workflow-run"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + /** Lists artifacts 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. */ + get: operations["actions/list-workflow-run-artifacts"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ + post: operations["actions/cancel-workflow-run"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + /** 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). */ + get: operations["actions/list-jobs-for-workflow-run"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + /** + * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for + * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use + * this endpoint. 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. + */ + get: operations["actions/download-workflow-run-logs"]; + /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ + delete: operations["actions/delete-workflow-run-logs"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + /** + * Get all deployment environments for a workflow run that are waiting for protection rules to pass. + * + * 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. + */ + get: operations["actions/get-pending-deployments-for-run"]; + /** + * Approve or reject pending deployments that are waiting on approval by a required reviewer. + * + * Anyone with read access to the repository contents and deployments can use this endpoint. + */ + post: operations["actions/review-pending-deployments-for-run"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ + post: operations["actions/re-run-workflow"]; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + /** + * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * 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. + */ + get: operations["actions/get-workflow-run-usage"]; + }; + "/repos/{owner}/{repo}/actions/secrets": { + /** 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. */ + get: operations["actions/list-repo-secrets"]; + }; + "/repos/{owner}/{repo}/actions/secrets/public-key": { + /** 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 `secrets` repository permission to use this endpoint. */ + get: operations["actions/get-repo-public-key"]; + }; + "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + /** 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. */ + get: operations["actions/get-repo-secret"]; + /** + * Creates or updates a repository secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + put: operations["actions/create-or-update-repo-secret"]; + /** 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. */ + delete: operations["actions/delete-repo-secret"]; + }; + "/repos/{owner}/{repo}/actions/workflows": { + /** 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. */ + get: operations["actions/list-repo-workflows"]; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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. */ + get: operations["actions/get-workflow"]; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + /** + * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + put: operations["actions/disable-workflow"]; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + /** + * 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`. + * + * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + */ + post: operations["actions/create-workflow-dispatch"]; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + /** + * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + put: operations["actions/enable-workflow"]; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + /** + * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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). + * + * 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. + */ + get: operations["actions/list-workflow-runs"]; + }; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + /** + * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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. + */ + get: operations["actions/get-workflow-usage"]; + }; + "/repos/{owner}/{repo}/assignees": { + /** Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ + get: operations["issues/list-assignees"]; + }; + "/repos/{owner}/{repo}/assignees/{assignee}": { + /** + * Checks if a user has permission to be assigned to an issue in this repository. + * + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + * + * Otherwise a `404` status code is returned. + */ + get: operations["issues/check-user-can-be-assigned"]; + }; + "/repos/{owner}/{repo}/automated-security-fixes": { + /** 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://help.github.com/en/articles/configuring-automated-security-fixes)". */ + put: operations["repos/enable-automated-security-fixes"]; + /** 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://help.github.com/en/articles/configuring-automated-security-fixes)". */ + delete: operations["repos/disable-automated-security-fixes"]; + }; + "/repos/{owner}/{repo}/branches": { + get: operations["repos/list-branches"]; + }; + "/repos/{owner}/{repo}/branches/{branch}": { + get: operations["repos/get-branch"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection": { + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + get: operations["repos/get-branch-protection"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Protecting a branch requires admin or owner permissions to the repository. + * + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * + * **Note**: The list of users, apps, and teams in total is limited to 100 items. + */ + put: operations["repos/update-branch-protection"]; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + delete: operations["repos/delete-branch-protection"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + get: operations["repos/get-admin-branch-protection"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + */ + post: operations["repos/set-admin-branch-protection"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + */ + delete: operations["repos/delete-admin-branch-protection"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + get: operations["repos/get-pull-request-review-protection"]; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + delete: operations["repos/delete-pull-request-review-protection"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + */ + patch: operations["repos/update-pull-request-review-protection"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help. + * + * **Note**: You must enable branch protection to require signed commits. + */ + get: operations["repos/get-commit-signature-protection"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. + */ + post: operations["repos/create-commit-signature-protection"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. + */ + delete: operations["repos/delete-commit-signature-protection"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + get: operations["repos/get-status-checks-protection"]; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + delete: operations["repos/remove-status-check-protection"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + */ + patch: operations["repos/update-status-check-protection"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + get: operations["repos/get-all-status-check-contexts"]; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + put: operations["repos/set-status-check-contexts"]; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + post: operations["repos/add-status-check-contexts"]; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + delete: operations["repos/remove-status-check-contexts"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists who has access to this protected branch. + * + * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + */ + get: operations["repos/get-access-restrictions"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Disables the ability to restrict who can push to this branch. + */ + delete: operations["repos/delete-access-restrictions"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + */ + get: operations["repos/get-apps-with-access-to-protected-branch"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `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. | + */ + put: operations["repos/set-app-access-restrictions"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `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. | + */ + post: operations["repos/add-app-access-restrictions"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `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. | + */ + delete: operations["repos/remove-app-access-restrictions"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the teams who have push access to this branch. The list includes child teams. + */ + get: operations["repos/get-teams-with-access-to-protected-branch"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. + * + * | Type | Description | + * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | + * | `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. | + */ + put: operations["repos/set-team-access-restrictions"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified teams push access for this branch. You can also give push access to child teams. + * + * | Type | Description | + * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | + * | `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. | + */ + post: operations["repos/add-team-access-restrictions"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of a team to push to this branch. You can also remove push access for child teams. + * + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `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. | + */ + delete: operations["repos/remove-team-access-restrictions"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the people who have push access to this branch. + */ + get: operations["repos/get-users-with-access-to-protected-branch"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. + * + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + put: operations["repos/set-user-access-restrictions"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified people push access for this branch. + * + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + post: operations["repos/add-user-access-restrictions"]; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of a user to push to this branch. + * + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + delete: operations["repos/remove-user-access-restrictions"]; + }; + "/repos/{owner}/{repo}/branches/{branch}/rename": { + /** + * Renames a branch in a repository. + * + * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + * + * The permissions required to use this endpoint depends on whether you are renaming the default branch. + * + * To rename a non-default branch: + * + * * Users must have push access. + * * GitHub Apps must have the `contents:write` repository permission. + * + * To rename the default branch: + * + * * Users must have admin or owner permissions. + * * GitHub Apps must have the `administration:write` repository permission. + */ + post: operations["repos/rename-branch"]; + }; + "/repos/{owner}/{repo}/check-runs": { + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * + * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + */ + post: operations["checks/create"]; + }; + "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + get: operations["checks/get"]; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + */ + patch: operations["checks/update"]; + }; + "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */ + get: operations["checks/list-annotations"]; + }; + "/repos/{owner}/{repo}/check-suites": { + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + */ + post: operations["checks/create-suite"]; + }; + "/repos/{owner}/{repo}/check-suites/preferences": { + /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ + patch: operations["checks/set-suites-preferences"]; + }; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. + */ + get: operations["checks/get-suite"]; + }; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + get: operations["checks/list-for-suite"]; + }; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + /** + * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * + * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. + */ + post: operations["checks/rerequest-suite"]; + }; + "/repos/{owner}/{repo}/code-scanning/alerts": { + /** + * Lists all open code scanning alerts for the default branch (usually `main` + * or `master`). You must use an access token with the `security_events` scope to use + * this endpoint. GitHub Apps must have the `security_events` read permission to use + * this endpoint. + * + * The response includes a `most_recent_instance` object. + * This provides details of the most recent instance of this alert + * for the default branch or for the specified Git reference + * (if you used `ref` in the request). + */ + get: operations["code-scanning/list-alerts-for-repo"]; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + /** + * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * **Deprecation notice**: + * 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`. + */ + get: operations["code-scanning/get-alert"]; + /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. */ + patch: operations["code-scanning/update-alert"]; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + /** Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. */ + get: operations["code-scanning/list-alert-instances"]; + }; + "/repos/{owner}/{repo}/code-scanning/analyses": { + /** + * Lists the details of all code scanning analyses for a repository, + * starting with the most recent. + * The response is paginated and you can use the `page` and `per_page` parameters + * to list the analyses you're interested in. + * By default 30 analyses are listed per page. + * + * The `rules_count` field in the response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. + * + * You must use an access token with the `security_events` scope to use this endpoint. + * GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + */ + get: operations["code-scanning/list-recent-analyses"]; + }; + "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + /** + * Gets a specified code scanning analysis for a repository. + * You must use an access token with the `security_events` scope to use this endpoint. + * GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * The default JSON response contains fields that describe the analysis. + * This includes the Git reference and commit SHA to which the analysis relates, + * the datetime of the analysis, the name of the code scanning tool, + * and the number of alerts. + * + * The `rules_count` field in the default response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. + * + * If you use the Accept header `application/sarif+json`, + * the response contains the analysis data that was uploaded. + * This is formatted as + * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + * For an example response, see "[Custom media type for code scanning](#custom-media-type-for-code-scanning)." + * + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + */ + get: operations["code-scanning/get-analysis"]; + /** + * Deletes a specified code scanning analysis from a repository. For + * private repositories, you must use an access token with the `repo` scope. For public repositories, + * you must use an access token with `public_repo` and `repo:security_events` scopes. + * GitHub Apps must have the `security_events` write permission to use this endpoint. + * + * You can delete one analysis at a time. + * To delete a series of analyses, start with the most recent analysis and work backwards. + * Conceptually, the process is similar to the undo function in a text editor. + * + * When you list the analyses for a repository, + * one or more will be identified as deletable in the response: + * + * ``` + * "deletable": true + * ``` + * + * An analysis is deletable when it's the most recent in a set of analyses. + * Typically, a repository will have multiple sets of analyses + * for each enabled code scanning tool, + * where a set is determined by a unique combination of analysis values: + * + * * `ref` + * * `tool` + * * `analysis_key` + * * `environment` + * + * If you attempt to delete an analysis that is not the most recent in a set, + * you'll get a 400 response with the message: + * + * ``` + * Analysis specified is not deletable. + * ``` + * + * The response from a successful `DELETE` operation provides you with + * two alternative URLs for deleting the next analysis in the set + * (see the example default response below). + * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis + * in the set. This is a useful option if you want to preserve at least one analysis + * for the specified tool in your repository. + * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. + * When you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url` + * in the 200 response is `null`. + * + * As an example of the deletion process, + * let's imagine that you added a workflow that configured a particular code scanning tool + * to analyze the code in a repository. This tool has added 15 analyses: + * 10 on the default branch, and another 5 on a topic branch. + * You therefore have two separate sets of analyses for this tool. + * You've now decided that you want to remove all of the analyses for the tool. + * To do this you must make 15 separate deletion requests. + * To start, you must find the deletable analysis for one of the sets, + * step through deleting the analyses in that set, + * and then repeat the process for the second set. + * The procedure therefore consists of a nested loop: + * + * **Outer loop**: + * * List the analyses for the repository, filtered by tool. + * * Parse this list to find a deletable analysis. If found: + * + * **Inner loop**: + * * Delete the identified analysis. + * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. + * + * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + */ + delete: operations["code-scanning/delete-analysis"]; + }; + "/repos/{owner}/{repo}/code-scanning/sarifs": { + /** + * 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. GitHub Apps must have the `security_events` write permission to use this endpoint. + * + * There are two places where you can upload code scanning results. + * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + * - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + * + * You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: + * + * ``` + * gzip -c analysis-data.sarif | base64 -w0 + * ``` + * + * SARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries. + * + * The `202 Accepted`, response includes an `id` value. + * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. + * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." + */ + post: operations["code-scanning/upload-sarif"]; + }; + "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + /** 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. GitHub Apps must have the `security_events` read permission to use this endpoint. */ + get: operations["code-scanning/get-sarif"]; + }; + "/repos/{owner}/{repo}/collaborators": { + /** + * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + * + * Team members will include the members of child teams. + */ + get: operations["repos/list-collaborators"]; + }; + "/repos/{owner}/{repo}/collaborators/{username}": { + /** + * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + * + * Team members will include the members of child teams. + */ + get: operations["repos/check-collaborator"]; + /** + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * For more information the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). + * + * **Rate limits** + * + * To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. + */ + put: operations["repos/add-collaborator"]; + delete: operations["repos/remove-collaborator"]; + }; + "/repos/{owner}/{repo}/collaborators/{username}/permission": { + /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */ + get: operations["repos/get-collaborator-permission-level"]; + }; + "/repos/{owner}/{repo}/comments": { + /** + * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * + * Comments are ordered by ascending ID. + */ + get: operations["repos/list-commit-comments-for-repo"]; + }; + "/repos/{owner}/{repo}/comments/{comment_id}": { + get: operations["repos/get-commit-comment"]; + delete: operations["repos/delete-commit-comment"]; + patch: operations["repos/update-commit-comment"]; + }; + "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ + get: operations["reactions/list-for-commit-comment"]; + /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ + post: operations["reactions/create-for-commit-comment"]; + }; + "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * + * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + */ + delete: operations["reactions/delete-for-commit-comment"]; + }; + "/repos/{owner}/{repo}/commits": { + /** + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + get: operations["repos/list-commits"]; + }; + "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + */ + get: operations["repos/list-branches-for-head-commit"]; + }; + "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + /** Use the `:commit_sha` to specify the commit that will have its comments listed. */ + get: operations["repos/list-comments-for-commit"]; + /** + * Create a comment for a commit using its `:commit_sha`. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + post: operations["repos/create-commit-comment"]; + }; + "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. */ + get: operations["repos/list-pull-requests-associated-with-commit"]; + }; + "/repos/{owner}/{repo}/commits/{ref}": { + /** + * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. + * + * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * + * 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. Diffs with binary data will have no `patch` property. + * + * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + get: operations["repos/get-commit"]; + }; + "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + get: operations["checks/list-for-ref"]; + }; + "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. + */ + get: operations["checks/list-suites-for-ref"]; + }; + "/repos/{owner}/{repo}/commits/{ref}/status": { + /** + * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. + * + * The most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts. + * + * Additionally, a combined `state` is returned. The `state` is one of: + * + * * **failure** if any of the contexts report as `error` or `failure` + * * **pending** if there are no statuses or a context is `pending` + * * **success** if the latest status for all contexts is `success` + */ + get: operations["repos/get-combined-status-for-ref"]; + }; + "/repos/{owner}/{repo}/commits/{ref}/statuses": { + /** + * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. + * + * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + */ + get: operations["repos/list-commit-statuses-for-ref"]; + }; + "/repos/{owner}/{repo}/community/code_of_conduct": { + /** + * Returns the contents of the repository's code of conduct file, if one is detected. + * + * A code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching. + */ + get: operations["codes-of-conduct/get-for-repo"]; + }; + "/repos/{owner}/{repo}/community/profile": { + /** + * This endpoint will return all community profile metrics, including an + * overall health score, repository description, the presence of documentation, detected + * code of conduct, detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE, + * README, and CONTRIBUTING files. + * + * The `health_percentage` score is defined as a percentage of how many of + * these four documents are present: README, CONTRIBUTING, LICENSE, and + * CODE_OF_CONDUCT. For example, if all four documents are present, then + * the `health_percentage` is `100`. If only one is present, then the + * `health_percentage` is `25`. + * + * `content_reports_enabled` is only returned for organization-owned repositories. + */ + get: operations["repos/get-community-profile-metrics"]; + }; + "/repos/{owner}/{repo}/compare/{basehead}": { + /** + * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. + * + * The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. 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. + * + * The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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. + * + * **Working with large comparisons** + * + * To process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)." + * + * When calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + get: operations["repos/compare-commits-with-basehead"]; + }; + "/repos/{owner}/{repo}/contents/{path}": { + /** + * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit + * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. + * + * Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for + * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media + * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent + * object format. + * + * **Note**: + * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). + * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees + * API](https://docs.github.com/rest/reference/git#get-a-tree). + * * This API supports files up to 1 megabyte in size. + * + * #### If the content is a directory + * The response will be an array of objects, one object for each item in the directory. + * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value + * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). + * In the next major version of the API, the type will be returned as "submodule". + * + * #### If the content is a symlink + * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the + * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object + * describing the symlink itself. + * + * #### If the content is a submodule + * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific + * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out + * the submodule at that specific commit. + * + * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the + * github.com URLs (`html_url` and `_links["html"]`) will have null values. + */ + get: operations["repos/get-content"]; + /** Creates a new file or replaces an existing file in a repository. */ + put: operations["repos/create-or-update-file-contents"]; + /** + * Deletes a file in a repository. + * + * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. + * + * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. + * + * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + */ + delete: operations["repos/delete-file"]; + }; + "/repos/{owner}/{repo}/contributors": { + /** + * 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 v3 caches contributor data to improve performance. + * + * 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. + */ + get: operations["repos/list-contributors"]; + }; + "/repos/{owner}/{repo}/deployments": { + /** Simple filtering of deployments is available via query parameters: */ + get: operations["repos/list-deployments"]; + /** + * Deployments offer a few configurable parameters with certain defaults. + * + * The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them + * before we merge a pull request. + * + * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have + * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter + * makes it easier to track which environments have requested deployments. The default environment is `production`. + * + * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If + * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, + * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will + * return a failure response. + * + * By default, [commit statuses](https://docs.github.com/rest/reference/repos#statuses) for every submitted context must be in a `success` + * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to + * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do + * not require any contexts or create any commit statuses, the deployment will always succeed. + * + * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text + * field that will be passed on when a deployment event is dispatched. + * + * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might + * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an + * application with debugging enabled. + * + * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. + * + * #### Merged branch response + * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating + * a deployment. This auto-merge happens when: + * * Auto-merge option is enabled in the repository + * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example + * * There are no merge conflicts + * + * If there are no new commits in the base branch, a new request to create a deployment should give a successful + * response. + * + * #### Merge conflict response + * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + * + * #### Failed commit status checks + * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` + * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + */ + post: operations["repos/create-deployment"]; + }; + "/repos/{owner}/{repo}/deployments/{deployment_id}": { + get: operations["repos/get-deployment"]; + /** + * To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment. + * + * To set a deployment as inactive, you must: + * + * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. + * * Mark the active deployment as inactive by adding any non-successful deployment status. + * + * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." + */ + delete: operations["repos/delete-deployment"]; + }; + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + /** Users with pull access can view deployment statuses for a deployment: */ + get: operations["repos/list-deployment-statuses"]; + /** + * Users with `push` access can create deployment statuses for a given deployment. + * + * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. + */ + post: operations["repos/create-deployment-status"]; + }; + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + /** Users with pull access can view a deployment status for a deployment: */ + get: operations["repos/get-deployment-status"]; + }; + "/repos/{owner}/{repo}/dispatches": { + /** + * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." + * + * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. + * + * This endpoint requires write access to the repository by providing either: + * + * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. + * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. + * + * This input example shows how you can use the `client_payload` as a test to debug your workflow. + */ + post: operations["repos/create-dispatch-event"]; + }; + "/repos/{owner}/{repo}/environments": { + /** + * Get all environments for 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. + */ + get: operations["repos/get-all-environments"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}": { + /** 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. */ + get: operations["repos/get-environment"]; + /** + * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." + * + * **Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see "[Environments](/actions/reference/environments#deployment-branches)." + * + * **Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)." + * + * You must authenticate using an access token with the repo scope to use this endpoint. + */ + put: operations["repos/create-or-update-environment"]; + /** You must authenticate using an access token with the repo scope to use this endpoint. */ + delete: operations["repos/delete-an-environment"]; + }; + "/repos/{owner}/{repo}/events": { + get: operations["activity/list-repo-events"]; + }; + "/repos/{owner}/{repo}/forks": { + get: operations["repos/list-forks"]; + /** + * Create a fork for the authenticated user. + * + * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com). + */ + post: operations["repos/create-fork"]; + }; + "/repos/{owner}/{repo}/git/blobs": { + post: operations["git/create-blob"]; + }; + "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + /** + * The `content` in the response will always be Base64 encoded. + * + * _Note_: This API supports blobs up to 100 megabytes in size. + */ + get: operations["git/get-blob"]; + }; + "/repos/{owner}/{repo}/git/commits": { + /** + * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + post: operations["git/create-commit"]; + }; + "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + /** + * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + get: operations["git/get-commit"]; + }; + "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + /** + * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. + * + * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. + * + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * + * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + */ + get: operations["git/list-matching-refs"]; + }; + "/repos/{owner}/{repo}/git/ref/{ref}": { + /** + * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. + * + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + */ + get: operations["git/get-ref"]; + }; + "/repos/{owner}/{repo}/git/refs": { + /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ + post: operations["git/create-ref"]; + }; + "/repos/{owner}/{repo}/git/refs/{ref}": { + delete: operations["git/delete-ref"]; + patch: operations["git/update-ref"]; + }; + "/repos/{owner}/{repo}/git/tags": { + /** + * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + post: operations["git/create-tag"]; + }; + "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + /** + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + get: operations["git/get-tag"]; + }; + "/repos/{owner}/{repo}/git/trees": { + /** + * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. + * + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." + */ + post: operations["git/create-tree"]; + }; + "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + /** + * Returns a single tree using the SHA1 value for that tree. + * + * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. + */ + get: operations["git/get-tree"]; + }; + "/repos/{owner}/{repo}/hooks": { + get: operations["repos/list-webhooks"]; + /** + * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can + * share the same `config` as long as those webhooks do not have any `events` that overlap. + */ + post: operations["repos/create-webhook"]; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}": { + /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */ + get: operations["repos/get-webhook"]; + delete: operations["repos/delete-webhook"]; + /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */ + patch: operations["repos/update-webhook"]; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + /** + * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." + * + * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + */ + get: operations["repos/get-webhook-config-for-repo"]; + /** + * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." + * + * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + */ + patch: operations["repos/update-webhook-config-for-repo"]; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ + post: operations["repos/ping-webhook"]; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + /** + * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. + * + * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + */ + post: operations["repos/test-push-webhook"]; + }; + "/repos/{owner}/{repo}/import": { + /** + * View the progress of an import. + * + * **Import status** + * + * This section includes details about the possible values of the `status` field of the Import Progress response. + * + * An import that does not have errors will progress through these steps: + * + * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. + * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). + * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. + * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". + * * `complete` - the import is complete, and the repository is ready on GitHub. + * + * If there are problems, you will see one of these in the `status` field: + * + * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information. + * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL. + * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * + * **The project_choices field** + * + * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. + * + * **Git LFS related fields** + * + * This section includes details about Git LFS related fields that may be present in the Import Progress response. + * + * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. + * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. + * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. + * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. + */ + get: operations["migrations/get-import-status"]; + /** Start a source import to a GitHub repository using GitHub Importer. */ + put: operations["migrations/start-import"]; + /** Stop an import for a repository. */ + delete: operations["migrations/cancel-import"]; + /** + * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API + * request. If no parameters are provided, the import will be restarted. + */ + patch: operations["migrations/update-import"]; + }; + "/repos/{owner}/{repo}/import/authors": { + /** + * 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 `. + * + * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. + */ + get: operations["migrations/get-commit-authors"]; + }; + "/repos/{owner}/{repo}/import/authors/{author_id}": { + /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ + patch: operations["migrations/map-commit-author"]; + }; + "/repos/{owner}/{repo}/import/large_files": { + /** List files larger than 100MB found during the import */ + get: operations["migrations/get-large-files"]; + }; + "/repos/{owner}/{repo}/import/lfs": { + /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/). */ + patch: operations["migrations/set-lfs-preference"]; + }; + "/repos/{owner}/{repo}/installation": { + /** + * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. + * + * 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. + */ + get: operations["apps/get-repo-installation"]; + }; + "/repos/{owner}/{repo}/interaction-limits": { + /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ + get: operations["interactions/get-restrictions-for-repo"]; + /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ + put: operations["interactions/set-restrictions-for-repo"]; + /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ + delete: operations["interactions/remove-restrictions-for-repo"]; + }; + "/repos/{owner}/{repo}/invitations": { + /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ + get: operations["repos/list-invitations"]; + }; + "/repos/{owner}/{repo}/invitations/{invitation_id}": { + delete: operations["repos/delete-invitation"]; + patch: operations["repos/update-invitation"]; + }; + "/repos/{owner}/{repo}/issues": { + /** + * List issues in a repository. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + get: operations["issues/list-for-repo"]; + /** + * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + post: operations["issues/create"]; + }; + "/repos/{owner}/{repo}/issues/comments": { + /** By default, Issue Comments are ordered by ascending ID. */ + get: operations["issues/list-comments-for-repo"]; + }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + get: operations["issues/get-comment"]; + delete: operations["issues/delete-comment"]; + patch: operations["issues/update-comment"]; + }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ + get: operations["reactions/list-for-issue-comment"]; + /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ + post: operations["reactions/create-for-issue-comment"]; + }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * + * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + */ + delete: operations["reactions/delete-for-issue-comment"]; + }; + "/repos/{owner}/{repo}/issues/events": { + get: operations["issues/list-events-for-repo"]; + }; + "/repos/{owner}/{repo}/issues/events/{event_id}": { + get: operations["issues/get-event"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}": { + /** + * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was + * [transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If + * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe + * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + get: operations["issues/get"]; + /** Issue owners and users with push access can edit an issue. */ + patch: operations["issues/update"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ + post: operations["issues/add-assignees"]; + /** Removes one or more assignees from an issue. */ + delete: operations["issues/remove-assignees"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + /** Issue Comments are ordered by ascending ID. */ + get: operations["issues/list-comments"]; + /** This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. */ + post: operations["issues/create-comment"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/events": { + get: operations["issues/list-events"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + get: operations["issues/list-labels-on-issue"]; + /** Removes any previous labels and sets the new labels for an issue. */ + put: operations["issues/set-labels"]; + post: operations["issues/add-labels"]; + delete: operations["issues/remove-all-labels"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ + delete: operations["issues/remove-label"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + /** + * Users with push access can lock an issue or pull request's conversation. + * + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + put: operations["issues/lock"]; + /** Users with push access can unlock an issue's conversation. */ + delete: operations["issues/unlock"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ + get: operations["reactions/list-for-issue"]; + /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ + post: operations["reactions/create-for-issue"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * + * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + */ + delete: operations["reactions/delete-for-issue"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + get: operations["issues/list-events-for-timeline"]; + }; + "/repos/{owner}/{repo}/keys": { + get: operations["repos/list-deploy-keys"]; + /** You can create a read-only deploy key. */ + post: operations["repos/create-deploy-key"]; + }; + "/repos/{owner}/{repo}/keys/{key_id}": { + get: operations["repos/get-deploy-key"]; + /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ + delete: operations["repos/delete-deploy-key"]; + }; + "/repos/{owner}/{repo}/labels": { + get: operations["issues/list-labels-for-repo"]; + post: operations["issues/create-label"]; + }; + "/repos/{owner}/{repo}/labels/{name}": { + get: operations["issues/get-label"]; + delete: operations["issues/delete-label"]; + patch: operations["issues/update-label"]; + }; + "/repos/{owner}/{repo}/languages": { + /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ + get: operations["repos/list-languages"]; + }; + "/repos/{owner}/{repo}/license": { + /** + * This method returns the contents of the repository's license file, if one is detected. + * + * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. + */ + get: operations["licenses/get-for-repo"]; + }; + "/repos/{owner}/{repo}/merges": { + post: operations["repos/merge"]; + }; + "/repos/{owner}/{repo}/milestones": { + get: operations["issues/list-milestones"]; + post: operations["issues/create-milestone"]; + }; + "/repos/{owner}/{repo}/milestones/{milestone_number}": { + get: operations["issues/get-milestone"]; + delete: operations["issues/delete-milestone"]; + patch: operations["issues/update-milestone"]; + }; + "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + get: operations["issues/list-labels-for-milestone"]; + }; + "/repos/{owner}/{repo}/notifications": { + /** List all notifications for the current user. */ + get: operations["activity/list-repo-notifications-for-authenticated-user"]; + /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). 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`. */ + put: operations["activity/mark-repo-notifications-as-read"]; + }; + "/repos/{owner}/{repo}/pages": { + get: operations["repos/get-pages"]; + /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */ + put: operations["repos/update-information-about-pages-site"]; + /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */ + post: operations["repos/create-pages-site"]; + delete: operations["repos/delete-pages-site"]; + }; + "/repos/{owner}/{repo}/pages/builds": { + get: operations["repos/list-pages-builds"]; + /** + * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. + * + * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + */ + post: operations["repos/request-pages-build"]; + }; + "/repos/{owner}/{repo}/pages/builds/latest": { + get: operations["repos/get-latest-pages-build"]; + }; + "/repos/{owner}/{repo}/pages/builds/{build_id}": { + get: operations["repos/get-pages-build"]; + }; + "/repos/{owner}/{repo}/pages/health": { + /** + * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. + * + * 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. + * + * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. + */ + get: operations["repos/get-pages-health-check"]; + }; + "/repos/{owner}/{repo}/projects": { + /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ + get: operations["projects/list-for-repo"]; + /** Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ + post: operations["projects/create-for-repo"]; + }; + "/repos/{owner}/{repo}/pulls": { + /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + get: operations["pulls/list"]; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + * + * You can create a new pull request. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + post: operations["pulls/create"]; + }; + "/repos/{owner}/{repo}/pulls/comments": { + /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */ + get: operations["pulls/list-review-comments-for-repo"]; + }; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + /** Provides details for a review comment. */ + get: operations["pulls/get-review-comment"]; + /** Deletes a review comment. */ + delete: operations["pulls/delete-review-comment"]; + /** Enables you to edit a review comment. */ + patch: operations["pulls/update-review-comment"]; + }; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ + get: operations["reactions/list-for-pull-request-review-comment"]; + /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ + post: operations["reactions/create-for-pull-request-review-comment"]; + }; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * + * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + */ + delete: operations["reactions/delete-for-pull-request-comment"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}": { + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists details of a pull request by providing its number. + * + * When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * + * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. + * + * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: + * + * * If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * + * 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. + */ + get: operations["pulls/get"]; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + */ + patch: operations["pulls/update"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */ + get: operations["pulls/list-review-comments"]; + /** + * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. + * + * You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices). + * + * **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. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + post: operations["pulls/create-review-comment"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + /** + * 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. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + post: operations["pulls/create-reply-for-review-comment"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */ + get: operations["pulls/list-commits"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ + get: operations["pulls/list-files"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + get: operations["pulls/check-if-merged"]; + /** 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. */ + put: operations["pulls/merge"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + get: operations["pulls/list-requested-reviewers"]; + /** 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. */ + post: operations["pulls/request-reviewers"]; + delete: operations["pulls/remove-requested-reviewers"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + /** The list of reviews returns in chronological order. */ + get: operations["pulls/list-reviews"]; + /** + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * Pull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response. + * + * **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 v3 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. + * + * 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. + */ + post: operations["pulls/create-review"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + get: operations["pulls/get-review"]; + /** Update the review summary comment with new text. */ + put: operations["pulls/update-review"]; + delete: operations["pulls/delete-pending-review"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + /** List comments for a specific pull request review. */ + get: operations["pulls/list-comments-for-review"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ + put: operations["pulls/dismiss-review"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + post: operations["pulls/submit-review"]; + }; + "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ + put: operations["pulls/update-branch"]; + }; + "/repos/{owner}/{repo}/readme": { + /** + * Gets the preferred README for a repository. + * + * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + */ + get: operations["repos/get-readme"]; + }; + "/repos/{owner}/{repo}/readme/{dir}": { + /** + * Gets the README from a repository directory. + * + * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + */ + get: operations["repos/get-readme-in-directory"]; + }; + "/repos/{owner}/{repo}/releases": { + /** + * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). + * + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + */ + get: operations["repos/list-releases"]; + /** + * Users with push access to the repository can create a release. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + post: operations["repos/create-release"]; + }; + "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ + get: operations["repos/get-release-asset"]; + delete: operations["repos/delete-release-asset"]; + /** Users with push access to the repository can edit a release asset. */ + patch: operations["repos/update-release-asset"]; + }; + "/repos/{owner}/{repo}/releases/latest": { + /** + * View the latest published full release for the repository. + * + * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + */ + get: operations["repos/get-latest-release"]; + }; + "/repos/{owner}/{repo}/releases/tags/{tag}": { + /** Get a published release with the specified tag. */ + get: operations["repos/get-release-by-tag"]; + }; + "/repos/{owner}/{repo}/releases/{release_id}": { + /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ + get: operations["repos/get-release"]; + /** Users with push access to the repository can delete a release. */ + delete: operations["repos/delete-release"]; + /** Users with push access to the repository can edit a release. */ + patch: operations["repos/update-release"]; + }; + "/repos/{owner}/{repo}/releases/{release_id}/assets": { + get: operations["repos/list-release-assets"]; + /** + * 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 + * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. + * + * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. + * + * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: + * + * `application/zip` + * + * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, + * you'll still need to pass your authentication to be able to upload an asset. + * + * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. + * + * **Notes:** + * * 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)" + * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact). + * * 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. + */ + post: operations["repos/upload-release-asset"]; + }; + "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ + post: operations["reactions/create-for-release"]; + }; + "/repos/{owner}/{repo}/secret-scanning/alerts": { + /** + * Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + */ + get: operations["secret-scanning/list-alerts-for-repo"]; + }; + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + /** + * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + */ + get: operations["secret-scanning/get-alert"]; + /** + * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + */ + patch: operations["secret-scanning/update-alert"]; + }; + "/repos/{owner}/{repo}/stargazers": { + /** + * Lists the people that have starred the repository. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + get: operations["activity/list-stargazers-for-repo"]; + }; + "/repos/{owner}/{repo}/stats/code_frequency": { + /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ + get: operations["repos/get-code-frequency-stats"]; + }; + "/repos/{owner}/{repo}/stats/commit_activity": { + /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ + get: operations["repos/get-commit-activity-stats"]; + }; + "/repos/{owner}/{repo}/stats/contributors": { + /** + * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: + * + * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits + */ + get: operations["repos/get-contributors-stats"]; + }; + "/repos/{owner}/{repo}/stats/participation": { + /** + * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. + * + * The array order is oldest week (index 0) to most recent week. + */ + get: operations["repos/get-participation-stats"]; + }; + "/repos/{owner}/{repo}/stats/punch_card": { + /** + * Each array contains the day number, hour number, and number of commits: + * + * * `0-6`: Sunday - Saturday + * * `0-23`: Hour of day + * * Number of commits + * + * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + */ + get: operations["repos/get-punch-card-stats"]; + }; + "/repos/{owner}/{repo}/statuses/{sha}": { + /** + * Users with push access in a repository can create commit statuses for a given SHA. + * + * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + */ + post: operations["repos/create-commit-status"]; + }; + "/repos/{owner}/{repo}/subscribers": { + /** Lists the people watching the specified repository. */ + get: operations["activity/list-watchers-for-repo"]; + }; + "/repos/{owner}/{repo}/subscription": { + get: operations["activity/get-repo-subscription"]; + /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */ + put: operations["activity/set-repo-subscription"]; + /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */ + delete: operations["activity/delete-repo-subscription"]; + }; + "/repos/{owner}/{repo}/tags": { + get: operations["repos/list-tags"]; + }; + "/repos/{owner}/{repo}/tarball/{ref}": { + /** + * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually + * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + * the `Location` header to make a second `GET` request. + * **Note**: For private repositories, these links are temporary and expire after five minutes. + */ + get: operations["repos/download-tarball-archive"]; + }; + "/repos/{owner}/{repo}/teams": { + get: operations["repos/list-teams"]; + }; + "/repos/{owner}/{repo}/topics": { + get: operations["repos/get-all-topics"]; + put: operations["repos/replace-all-topics"]; + }; + "/repos/{owner}/{repo}/traffic/clones": { + /** 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. */ + get: operations["repos/get-clones"]; + }; + "/repos/{owner}/{repo}/traffic/popular/paths": { + /** Get the top 10 popular contents over the last 14 days. */ + get: operations["repos/get-top-paths"]; + }; + "/repos/{owner}/{repo}/traffic/popular/referrers": { + /** Get the top 10 referrers over the last 14 days. */ + get: operations["repos/get-top-referrers"]; + }; + "/repos/{owner}/{repo}/traffic/views": { + /** Get the total number of views 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. */ + get: operations["repos/get-views"]; + }; + "/repos/{owner}/{repo}/transfer": { + /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/). */ + post: operations["repos/transfer"]; + }; + "/repos/{owner}/{repo}/vulnerability-alerts": { + /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ + get: operations["repos/check-vulnerability-alerts"]; + /** 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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ + put: operations["repos/enable-vulnerability-alerts"]; + /** Disables 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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ + delete: operations["repos/disable-vulnerability-alerts"]; + }; + "/repos/{owner}/{repo}/zipball/{ref}": { + /** + * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually + * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + * the `Location` header to make a second `GET` request. + * **Note**: For private repositories, these links are temporary and expire after five minutes. + */ + get: operations["repos/download-zipball-archive"]; + }; + "/repos/{template_owner}/{template_repo}/generate": { + /** + * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. + * * `repo` scope to create a private repository + */ + post: operations["repos/create-using-template"]; + }; + "/repositories": { + /** + * Lists all public repositories in the order that they were created. + * + * Note: + * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. + */ + get: operations["repos/list-public"]; + }; + "/repositories/{repository_id}/environments/{environment_name}/secrets": { + /** Lists all secrets available in an environment 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. */ + get: operations["actions/list-environment-secrets"]; + }; + "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { + /** Get the public key for an environment, which you need to encrypt environment 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 `secrets` repository permission to use this endpoint. */ + get: operations["actions/get-environment-public-key"]; + }; + "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { + /** Gets a single environment 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. */ + get: operations["actions/get-environment-secret"]; + /** + * Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + put: operations["actions/create-or-update-environment-secret"]; + /** Deletes a secret in an environment 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. */ + delete: operations["actions/delete-environment-secret"]; + }; + "/scim/v2/enterprises/{enterprise}/Groups": { + /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ + get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. + */ + post: operations["enterprise-admin/provision-and-invite-enterprise-group"]; + }; + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ + get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + */ + put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; + /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ + delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + */ + patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; + }; + "/scim/v2/enterprises/{enterprise}/Users": { + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Retrieves a paginated list of all provisioned enterprise members, including pending invitations. + * + * When a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member: + * - When a user with a SCIM-provisioned external identity is removed from an enterprise, the account's metadata is preserved to allow the user to re-join the organization in the future. + * - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). + * - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. + * + * The returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO: + * + * 1. The user is granted access by the IdP and is not a member of the GitHub enterprise. + * + * 1. The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account. + * + * 1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub account: + * - If the user signs in, their GitHub account is linked to this entry. + * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. + */ + get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Provision enterprise membership for a user, and send organization invitation emails to the email address. + * + * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. + */ + post: operations["enterprise-admin/provision-and-invite-enterprise-user"]; + }; + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ + get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-an-enterprise-scim-user) endpoint instead. + * + * You must at least provide the required values for the user: `userName`, `name`, and `emails`. + * + * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. + */ + put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; + /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ + delete: operations["enterprise-admin/delete-user-from-enterprise"]; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + * + * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * **Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated `:scim_user_id`. + * + * ``` + * { + * "Operations":[{ + * "op":"replace", + * "value":{ + * "active":false + * } + * }] + * } + * ``` + */ + patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; + }; + "/scim/v2/organizations/{org}/Users": { + /** + * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. + * + * When a user with a SAML-provisioned external identity leaves (or is removed from) an organization, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member: + * - When a user with a SCIM-provisioned external identity is removed from an organization, the account's metadata is preserved to allow the user to re-join the organization in the future. + * - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). + * - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. + * + * The returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO: + * + * 1. The user is granted access by the IdP and is not a member of the GitHub organization. + * + * 1. The user attempts to access the GitHub organization and initiates the SAML SSO process, and is not currently signed in to their GitHub account. + * + * 1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub account: + * - If the user signs in, their GitHub account is linked to this entry. + * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. + */ + get: operations["scim/list-provisioned-identities"]; + /** Provision organization membership for a user, and send an activation email to the email address. */ + post: operations["scim/provision-and-invite-user"]; + }; + "/scim/v2/organizations/{org}/Users/{scim_user_id}": { + get: operations["scim/get-provisioning-information-for-user"]; + /** + * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. + * + * You must at least provide the required values for the user: `userName`, `name`, and `emails`. + * + * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. + */ + put: operations["scim/set-information-for-provisioned-user"]; + delete: operations["scim/delete-user-from-org"]; + /** + * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + * + * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * **Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`. + * + * ``` + * { + * "Operations":[{ + * "op":"replace", + * "value":{ + * "active":false + * } + * }] + * } + * ``` + */ + patch: operations["scim/update-attribute-for-user"]; + }; + "/search/code": { + /** + * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: + * + * `q=addClass+in:file+language:js+repo:jquery/jquery` + * + * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. + * + * #### Considerations for code search + * + * Due to the complexity of searching code, there are a few restrictions on how searches are performed: + * + * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. + * * Only files smaller than 384 KB are searchable. + * * 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 + * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. + */ + get: operations["search/code"]; + }; + "/search/commits": { + /** + * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * 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 + * metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: + * + * `q=repo:octocat/Spoon-Knife+css` + */ + get: operations["search/commits"]; + }; + "/search/issues": { + /** + * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted + * search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. + * + * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + * + * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. + * + * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + */ + get: operations["search/issues-and-pull-requests"]; + }; + "/search/labels": { + /** + * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: + * + * `q=bug+defect+enhancement&repository_id=64778136` + * + * The labels that best match the query appear first in the search results. + */ + get: operations["search/labels"]; + }; + "/search/repositories": { + /** + * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: + * + * `q=tetris+language:assembly&sort=stars&order=desc` + * + * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + * + * When you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this: + * + * `q=topic:ruby+topic:rails` + */ + get: operations["search/repos"]; + }; + "/search/topics": { + /** + * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://help.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + * + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: + * + * `q=ruby+is:featured` + * + * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + */ + get: operations["search/topics"]; + }; + "/search/users": { + /** + * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you're looking for a list of popular users, you might try this query: + * + * `q=tom+repos:%3E42+followers:%3E1000` + * + * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + */ + get: operations["search/users"]; + }; + "/teams/{team_id}": { + /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */ + get: operations["teams/get-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. + * + * To delete a team, the authenticated user must be an organization owner or team maintainer. + * + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + */ + delete: operations["teams/delete-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. + * + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * + * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + */ + patch: operations["teams/update-legacy"]; + }; + "/teams/{team_id}/discussions": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. + * + * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + get: operations["teams/list-discussions-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. + * + * 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/). + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + post: operations["teams/create-discussion-legacy"]; + }; + "/teams/{team_id}/discussions/{discussion_number}": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. + * + * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + get: operations["teams/get-discussion-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. + * + * Delete a discussion from 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/). + */ + delete: operations["teams/delete-discussion-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. + * + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + patch: operations["teams/update-discussion-legacy"]; + }; + "/teams/{team_id}/discussions/{discussion_number}/comments": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. + * + * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + get: operations["teams/list-discussion-comments-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. + * + * 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/). + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + post: operations["teams/create-discussion-comment-legacy"]; + }; + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. + * + * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + get: operations["teams/get-discussion-comment-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. + * + * Deletes a 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/). + */ + delete: operations["teams/delete-discussion-comment-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. + * + * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + patch: operations["teams/update-discussion-comment-legacy"]; + }; + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * + * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + get: operations["reactions/list-for-team-discussion-comment-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + */ + post: operations["reactions/create-for-team-discussion-comment-legacy"]; + }; + "/teams/{team_id}/discussions/{discussion_number}/reactions": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. + * + * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + get: operations["reactions/list-for-team-discussion-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. + * + * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + */ + post: operations["reactions/create-for-team-discussion-legacy"]; + }; + "/teams/{team_id}/invitations": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. + * + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + */ + get: operations["teams/list-pending-invitations-legacy"]; + }; + "/teams/{team_id}/members": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. + * + * Team members will include the members of child teams. + */ + get: operations["teams/list-members-legacy"]; + }; + "/teams/{team_id}/members/{username}": { + /** + * The "Get team member" endpoint (described below) is deprecated. + * + * We recommend using the [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * + * To list members in a team, the team must be visible to the authenticated user. + */ + get: operations["teams/get-member-legacy"]; + /** + * The "Add team member" endpoint (described below) is deprecated. + * + * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + put: operations["teams/add-member-legacy"]; + /** + * The "Remove team member" endpoint (described below) is deprecated. + * + * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + */ + delete: operations["teams/remove-member-legacy"]; + }; + "/teams/{team_id}/memberships/{username}": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. + * + * Team members will include the members of child teams. + * + * To get a user's membership with a team, the team must be visible to the authenticated user. + * + * **Note:** + * The response contains the `state` of the membership and the member's `role`. + * + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). + */ + get: operations["teams/get-membership-for-user-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. + * + * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + */ + put: operations["teams/add-or-update-membership-for-user-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + */ + delete: operations["teams/remove-membership-for-user-legacy"]; + }; + "/teams/{team_id}/projects": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. + * + * Lists the organization projects for a team. + */ + get: operations["teams/list-projects-legacy"]; + }; + "/teams/{team_id}/projects/{project_id}": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. + * + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + */ + get: operations["teams/check-permissions-for-project-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. + * + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + */ + put: operations["teams/add-or-update-project-permissions-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. + * + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + */ + delete: operations["teams/remove-project-legacy"]; + }; + "/teams/{team_id}/repos": { + /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */ + get: operations["teams/list-repos-legacy"]; + }; + "/teams/{team_id}/repos/{owner}/{repo}": { + /** + * **Note**: Repositories inherited through a parent team will also be checked. + * + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint. + * + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + get: operations["teams/check-permissions-for-repo-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. + * + * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. + * + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + put: operations["teams/add-or-update-repo-permissions-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. + * + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + */ + delete: operations["teams/remove-repo-legacy"]; + }; + "/teams/{team_id}/team-sync/group-mappings": { + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * List IdP groups connected to a team on GitHub. + */ + get: operations["teams/list-idp-groups-for-legacy"]; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. + */ + patch: operations["teams/create-or-update-idp-group-connections-legacy"]; + }; + "/teams/{team_id}/teams": { + /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */ + get: operations["teams/list-child-legacy"]; + }; + "/user": { + /** + * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. + * + * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + */ + get: operations["users/get-authenticated"]; + /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ + patch: operations["users/update-authenticated"]; + }; + "/user/blocks": { + /** List the users you've blocked on your personal account. */ + get: operations["users/list-blocked-by-authenticated"]; + }; + "/user/blocks/{username}": { + get: operations["users/check-blocked"]; + put: operations["users/block"]; + delete: operations["users/unblock"]; + }; + "/user/email/visibility": { + /** Sets the visibility for your primary email addresses. */ + patch: operations["users/set-primary-email-visibility-for-authenticated"]; + }; + "/user/emails": { + /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ + get: operations["users/list-emails-for-authenticated"]; + /** This endpoint is accessible with the `user` scope. */ + post: operations["users/add-email-for-authenticated"]; + /** This endpoint is accessible with the `user` scope. */ + delete: operations["users/delete-email-for-authenticated"]; + }; + "/user/followers": { + /** Lists the people following the authenticated user. */ + get: operations["users/list-followers-for-authenticated-user"]; + }; + "/user/following": { + /** Lists the people who the authenticated user follows. */ + get: operations["users/list-followed-by-authenticated"]; + }; + "/user/following/{username}": { + get: operations["users/check-person-is-followed-by-authenticated"]; + /** + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + */ + put: operations["users/follow"]; + /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ + delete: operations["users/unfollow"]; + }; + "/user/gpg_keys": { + /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + get: operations["users/list-gpg-keys-for-authenticated"]; + /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + post: operations["users/create-gpg-key-for-authenticated"]; + }; + "/user/gpg_keys/{gpg_key_id}": { + /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + get: operations["users/get-gpg-key-for-authenticated"]; + /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + delete: operations["users/delete-gpg-key-for-authenticated"]; + }; + "/user/installations": { + /** + * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. + * + * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * + * You can find the permissions for the installation under the `permissions` key. + */ + get: operations["apps/list-installations-for-authenticated-user"]; + }; + "/user/installations/{installation_id}/repositories": { + /** + * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * + * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. + * + * The access the user has to each repository is included in the hash under the `permissions` key. + */ + get: operations["apps/list-installation-repos-for-authenticated-user"]; + }; + "/user/installations/{installation_id}/repositories/{repository_id}": { + /** + * Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + */ + put: operations["apps/add-repo-to-installation"]; + /** + * Remove a single repository from an installation. The authenticated user must have admin access to the repository. + * + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + */ + delete: operations["apps/remove-repo-from-installation"]; + }; + "/user/interaction-limits": { + /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ + get: operations["interactions/get-restrictions-for-authenticated-user"]; + /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ + put: operations["interactions/set-restrictions-for-authenticated-user"]; + /** Removes any interaction restrictions from your public repositories. */ + delete: operations["interactions/remove-restrictions-for-authenticated-user"]; + }; + "/user/issues": { + /** + * List issues across owned and member repositories assigned to the authenticated user. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + get: operations["issues/list-for-authenticated-user"]; + }; + "/user/keys": { + /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + get: operations["users/list-public-ssh-keys-for-authenticated"]; + /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + post: operations["users/create-public-ssh-key-for-authenticated"]; + }; + "/user/keys/{key_id}": { + /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + get: operations["users/get-public-ssh-key-for-authenticated"]; + /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + delete: operations["users/delete-public-ssh-key-for-authenticated"]; + }; + "/user/marketplace_purchases": { + /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ + get: operations["apps/list-subscriptions-for-authenticated-user"]; + }; + "/user/marketplace_purchases/stubbed": { + /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ + get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; + }; + "/user/memberships/orgs": { + get: operations["orgs/list-memberships-for-authenticated-user"]; + }; + "/user/memberships/orgs/{org}": { + get: operations["orgs/get-membership-for-authenticated-user"]; + patch: operations["orgs/update-membership-for-authenticated-user"]; + }; + "/user/migrations": { + /** Lists all migrations a user has started. */ + get: operations["migrations/list-for-authenticated-user"]; + /** Initiates the generation of a user migration archive. */ + post: operations["migrations/start-for-authenticated-user"]; + }; + "/user/migrations/{migration_id}": { + /** + * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: + * + * * `pending` - the migration hasn't started yet. + * * `exporting` - the migration is in progress. + * * `exported` - the migration finished successfully. + * * `failed` - the migration failed. + * + * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). + */ + get: operations["migrations/get-status-for-authenticated-user"]; + }; + "/user/migrations/{migration_id}/archive": { + /** + * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: + * + * * attachments + * * bases + * * commit\_comments + * * issue\_comments + * * issue\_events + * * issues + * * milestones + * * organizations + * * projects + * * protected\_branches + * * pull\_request\_reviews + * * pull\_requests + * * releases + * * repositories + * * review\_comments + * * schema + * * users + * + * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. + */ + get: operations["migrations/get-archive-for-authenticated-user"]; + /** 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/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ + delete: operations["migrations/delete-archive-for-authenticated-user"]; + }; + "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#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/reference/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. */ + delete: operations["migrations/unlock-repo-for-authenticated-user"]; + }; + "/user/migrations/{migration_id}/repositories": { + /** Lists all the repositories for this user migration. */ + get: operations["migrations/list-repos-for-user"]; + }; + "/user/orgs": { + /** + * List organizations for the authenticated user. + * + * **OAuth scope requirements** + * + * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + */ + get: operations["orgs/list-for-authenticated-user"]; + }; + "/user/packages/{package_type}/{package_name}": { + /** + * Gets a specific package for a package owned by the authenticated user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + get: operations["packages/get-package-for-authenticated-user"]; + /** + * 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. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + delete: operations["packages/delete-package-for-authenticated-user"]; + }; + "/user/packages/{package_type}/{package_name}/restore": { + /** + * Restores a package owned by the authenticated user. + * + * You can restore a deleted package under the following conditions: + * - The package was deleted within the last 30 days. + * - 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. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scope. If `package_type` is not `container`, your token must also include the `repo` scope. + */ + post: operations["packages/restore-package-for-authenticated-user"]; + }; + "/user/packages/{package_type}/{package_name}/versions": { + /** + * Returns all package versions for a package owned by the authenticated user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; + }; + "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + /** + * Gets a specific package version for a package owned by the authenticated user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + get: operations["packages/get-package-version-for-authenticated-user"]; + /** + * 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + delete: operations["packages/delete-package-version-for-authenticated-user"]; + }; + "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + /** + * Restores a package version owned by the authenticated user. + * + * You can restore a deleted package version under the following conditions: + * - The package was deleted within the last 30 days. + * - 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. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scope. If `package_type` is not `container`, your token must also include the `repo` scope. + */ + post: operations["packages/restore-package-version-for-authenticated-user"]; + }; + "/user/projects": { + post: operations["projects/create-for-authenticated-user"]; + }; + "/user/public_emails": { + /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ + get: operations["users/list-public-emails-for-authenticated"]; + }; + "/user/repos": { + /** + * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + */ + get: operations["repos/list-for-authenticated-user"]; + /** + * Creates a new repository for the authenticated user. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. + * * `repo` scope to create a private repository. + */ + post: operations["repos/create-for-authenticated-user"]; + }; + "/user/repository_invitations": { + /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ + get: operations["repos/list-invitations-for-authenticated-user"]; + }; + "/user/repository_invitations/{invitation_id}": { + delete: operations["repos/decline-invitation"]; + patch: operations["repos/accept-invitation"]; + }; + "/user/starred": { + /** + * Lists repositories the authenticated user has starred. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + get: operations["activity/list-repos-starred-by-authenticated-user"]; + }; + "/user/starred/{owner}/{repo}": { + get: operations["activity/check-repo-is-starred-by-authenticated-user"]; + /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ + put: operations["activity/star-repo-for-authenticated-user"]; + delete: operations["activity/unstar-repo-for-authenticated-user"]; + }; + "/user/subscriptions": { + /** Lists repositories the authenticated user is watching. */ + get: operations["activity/list-watched-repos-for-authenticated-user"]; + }; + "/user/teams": { + /** 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/). */ + get: operations["teams/list-for-authenticated-user"]; + }; + "/users": { + /** + * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. + * + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. + */ + get: operations["users/list"]; + }; + "/users/{username}": { + /** + * Provides publicly available information about someone with a GitHub account. + * + * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". + */ + get: operations["users/get-by-username"]; + }; + "/users/{username}/events": { + /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ + get: operations["activity/list-events-for-authenticated-user"]; + }; + "/users/{username}/events/orgs/{org}": { + /** This is the user's organization dashboard. You must be authenticated as the user to view this. */ + get: operations["activity/list-org-events-for-authenticated-user"]; + }; + "/users/{username}/events/public": { + get: operations["activity/list-public-events-for-user"]; + }; + "/users/{username}/followers": { + /** Lists the people following the specified user. */ + get: operations["users/list-followers-for-user"]; + }; + "/users/{username}/following": { + /** Lists the people who the specified user follows. */ + get: operations["users/list-following-for-user"]; + }; + "/users/{username}/following/{target_user}": { + get: operations["users/check-following-for-user"]; + }; + "/users/{username}/gists": { + /** Lists public gists for the specified user: */ + get: operations["gists/list-for-user"]; + }; + "/users/{username}/gpg_keys": { + /** Lists the GPG keys for a user. This information is accessible by anyone. */ + get: operations["users/list-gpg-keys-for-user"]; + }; + "/users/{username}/hovercard": { + /** + * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + * + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: + * + * ```shell + * curl -u username:token + * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 + * ``` + */ + get: operations["users/get-context-for-user"]; + }; + "/users/{username}/installation": { + /** + * Enables an authenticated GitHub App to find the user’s installation information. + * + * 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. + */ + get: operations["apps/get-user-installation"]; + }; + "/users/{username}/keys": { + /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ + get: operations["users/list-public-keys-for-user"]; + }; + "/users/{username}/orgs": { + /** + * List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. + * + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. + */ + get: operations["orgs/list-for-user"]; + }; + "/users/{username}/packages/{package_type}/{package_name}": { + /** + * Gets a specific package metadata for a public package owned by a user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + get: operations["packages/get-package-for-user"]; + }; + "/users/{username}/packages/{package_type}/{package_name}/versions": { + /** + * Returns all package versions for a public package owned by a specified user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; + }; + "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + /** + * Gets a specific package version for a public package owned by a specified user. + * + * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + get: operations["packages/get-package-version-for-user"]; + }; + "/users/{username}/projects": { + get: operations["projects/list-for-user"]; + }; + "/users/{username}/received_events": { + /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ + get: operations["activity/list-received-events-for-user"]; + }; + "/users/{username}/received_events/public": { + get: operations["activity/list-received-public-events-for-user"]; + }; + "/users/{username}/repos": { + /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */ + get: operations["repos/list-for-user"]; + }; + "/users/{username}/settings/billing/actions": { + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * Access tokens must have the `user` scope. + */ + get: operations["billing/get-github-actions-billing-user"]; + }; + "/users/{username}/settings/billing/packages": { + /** + * Gets the free and paid storage used for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `user` scope. + */ + get: operations["billing/get-github-packages-billing-user"]; + }; + "/users/{username}/settings/billing/shared-storage": { + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `user` scope. + */ + get: operations["billing/get-shared-storage-billing-user"]; + }; + "/users/{username}/starred": { + /** + * Lists repositories a user has starred. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + get: operations["activity/list-repos-starred-by-user"]; + }; + "/users/{username}/subscriptions": { + /** Lists repositories a user is watching. */ + get: operations["activity/list-repos-watched-by-user"]; + }; + "/zen": { + /** Get a random sentence from the Zen of GitHub */ + get: operations["meta/get-zen"]; + }; + "/repos/{owner}/{repo}/compare/{base}...{head}": { + /** + * **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. + * + * The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. 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. + * + * The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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. + * + * **Working with large comparisons** + * + * To process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)." + * + * When calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + get: operations["repos/compare-commits"]; + }; + "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": { + /** + * Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. + * + * The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + post: operations["apps/create-content-attachment-for-repo"]; + }; + "/content_references/{content_reference_id}/attachments": { + /** + * **Deprecated:** use `apps.createContentAttachmentForRepo()` (`POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments`) instead. Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. + * + * The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + post: operations["apps/create-content-attachment"]; + }; +} +export interface components { + schemas: { + /** Simple User */ + "simple-user": ({ + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string | null; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + starred_at?: string; + } & { + [key: string]: any; + }) | null; + /** GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ + integration: { + /** Unique identifier of the GitHub app */ + id: number; + /** The slug name of the GitHub app */ + slug?: string; + node_id: string; + owner: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + /** The name of the GitHub app */ + name: string; + description: string | null; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + /** The set of permissions for the GitHub app */ + permissions: { + issues?: string; + checks?: string; + metadata?: string; + contents?: string; + deployments?: string; + } & { + [key: string]: string; + }; + /** The list of events for the GitHub app */ + events: string[]; + /** The number of installations associated with the GitHub app */ + installations_count?: number; + client_id?: string; + client_secret?: string; + webhook_secret?: string | null; + pem?: string; + } & { + [key: string]: any; + }; + /** Basic Error */ + "basic-error": { + message?: string; + documentation_url?: string; + url?: string; + status?: string; + } & { + [key: string]: any; + }; + /** Validation Error Simple */ + "validation-error-simple": { + message: string; + documentation_url: string; + errors?: string[]; + } & { + [key: string]: any; + }; + /** The URL to which the payloads will be delivered. */ + "webhook-config-url": string; + /** The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. */ + "webhook-config-content-type": string; + /** If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). */ + "webhook-config-secret": string; + "webhook-config-insecure-ssl": (string | number) & { + [key: string]: any; + }; + /** Configuration object of the webhook */ + "webhook-config": { + url?: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + } & { + [key: string]: any; + }; + /** An enterprise account */ + enterprise: { + /** A short description of the enterprise. */ + description?: string | null; + html_url: string; + /** The enterprise's website URL. */ + website_url?: string | null; + /** Unique identifier of the enterprise */ + id: number; + node_id: string; + /** The name of the enterprise. */ + name: string; + /** The slug url identifier for the enterprise. */ + slug: string; + created_at: string | null; + updated_at: string | null; + avatar_url: string; + } & { + [key: string]: any; + }; + /** Installation */ + installation: { + /** The ID of the installation. */ + id: number; + account: ((Partial & Partial) & { + [key: string]: any; + }) | null; + /** Describe whether all repositories have been selected or there's a selection involved */ + repository_selection: "all" | "selected"; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + /** The ID of the user or organization this token is being scoped to. */ + target_id: number; + target_type: string; + permissions: { + deployments?: string; + checks?: string; + metadata?: string; + contents?: string; + pull_requests?: string; + statuses?: string; + issues?: string; + organization_administration?: string; + } & { + [key: string]: any; + }; + events: string[]; + created_at: string; + updated_at: string; + single_file_name: string | null; + has_multiple_single_files?: boolean; + single_file_paths?: string[]; + app_slug: string; + suspended_by: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + suspended_at: string | null; + contact_email?: string | null; + } & { + [key: string]: any; + }; + /** The permissions granted to the user-to-server access token. */ + "app-permissions": { + /** The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`. */ + actions?: "read" | "write"; + /** The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`. */ + administration?: "read" | "write"; + /** The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`. */ + checks?: "read" | "write"; + /** The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`. */ + content_references?: "read" | "write"; + /** The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: `read` or `write`. */ + contents?: "read" | "write"; + /** The level of permission to grant the access token for deployments and deployment statuses. Can be one of: `read` or `write`. */ + deployments?: "read" | "write"; + /** The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`. */ + environments?: "read" | "write"; + /** The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`. */ + issues?: "read" | "write"; + /** The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`. */ + metadata?: "read" | "write"; + /** The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`. */ + packages?: "read" | "write"; + /** The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`. */ + pages?: "read" | "write"; + /** The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`. */ + pull_requests?: "read" | "write"; + /** The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: `read` or `write`. */ + repository_hooks?: "read" | "write"; + /** The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. */ + repository_projects?: "read" | "write" | "admin"; + /** The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`. */ + secret_scanning_alerts?: "read" | "write"; + /** The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`. */ + secrets?: "read" | "write"; + /** The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`. */ + security_events?: "read" | "write"; + /** The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`. */ + single_file?: "read" | "write"; + /** The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`. */ + statuses?: "read" | "write"; + /** The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`. */ + vulnerability_alerts?: "read"; + /** The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`. */ + workflows?: "write"; + /** The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`. */ + members?: "read" | "write"; + /** The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`. */ + organization_administration?: "read" | "write"; + /** The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`. */ + organization_hooks?: "read" | "write"; + /** The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`. */ + organization_plan?: "read"; + /** The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`. */ + organization_projects?: "read" | "write" | "admin"; + /** The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`. */ + organization_secrets?: "read" | "write"; + /** The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`. */ + organization_self_hosted_runners?: "read" | "write"; + /** The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`. */ + organization_user_blocking?: "read" | "write"; + /** The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`. */ + team_discussions?: "read" | "write"; + } & { + [key: string]: any; + }; + /** License Simple */ + "license-simple": { + key: string; + name: string; + url: string | null; + spdx_id: string | null; + node_id: string; + html_url?: string; + } & { + [key: string]: any; + }; + /** A git repository */ + repository: { + /** Unique identifier of the repository */ + id: number; + node_id: string; + /** The name of the repository. */ + name: string; + full_name: string; + license: (components["schemas"]["license-simple"] & { + [key: string]: any; + }) | null; + organization?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + } & { + [key: string]: any; + }; + owner: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + /** Whether the repository is private or public. */ + private: boolean; + html_url: string; + description: string | null; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string | null; + hooks_url: string; + svn_url: string; + homepage: string | null; + language: string | null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + /** The default branch of the repository. */ + default_branch: string; + open_issues_count: number; + /** Whether this repository acts as a template that can be used to generate new repositories. */ + is_template?: boolean; + topics?: string[]; + /** Whether issues are enabled. */ + has_issues: boolean; + /** Whether projects are enabled. */ + has_projects: boolean; + /** Whether the wiki is enabled. */ + has_wiki: boolean; + has_pages: boolean; + /** Whether downloads are enabled. */ + has_downloads: boolean; + /** Whether the repository is archived. */ + archived: boolean; + /** Returns whether or not this repository disabled. */ + disabled: boolean; + /** The repository visibility: public, private, or internal. */ + visibility?: string; + pushed_at: string | null; + created_at: string | null; + updated_at: string | null; + /** Whether to allow rebase merges for pull requests. */ + allow_rebase_merge?: boolean; + template_repository?: ({ + id?: number; + node_id?: string; + name?: string; + full_name?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + } & { + [key: string]: any; + }; + private?: boolean; + html_url?: string; + description?: string; + fork?: boolean; + url?: string; + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + downloads_url?: string; + events_url?: string; + forks_url?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + notifications_url?: string; + pulls_url?: string; + releases_url?: string; + ssh_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + clone_url?: string; + mirror_url?: string; + hooks_url?: string; + svn_url?: string; + homepage?: string; + language?: string; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string; + created_at?: string; + updated_at?: string; + permissions?: { + admin?: boolean; + push?: boolean; + pull?: boolean; + } & { + [key: string]: any; + }; + allow_rebase_merge?: boolean; + temp_clone_token?: string; + allow_squash_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; + } & { + [key: string]: any; + }) | null; + temp_clone_token?: string; + /** Whether to allow squash merges for pull requests. */ + allow_squash_merge?: boolean; + /** Whether to delete head branches when pull requests are merged */ + delete_branch_on_merge?: boolean; + /** Whether to allow merge commits for pull requests. */ + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; + starred_at?: string; + } & { + [key: string]: any; + }; + /** Authentication token for a GitHub App installed on a user or org. */ + "installation-token": { + token: string; + expires_at: string; + permissions?: { + issues?: string; + contents?: string; + metadata?: string; + single_file?: string; + } & { + [key: string]: any; + }; + repository_selection?: "all" | "selected"; + repositories?: components["schemas"]["repository"][]; + single_file?: string; + has_multiple_single_files?: boolean; + single_file_paths?: string[]; + } & { + [key: string]: any; + }; + /** Validation Error */ + "validation-error": { + message: string; + documentation_url: string; + errors?: ({ + resource?: string; + field?: string; + message?: string; + code: string; + index?: number; + value?: ((string | null) | (number | null) | (string[] | null)) & { + [key: string]: any; + }; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + /** The authorization associated with an OAuth Access. */ + "application-grant": { + id: number; + url: string; + app: { + client_id: string; + name: string; + url: string; + } & { + [key: string]: any; + }; + created_at: string; + updated_at: string; + scopes: string[]; + user?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + "scoped-installation": { + permissions: components["schemas"]["app-permissions"]; + /** Describe whether all repositories have been selected or there's a selection involved */ + repository_selection: "all" | "selected"; + single_file_name: string | null; + has_multiple_single_files?: boolean; + single_file_paths?: string[]; + repositories_url: string; + account: components["schemas"]["simple-user"]; + } & { + [key: string]: any; + }; + /** The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ + authorization: { + id: number; + url: string; + /** A list of scopes that this authorization is in. */ + scopes: string[] | null; + token: string; + token_last_eight: string | null; + hashed_token: string | null; + app: { + client_id: string; + name: string; + url: string; + } & { + [key: string]: any; + }; + note: string | null; + note_url: string | null; + updated_at: string; + created_at: string; + fingerprint: string | null; + user?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + installation?: (components["schemas"]["scoped-installation"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + /** Code Of Conduct */ + "code-of-conduct": { + key: string; + name: string; + url: string; + body?: string; + html_url: string | null; + } & { + [key: string]: any; + }; + /** The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. */ + "enabled-organizations": "all" | "none" | "selected"; + /** The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`. */ + "allowed-actions": "all" | "local_only" | "selected"; + /** The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`. */ + "selected-actions-url": string; + "actions-enterprise-permissions": { + enabled_organizations: components["schemas"]["enabled-organizations"]; + /** The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`. */ + selected_organizations_url?: string; + allowed_actions: components["schemas"]["allowed-actions"]; + selected_actions_url?: components["schemas"]["selected-actions-url"]; + } & { + [key: string]: any; + }; + /** Organization Simple */ + "organization-simple": { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string | null; + } & { + [key: string]: any; + }; + "selected-actions": { + /** Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */ + github_owned_allowed?: boolean; + /** Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators. */ + verified_allowed?: boolean; + /** Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." */ + patterns_allowed?: string[]; + } & { + [key: string]: any; + }; + "runner-groups-enterprise": { + id: number; + name: string; + visibility: string; + default: boolean; + selected_organizations_url?: string; + runners_url: string; + allows_public_repositories: boolean; + } & { + [key: string]: any; + }; + /** A self hosted runner */ + runner: { + /** The id of the runner. */ + id: number; + /** The name of the runner. */ + name: string; + /** The Operating System of the runner. */ + os: string; + /** The status of the runner. */ + status: string; + busy: boolean; + labels: ({ + /** Unique identifier of the label. */ + id?: number; + /** Name of the label. */ + name?: string; + /** The type of label. Read-only labels are applied automatically when the runner is configured. */ + type?: "read-only" | "custom"; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + /** Runner Application */ + "runner-application": { + os: string; + architecture: string; + download_url: string; + filename: string; + /** A short lived bearer token used to download the runner, if needed. */ + temp_download_token?: string; + sha256_checksum?: string; + } & { + [key: string]: any; + }; + /** Authentication Token */ + "authentication-token": { + /** The token used for authentication */ + token: string; + /** The time this token expires */ + expires_at: string; + permissions?: { + [key: string]: any; + }; + /** The repositories this token has access to */ + repositories?: components["schemas"]["repository"][]; + single_file?: string | null; + /** Describe whether all repositories have been selected or there's a selection involved */ + repository_selection?: "all" | "selected"; + } & { + [key: string]: any; + }; + "audit-log-event": { + /** The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). */ + "@timestamp"?: number; + /** The name of the action that was performed, for example `user.login` or `repo.create`. */ + action?: string; + active?: boolean; + active_was?: boolean; + /** The actor who performed the action. */ + actor?: string; + /** The username of the account being blocked. */ + blocked_user?: string; + business?: string; + config?: any[]; + config_was?: any[]; + content_type?: string; + /** The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). */ + created_at?: number; + deploy_key_fingerprint?: string; + /** A unique identifier for an audit event. */ + _document_id?: string; + emoji?: string; + events?: any[]; + events_were?: any[]; + explanation?: string; + fingerprint?: string; + hook_id?: number; + limited_availability?: boolean; + message?: string; + name?: string; + old_user?: string; + openssh_public_key?: string; + org?: string; + previous_visibility?: string; + read_only?: boolean; + /** The name of the repository. */ + repo?: string; + /** The name of the repository. */ + repository?: string; + repository_public?: boolean; + target_login?: string; + team?: string; + /** The type of protocol (for example, HTTP or SSH) used to transfer Git data. */ + transport_protocol?: number; + /** A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data. */ + transport_protocol_name?: string; + /** The user that was affected by the action performed (if available). */ + user?: string; + /** The repository visibility, for example `public` or `private`. */ + visibility?: string; + } & { + [key: string]: any; + }; + "actions-billing-usage": { + /** The sum of the free and paid GitHub Actions minutes used. */ + total_minutes_used: number; + /** The total paid GitHub Actions minutes used. */ + total_paid_minutes_used: number; + /** The amount of free GitHub Actions minutes available. */ + included_minutes: number; + minutes_used_breakdown: { + /** Total minutes used on Ubuntu runner machines. */ + UBUNTU?: number; + /** Total minutes used on macOS runner machines. */ + MACOS?: number; + /** Total minutes used on Windows runner machines. */ + WINDOWS?: number; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + "packages-billing-usage": { + /** Sum of the free and paid storage space (GB) for GitHuub Packages. */ + total_gigabytes_bandwidth_used: number; + /** Total paid storage space (GB) for GitHuub Packages. */ + total_paid_gigabytes_bandwidth_used: number; + /** Free storage space (GB) for GitHub Packages. */ + included_gigabytes_bandwidth: number; + } & { + [key: string]: any; + }; + "combined-billing-usage": { + /** Numbers of days left in billing cycle. */ + days_left_in_billing_cycle: number; + /** Estimated storage space (GB) used in billing cycle. */ + estimated_paid_storage_for_month: number; + /** Estimated sum of free and paid storage space (GB) used in billing cycle. */ + estimated_storage_for_month: number; + } & { + [key: string]: any; + }; + /** Actor */ + actor: { + id: number; + login: string; + display_login?: string; + gravatar_id: string | null; + url: string; + avatar_url: string; + } & { + [key: string]: any; + }; + /** Color-coded labels help you categorize and filter your issues (just like labels in Gmail). */ + label: { + id: number; + node_id: string; + /** URL for the label */ + url: string; + /** The name of the label. */ + name: string; + description: string | null; + /** 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + } & { + [key: string]: any; + }; + /** A collection of related issues and pull requests. */ + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + /** The number of the milestone. */ + number: number; + /** The state of the milestone. */ + state: "open" | "closed"; + /** The title of the milestone. */ + title: string; + description: string | null; + creator: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string | null; + due_on: string | null; + } & { + [key: string]: any; + }; + /** How the author is associated with the repository. */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** Issue Simple */ + "issue-simple": { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body?: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + labels: components["schemas"]["label"][]; + assignee: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + assignees?: components["schemas"]["simple-user"][] | null; + milestone: (components["schemas"]["milestone"] & { + [key: string]: any; + }) | null; + locked: boolean; + active_lock_reason?: string | null; + comments: number; + pull_request?: { + merged_at?: string | null; + diff_url: string | null; + html_url: string | null; + patch_url: string | null; + url: string | null; + } & { + [key: string]: any; + }; + closed_at: string | null; + created_at: string; + updated_at: string; + author_association: components["schemas"]["author_association"]; + body_html?: string; + body_text?: string; + timeline_url?: string; + repository?: components["schemas"]["repository"]; + performed_via_github_app?: (components["schemas"]["integration"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + "reaction-rollup": { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + eyes: number; + rocket: number; + } & { + [key: string]: any; + }; + /** Comments provide a way for people to collaborate on an issue. */ + "issue-comment": { + /** Unique identifier of the issue comment */ + id: number; + node_id: string; + /** URL for the issue comment */ + url: string; + /** Contents of the issue comment */ + body?: string; + body_text?: string; + body_html?: string; + html_url: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + created_at: string; + updated_at: string; + issue_url: string; + author_association: components["schemas"]["author_association"]; + performed_via_github_app?: (components["schemas"]["integration"] & { + [key: string]: any; + }) | null; + reactions?: components["schemas"]["reaction-rollup"]; + } & { + [key: string]: any; + }; + /** Event */ + event: { + id: string; + type: string | null; + actor: components["schemas"]["actor"]; + repo: { + id: number; + name: string; + url: string; + } & { + [key: string]: any; + }; + org?: components["schemas"]["actor"]; + payload: { + action?: string; + issue?: components["schemas"]["issue-simple"]; + comment?: components["schemas"]["issue-comment"]; + pages?: ({ + page_name?: string; + title?: string; + summary?: string | null; + action?: string; + sha?: string; + html_url?: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + public: boolean; + created_at: string | null; + } & { + [key: string]: any; + }; + /** Hypermedia Link with Type */ + "link-with-type": { + href: string; + type: string; + } & { + [key: string]: any; + }; + /** Feed */ + feed: { + timeline_url: string; + user_url: string; + current_user_public_url?: string; + current_user_url?: string; + current_user_actor_url?: string; + current_user_organization_url?: string; + current_user_organization_urls?: string[]; + security_advisories_url?: string; + _links: { + timeline: components["schemas"]["link-with-type"]; + user: components["schemas"]["link-with-type"]; + security_advisories?: components["schemas"]["link-with-type"]; + current_user?: components["schemas"]["link-with-type"]; + current_user_public?: components["schemas"]["link-with-type"]; + current_user_actor?: components["schemas"]["link-with-type"]; + current_user_organization?: components["schemas"]["link-with-type"]; + current_user_organizations?: components["schemas"]["link-with-type"][]; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** Base Gist */ + "base-gist": { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [key: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } & { + [key: string]: any; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string | null; + comments: number; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + comments_url: string; + owner?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + truncated?: boolean; + forks?: { + [key: string]: any; + }[]; + history?: { + [key: string]: any; + }[]; + } & { + [key: string]: any; + }; + /** Gist Simple */ + "gist-simple": { + forks?: { + [key: string]: any; + }[] | null; + history?: { + [key: string]: any; + }[] | null; + /** Gist */ + fork_of?: ({ + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [key: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } & { + [key: string]: any; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string | null; + comments: number; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + comments_url: string; + owner?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + truncated?: boolean; + forks?: { + [key: string]: any; + }[]; + history?: { + [key: string]: any; + }[]; + } & { + [key: string]: any; + }) | null; + url?: string; + forks_url?: string; + commits_url?: string; + id?: string; + node_id?: string; + git_pull_url?: string; + git_push_url?: string; + html_url?: string; + files?: { + [key: string]: ({ + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + } & { + [key: string]: any; + }) | null; + }; + public?: boolean; + created_at?: string; + updated_at?: string; + description?: string | null; + comments?: number; + user?: string | null; + comments_url?: string; + owner?: components["schemas"]["simple-user"]; + truncated?: boolean; + } & { + [key: string]: any; + }; + /** A comment made to a gist. */ + "gist-comment": { + id: number; + node_id: string; + url: string; + /** The comment text. */ + body: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + created_at: string; + updated_at: string; + author_association: components["schemas"]["author_association"]; + } & { + [key: string]: any; + }; + /** Gist Commit */ + "gist-commit": { + url: string; + version: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + change_status: { + total?: number; + additions?: number; + deletions?: number; + } & { + [key: string]: any; + }; + committed_at: string; + } & { + [key: string]: any; + }; + /** Gitignore Template */ + "gitignore-template": { + name: string; + source: string; + } & { + [key: string]: any; + }; + /** Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ + issue: { + id: number; + node_id: string; + /** URL for the issue */ + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + /** Number uniquely identifying the issue within its repository */ + number: number; + /** State of the issue; either 'open' or 'closed' */ + state: string; + /** Title of the issue */ + title: string; + /** Contents of the issue */ + body?: string | null; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + /** Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository */ + labels: ((string | ({ + id?: number; + node_id?: string; + url?: string; + name?: string; + description?: string | null; + color?: string | null; + default?: boolean; + } & { + [key: string]: any; + })) & { + [key: string]: any; + })[]; + assignee: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + assignees?: components["schemas"]["simple-user"][] | null; + milestone: (components["schemas"]["milestone"] & { + [key: string]: any; + }) | null; + locked: boolean; + active_lock_reason?: string | null; + comments: number; + pull_request?: { + merged_at?: string | null; + diff_url: string | null; + html_url: string | null; + patch_url: string | null; + url: string | null; + } & { + [key: string]: any; + }; + closed_at: string | null; + created_at: string; + updated_at: string; + closed_by?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + body_html?: string; + body_text?: string; + timeline_url?: string; + repository?: components["schemas"]["repository"]; + performed_via_github_app?: (components["schemas"]["integration"] & { + [key: string]: any; + }) | null; + author_association: components["schemas"]["author_association"]; + reactions?: components["schemas"]["reaction-rollup"]; + } & { + [key: string]: any; + }; + /** License */ + license: { + key: string; + name: string; + spdx_id: string | null; + url: string | null; + node_id: string; + html_url: string; + description: string; + implementation: string; + permissions: string[]; + conditions: string[]; + limitations: string[]; + body: string; + featured: boolean; + } & { + [key: string]: any; + }; + /** Marketplace Listing Plan */ + "marketplace-listing-plan": { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string | null; + state: string; + bullets: string[]; + } & { + [key: string]: any; + }; + /** Marketplace Purchase */ + "marketplace-purchase": { + url: string; + type: string; + id: number; + login: string; + organization_billing_email?: string; + email?: string | null; + marketplace_pending_change?: ({ + is_installed?: boolean; + effective_date?: string; + unit_count?: number | null; + id?: number; + plan?: components["schemas"]["marketplace-listing-plan"]; + } & { + [key: string]: any; + }) | null; + marketplace_purchase: { + billing_cycle?: string; + next_billing_date?: string | null; + is_installed?: boolean; + unit_count?: number | null; + on_free_trial?: boolean; + free_trial_ends_on?: string | null; + updated_at?: string; + plan?: components["schemas"]["marketplace-listing-plan"]; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** Api Overview */ + "api-overview": { + verifiable_password_authentication: boolean; + ssh_key_fingerprints?: { + SHA256_RSA?: string; + SHA256_DSA?: string; + } & { + [key: string]: any; + }; + hooks?: string[]; + web?: string[]; + api?: string[]; + git?: string[]; + packages?: string[]; + pages?: string[]; + importer?: string[]; + actions?: string[]; + dependabot?: string[]; + } & { + [key: string]: any; + }; + /** Minimal Repository */ + "minimal-repository": { + id: number; + node_id: string; + name: string; + full_name: string; + owner: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + private: boolean; + html_url: string; + description: string | null; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url?: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url?: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url?: string; + mirror_url?: string | null; + hooks_url: string; + svn_url?: string; + homepage?: string | null; + language?: string | null; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string | null; + created_at?: string | null; + updated_at?: string | null; + permissions?: { + admin?: boolean; + push?: boolean; + pull?: boolean; + } & { + [key: string]: any; + }; + template_repository?: (components["schemas"]["repository"] & { + [key: string]: any; + }) | null; + temp_clone_token?: string; + delete_branch_on_merge?: boolean; + subscribers_count?: number; + network_count?: number; + license?: ({ + key?: string; + name?: string; + spdx_id?: string; + url?: string; + node_id?: string; + } & { + [key: string]: any; + }) | null; + forks?: number; + open_issues?: number; + watchers?: number; + } & { + [key: string]: any; + }; + /** Thread */ + thread: { + id: string; + repository: components["schemas"]["minimal-repository"]; + subject: { + title: string; + url: string; + latest_comment_url: string; + type: string; + } & { + [key: string]: any; + }; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string | null; + url: string; + subscription_url: string; + } & { + [key: string]: any; + }; + /** Thread Subscription */ + "thread-subscription": { + subscribed: boolean; + ignored: boolean; + reason: string | null; + created_at: string | null; + url: string; + thread_url?: string; + repository_url?: string; + } & { + [key: string]: any; + }; + /** Organization Full */ + "organization-full": { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string | null; + name?: string; + company?: string; + blog?: string; + location?: string; + email?: string; + twitter_username?: string | null; + is_verified?: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + total_private_repos?: number; + owned_private_repos?: number; + private_gists?: number | null; + disk_usage?: number | null; + collaborators?: number | null; + billing_email?: string | null; + plan?: { + name: string; + space: number; + private_repos: number; + filled_seats?: number; + seats?: number; + } & { + [key: string]: any; + }; + default_repository_permission?: string | null; + members_can_create_repositories?: boolean | null; + two_factor_requirement_enabled?: boolean | null; + members_allowed_repository_creation_type?: string; + members_can_create_public_repositories?: boolean; + members_can_create_private_repositories?: boolean; + members_can_create_internal_repositories?: boolean; + members_can_create_pages?: boolean; + members_can_create_public_pages?: boolean; + members_can_create_private_pages?: boolean; + updated_at: string; + } & { + [key: string]: any; + }; + /** The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`. */ + "enabled-repositories": "all" | "none" | "selected"; + "actions-organization-permissions": { + enabled_repositories: components["schemas"]["enabled-repositories"]; + /** The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */ + selected_repositories_url?: string; + allowed_actions?: components["schemas"]["allowed-actions"]; + selected_actions_url?: components["schemas"]["selected-actions-url"]; + } & { + [key: string]: any; + }; + "runner-groups-org": { + id: number; + name: string; + visibility: string; + default: boolean; + /** Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ + selected_repositories_url?: string; + runners_url: string; + inherited: boolean; + inherited_allows_public_repositories?: boolean; + allows_public_repositories: boolean; + } & { + [key: string]: any; + }; + /** Secrets for GitHub Actions for an organization. */ + "organization-actions-secret": { + /** The name of the secret. */ + name: string; + created_at: string; + updated_at: string; + /** Visibility of a secret */ + visibility: "all" | "private" | "selected"; + selected_repositories_url?: string; + } & { + [key: string]: any; + }; + /** The public key used for setting Actions Secrets. */ + "actions-public-key": { + /** The identifier for the key. */ + key_id: string; + /** The Base64 encoded public key. */ + key: string; + id?: number; + url?: string; + title?: string; + created_at?: string; + } & { + [key: string]: any; + }; + /** An object without any properties. */ + "empty-object": { + [key: string]: any; + }; + /** Credential Authorization */ + "credential-authorization": { + /** User login that owns the underlying credential. */ + login: string; + /** Unique identifier for the credential. */ + credential_id: number; + /** Human-readable description of the credential type. */ + credential_type: string; + /** Last eight characters of the credential. Only included in responses with credential_type of personal access token. */ + token_last_eight?: string; + /** Date when the credential was authorized for use. */ + credential_authorized_at: string; + /** List of oauth scopes the token has been granted. */ + scopes?: string[]; + /** Unique string to distinguish the credential. Only included in responses with credential_type of SSH Key. */ + fingerprint?: string; + /** Date when the credential was last accessed. May be null if it was never accessed */ + credential_accessed_at?: string | null; + authorized_credential_id?: number | null; + /** The title given to the ssh key. This will only be present when the credential is an ssh key. */ + authorized_credential_title?: string | null; + /** The note given to the token. This will only be present when the credential is a token. */ + authorized_credential_note?: string | null; + } & { + [key: string]: any; + }; + /** Organization Invitation */ + "organization-invitation": { + id: number; + login: string | null; + email: string | null; + role: string; + created_at: string; + failed_at?: string | null; + failed_reason?: string | null; + inviter: components["schemas"]["simple-user"]; + team_count: number; + node_id: string; + invitation_teams_url: string; + } & { + [key: string]: any; + }; + /** Org Hook */ + "org-hook": { + id: number; + url: string; + ping_url: string; + name: string; + events: string[]; + active: boolean; + config: { + url?: string; + insecure_ssl?: string; + content_type?: string; + secret?: string; + } & { + [key: string]: any; + }; + updated_at: string; + created_at: string; + type: string; + } & { + [key: string]: any; + }; + /** The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`. */ + "interaction-group": "existing_users" | "contributors_only" | "collaborators_only"; + /** Interaction limit settings. */ + "interaction-limit-response": { + limit: components["schemas"]["interaction-group"]; + origin: string; + expires_at: string; + } & { + [key: string]: any; + }; + /** The duration of the interaction restriction. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`. Default: `one_day`. */ + "interaction-expiry": "one_day" | "three_days" | "one_week" | "one_month" | "six_months"; + /** Limit interactions to a specific type of user for a specified duration */ + "interaction-limit": { + limit: components["schemas"]["interaction-group"]; + expiry?: components["schemas"]["interaction-expiry"]; + } & { + [key: string]: any; + }; + /** Groups of organization members that gives permissions on specified repositories. */ + "team-simple": ({ + /** Unique identifier of the team */ + id: number; + node_id: string; + /** URL for the team */ + url: string; + members_url: string; + /** Name of the team */ + name: string; + /** Description of the team */ + description: string | null; + /** Permission that the team will have for its repositories */ + permission: string; + /** The level of privacy this team should have */ + privacy?: string; + html_url: string; + repositories_url: string; + slug: string; + /** Distinguished Name (DN) that team maps to within LDAP environment */ + ldap_dn?: string; + } & { + [key: string]: any; + }) | null; + /** Groups of organization members that gives permissions on specified repositories. */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + permission: string; + url: string; + html_url: string; + members_url: string; + repositories_url: string; + parent?: (components["schemas"]["team-simple"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + /** Org Membership */ + "org-membership": { + url: string; + /** The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. */ + state: "active" | "pending"; + /** The user's membership type in the organization. */ + role: "admin" | "member" | "billing_manager"; + organization_url: string; + organization: components["schemas"]["organization-simple"]; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + permissions?: { + can_create_repository: boolean; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** A migration. */ + migration: { + id: number; + owner: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: components["schemas"]["repository"][]; + url: string; + created_at: string; + updated_at: string; + node_id: string; + archive_url?: string; + exclude?: { + [key: string]: any; + }[]; + } & { + [key: string]: any; + }; + /** A software package */ + package: { + /** Unique identifier of the package. */ + id: number; + /** The name of the package. */ + name: string; + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + url: string; + html_url: string; + /** The number of versions of the package. */ + version_count: number; + visibility: "private" | "public"; + owner?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + repository?: (components["schemas"]["minimal-repository"] & { + [key: string]: any; + }) | null; + created_at: string; + updated_at: string; + } & { + [key: string]: any; + }; + /** A version of a software package */ + "package-version": { + /** Unique identifier of the package version. */ + id: number; + /** The name of the package version. */ + name: string; + url: string; + package_html_url: string; + html_url?: string; + license?: string; + description?: string; + created_at: string; + updated_at: string; + deleted_at?: string; + metadata?: { + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + container?: { + tags: any[]; + } & { + [key: string]: any; + }; + docker?: { + tag?: any[]; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** Projects are a way to organize columns and cards of work. */ + project: { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + /** Name of the project */ + name: string; + /** Body of the project */ + body: string | null; + number: number; + /** State of the project; either 'open' or 'closed' */ + state: string; + creator: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + created_at: string; + updated_at: string; + /** The baseline permission that all organization members have on this project. Only present if owner is an organization. */ + organization_permission?: "read" | "write" | "admin" | "none"; + /** Whether or not this project can be seen by everyone. Only present if owner is an organization. */ + private?: boolean; + } & { + [key: string]: any; + }; + /** External Groups to be mapped to a team for membership */ + "group-mapping": { + /** Array of groups to be mapped to this team */ + groups?: ({ + /** The ID of the group */ + group_id: string; + /** The name of the group */ + group_name: string; + /** a description of the group */ + group_description: string; + /** synchronization status for this group mapping */ + status?: string; + /** the time of the last sync for this group-mapping */ + synced_at?: string | null; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + /** Groups of organization members that gives permissions on specified repositories. */ + "team-full": { + /** Unique identifier of the team */ + id: number; + node_id: string; + /** URL for the team */ + url: string; + html_url: string; + /** Name of the team */ + name: string; + slug: string; + description: string | null; + /** The level of privacy this team should have */ + privacy?: "closed" | "secret"; + /** Permission that the team will have for its repositories */ + permission: string; + members_url: string; + repositories_url: string; + parent?: (components["schemas"]["team-simple"] & { + [key: string]: any; + }) | null; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: components["schemas"]["organization-full"]; + /** Distinguished Name (DN) that team maps to within LDAP environment */ + ldap_dn?: string; + } & { + [key: string]: any; + }; + /** A team discussion is a persistent record of a free-form conversation within a team. */ + "team-discussion": { + author: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + /** The main text of the discussion. */ + body: string; + body_html: string; + /** The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. */ + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string | null; + html_url: string; + node_id: string; + /** The unique sequence number of a team discussion. */ + number: number; + /** Whether or not this discussion should be pinned for easy retrieval. */ + pinned: boolean; + /** Whether or not this discussion should be restricted to team members and organization administrators. */ + private: boolean; + team_url: string; + /** The title of the discussion. */ + title: string; + updated_at: string; + url: string; + reactions?: components["schemas"]["reaction-rollup"]; + } & { + [key: string]: any; + }; + /** A reply to a discussion within a team. */ + "team-discussion-comment": { + author: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + /** The main text of the comment. */ + body: string; + body_html: string; + /** The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. */ + body_version: string; + created_at: string; + last_edited_at: string | null; + discussion_url: string; + html_url: string; + node_id: string; + /** The unique sequence number of a team discussion comment. */ + number: number; + updated_at: string; + url: string; + reactions?: components["schemas"]["reaction-rollup"]; + } & { + [key: string]: any; + }; + /** Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ + reaction: { + id: number; + node_id: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + /** The reaction to use */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + created_at: string; + } & { + [key: string]: any; + }; + /** Team Membership */ + "team-membership": { + url: string; + /** The role of the user in the team. */ + role: "member" | "maintainer"; + /** The state of the user's membership in the team. */ + state: "active" | "pending"; + } & { + [key: string]: any; + }; + /** A team's access to a project. */ + "team-project": { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string | null; + number: number; + state: string; + creator: components["schemas"]["simple-user"]; + created_at: string; + updated_at: string; + /** The organization permission for this project. Only present when owner is an organization. */ + organization_permission?: string; + /** Whether the project is private or not. Only present when owner is an organization. */ + private?: boolean; + permissions: { + read: boolean; + write: boolean; + admin: boolean; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** A team's access to a repository. */ + "team-repository": { + /** Unique identifier of the repository */ + id: number; + node_id: string; + /** The name of the repository. */ + name: string; + full_name: string; + license: (components["schemas"]["license-simple"] & { + [key: string]: any; + }) | null; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + } & { + [key: string]: any; + }; + owner: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + /** Whether the repository is private or public. */ + private: boolean; + html_url: string; + description: string | null; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string | null; + hooks_url: string; + svn_url: string; + homepage: string | null; + language: string | null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + /** The default branch of the repository. */ + default_branch: string; + open_issues_count: number; + /** Whether this repository acts as a template that can be used to generate new repositories. */ + is_template?: boolean; + topics?: string[]; + /** Whether issues are enabled. */ + has_issues: boolean; + /** Whether projects are enabled. */ + has_projects: boolean; + /** Whether the wiki is enabled. */ + has_wiki: boolean; + has_pages: boolean; + /** Whether downloads are enabled. */ + has_downloads: boolean; + /** Whether the repository is archived. */ + archived: boolean; + /** Returns whether or not this repository disabled. */ + disabled: boolean; + /** The repository visibility: public, private, or internal. */ + visibility?: string; + pushed_at: string | null; + created_at: string | null; + updated_at: string | null; + /** Whether to allow rebase merges for pull requests. */ + allow_rebase_merge?: boolean; + template_repository?: (components["schemas"]["repository"] & { + [key: string]: any; + }) | null; + temp_clone_token?: string; + /** Whether to allow squash merges for pull requests. */ + allow_squash_merge?: boolean; + /** Whether to delete head branches when pull requests are merged */ + delete_branch_on_merge?: boolean; + /** Whether to allow merge commits for pull requests. */ + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; + } & { + [key: string]: any; + }; + /** Project cards represent a scope of work. */ + "project-card": { + url: string; + /** The project card's ID */ + id: number; + node_id: string; + note: string | null; + creator: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + created_at: string; + updated_at: string; + /** Whether or not the card is archived */ + archived?: boolean; + column_url: string; + content_url?: string; + project_url: string; + } & { + [key: string]: any; + }; + /** Project columns contain cards of work. */ + "project-column": { + url: string; + project_url: string; + cards_url: string; + /** The unique identifier of the project column */ + id: number; + node_id: string; + /** Name of the project column */ + name: string; + created_at: string; + updated_at: string; + } & { + [key: string]: any; + }; + /** Repository Collaborator Permission */ + "repository-collaborator-permission": { + permission: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + "rate-limit": { + limit: number; + remaining: number; + reset: number; + } & { + [key: string]: any; + }; + /** Rate Limit Overview */ + "rate-limit-overview": { + resources: { + core: components["schemas"]["rate-limit"]; + graphql?: components["schemas"]["rate-limit"]; + search: components["schemas"]["rate-limit"]; + source_import?: components["schemas"]["rate-limit"]; + integration_manifest?: components["schemas"]["rate-limit"]; + code_scanning_upload?: components["schemas"]["rate-limit"]; + } & { + [key: string]: any; + }; + rate: components["schemas"]["rate-limit"]; + } & { + [key: string]: any; + }; + /** Code of Conduct Simple */ + "code-of-conduct-simple": { + url: string; + key: string; + name: string; + html_url: string | null; + } & { + [key: string]: any; + }; + /** Full Repository */ + "full-repository": { + id: number; + node_id: string; + name: string; + full_name: string; + owner: components["schemas"]["simple-user"]; + private: boolean; + html_url: string; + description: string | null; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string | null; + hooks_url: string; + svn_url: string; + homepage: string | null; + language: string | null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template?: boolean; + topics?: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + /** Returns whether or not this repository disabled. */ + disabled: boolean; + /** The repository visibility: public, private, or internal. */ + visibility?: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions?: { + admin: boolean; + pull: boolean; + push: boolean; + } & { + [key: string]: any; + }; + allow_rebase_merge?: boolean; + template_repository?: (components["schemas"]["repository"] & { + [key: string]: any; + }) | null; + temp_clone_token?: string | null; + allow_squash_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_merge_commit?: boolean; + subscribers_count: number; + network_count: number; + license: (components["schemas"]["license-simple"] & { + [key: string]: any; + }) | null; + organization?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + parent?: components["schemas"]["repository"]; + source?: components["schemas"]["repository"]; + forks: number; + master_branch?: string; + open_issues: number; + watchers: number; + /** Whether anonymous git access is allowed. */ + anonymous_access_enabled?: boolean; + code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; + } & { + [key: string]: any; + }; + /** An artifact */ + artifact: { + id: number; + node_id: string; + /** The name of the artifact. */ + name: string; + /** The size in bytes of the artifact. */ + size_in_bytes: number; + url: string; + archive_download_url: string; + /** Whether or not the artifact has expired. */ + expired: boolean; + created_at: string | null; + expires_at: string | null; + updated_at: string | null; + } & { + [key: string]: any; + }; + /** Information of a job execution in a workflow run */ + job: { + /** The id of the job. */ + id: number; + /** The id of the associated workflow run. */ + run_id: number; + run_url: string; + node_id: string; + /** The SHA of the commit that is being run. */ + head_sha: string; + url: string; + html_url: string | null; + /** The phase of the lifecycle that the job is currently in. */ + status: "queued" | "in_progress" | "completed"; + /** The outcome of the job. */ + conclusion: string | null; + /** The time that the job started, in ISO 8601 format. */ + started_at: string; + /** The time that the job finished, in ISO 8601 format. */ + completed_at: string | null; + /** The name of the job. */ + name: string; + /** Steps in this job. */ + steps?: ({ + /** The phase of the lifecycle that the job is currently in. */ + status: "queued" | "in_progress" | "completed"; + /** The outcome of the job. */ + conclusion: string | null; + /** The name of the job. */ + name: string; + number: number; + /** The time that the step started, in ISO 8601 format. */ + started_at?: string | null; + /** The time that the job finished, in ISO 8601 format. */ + completed_at?: string | null; + } & { + [key: string]: any; + })[]; + check_run_url: string; + } & { + [key: string]: any; + }; + /** Whether GitHub Actions is enabled on the repository. */ + "actions-enabled": boolean; + "actions-repository-permissions": { + enabled: components["schemas"]["actions-enabled"]; + allowed_actions: components["schemas"]["allowed-actions"]; + selected_actions_url?: components["schemas"]["selected-actions-url"]; + } & { + [key: string]: any; + }; + "pull-request-minimal": { + id: number; + number: number; + url: string; + head: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + base: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** Simple Commit */ + "simple-commit": { + id: string; + tree_id: string; + message: string; + timestamp: string; + author: ({ + name: string; + email: string; + } & { + [key: string]: any; + }) | null; + committer: ({ + name: string; + email: string; + } & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + /** An invocation of a workflow */ + "workflow-run": { + /** The ID of the workflow run. */ + id: number; + /** The name of the workflow run. */ + name?: string | null; + node_id: string; + /** The ID of the associated check suite. */ + check_suite_id?: number; + /** The node ID of the associated check suite. */ + check_suite_node_id?: string; + head_branch: string | null; + /** The SHA of the head commit that points to the version of the worflow being run. */ + head_sha: string; + /** The auto incrementing run number for the workflow run. */ + run_number: number; + event: string; + status: string | null; + conclusion: string | null; + /** The ID of the parent workflow. */ + workflow_id: number; + /** The URL to the workflow run. */ + url: string; + html_url: string; + pull_requests: components["schemas"]["pull-request-minimal"][] | null; + created_at: string; + updated_at: string; + /** The URL to the jobs for the workflow run. */ + jobs_url: string; + /** The URL to download the logs for the workflow run. */ + logs_url: string; + /** The URL to the associated check suite. */ + check_suite_url: string; + /** The URL to the artifacts for the workflow run. */ + artifacts_url: string; + /** The URL to cancel the workflow run. */ + cancel_url: string; + /** The URL to rerun the workflow run. */ + rerun_url: string; + /** The URL to the workflow. */ + workflow_url: string; + head_commit: (components["schemas"]["simple-commit"] & { + [key: string]: any; + }) | null; + repository: components["schemas"]["minimal-repository"]; + head_repository: components["schemas"]["minimal-repository"]; + head_repository_id?: number; + } & { + [key: string]: any; + }; + /** An entry in the reviews log for environment deployments */ + "environment-approvals": { + /** The list of environments that were approved or rejected */ + environments: ({ + /** The id of the environment. */ + id?: number; + node_id?: string; + /** The name of the environment. */ + name?: string; + url?: string; + html_url?: string; + /** The time that the environment was created, in ISO 8601 format. */ + created_at?: string; + /** The time that the environment was last updated, in ISO 8601 format. */ + updated_at?: string; + } & { + [key: string]: any; + })[]; + /** Whether deployment to the environment(s) was approved or rejected */ + state: "approved" | "rejected"; + user: components["schemas"]["simple-user"]; + /** The comment submitted with the deployment review */ + comment: string; + } & { + [key: string]: any; + }; + /** The type of reviewer. Must be one of: `User` or `Team` */ + "deployment-reviewer-type": "User" | "Team"; + /** Details of a deployment that is waiting for protection rules to pass */ + "pending-deployment": { + environment: { + /** The id of the environment. */ + id?: number; + node_id?: string; + /** The name of the environment. */ + name?: string; + url?: string; + html_url?: string; + } & { + [key: string]: any; + }; + /** The set duration of the wait timer */ + wait_timer: number; + /** The time that the wait timer began. */ + wait_timer_started_at: string | null; + /** Whether the currently authenticated user can approve the deployment */ + current_user_can_approve: boolean; + /** The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ + reviewers: ({ + type?: components["schemas"]["deployment-reviewer-type"]; + reviewer?: (Partial & Partial) & { + [key: string]: any; + }; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + /** A request for a specific ref(branch,sha,tag) to be deployed */ + deployment: { + url: string; + /** Unique identifier of the deployment */ + id: number; + node_id: string; + sha: string; + /** The ref to deploy. This can be a branch, tag, or sha. */ + ref: string; + /** Parameter to specify a task to execute */ + task: string; + payload: ({ + [key: string]: any; + } | string) & { + [key: string]: any; + }; + original_environment?: string; + /** Name for the target deployment environment. */ + environment: string; + description: string | null; + creator: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + created_at: string; + updated_at: string; + statuses_url: string; + repository_url: string; + /** Specifies if the given environment is will no longer exist at some point in the future. Default: false. */ + transient_environment?: boolean; + /** Specifies if the given environment is one that end-users directly interact with. Default: false. */ + production_environment?: boolean; + performed_via_github_app?: (components["schemas"]["integration"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + /** Workflow Run Usage */ + "workflow-run-usage": { + billable: { + UBUNTU?: { + total_ms: number; + jobs: number; + } & { + [key: string]: any; + }; + MACOS?: { + total_ms: number; + jobs: number; + } & { + [key: string]: any; + }; + WINDOWS?: { + total_ms: number; + jobs: number; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + run_duration_ms?: number; + } & { + [key: string]: any; + }; + /** Set secrets for GitHub Actions. */ + "actions-secret": { + /** The name of the secret. */ + name: string; + created_at: string; + updated_at: string; + } & { + [key: string]: any; + }; + /** A GitHub Actions workflow */ + workflow: { + id: number; + node_id: string; + name: string; + path: string; + state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; + created_at: string; + updated_at: string; + url: string; + html_url: string; + badge_url: string; + deleted_at?: string; + } & { + [key: string]: any; + }; + /** Workflow Usage */ + "workflow-usage": { + billable: { + UBUNTU?: { + total_ms?: number; + } & { + [key: string]: any; + }; + MACOS?: { + total_ms?: number; + } & { + [key: string]: any; + }; + WINDOWS?: { + total_ms?: number; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** Protected Branch Admin Enforced */ + "protected-branch-admin-enforced": { + url: string; + enabled: boolean; + } & { + [key: string]: any; + }; + /** Protected Branch Pull Request Review */ + "protected-branch-pull-request-review": { + url?: string; + dismissal_restrictions?: { + /** The list of users with review dismissal access. */ + users?: components["schemas"]["simple-user"][]; + /** The list of teams with review dismissal access. */ + teams?: components["schemas"]["team"][]; + url?: string; + users_url?: string; + teams_url?: string; + } & { + [key: string]: any; + }; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count?: number; + } & { + [key: string]: any; + }; + /** Branch Restriction Policy */ + "branch-restriction-policy": { + url: string; + users_url: string; + teams_url: string; + apps_url: string; + users: ({ + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + } & { + [key: string]: any; + })[]; + teams: ({ + id?: number; + node_id?: string; + url?: string; + html_url?: string; + name?: string; + slug?: string; + description?: string | null; + privacy?: string; + permission?: string; + members_url?: string; + repositories_url?: string; + parent?: string | null; + } & { + [key: string]: any; + })[]; + apps: ({ + id?: number; + slug?: string; + node_id?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + url?: string; + repos_url?: string; + events_url?: string; + hooks_url?: string; + issues_url?: string; + members_url?: string; + public_members_url?: string; + avatar_url?: string; + description?: string; + gravatar_id?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + received_events_url?: string; + type?: string; + } & { + [key: string]: any; + }; + name?: string; + description?: string; + external_url?: string; + html_url?: string; + created_at?: string; + updated_at?: string; + permissions?: { + metadata?: string; + contents?: string; + issues?: string; + single_file?: string; + } & { + [key: string]: any; + }; + events?: string[]; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + /** Branch Protection */ + "branch-protection": { + url?: string; + required_status_checks?: { + url?: string; + enforcement_level?: string; + contexts: string[]; + contexts_url?: string; + } & { + [key: string]: any; + }; + enforce_admins?: components["schemas"]["protected-branch-admin-enforced"]; + required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"]; + restrictions?: components["schemas"]["branch-restriction-policy"]; + required_linear_history?: { + enabled?: boolean; + } & { + [key: string]: any; + }; + allow_force_pushes?: { + enabled?: boolean; + } & { + [key: string]: any; + }; + allow_deletions?: { + enabled?: boolean; + } & { + [key: string]: any; + }; + required_conversation_resolution?: { + enabled?: boolean; + } & { + [key: string]: any; + }; + name?: string; + protection_url?: string; + required_signatures?: { + url: string; + enabled: boolean; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** Short Branch */ + "short-branch": { + name: string; + commit: { + sha: string; + url: string; + } & { + [key: string]: any; + }; + protected: boolean; + protection?: components["schemas"]["branch-protection"]; + protection_url?: string; + } & { + [key: string]: any; + }; + /** Metaproperties for Git author/committer information. */ + "git-user": { + name?: string; + email?: string; + date?: string; + } & { + [key: string]: any; + }; + verification: { + verified: boolean; + reason: string; + payload: string | null; + signature: string | null; + } & { + [key: string]: any; + }; + /** Commit */ + commit: { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: (components["schemas"]["git-user"] & { + [key: string]: any; + }) | null; + committer: (components["schemas"]["git-user"] & { + [key: string]: any; + }) | null; + message: string; + comment_count: number; + tree: { + sha: string; + url: string; + } & { + [key: string]: any; + }; + verification?: components["schemas"]["verification"]; + } & { + [key: string]: any; + }; + author: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + committer: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + parents: ({ + sha: string; + url: string; + html_url?: string; + } & { + [key: string]: any; + })[]; + stats?: { + additions?: number; + deletions?: number; + total?: number; + } & { + [key: string]: any; + }; + files?: ({ + filename?: string; + additions?: number; + deletions?: number; + changes?: number; + status?: string; + raw_url?: string; + blob_url?: string; + patch?: string; + sha?: string; + contents_url?: string; + previous_filename?: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + /** Branch With Protection */ + "branch-with-protection": { + name: string; + commit: components["schemas"]["commit"]; + _links: { + html: string; + self: string; + } & { + [key: string]: any; + }; + protected: boolean; + protection: components["schemas"]["branch-protection"]; + protection_url: string; + pattern?: string; + required_approving_review_count?: number; + } & { + [key: string]: any; + }; + /** Status Check Policy */ + "status-check-policy": { + url: string; + strict: boolean; + contexts: string[]; + contexts_url: string; + } & { + [key: string]: any; + }; + /** Branch protections protect branches */ + "protected-branch": { + url: string; + required_status_checks?: components["schemas"]["status-check-policy"]; + required_pull_request_reviews?: { + url: string; + dismiss_stale_reviews?: boolean; + require_code_owner_reviews?: boolean; + required_approving_review_count?: number; + dismissal_restrictions?: { + url: string; + users_url: string; + teams_url: string; + users: components["schemas"]["simple-user"][]; + teams: components["schemas"]["team"][]; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + required_signatures?: { + url: string; + enabled: boolean; + } & { + [key: string]: any; + }; + enforce_admins?: { + url: string; + enabled: boolean; + }; + required_linear_history?: { + enabled: boolean; + }; + allow_force_pushes?: { + enabled: boolean; + }; + allow_deletions?: { + enabled: boolean; + }; + restrictions?: components["schemas"]["branch-restriction-policy"]; + required_conversation_resolution?: { + enabled?: boolean; + }; + } & { + [key: string]: any; + }; + /** A deployment created as the result of an Actions check run from a workflow that references an environment */ + "deployment-simple": { + url: string; + /** Unique identifier of the deployment */ + id: number; + node_id: string; + /** Parameter to specify a task to execute */ + task: string; + original_environment?: string; + /** Name for the target deployment environment. */ + environment: string; + description: string | null; + created_at: string; + updated_at: string; + statuses_url: string; + repository_url: string; + /** Specifies if the given environment is will no longer exist at some point in the future. Default: false. */ + transient_environment?: boolean; + /** Specifies if the given environment is one that end-users directly interact with. Default: false. */ + production_environment?: boolean; + performed_via_github_app?: (components["schemas"]["integration"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + /** A check performed on the code of a given code change */ + "check-run": { + /** The id of the check. */ + id: number; + /** The SHA of the commit that is being checked. */ + head_sha: string; + node_id: string; + external_id: string | null; + url: string; + html_url: string | null; + details_url: string | null; + /** The phase of the lifecycle that the check is currently in. */ + status: "queued" | "in_progress" | "completed"; + conclusion: ("success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required") | null; + started_at: string | null; + completed_at: string | null; + output: { + title: string | null; + summary: string | null; + text: string | null; + annotations_count: number; + annotations_url: string; + } & { + [key: string]: any; + }; + /** The name of the check. */ + name: string; + check_suite: ({ + id: number; + } & { + [key: string]: any; + }) | null; + app: (components["schemas"]["integration"] & { + [key: string]: any; + }) | null; + pull_requests: components["schemas"]["pull-request-minimal"][]; + deployment?: components["schemas"]["deployment-simple"]; + } & { + [key: string]: any; + }; + /** Check Annotation */ + "check-annotation": { + path: string; + start_line: number; + end_line: number; + start_column: number | null; + end_column: number | null; + annotation_level: string | null; + title: string | null; + message: string | null; + raw_details: string | null; + blob_href: string; + } & { + [key: string]: any; + }; + /** A suite of checks performed on the code of a given code change */ + "check-suite": { + id: number; + node_id: string; + head_branch: string | null; + /** The SHA of the head commit that is being checked. */ + head_sha: string; + status: ("queued" | "in_progress" | "completed") | null; + conclusion: ("success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required") | null; + url: string | null; + before: string | null; + after: string | null; + pull_requests: components["schemas"]["pull-request-minimal"][] | null; + app: (components["schemas"]["integration"] & { + [key: string]: any; + }) | null; + repository: components["schemas"]["minimal-repository"]; + created_at: string | null; + updated_at: string | null; + head_commit: components["schemas"]["simple-commit"]; + latest_check_runs_count: number; + check_runs_url: string; + } & { + [key: string]: any; + }; + /** Check suite configuration preferences for a repository. */ + "check-suite-preference": { + preferences: { + auto_trigger_checks?: ({ + app_id: number; + setting: boolean; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + repository: components["schemas"]["minimal-repository"]; + } & { + [key: string]: any; + }; + /** The name of the tool used to generate the code scanning analysis. */ + "code-scanning-analysis-tool-name": string; + /** The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ + "code-scanning-analysis-tool-guid": string | null; + /** + * The full Git reference, formatted as `refs/heads/`, + * `refs/pull//merge`, or `refs/pull//head`. + */ + "code-scanning-ref": string; + /** State of a code scanning alert. */ + "code-scanning-alert-state": "open" | "closed" | "dismissed" | "fixed"; + /** The security alert number. */ + "alert-number": number; + /** The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "alert-created-at": string; + /** The REST API URL of the alert resource. */ + "alert-url": string; + /** The GitHub URL of the alert resource. */ + "alert-html-url": string; + /** The REST API URL for fetching the list of instances for an alert. */ + "alert-instances-url": string; + /** The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "code-scanning-alert-dismissed-at": string | null; + /** **Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + "code-scanning-alert-dismissed-reason": ("false positive" | "won't fix" | "used in tests") | null; + "code-scanning-alert-rule-summary": { + /** A unique identifier for the rule used to detect the alert. */ + id?: string | null; + /** The name of the rule used to detect the alert. */ + name?: string; + /** The severity of the alert. */ + severity?: ("none" | "note" | "warning" | "error") | null; + /** A short description of the rule used to detect the alert. */ + description?: string; + } & { + [key: string]: any; + }; + /** The version of the tool used to generate the code scanning analysis. */ + "code-scanning-analysis-tool-version": string | null; + "code-scanning-analysis-tool": { + name?: components["schemas"]["code-scanning-analysis-tool-name"]; + version?: components["schemas"]["code-scanning-analysis-tool-version"]; + guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; + } & { + [key: string]: any; + }; + /** Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + "code-scanning-analysis-analysis-key": string; + /** Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + "code-scanning-alert-environment": string; + /** Describe a region within a file for the alert. */ + "code-scanning-alert-location": { + path?: string; + start_line?: number; + end_line?: number; + start_column?: number; + end_column?: number; + } & { + [key: string]: any; + }; + /** A classification of the file. For example to identify it as generated. */ + "code-scanning-alert-classification": ("source" | "generated" | "test" | "library") | null; + "code-scanning-alert-instance": { + ref?: components["schemas"]["code-scanning-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + state?: components["schemas"]["code-scanning-alert-state"]; + commit_sha?: string; + message?: { + text?: string; + } & { + [key: string]: any; + }; + location?: components["schemas"]["code-scanning-alert-location"]; + html_url?: string; + /** + * Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. + */ + classifications?: components["schemas"]["code-scanning-alert-classification"][]; + } & { + [key: string]: any; + }; + "code-scanning-alert-items": { + number: components["schemas"]["alert-number"]; + created_at: components["schemas"]["alert-created-at"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + instances_url: components["schemas"]["alert-instances-url"]; + state: components["schemas"]["code-scanning-alert-state"]; + dismissed_by: components["schemas"]["simple-user"]; + dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; + dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; + rule: components["schemas"]["code-scanning-alert-rule-summary"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + } & { + [key: string]: any; + }; + "code-scanning-alert-rule": { + /** A unique identifier for the rule used to detect the alert. */ + id?: string | null; + /** The name of the rule used to detect the alert. */ + name?: string; + /** The severity of the alert. */ + severity?: ("none" | "note" | "warning" | "error") | null; + /** A short description of the rule used to detect the alert. */ + description?: string; + /** description of the rule used to detect the alert. */ + full_description?: string; + /** A set of tags applicable for the rule. */ + tags?: string[] | null; + /** Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + } & { + [key: string]: any; + }; + "code-scanning-alert": { + number: components["schemas"]["alert-number"]; + created_at: components["schemas"]["alert-created-at"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + instances?: { + [key: string]: any; + }; + instances_url: components["schemas"]["alert-instances-url"]; + state: components["schemas"]["code-scanning-alert-state"]; + dismissed_by: components["schemas"]["simple-user"]; + dismissed_at: components["schemas"]["code-scanning-alert-dismissed-at"]; + dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; + rule: components["schemas"]["code-scanning-alert-rule"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + } & { + [key: string]: any; + }; + /** Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`. */ + "code-scanning-alert-set-state": "open" | "dismissed"; + /** An identifier for the upload. */ + "code-scanning-analysis-sarif-id": string; + /** The SHA of the commit to which the analysis you are uploading relates. */ + "code-scanning-analysis-commit-sha": string; + /** Identifies the variable values associated with the environment in which this analysis was performed. */ + "code-scanning-analysis-environment": string; + /** Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ + "code-scanning-analysis-category": string; + /** The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "code-scanning-analysis-created-at": string; + /** The REST API URL of the analysis resource. */ + "code-scanning-analysis-url": string; + "code-scanning-analysis": { + ref: components["schemas"]["code-scanning-ref"]; + commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; + analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment: components["schemas"]["code-scanning-analysis-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; + error: string; + created_at: components["schemas"]["code-scanning-analysis-created-at"]; + /** The total number of results in the analysis. */ + results_count: number; + /** The total number of rules used in the analysis. */ + rules_count: number; + /** Unique identifier for this analysis. */ + id: number; + url: components["schemas"]["code-scanning-analysis-url"]; + sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + deletable: boolean; + /** Warning generated when processing the analysis */ + warning: string; + } & { + [key: string]: any; + }; + /** Successful deletion of a code scanning analysis */ + "code-scanning-analysis-deletion": { + /** Next deletable analysis in chain, without last analysis deletion confirmation */ + next_analysis_url: string | null; + /** Next deletable analysis in chain, with last analysis deletion confirmation */ + confirm_delete_url: string | null; + } & { + [key: string]: any; + }; + /** Scim Error */ + "scim-error": { + message?: string | null; + documentation_url?: string | null; + detail?: string | null; + status?: number; + scimType?: string | null; + schemas?: string[]; + } & { + [key: string]: any; + }; + /** A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */ + "code-scanning-analysis-sarif-file": string; + "code-scanning-sarifs-receipt": { + id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + /** The REST API URL for checking the status of the upload. */ + url?: string; + } & { + [key: string]: any; + }; + "code-scanning-sarifs-status": { + /** `pending` files have not yet been processed, while `complete` means all results in the SARIF have been stored. */ + processing_status?: "pending" | "complete"; + /** The REST API URL for getting the analyses associated with the upload. */ + analyses_url?: string | null; + } & { + [key: string]: any; + }; + /** Collaborator */ + collaborator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string | null; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + permissions?: { + pull: boolean; + push: boolean; + admin: boolean; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** Repository invitations let you manage who you collaborate with. */ + "repository-invitation": { + /** Unique identifier of the repository invitation. */ + id: number; + repository: components["schemas"]["minimal-repository"]; + invitee: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + inviter: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + /** The permission associated with the invitation. */ + permissions: "read" | "write" | "admin" | "triage" | "maintain"; + created_at: string; + /** Whether or not the invitation has expired */ + expired?: boolean; + /** URL for the repository invitation */ + url: string; + html_url: string; + node_id: string; + } & { + [key: string]: any; + }; + /** Commit Comment */ + "commit-comment": { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string | null; + position: number | null; + line: number | null; + commit_id: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + created_at: string; + updated_at: string; + author_association: components["schemas"]["author_association"]; + reactions?: components["schemas"]["reaction-rollup"]; + } & { + [key: string]: any; + }; + /** Branch Short */ + "branch-short": { + name: string; + commit: { + sha: string; + url: string; + } & { + [key: string]: any; + }; + protected: boolean; + } & { + [key: string]: any; + }; + /** Hypermedia Link */ + link: { + href: string; + } & { + [key: string]: any; + }; + /** The status of auto merging a pull request. */ + auto_merge: ({ + enabled_by: components["schemas"]["simple-user"]; + /** The merge method to use. */ + merge_method: "merge" | "squash" | "rebase"; + /** Title for the merge commit message. */ + commit_title: string; + /** Commit message for the merge commit. */ + commit_message: string; + } & { + [key: string]: any; + }) | null; + /** Pull Request Simple */ + "pull-request-simple": { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + body: string | null; + labels: ({ + id?: number; + node_id?: string; + url?: string; + name?: string; + description?: string; + color?: string; + default?: boolean; + } & { + [key: string]: any; + })[]; + milestone: (components["schemas"]["milestone"] & { + [key: string]: any; + }) | null; + active_lock_reason?: string | null; + created_at: string; + updated_at: string; + closed_at: string | null; + merged_at: string | null; + merge_commit_sha: string | null; + assignee: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + assignees?: components["schemas"]["simple-user"][] | null; + requested_reviewers?: components["schemas"]["simple-user"][] | null; + requested_teams?: components["schemas"]["team-simple"][] | null; + head: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + base: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + _links: { + comments: components["schemas"]["link"]; + commits: components["schemas"]["link"]; + statuses: components["schemas"]["link"]; + html: components["schemas"]["link"]; + issue: components["schemas"]["link"]; + review_comments: components["schemas"]["link"]; + review_comment: components["schemas"]["link"]; + self: components["schemas"]["link"]; + } & { + [key: string]: any; + }; + author_association: components["schemas"]["author_association"]; + auto_merge: components["schemas"]["auto_merge"]; + /** Indicates whether or not the pull request is a draft. */ + draft?: boolean; + } & { + [key: string]: any; + }; + "simple-commit-status": { + description: string | null; + id: number; + node_id: string; + state: string; + context: string; + target_url: string; + required?: boolean | null; + avatar_url: string | null; + url: string; + created_at: string; + updated_at: string; + } & { + [key: string]: any; + }; + /** Combined Commit Status */ + "combined-commit-status": { + state: string; + statuses: components["schemas"]["simple-commit-status"][]; + sha: string; + total_count: number; + repository: components["schemas"]["minimal-repository"]; + commit_url: string; + url: string; + } & { + [key: string]: any; + }; + /** The status of a commit. */ + status: { + url: string; + avatar_url: string | null; + id: number; + node_id: string; + state: string; + description: string; + target_url: string; + context: string; + created_at: string; + updated_at: string; + creator: components["schemas"]["simple-user"]; + } & { + [key: string]: any; + }; + "community-health-file": { + url: string; + html_url: string; + } & { + [key: string]: any; + }; + /** Community Profile */ + "community-profile": { + health_percentage: number; + description: string | null; + documentation: string | null; + files: { + code_of_conduct: (components["schemas"]["code-of-conduct-simple"] & { + [key: string]: any; + }) | null; + code_of_conduct_file: (components["schemas"]["community-health-file"] & { + [key: string]: any; + }) | null; + license: (components["schemas"]["license-simple"] & { + [key: string]: any; + }) | null; + contributing: (components["schemas"]["community-health-file"] & { + [key: string]: any; + }) | null; + readme: (components["schemas"]["community-health-file"] & { + [key: string]: any; + }) | null; + issue_template: (components["schemas"]["community-health-file"] & { + [key: string]: any; + }) | null; + pull_request_template: (components["schemas"]["community-health-file"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + updated_at: string | null; + content_reports_enabled?: boolean; + } & { + [key: string]: any; + }; + /** Diff Entry */ + "diff-entry": { + sha: string; + filename: string; + status: string; + additions: number; + deletions: number; + changes: number; + blob_url: string; + raw_url: string; + contents_url: string; + patch?: string; + previous_filename?: string; + } & { + [key: string]: any; + }; + /** Commit Comparison */ + "commit-comparison": { + url: string; + html_url: string; + permalink_url: string; + diff_url: string; + patch_url: string; + base_commit: components["schemas"]["commit"]; + merge_base_commit: components["schemas"]["commit"]; + status: "diverged" | "ahead" | "behind" | "identical"; + ahead_by: number; + behind_by: number; + total_commits: number; + commits: components["schemas"]["commit"][]; + files?: components["schemas"]["diff-entry"][]; + } & { + [key: string]: any; + }; + /** Content Tree */ + "content-tree": { + type: string; + size: number; + name: string; + path: string; + sha: string; + url: string; + git_url: string | null; + html_url: string | null; + download_url: string | null; + entries?: ({ + type: string; + size: number; + name: string; + path: string; + content?: string; + sha: string; + url: string; + git_url: string | null; + html_url: string | null; + download_url: string | null; + _links: { + git: string | null; + html: string | null; + self: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + })[]; + _links: { + git: string | null; + html: string | null; + self: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** A list of directory items */ + "content-directory": ({ + type: string; + size: number; + name: string; + path: string; + content?: string; + sha: string; + url: string; + git_url: string | null; + html_url: string | null; + download_url: string | null; + _links: { + git: string | null; + html: string | null; + self: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + })[]; + /** Content File */ + "content-file": { + type: string; + encoding: string; + size: number; + name: string; + path: string; + content: string; + sha: string; + url: string; + git_url: string | null; + html_url: string | null; + download_url: string | null; + _links: { + git: string | null; + html: string | null; + self: string; + } & { + [key: string]: any; + }; + target?: string; + submodule_git_url?: string; + } & { + [key: string]: any; + }; + /** An object describing a symlink */ + "content-symlink": { + type: string; + target: string; + size: number; + name: string; + path: string; + sha: string; + url: string; + git_url: string | null; + html_url: string | null; + download_url: string | null; + _links: { + git: string | null; + html: string | null; + self: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** An object describing a symlink */ + "content-submodule": { + type: string; + submodule_git_url: string; + size: number; + name: string; + path: string; + sha: string; + url: string; + git_url: string | null; + html_url: string | null; + download_url: string | null; + _links: { + git: string | null; + html: string | null; + self: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** File Commit */ + "file-commit": { + content: ({ + name?: string; + path?: string; + sha?: string; + size?: number; + url?: string; + html_url?: string; + git_url?: string; + download_url?: string; + type?: string; + _links?: { + self?: string; + git?: string; + html?: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }) | null; + commit: { + sha?: string; + node_id?: string; + url?: string; + html_url?: string; + author?: { + date?: string; + name?: string; + email?: string; + } & { + [key: string]: any; + }; + committer?: { + date?: string; + name?: string; + email?: string; + } & { + [key: string]: any; + }; + message?: string; + tree?: { + url?: string; + sha?: string; + } & { + [key: string]: any; + }; + parents?: ({ + url?: string; + html_url?: string; + sha?: string; + } & { + [key: string]: any; + })[]; + verification?: { + verified?: boolean; + reason?: string; + signature?: string | null; + payload?: string | null; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** Contributor */ + contributor: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string | null; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type: string; + site_admin?: boolean; + contributions: number; + email?: string; + name?: string; + } & { + [key: string]: any; + }; + /** The status of a deployment. */ + "deployment-status": { + url: string; + id: number; + node_id: string; + /** The state of the status. */ + state: "error" | "failure" | "inactive" | "pending" | "success" | "queued" | "in_progress"; + creator: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + /** A short description of the status. */ + description: string; + /** The environment of the deployment that the status is for. */ + environment?: string; + /** Deprecated: the URL to associate with this status. */ + target_url: string; + created_at: string; + updated_at: string; + deployment_url: string; + repository_url: string; + /** The URL for accessing your environment. */ + environment_url?: string; + /** The URL to associate with this status. */ + log_url?: string; + performed_via_github_app?: (components["schemas"]["integration"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + /** The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). */ + "wait-timer": number; + /** The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ + deployment_branch_policy: ({ + /** Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ + protected_branches: boolean; + /** Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. */ + custom_branch_policies: boolean; + } & { + [key: string]: any; + }) | null; + /** Details of a deployment environment */ + environment: { + /** The id of the environment. */ + id: number; + node_id: string; + /** The name of the environment. */ + name: string; + url: string; + html_url: string; + /** The time that the environment was created, in ISO 8601 format. */ + created_at: string; + /** The time that the environment was last updated, in ISO 8601 format. */ + updated_at: string; + protection_rules?: ((Partial<{ + id: number; + node_id: string; + type: string; + wait_timer?: components["schemas"]["wait-timer"]; + } & { + [key: string]: any; + }> & Partial<{ + id: number; + node_id: string; + type: string; + /** The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ + reviewers?: ({ + type?: components["schemas"]["deployment-reviewer-type"]; + reviewer?: (Partial & Partial) & { + [key: string]: any; + }; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }> & Partial<{ + id: number; + node_id: string; + type: string; + } & { + [key: string]: any; + }>) & { + [key: string]: any; + })[]; + deployment_branch_policy?: components["schemas"]["deployment_branch_policy"]; + } & { + [key: string]: any; + }; + /** Short Blob */ + "short-blob": { + url: string; + sha: string; + } & { + [key: string]: any; + }; + /** Blob */ + blob: { + content: string; + encoding: string; + url: string; + sha: string; + size: number | null; + node_id: string; + highlighted_content?: string; + } & { + [key: string]: any; + }; + /** Low-level Git commit operations within a repository */ + "git-commit": { + /** SHA for the commit */ + sha: string; + node_id: string; + url: string; + /** Identifying information for the git-user */ + author: { + /** Timestamp of the commit */ + date: string; + /** Git email address of the user */ + email: string; + /** Name of the git user */ + name: string; + } & { + [key: string]: any; + }; + /** Identifying information for the git-user */ + committer: { + /** Timestamp of the commit */ + date: string; + /** Git email address of the user */ + email: string; + /** Name of the git user */ + name: string; + } & { + [key: string]: any; + }; + /** Message describing the purpose of the commit */ + message: string; + tree: { + /** SHA for the commit */ + sha: string; + url: string; + } & { + [key: string]: any; + }; + parents: ({ + /** SHA for the commit */ + sha: string; + url: string; + html_url: string; + } & { + [key: string]: any; + })[]; + verification: { + verified: boolean; + reason: string; + signature: string | null; + payload: string | null; + } & { + [key: string]: any; + }; + html_url: string; + } & { + [key: string]: any; + }; + /** Git references within a repository */ + "git-ref": { + ref: string; + node_id: string; + url: string; + object: { + type: string; + /** SHA for the reference */ + sha: string; + url: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** Metadata for a Git tag */ + "git-tag": { + node_id: string; + /** Name of the tag */ + tag: string; + sha: string; + /** URL for the tag */ + url: string; + /** Message describing the purpose of the tag */ + message: string; + tagger: { + date: string; + email: string; + name: string; + } & { + [key: string]: any; + }; + object: { + sha: string; + type: string; + url: string; + } & { + [key: string]: any; + }; + verification?: components["schemas"]["verification"]; + } & { + [key: string]: any; + }; + /** The hierarchy between files in a Git repository. */ + "git-tree": { + sha: string; + url: string; + truncated: boolean; + /** Objects specifying a tree structure */ + tree: ({ + path?: string; + mode?: string; + type?: string; + sha?: string; + size?: number; + url?: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + "hook-response": { + code: number | null; + status: string | null; + message: string | null; + } & { + [key: string]: any; + }; + /** Webhooks for repositories. */ + hook: { + type: string; + /** Unique identifier of the webhook. */ + id: number; + /** The name of a valid service, use 'web' for a webhook. */ + name: string; + /** Determines whether the hook is actually triggered on pushes. */ + active: boolean; + /** Determines what events the hook is triggered for. Default: ['push']. */ + events: string[]; + config: { + email?: string; + password?: string; + room?: string; + subdomain?: string; + url?: components["schemas"]["webhook-config-url"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + digest?: string; + secret?: components["schemas"]["webhook-config-secret"]; + token?: string; + } & { + [key: string]: any; + }; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: components["schemas"]["hook-response"]; + } & { + [key: string]: any; + }; + /** A repository import from an external source. */ + import: { + vcs: string | null; + use_lfs?: boolean; + /** The URL of the originating repository. */ + vcs_url: string; + svc_root?: string; + tfvc_project?: string; + status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth"; + status_text?: string | null; + failed_step?: string | null; + error_message?: string | null; + import_percent?: number | null; + commit_count?: number | null; + push_percent?: number | null; + has_large_files?: boolean; + large_files_size?: number; + large_files_count?: number; + project_choices?: ({ + vcs?: string; + tfvc_project?: string; + human_name?: string; + } & { + [key: string]: any; + })[]; + message?: string; + authors_count?: number | null; + url: string; + html_url: string; + authors_url: string; + repository_url: string; + svn_root?: string; + } & { + [key: string]: any; + }; + /** Porter Author */ + "porter-author": { + id: number; + remote_id: string; + remote_name: string; + email: string; + name: string; + url: string; + import_url: string; + } & { + [key: string]: any; + }; + /** Porter Large File */ + "porter-large-file": { + ref_name: string; + path: string; + oid: string; + size: number; + } & { + [key: string]: any; + }; + /** Issue Event Label */ + "issue-event-label": { + name: string | null; + color: string | null; + } & { + [key: string]: any; + }; + "issue-event-dismissed-review": { + state: string; + review_id: number; + dismissal_message: string | null; + dismissal_commit_id?: string | null; + } & { + [key: string]: any; + }; + /** Issue Event Milestone */ + "issue-event-milestone": { + title: string; + } & { + [key: string]: any; + }; + /** Issue Event Project Card */ + "issue-event-project-card": { + url: string; + id: number; + project_url: string; + project_id: number; + column_name: string; + previous_column_name?: string; + } & { + [key: string]: any; + }; + /** Issue Event Rename */ + "issue-event-rename": { + from: string; + to: string; + } & { + [key: string]: any; + }; + /** Issue Event */ + "issue-event": { + id: number; + node_id: string; + url: string; + actor: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + issue?: components["schemas"]["issue-simple"]; + label?: components["schemas"]["issue-event-label"]; + assignee?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + assigner?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + review_requester?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + requested_reviewer?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + requested_team?: components["schemas"]["team"]; + dismissed_review?: components["schemas"]["issue-event-dismissed-review"]; + milestone?: components["schemas"]["issue-event-milestone"]; + project_card?: components["schemas"]["issue-event-project-card"]; + rename?: components["schemas"]["issue-event-rename"]; + author_association?: components["schemas"]["author_association"]; + lock_reason?: string | null; + performed_via_github_app?: (components["schemas"]["integration"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + /** Issue Event for Issue */ + "issue-event-for-issue": { + id?: number; + node_id?: string; + url?: string; + actor?: components["schemas"]["simple-user"]; + event?: string; + commit_id?: string | null; + commit_url?: string | null; + created_at?: string; + sha?: string; + html_url?: string; + message?: string; + issue_url?: string; + updated_at?: string; + author_association?: components["schemas"]["author_association"]; + body?: string | null; + lock_reason?: string | null; + submitted_at?: string; + state?: string; + pull_request_url?: string; + body_html?: string; + body_text?: string; + } & { + [key: string]: any; + }; + /** An SSH key granting access to a single repository. */ + "deploy-key": { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; + } & { + [key: string]: any; + }; + /** Language */ + language: { + [key: string]: number; + }; + /** License Content */ + "license-content": { + name: string; + path: string; + sha: string; + size: number; + url: string; + html_url: string | null; + git_url: string | null; + download_url: string | null; + type: string; + content: string; + encoding: string; + _links: { + git: string | null; + html: string | null; + self: string; + } & { + [key: string]: any; + }; + license: (components["schemas"]["license-simple"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + "pages-source-hash": { + branch: string; + path: string; + } & { + [key: string]: any; + }; + "pages-https-certificate": { + state: "new" | "authorization_created" | "authorization_pending" | "authorized" | "authorization_revoked" | "issued" | "uploaded" | "approved" | "errored" | "bad_authz" | "destroy_pending" | "dns_changed"; + description: string; + /** Array of the domain set and its alternate name (if it is configured) */ + domains: any[]; + expires_at?: string; + } & { + [key: string]: any; + }; + /** The configuration for GitHub Pages for a repository. */ + page: { + /** The API address for accessing this Page resource. */ + url: string; + /** The status of the most recent build of the Page. */ + status: ("built" | "building" | "errored") | null; + /** The Pages site's custom domain */ + cname: string | null; + /** Whether the Page has a custom 404 page. */ + custom_404: boolean; + /** The web address the Page can be accessed from. */ + html_url?: string; + source?: components["schemas"]["pages-source-hash"]; + /** Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. */ + public: boolean; + https_certificate?: components["schemas"]["pages-https-certificate"]; + /** Whether https is enabled on the domain */ + https_enforced?: boolean; + } & { + [key: string]: any; + }; + /** Page Build */ + "page-build": { + url: string; + status: string; + error: { + message: string | null; + } & { + [key: string]: any; + }; + pusher: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + commit: string; + duration: number; + created_at: string; + updated_at: string; + } & { + [key: string]: any; + }; + /** Page Build Status */ + "page-build-status": { + url: string; + status: string; + } & { + [key: string]: any; + }; + /** Pages Health Check Status */ + "pages-health-check": { + domain?: { + host?: string; + uri?: string; + nameservers?: string; + dns_resolves?: boolean; + is_proxied?: boolean | null; + is_cloudflare_ip?: boolean | null; + is_fastly_ip?: boolean | null; + is_old_ip_address?: boolean | null; + is_a_record?: boolean | null; + has_cname_record?: boolean | null; + has_mx_records_present?: boolean | null; + is_valid_domain?: boolean; + is_apex_domain?: boolean; + should_be_a_record?: boolean | null; + is_cname_to_github_user_domain?: boolean | null; + is_cname_to_pages_dot_github_dot_com?: boolean | null; + is_cname_to_fastly?: boolean | null; + is_pointed_to_github_pages_ip?: boolean | null; + is_non_github_pages_ip_present?: boolean | null; + is_pages_domain?: boolean; + is_served_by_pages?: boolean | null; + is_valid?: boolean; + reason?: string | null; + responds_to_https?: boolean; + enforces_https?: boolean; + https_error?: string | null; + is_https_eligible?: boolean | null; + caa_error?: string | null; + } & { + [key: string]: any; + }; + alt_domain?: ({ + host?: string; + uri?: string; + nameservers?: string; + dns_resolves?: boolean; + is_proxied?: boolean | null; + is_cloudflare_ip?: boolean | null; + is_fastly_ip?: boolean | null; + is_old_ip_address?: boolean | null; + is_a_record?: boolean | null; + has_cname_record?: boolean | null; + has_mx_records_present?: boolean | null; + is_valid_domain?: boolean; + is_apex_domain?: boolean; + should_be_a_record?: boolean | null; + is_cname_to_github_user_domain?: boolean | null; + is_cname_to_pages_dot_github_dot_com?: boolean | null; + is_cname_to_fastly?: boolean | null; + is_pointed_to_github_pages_ip?: boolean | null; + is_non_github_pages_ip_present?: boolean | null; + is_pages_domain?: boolean; + is_served_by_pages?: boolean | null; + is_valid?: boolean; + reason?: string | null; + responds_to_https?: boolean; + enforces_https?: boolean; + https_error?: string | null; + is_https_eligible?: boolean | null; + caa_error?: string | null; + } & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + /** Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. */ + "pull-request": { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + /** Number uniquely identifying the pull request within its repository. */ + number: number; + /** State of this Pull Request. Either `open` or `closed`. */ + state: "open" | "closed"; + locked: boolean; + /** The title of the pull request. */ + title: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + body: string | null; + labels: ({ + id?: number; + node_id?: string; + url?: string; + name?: string; + description?: string | null; + color?: string; + default?: boolean; + } & { + [key: string]: any; + })[]; + milestone: (components["schemas"]["milestone"] & { + [key: string]: any; + }) | null; + active_lock_reason?: string | null; + created_at: string; + updated_at: string; + closed_at: string | null; + merged_at: string | null; + merge_commit_sha: string | null; + assignee: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + assignees?: components["schemas"]["simple-user"][] | null; + requested_reviewers?: components["schemas"]["simple-user"][] | null; + requested_teams?: components["schemas"]["team-simple"][] | null; + head: { + label: string; + ref: string; + repo: { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + description: string | null; + downloads_url: string; + events_url: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + hooks_url: string; + html_url: string; + id: number; + node_id: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + name: string; + notifications_url: string; + owner: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string | null; + html_url: string; + id: number; + node_id: string; + login: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + } & { + [key: string]: any; + }; + private: boolean; + pulls_url: string; + releases_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + url: string; + clone_url: string; + default_branch: string; + forks: number; + forks_count: number; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + homepage: string | null; + language: string | null; + master_branch?: string; + archived: boolean; + disabled: boolean; + mirror_url: string | null; + open_issues: number; + open_issues_count: number; + permissions?: { + admin: boolean; + pull: boolean; + push: boolean; + } & { + [key: string]: any; + }; + temp_clone_token?: string; + allow_merge_commit?: boolean; + allow_squash_merge?: boolean; + allow_rebase_merge?: boolean; + license: ({ + key: string; + name: string; + url: string | null; + spdx_id: string | null; + node_id: string; + } & { + [key: string]: any; + }) | null; + pushed_at: string; + size: number; + ssh_url: string; + stargazers_count: number; + svn_url: string; + topics?: string[]; + watchers: number; + watchers_count: number; + created_at: string; + updated_at: string; + } & { + [key: string]: any; + }; + sha: string; + user: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string | null; + html_url: string; + id: number; + node_id: string; + login: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + base: { + label: string; + ref: string; + repo: { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + description: string | null; + downloads_url: string; + events_url: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + hooks_url: string; + html_url: string; + id: number; + node_id: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + name: string; + notifications_url: string; + owner: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string | null; + html_url: string; + id: number; + node_id: string; + login: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + } & { + [key: string]: any; + }; + private: boolean; + pulls_url: string; + releases_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + url: string; + clone_url: string; + default_branch: string; + forks: number; + forks_count: number; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + homepage: string | null; + language: string | null; + master_branch?: string; + archived: boolean; + disabled: boolean; + mirror_url: string | null; + open_issues: number; + open_issues_count: number; + permissions?: { + admin: boolean; + pull: boolean; + push: boolean; + } & { + [key: string]: any; + }; + temp_clone_token?: string; + allow_merge_commit?: boolean; + allow_squash_merge?: boolean; + allow_rebase_merge?: boolean; + license: (components["schemas"]["license-simple"] & { + [key: string]: any; + }) | null; + pushed_at: string; + size: number; + ssh_url: string; + stargazers_count: number; + svn_url: string; + topics?: string[]; + watchers: number; + watchers_count: number; + created_at: string; + updated_at: string; + } & { + [key: string]: any; + }; + sha: string; + user: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string | null; + html_url: string; + id: number; + node_id: string; + login: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + _links: { + comments: components["schemas"]["link"]; + commits: components["schemas"]["link"]; + statuses: components["schemas"]["link"]; + html: components["schemas"]["link"]; + issue: components["schemas"]["link"]; + review_comments: components["schemas"]["link"]; + review_comment: components["schemas"]["link"]; + self: components["schemas"]["link"]; + } & { + [key: string]: any; + }; + author_association: components["schemas"]["author_association"]; + auto_merge: components["schemas"]["auto_merge"]; + /** Indicates whether or not the pull request is a draft. */ + draft?: boolean; + merged: boolean; + mergeable: boolean | null; + rebaseable?: boolean | null; + mergeable_state: string; + merged_by: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + comments: number; + review_comments: number; + /** Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify: boolean; + commits: number; + additions: number; + deletions: number; + changed_files: number; + } & { + [key: string]: any; + }; + /** Pull Request Review Comments are comments on a portion of the Pull Request's diff. */ + "pull-request-review-comment": { + /** URL for the pull request review comment */ + url: string; + /** The ID of the pull request review to which the comment belongs. */ + pull_request_review_id: number | null; + /** The ID of the pull request review comment. */ + id: number; + /** The node ID of the pull request review comment. */ + node_id: string; + /** The diff of the line that the comment refers to. */ + diff_hunk: string; + /** The relative path of the file to which the comment applies. */ + path: string; + /** The line index in the diff to which the comment applies. */ + position: number; + /** The index of the original line in the diff to which the comment applies. */ + original_position: number; + /** The SHA of the commit to which the comment applies. */ + commit_id: string; + /** The SHA of the original commit to which the comment applies. */ + original_commit_id: string; + /** The comment ID to reply to. */ + in_reply_to_id?: number; + user: components["schemas"]["simple-user"]; + /** The text of the comment. */ + body: string; + created_at: string; + updated_at: string; + /** HTML URL for the pull request review comment. */ + html_url: string; + /** URL for the pull request that the review comment belongs to. */ + pull_request_url: string; + author_association: components["schemas"]["author_association"]; + _links: { + self: { + href: string; + } & { + [key: string]: any; + }; + html: { + href: string; + } & { + [key: string]: any; + }; + pull_request: { + href: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** The first line of the range for a multi-line comment. */ + start_line?: number | null; + /** The first line of the range for a multi-line comment. */ + original_start_line?: number | null; + /** The side of the first line of the range for a multi-line comment. */ + start_side?: ("LEFT" | "RIGHT") | null; + /** The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + line?: number; + /** The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + original_line?: number; + /** The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment */ + side?: "LEFT" | "RIGHT"; + reactions?: components["schemas"]["reaction-rollup"]; + body_html?: string; + body_text?: string; + } & { + [key: string]: any; + }; + /** Pull Request Merge Result */ + "pull-request-merge-result": { + sha: string; + merged: boolean; + message: string; + } & { + [key: string]: any; + }; + /** Pull Request Review Request */ + "pull-request-review-request": { + users: components["schemas"]["simple-user"][]; + teams: components["schemas"]["team-simple"][]; + } & { + [key: string]: any; + }; + /** Pull Request Reviews are reviews on pull requests. */ + "pull-request-review": { + /** Unique identifier of the review */ + id: number; + node_id: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + /** The text of the review. */ + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + } & { + [key: string]: any; + }; + pull_request: { + href: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + submitted_at?: string; + /** A commit SHA for the review. */ + commit_id: string; + body_html?: string; + body_text?: string; + author_association: components["schemas"]["author_association"]; + } & { + [key: string]: any; + }; + /** Legacy Review Comment */ + "review-comment": { + url: string; + pull_request_review_id: number | null; + id: number; + node_id: string; + diff_hunk: string; + path: string; + position: number | null; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id?: number; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: components["schemas"]["author_association"]; + _links: { + self: components["schemas"]["link"]; + html: components["schemas"]["link"]; + pull_request: components["schemas"]["link"]; + } & { + [key: string]: any; + }; + body_text?: string; + body_html?: string; + /** The side of the first line of the range for a multi-line comment. */ + side?: "LEFT" | "RIGHT"; + /** The side of the first line of the range for a multi-line comment. */ + start_side?: ("LEFT" | "RIGHT") | null; + /** The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + line?: number; + /** The original line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + original_line?: number; + /** The first line of the range for a multi-line comment. */ + start_line?: number | null; + /** The original first line of the range for a multi-line comment. */ + original_start_line?: number | null; + } & { + [key: string]: any; + }; + /** Data related to a release. */ + "release-asset": { + url: string; + browser_download_url: string; + id: number; + node_id: string; + /** The file name of the asset. */ + name: string; + label: string | null; + /** State of the release asset. */ + state: "uploaded" | "open"; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + /** A release. */ + release: { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string | null; + zipball_url: string | null; + id: number; + node_id: string; + /** The name of the tag. */ + tag_name: string; + /** Specifies the commitish value that determines where the Git tag is created from. */ + target_commitish: string; + name: string | null; + body?: string | null; + /** true to create a draft (unpublished) release, false to create a published one. */ + draft: boolean; + /** Whether to identify the release as a prerelease or a full release. */ + prerelease: boolean; + created_at: string; + published_at: string | null; + author: components["schemas"]["simple-user"]; + assets: components["schemas"]["release-asset"][]; + body_html?: string; + body_text?: string; + /** The URL of the release discussion. */ + discussion_url?: string; + reactions?: components["schemas"]["reaction-rollup"]; + } & { + [key: string]: any; + }; + /** Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. */ + "secret-scanning-alert-state": "open" | "resolved"; + /** **Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`. */ + "secret-scanning-alert-resolution": ("false_positive" | "wont_fix" | "revoked" | "used_in_tests") | null; + "secret-scanning-alert": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + /** The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + resolved_at?: string | null; + resolved_by?: components["schemas"]["simple-user"]; + /** The type of secret that secret scanning detected. */ + secret_type?: string; + /** The secret that was detected. */ + secret?: string; + } & { + [key: string]: any; + }; + /** Stargazer */ + stargazer: { + starred_at: string; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + /** Code Frequency Stat */ + "code-frequency-stat": number[]; + /** Commit Activity */ + "commit-activity": { + days: number[]; + total: number; + week: number; + } & { + [key: string]: any; + }; + /** Contributor Activity */ + "contributor-activity": { + author: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + total: number; + weeks: ({ + w?: number; + a?: number; + d?: number; + c?: number; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + "participation-stats": { + all: number[]; + owner: number[]; + } & { + [key: string]: any; + }; + /** Repository invitations let you manage who you collaborate with. */ + "repository-subscription": { + /** Determines if notifications should be received from this repository. */ + subscribed: boolean; + /** Determines if all notifications should be blocked from this repository. */ + ignored: boolean; + reason: string | null; + created_at: string; + url: string; + repository_url: string; + } & { + [key: string]: any; + }; + /** Tag */ + tag: { + name: string; + commit: { + sha: string; + url: string; + } & { + [key: string]: any; + }; + zipball_url: string; + tarball_url: string; + node_id: string; + } & { + [key: string]: any; + }; + /** A topic aggregates entities that are related to a subject. */ + topic: { + names: string[]; + } & { + [key: string]: any; + }; + traffic: { + timestamp: string; + uniques: number; + count: number; + } & { + [key: string]: any; + }; + /** Clone Traffic */ + "clone-traffic": { + count: number; + uniques: number; + clones: components["schemas"]["traffic"][]; + } & { + [key: string]: any; + }; + /** Content Traffic */ + "content-traffic": { + path: string; + title: string; + count: number; + uniques: number; + } & { + [key: string]: any; + }; + /** Referrer Traffic */ + "referrer-traffic": { + referrer: string; + count: number; + uniques: number; + } & { + [key: string]: any; + }; + /** View Traffic */ + "view-traffic": { + count: number; + uniques: number; + views: components["schemas"]["traffic"][]; + } & { + [key: string]: any; + }; + "scim-group-list-enterprise": { + schemas: string[]; + totalResults: number; + itemsPerPage: number; + startIndex: number; + Resources: ({ + schemas: string[]; + id: string; + externalId?: string | null; + displayName?: string; + members?: ({ + value?: string; + $ref?: string; + display?: string; + } & { + [key: string]: any; + })[]; + meta?: { + resourceType?: string; + created?: string; + lastModified?: string; + location?: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + "scim-enterprise-group": { + schemas: string[]; + id: string; + externalId?: string | null; + displayName?: string; + members?: ({ + value?: string; + $ref?: string; + display?: string; + } & { + [key: string]: any; + })[]; + meta?: { + resourceType?: string; + created?: string; + lastModified?: string; + location?: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + "scim-user-list-enterprise": { + schemas: string[]; + totalResults: number; + itemsPerPage: number; + startIndex: number; + Resources: ({ + schemas: string[]; + id: string; + externalId?: string; + userName?: string; + name?: { + givenName?: string; + familyName?: string; + } & { + [key: string]: any; + }; + emails?: ({ + value?: string; + primary?: boolean; + type?: string; + } & { + [key: string]: any; + })[]; + groups?: ({ + value?: string; + } & { + [key: string]: any; + })[]; + active?: boolean; + meta?: { + resourceType?: string; + created?: string; + lastModified?: string; + location?: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + "scim-enterprise-user": { + schemas: string[]; + id: string; + externalId?: string; + userName?: string; + name?: { + givenName?: string; + familyName?: string; + } & { + [key: string]: any; + }; + emails?: ({ + value?: string; + type?: string; + primary?: boolean; + } & { + [key: string]: any; + })[]; + groups?: ({ + value?: string; + } & { + [key: string]: any; + })[]; + active?: boolean; + meta?: { + resourceType?: string; + created?: string; + lastModified?: string; + location?: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + /** SCIM /Users provisioning endpoints */ + "scim-user": { + /** SCIM schema used. */ + schemas: string[]; + /** Unique identifier of an external identity */ + id: string; + /** The ID of the User. */ + externalId: string | null; + /** Configured by the admin. Could be an email, login, or username */ + userName: string | null; + /** The name of the user, suitable for display to end-users */ + displayName?: string | null; + name: { + givenName: string | null; + familyName: string | null; + formatted?: string | null; + } & { + [key: string]: any; + }; + /** user emails */ + emails: ({ + value: string; + primary?: boolean; + } & { + [key: string]: any; + })[]; + /** The active status of the User. */ + active: boolean; + meta: { + resourceType?: string; + created?: string; + lastModified?: string; + location?: string; + } & { + [key: string]: any; + }; + /** The ID of the organization. */ + organization_id?: number; + /** Set of operations to be performed */ + operations?: ({ + op: "add" | "remove" | "replace"; + path?: string; + value?: (string | { + [key: string]: any; + } | { + [key: string]: any; + }[]) & { + [key: string]: any; + }; + } & { + [key: string]: any; + })[]; + /** associated groups */ + groups?: ({ + value?: string; + display?: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + /** SCIM User List */ + "scim-user-list": { + /** SCIM schema used. */ + schemas: string[]; + totalResults: number; + itemsPerPage: number; + startIndex: number; + Resources: components["schemas"]["scim-user"][]; + } & { + [key: string]: any; + }; + "search-result-text-matches": ({ + object_url?: string; + object_type?: string | null; + property?: string; + fragment?: string; + matches?: ({ + text?: string; + indices?: number[]; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + })[]; + /** Code Search Result Item */ + "code-search-result-item": { + name: string; + path: string; + sha: string; + url: string; + git_url: string; + html_url: string; + repository: components["schemas"]["minimal-repository"]; + score: number; + file_size?: number; + language?: string | null; + last_modified_at?: string; + line_numbers?: string[]; + text_matches?: components["schemas"]["search-result-text-matches"]; + } & { + [key: string]: any; + }; + /** Commit Search Result Item */ + "commit-search-result-item": { + url: string; + sha: string; + html_url: string; + comments_url: string; + commit: { + author: { + name: string; + email: string; + date: string; + } & { + [key: string]: any; + }; + committer: (components["schemas"]["git-user"] & { + [key: string]: any; + }) | null; + comment_count: number; + message: string; + tree: { + sha: string; + url: string; + } & { + [key: string]: any; + }; + url: string; + verification?: components["schemas"]["verification"]; + } & { + [key: string]: any; + }; + author: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + committer: (components["schemas"]["git-user"] & { + [key: string]: any; + }) | null; + parents: ({ + url?: string; + html_url?: string; + sha?: string; + } & { + [key: string]: any; + })[]; + repository: components["schemas"]["minimal-repository"]; + score: number; + node_id: string; + text_matches?: components["schemas"]["search-result-text-matches"]; + } & { + [key: string]: any; + }; + /** Issue Search Result Item */ + "issue-search-result-item": { + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + id: number; + node_id: string; + number: number; + title: string; + locked: boolean; + active_lock_reason?: string | null; + assignees?: components["schemas"]["simple-user"][] | null; + user: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + labels: ({ + id?: number; + node_id?: string; + url?: string; + name?: string; + color?: string; + default?: boolean; + description?: string | null; + } & { + [key: string]: any; + })[]; + state: string; + assignee: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + milestone: (components["schemas"]["milestone"] & { + [key: string]: any; + }) | null; + comments: number; + created_at: string; + updated_at: string; + closed_at: string | null; + text_matches?: components["schemas"]["search-result-text-matches"]; + pull_request?: { + merged_at?: string | null; + diff_url: string | null; + html_url: string | null; + patch_url: string | null; + url: string | null; + } & { + [key: string]: any; + }; + body?: string; + score: number; + author_association: components["schemas"]["author_association"]; + draft?: boolean; + repository?: components["schemas"]["repository"]; + body_html?: string; + body_text?: string; + timeline_url?: string; + performed_via_github_app?: (components["schemas"]["integration"] & { + [key: string]: any; + }) | null; + } & { + [key: string]: any; + }; + /** Label Search Result Item */ + "label-search-result-item": { + id: number; + node_id: string; + url: string; + name: string; + color: string; + default: boolean; + description: string | null; + score: number; + text_matches?: components["schemas"]["search-result-text-matches"]; + } & { + [key: string]: any; + }; + /** Repo Search Result Item */ + "repo-search-result-item": { + id: number; + node_id: string; + name: string; + full_name: string; + owner: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + private: boolean; + html_url: string; + description: string | null; + fork: boolean; + url: string; + created_at: string; + updated_at: string; + pushed_at: string; + homepage: string | null; + size: number; + stargazers_count: number; + watchers_count: number; + language: string | null; + forks_count: number; + open_issues_count: number; + master_branch?: string; + default_branch: string; + score: number; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; + git_url: string; + ssh_url: string; + clone_url: string; + svn_url: string; + forks: number; + open_issues: number; + watchers: number; + topics?: string[]; + mirror_url: string | null; + has_issues: boolean; + has_projects: boolean; + has_pages: boolean; + has_wiki: boolean; + has_downloads: boolean; + archived: boolean; + /** Returns whether or not this repository disabled. */ + disabled: boolean; + license: (components["schemas"]["license-simple"] & { + [key: string]: any; + }) | null; + permissions?: { + admin: boolean; + pull: boolean; + push: boolean; + } & { + [key: string]: any; + }; + text_matches?: components["schemas"]["search-result-text-matches"]; + temp_clone_token?: string; + allow_merge_commit?: boolean; + allow_squash_merge?: boolean; + allow_rebase_merge?: boolean; + delete_branch_on_merge?: boolean; + } & { + [key: string]: any; + }; + /** Topic Search Result Item */ + "topic-search-result-item": { + name: string; + display_name: string | null; + short_description: string | null; + description: string | null; + created_by: string | null; + released: string | null; + created_at: string; + updated_at: string; + featured: boolean; + curated: boolean; + score: number; + repository_count?: number | null; + logo_url?: string | null; + text_matches?: components["schemas"]["search-result-text-matches"]; + related?: ({ + topic_relation?: { + id?: number; + name?: string; + topic_id?: number; + relation_type?: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + })[] | null; + aliases?: ({ + topic_relation?: { + id?: number; + name?: string; + topic_id?: number; + relation_type?: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + })[] | null; + } & { + [key: string]: any; + }; + /** User Search Result Item */ + "user-search-result-item": { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string | null; + url: string; + html_url: string; + followers_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + received_events_url: string; + type: string; + score: number; + following_url: string; + gists_url: string; + starred_url: string; + events_url: string; + public_repos?: number; + public_gists?: number; + followers?: number; + following?: number; + created_at?: string; + updated_at?: string; + name?: string | null; + bio?: string | null; + email?: string | null; + location?: string | null; + site_admin: boolean; + hireable?: boolean | null; + text_matches?: components["schemas"]["search-result-text-matches"]; + blog?: string | null; + company?: string | null; + suspended_at?: string | null; + } & { + [key: string]: any; + }; + /** Private User */ + "private-user": { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string | null; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string | null; + company: string | null; + blog: string | null; + location: string | null; + email: string | null; + hireable: boolean | null; + bio: string | null; + twitter_username?: string | null; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; + private_gists: number; + total_private_repos: number; + owned_private_repos: number; + disk_usage: number; + collaborators: number; + two_factor_authentication: boolean; + plan?: { + collaborators: number; + name: string; + space: number; + private_repos: number; + } & { + [key: string]: any; + }; + suspended_at?: string | null; + business_plus?: boolean; + ldap_dn?: string; + } & { + [key: string]: any; + }; + /** Public User */ + "public-user": { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string | null; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string | null; + company: string | null; + blog: string | null; + location: string | null; + email: string | null; + hireable: boolean | null; + bio: string | null; + twitter_username?: string | null; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; + plan?: { + collaborators: number; + name: string; + space: number; + private_repos: number; + } & { + [key: string]: any; + }; + suspended_at?: string | null; + private_gists?: number; + total_private_repos?: number; + owned_private_repos?: number; + disk_usage?: number; + collaborators?: number; + }; + /** Email */ + email: { + email: string; + primary: boolean; + verified: boolean; + visibility: string | null; + } & { + [key: string]: any; + }; + /** A unique encryption key */ + "gpg-key": { + id: number; + primary_key_id: number | null; + key_id: string; + public_key: string; + emails: ({ + email?: string; + verified?: boolean; + } & { + [key: string]: any; + })[]; + subkeys: ({ + id?: number; + primary_key_id?: number; + key_id?: string; + public_key?: string; + emails?: { + [key: string]: any; + }[]; + subkeys?: { + [key: string]: any; + }[]; + can_sign?: boolean; + can_encrypt_comms?: boolean; + can_encrypt_storage?: boolean; + can_certify?: boolean; + created_at?: string; + expires_at?: string | null; + raw_key?: string | null; + } & { + [key: string]: any; + })[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string | null; + raw_key: string | null; + } & { + [key: string]: any; + }; + /** Key */ + key: { + key: string; + id: number; + url: string; + title: string; + created_at: string; + verified: boolean; + read_only: boolean; + } & { + [key: string]: any; + }; + "marketplace-account": { + url: string; + id: number; + type: string; + node_id?: string; + login: string; + email?: string | null; + organization_billing_email?: string | null; + } & { + [key: string]: any; + }; + /** User Marketplace Purchase */ + "user-marketplace-purchase": { + billing_cycle: string; + next_billing_date: string | null; + unit_count: number | null; + on_free_trial: boolean; + free_trial_ends_on: string | null; + updated_at: string | null; + account: components["schemas"]["marketplace-account"]; + plan: components["schemas"]["marketplace-listing-plan"]; + } & { + [key: string]: any; + }; + /** Starred Repository */ + "starred-repository": { + starred_at: string; + repo: components["schemas"]["repository"]; + } & { + [key: string]: any; + }; + /** The authorization for a Personal Access Token. */ + "personal-access-token": { + id: number; + url: string; + /** A list of scopes that this authorization is in. */ + scopes: string[] | null; + token: string; + token_last_eight: string | null; + hashed_token: string | null; + note: string | null; + note_url: string | null; + updated_at: string; + created_at: string; + fingerprint: string | null; + user?: (components["schemas"]["simple-user"] & { + [key: string]: any; + }) | null; + expiration: string | null; + } & { + [key: string]: any; + }; + /** Hovercard */ + hovercard: { + contexts: ({ + message: string; + octicon: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + /** Key Simple */ + "key-simple": { + id: number; + key: string; + } & { + [key: string]: any; + }; + /** Content Reference attachments allow you to provide context around URLs posted in comments */ + "content-reference-attachment": { + /** The ID of the attachment */ + id: number; + /** The title of the attachment */ + title: string; + /** The body of the attachment */ + body: string; + /** The node_id of the content attachment */ + node_id?: string; + } & { + [key: string]: any; + }; + }; + responses: { + /** Resource not found */ + not_found: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** Validation failed */ + validation_failed_simple: { + content: { + "application/json": components["schemas"]["validation-error-simple"]; + }; + }; + /** Preview header missing */ + preview_header_missing: { + content: { + "application/json": { + message: string; + documentation_url: string; + } & { + [key: string]: any; + }; + }; + }; + /** Forbidden */ + forbidden: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** Requires authentication */ + requires_authentication: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** Validation failed */ + validation_failed: { + content: { + "application/json": components["schemas"]["validation-error"]; + }; + }; + /** Not modified */ + not_modified: unknown; + /** Gone */ + gone: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** Service unavailable */ + service_unavailable: { + content: { + "application/json": { + code?: string; + message?: string; + documentation_url?: string; + } & { + [key: string]: any; + }; + }; + }; + /** Forbidden Gist */ + forbidden_gist: { + content: { + "application/json": { + block?: { + reason?: string; + created_at?: string; + html_url?: string | null; + } & { + [key: string]: any; + }; + message?: string; + documentation_url?: string; + } & { + [key: string]: any; + }; + }; + }; + /** Moved permanently */ + moved_permanently: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** Conflict */ + conflict: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** Temporary Redirect */ + temporary_redirect: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** Response if GitHub Advanced Security is not enabled for this repository */ + code_scanning_forbidden_read: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** Response if the repository is archived or if github advanced security is not enabled for this repository */ + code_scanning_forbidden_write: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** Bad Request */ + bad_request: { + content: { + "application/json": components["schemas"]["basic-error"]; + "application/scim+json": components["schemas"]["scim-error"]; + }; + }; + /** Internal Error */ + internal_error: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** Found */ + found: unknown; + /** Accepted */ + accepted: { + content: { + "application/json": { + [key: string]: any; + }; + }; + }; + /** A header with no content is returned. */ + no_content: unknown; + /** Resource not found */ + scim_not_found: { + content: { + "application/json": components["schemas"]["scim-error"]; + "application/scim+json": components["schemas"]["scim-error"]; + }; + }; + /** Forbidden */ + scim_forbidden: { + content: { + "application/json": components["schemas"]["scim-error"]; + "application/scim+json": components["schemas"]["scim-error"]; + }; + }; + /** Bad Request */ + scim_bad_request: { + content: { + "application/json": components["schemas"]["scim-error"]; + "application/scim+json": components["schemas"]["scim-error"]; + }; + }; + /** Internal Error */ + scim_internal_error: { + content: { + "application/json": components["schemas"]["scim-error"]; + "application/scim+json": components["schemas"]["scim-error"]; + }; + }; + /** Conflict */ + scim_conflict: { + content: { + "application/json": components["schemas"]["scim-error"]; + "application/scim+json": components["schemas"]["scim-error"]; + }; + }; + }; + parameters: { + /** Results per page (max 100). */ + per_page: number; + /** Page number of the results to fetch. */ + page: number; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since: string; + /** installation_id parameter */ + installation_id: number; + /** grant_id parameter */ + grant_id: number; + /** The client ID of your GitHub app. */ + "client-id": string; + "access-token": string; + app_slug: string; + /** authorization_id parameter */ + authorization_id: number; + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: string; + /** Unique identifier of an organization. */ + org_id: number; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: number; + /** Unique identifier of the self-hosted runner. */ + runner_id: number; + /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ + "audit-log-phrase": string; + /** + * The event types to include: + * + * - `web` - returns web (non-Git) events + * - `git` - returns Git events + * - `all` - returns both web and Git events + * + * The default is `web`. + */ + "audit-log-include": "web" | "git" | "all"; + /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ + "audit-log-after": string; + /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ + "audit-log-before": string; + /** + * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. + */ + "audit-log-order": "desc" | "asc"; + /** gist_id parameter */ + gist_id: string; + /** comment_id parameter */ + comment_id: number; + /** A list of comma separated label names. Example: `bug,ui,@high` */ + labels: string; + /** One of `asc` (ascending) or `desc` (descending). */ + direction: "asc" | "desc"; + /** account_id parameter */ + account_id: number; + /** plan_id parameter */ + plan_id: number; + /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ + sort: "created" | "updated"; + owner: string; + repo: string; + /** If `true`, show notifications marked as read. */ + all: boolean; + /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ + participating: boolean; + /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + before: string; + /** thread_id parameter */ + thread_id: number; + /** An organization ID. Only return organizations with an ID greater than this ID. */ + "since-org": number; + org: string; + repository_id: number; + /** secret_name parameter */ + secret_name: string; + username: string; + "hook-id": number; + /** invitation_id parameter */ + invitation_id: number; + /** migration_id parameter */ + migration_id: number; + /** repo_name parameter */ + repo_name: string; + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + /** The name of the package. */ + package_name: string; + /** Unique identifier of the package version. */ + package_version_id: number; + /** team_slug parameter */ + team_slug: string; + "discussion-number": number; + "comment-number": number; + "reaction-id": number; + "project-id": number; + /** card_id parameter */ + card_id: number; + /** column_id parameter */ + column_id: number; + /** artifact_id parameter */ + artifact_id: number; + /** job_id parameter */ + job_id: number; + /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ + actor: string; + /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ + "workflow-run-branch": string; + /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ + event: string; + /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ + "workflow-run-status": "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting"; + /** The id of the workflow run. */ + "run-id": number; + /** The ID of the workflow. You can also pass the workflow file name as a string. */ + "workflow-id": (number | string) & { + [key: string]: any; + }; + /** The name of the branch. */ + branch: string; + /** check_run_id parameter */ + check_run_id: number; + /** check_suite_id parameter */ + check_suite_id: number; + /** Returns check runs with the specified `name`. */ + check_name: string; + /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ + status: "queued" | "in_progress" | "completed"; + /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ + tool_name: components["schemas"]["code-scanning-analysis-tool-name"]; + /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ + tool_guid: components["schemas"]["code-scanning-analysis-tool-guid"]; + /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ + git_ref: components["schemas"]["code-scanning-ref"]; + /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["schemas"]["alert-number"]; + /** commit_sha parameter */ + commit_sha: string; + /** Results per page (max 100) */ + "per-page": number; + /** deployment_id parameter */ + deployment_id: number; + /** The name of the environment */ + environment_name: string; + /** A user ID. Only return users with an ID greater than this ID. */ + "since-user": number; + /** issue_number parameter */ + issue_number: number; + /** key_id parameter */ + key_id: number; + /** milestone_number parameter */ + milestone_number: number; + "pull-number": number; + /** review_id parameter */ + review_id: number; + /** asset_id parameter */ + asset_id: number; + /** release_id parameter */ + release_id: number; + /** Must be one of: `day`, `week`. */ + per: "" | "day" | "week"; + /** A repository ID. Only return repositories with an ID greater than this ID. */ + "since-repo": number; + /** Used for pagination: the index of the first result to return. */ + start_index: number; + /** Used for pagination: the number of results to return. */ + count: number; + /** Identifier generated by the GitHub SCIM endpoint. */ + scim_group_id: string; + /** scim_user_id parameter */ + scim_user_id: string; + /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ + order: "desc" | "asc"; + "team-id": number; + /** gpg_key_id parameter */ + gpg_key_id: number; + }; + headers: { + link?: string; + "content-type"?: string; + "x-common-marker-version"?: string; + "x-rate-limit-limit"?: number; + "x-rate-limit-remaining"?: number; + "x-rate-limit-reset"?: number; + location?: string; + }; +} +export interface operations { + /** Get Hypermedia links to resources accessible in GitHub's REST API */ + "meta/root": { + responses: { + /** Response */ + 200: { + content: { + "application/json": { + current_user_url: string; + current_user_authorizations_html_url: string; + authorizations_url: string; + code_search_url: string; + commit_search_url: string; + emails_url: string; + emojis_url: string; + events_url: string; + feeds_url: string; + followers_url: string; + following_url: string; + gists_url: string; + hub_url: string; + issue_search_url: string; + issues_url: string; + keys_url: string; + label_search_url: string; + notifications_url: string; + organization_url: string; + organization_repositories_url: string; + organization_teams_url: string; + public_gists_url: string; + rate_limit_url: string; + repository_url: string; + repository_search_url: string; + current_user_repositories_url: string; + starred_url: string; + starred_gists_url: string; + topic_search_url?: string; + user_url: string; + user_organizations_url: string; + user_repositories_url: string; + user_search_url: string; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. + * + * 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. + */ + "apps/get-authenticated": { + parameters: {}; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["integration"]; + }; + }; + }; + }; + /** Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ + "apps/create-from-manifest": { + parameters: { + path: { + code: string; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["integration"] & ({ + client_id: string; + client_secret: string; + webhook_secret: string | null; + pem: string; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + [key: string]: any; + }; + }; + }; + }; + /** + * Returns 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)." + * + * 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. + */ + "apps/get-webhook-config-for-app": { + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + /** + * 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)." + * + * 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. + */ + "apps/update-webhook-config-for-app": { + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + url?: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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. + * + * The permissions the installation has are included under the `permissions` key. + */ + "apps/list-installations": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + outdated?: string; + }; + }; + responses: { + /** The permissions the installation has are included under the `permissions` key. */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["installation"][]; + }; + }; + }; + }; + /** + * Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to. + * + * 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. + */ + "apps/get-installation": { + parameters: { + path: { + /** installation_id parameter */ + installation_id: components["parameters"]["installation_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["installation"]; + }; + }; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** + * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. + * + * 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. + */ + "apps/delete-installation": { + parameters: { + path: { + /** installation_id parameter */ + installation_id: components["parameters"]["installation_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + "apps/create-installation-access-token": { + parameters: { + path: { + /** installation_id parameter */ + installation_id: components["parameters"]["installation_id"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["installation-token"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** List of repository names that the token should have access to */ + repositories?: string[]; + /** List of repository IDs that the token should have access to */ + repository_ids?: number[]; + permissions?: components["schemas"]["app-permissions"]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + * + * 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. + */ + "apps/suspend-installation": { + parameters: { + path: { + /** installation_id parameter */ + installation_id: components["parameters"]["installation_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Removes a GitHub App installation suspension. + * + * 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. + */ + "apps/unsuspend-installation": { + parameters: { + path: { + /** installation_id parameter */ + installation_id: components["parameters"]["installation_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + */ + "oauth-authorizations/list-grants": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** The client ID of your GitHub app. */ + client_id?: string; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["application-grant"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ + "oauth-authorizations/get-grant": { + parameters: { + path: { + /** grant_id parameter */ + grant_id: components["parameters"]["grant_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["application-grant"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + */ + "oauth-authorizations/delete-grant": { + parameters: { + path: { + /** grant_id parameter */ + grant_id: components["parameters"]["grant_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** + * OAuth application owners can revoke a grant for their OAuth 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. + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + */ + "apps/delete-authorization": { + parameters: { + path: { + /** The client ID of your GitHub app. */ + client_id: components["parameters"]["client-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The OAuth access token used to authenticate to the GitHub API. */ + access_token?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). + * + * OAuth application owners can revoke a grant for their OAuth 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 token as `:access_token` and the grant for the token's owner will be deleted. + * + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under "Authorized OAuth Apps" on GitHub](https://github.com/settings/applications#authorized). + */ + "apps/revoke-grant-for-application": { + parameters: { + path: { + /** The client ID of your GitHub app. */ + client_id: components["parameters"]["client-id"]; + access_token: components["parameters"]["access-token"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ + "apps/check-token": { + parameters: { + path: { + /** The client ID of your GitHub app. */ + client_id: components["parameters"]["client-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["authorization"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The access_token of the OAuth application. */ + access_token: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** 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 OAuth application's `client_id` and `client_secret` as the username and password. */ + "apps/delete-token": { + parameters: { + path: { + /** The client ID of your GitHub app. */ + client_id: components["parameters"]["client-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The OAuth access token used to authenticate to the GitHub API. */ + access_token: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** 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 OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ + "apps/reset-token": { + parameters: { + path: { + /** The client ID of your GitHub app. */ + client_id: components["parameters"]["client-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["authorization"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The access_token of the OAuth application. */ + access_token: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth 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 OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ + "apps/scope-token": { + parameters: { + path: { + /** The client ID of your GitHub app. */ + client_id: components["parameters"]["client-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["authorization"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The OAuth access token used to authenticate to the GitHub API. */ + access_token: string; + /** The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified. */ + target?: string; + /** The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified. */ + target_id?: number; + /** The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified. */ + repositories?: string[]; + /** The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified. */ + repository_ids?: number[]; + permissions?: components["schemas"]["app-permissions"]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). + * + * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://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. Invalid tokens will return `404 NOT FOUND`. + */ + "apps/check-authorization": { + parameters: { + path: { + /** The client ID of your GitHub app. */ + client_id: components["parameters"]["client-id"]; + access_token: components["parameters"]["access-token"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": (components["schemas"]["authorization"] & { + [key: string]: any; + }) | null; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). + * + * 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 OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + */ + "apps/reset-authorization": { + parameters: { + path: { + /** The client ID of your GitHub app. */ + client_id: components["parameters"]["client-id"]; + access_token: components["parameters"]["access-token"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["authorization"]; + }; + }; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). + * + * 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 OAuth application's `client_id` and `client_secret` as the username and password. + */ + "apps/revoke-authorization-for-application": { + parameters: { + path: { + /** The client ID of your GitHub app. */ + client_id: components["parameters"]["client-id"]; + access_token: components["parameters"]["access-token"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * + * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + "apps/get-by-slug": { + parameters: { + path: { + app_slug: components["parameters"]["app_slug"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["integration"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ + "oauth-authorizations/list-authorizations": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** The client ID of your GitHub app. */ + client_id?: string; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["authorization"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * **Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * + * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. + * + * You can also create tokens on GitHub from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use). + * + * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). + */ + "oauth-authorizations/create-authorization": { + parameters: {}; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["authorization"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** A list of scopes that this authorization is in. */ + scopes?: string[] | null; + /** A note to remind you what the OAuth token is for. */ + note?: string; + /** A URL to remind you what app the OAuth token is for. */ + note_url?: string; + /** The OAuth app client key for which to create the token. */ + client_id?: string; + /** The OAuth app client secret for which to create the token. */ + client_secret?: string; + /** A unique string to distinguish an authorization from others created for the same client ID and user. */ + fingerprint?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * **Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * + * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + * + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + */ + "oauth-authorizations/get-or-create-authorization-for-app": { + parameters: { + path: { + /** The client ID of your GitHub app. */ + client_id: components["parameters"]["client-id"]; + }; + }; + responses: { + /** if returning an existing token */ + 200: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["authorization"]; + }; + }; + /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["authorization"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The OAuth app client secret for which to create the token. */ + client_secret: string; + /** A list of scopes that this authorization is in. */ + scopes?: string[] | null; + /** A note to remind you what the OAuth token is for. */ + note?: string; + /** A URL to remind you what app the OAuth token is for. */ + note_url?: string; + /** A unique string to distinguish an authorization from others created for the same client ID and user. */ + fingerprint?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * **Warning:** Apps must use the [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * + * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + * + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + */ + "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { + parameters: { + path: { + /** The client ID of your GitHub app. */ + client_id: components["parameters"]["client-id"]; + fingerprint: string; + }; + }; + responses: { + /** if returning an existing token */ + 200: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["authorization"]; + }; + }; + /** Response if returning a new token */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["authorization"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The OAuth app client secret for which to create the token. */ + client_secret: string; + /** A list of scopes that this authorization is in. */ + scopes?: string[] | null; + /** A note to remind you what the OAuth token is for. */ + note?: string; + /** A URL to remind you what app the OAuth token is for. */ + note_url?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ + "oauth-authorizations/get-authorization": { + parameters: { + path: { + /** authorization_id parameter */ + authorization_id: components["parameters"]["authorization_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["authorization"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ + "oauth-authorizations/delete-authorization": { + parameters: { + path: { + /** authorization_id parameter */ + authorization_id: components["parameters"]["authorization_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** + * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * + * You can only send one of these scope keys at a time. + */ + "oauth-authorizations/update-authorization": { + parameters: { + path: { + /** authorization_id parameter */ + authorization_id: components["parameters"]["authorization_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["authorization"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** A list of scopes that this authorization is in. */ + scopes?: string[] | null; + /** A list of scopes to add to this authorization. */ + add_scopes?: string[]; + /** A list of scopes to remove from this authorization. */ + remove_scopes?: string[]; + /** A note to remind you what the OAuth token is for. */ + note?: string; + /** A URL to remind you what app the OAuth token is for. */ + note_url?: string; + /** A unique string to distinguish an authorization from others created for the same client ID and user. */ + fingerprint?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "codes-of-conduct/get-all-codes-of-conduct": { + parameters: {}; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["code-of-conduct"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + "codes-of-conduct/get-conduct-code": { + parameters: { + path: { + key: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["code-of-conduct"]; + }; + }; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** Lists all the emojis available to use on GitHub. */ + "emojis/get": { + parameters: {}; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + [key: string]: string; + }; + }; + }; + 304: components["responses"]["not_modified"]; + }; + }; + /** + * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/get-github-actions-permissions-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-enterprise-permissions"]; + }; + }; + }; + }; + /** + * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/set-github-actions-permissions-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + enabled_organizations: components["schemas"]["enabled-organizations"]; + allowed_actions?: components["schemas"]["allowed-actions"]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + organizations: components["schemas"]["organization-simple"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + /** List of organization IDs to enable for GitHub Actions. */ + selected_organization_ids: number[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/enable-selected-organization-github-actions-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of an organization. */ + org_id: components["parameters"]["org_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/disable-selected-organization-github-actions-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of an organization. */ + org_id: components["parameters"]["org_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/get-allowed-actions-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + }; + }; + /** + * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/set-allowed-actions-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + }; + /** + * Lists all self-hosted runner groups for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-enterprise"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Creates a new self-hosted runner group for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["runner-groups-enterprise"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** Name of the runner group. */ + name: string; + /** Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected` */ + visibility?: "selected" | "all"; + /** List of organization IDs that can access the runner group. */ + selected_organization_ids?: number[]; + /** List of runner IDs to add to the runner group. */ + runners?: number[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Gets a specific self-hosted runner group for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["runner-groups-enterprise"]; + }; + }; + }; + }; + /** + * Deletes a self-hosted runner group for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["runner-groups-enterprise"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** Name of the runner group. */ + name?: string; + /** Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected` */ + visibility?: "selected" | "all"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Lists the organizations with access to a self-hosted runner group. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + organizations: components["schemas"]["organization-simple"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + /** List of organization IDs that can access the runner group. */ + selected_organization_ids: number[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + /** Unique identifier of an organization. */ + org_id: components["parameters"]["org_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + /** Unique identifier of an organization. */ + org_id: components["parameters"]["org_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Lists the self-hosted runners that are in a specific enterprise group. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Replaces the list of self-hosted runners that are part of an enterprise runner group. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + /** List of runner IDs to add to the runner group. */ + runners: number[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Adds a self-hosted runner to a runner group configured in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` + * scope to use this endpoint. + */ + "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + /** Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + /** Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Lists all self-hosted runners configured for an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/list-self-hosted-runners-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count?: number; + runners?: components["schemas"]["runner"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/list-runner-applications-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["runner-application"][]; + }; + }; + }; + }; + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN + * ``` + */ + "enterprise-admin/create-registration-token-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + }; + /** + * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this + * endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + "enterprise-admin/create-remove-token-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + }; + /** + * Gets a specific self-hosted runner configured in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/get-self-hosted-runner-for-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["runner"]; + }; + }; + }; + }; + /** + * Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + "enterprise-admin/delete-self-hosted-runner-from-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ + "enterprise-admin/get-audit-log": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + query: { + /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ + phrase?: components["parameters"]["audit-log-phrase"]; + /** + * The event types to include: + * + * - `web` - returns web (non-Git) events + * - `git` - returns Git events + * - `all` - returns both web and Git events + * + * The default is `web`. + */ + include?: components["parameters"]["audit-log-include"]; + /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ + after?: components["parameters"]["audit-log-after"]; + /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ + before?: components["parameters"]["audit-log-before"]; + /** + * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. + */ + order?: components["parameters"]["audit-log-order"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["audit-log-event"][]; + }; + }; + }; + }; + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * 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 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * The authenticated user must be an enterprise admin. + */ + "billing/get-github-actions-billing-ghe": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-billing-usage"]; + }; + }; + }; + }; + /** + * Gets the free and paid storage used for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * The authenticated user must be an enterprise admin. + */ + "billing/get-github-packages-billing-ghe": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["packages-billing-usage"]; + }; + }; + }; + }; + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * The authenticated user must be an enterprise admin. + */ + "billing/get-shared-storage-billing-ghe": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["combined-billing-usage"]; + }; + }; + }; + }; + /** We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ + "activity/list-public-events": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["event"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + * + * * **Timeline**: The GitHub global public timeline + * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + * * **Current user public**: The public timeline for the authenticated user + * * **Current user**: The private timeline for the authenticated user + * * **Current user actor**: The private timeline for activity created by the authenticated user + * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. + * + * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + */ + "activity/get-feeds": { + parameters: {}; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["feed"]; + }; + }; + }; + }; + /** Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ + "gists/list": { + parameters: { + query: { + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["base-gist"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** + * Allows you to add a new gist with one or more files. + * + * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + */ + "gists/create": { + parameters: {}; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["gist-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** Description of the gist */ + description?: string; + /** Names and content for the files that make up the gist */ + files: { + [key: string]: { + /** Content of the file */ + content: string; + } & { + [key: string]: any; + }; + }; + public?: (boolean | ("true" | "false")) & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * List public gists sorted by most recently updated to least recently updated. + * + * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + */ + "gists/list-public": { + parameters: { + query: { + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["base-gist"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** List the authenticated user's starred gists: */ + "gists/list-starred": { + parameters: { + query: { + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["base-gist"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "gists/get": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["gist-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden_gist"]; + 404: components["responses"]["not_found"]; + }; + }; + "gists/delete": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. */ + "gists/update": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["gist-simple"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ((Partial<{ + [key: string]: any; + }> & Partial<{ + [key: string]: any; + }>) & { + /** Description of the gist */ + description?: string; + /** Names of files to be updated */ + files?: { + [key: string]: Partial<{ + [key: string]: any; + }> & Partial<{ + [key: string]: any; + }> & Partial<{ + [key: string]: any; + }>; + }; + } & { + [key: string]: any; + }) | null; + }; + }; + }; + "gists/list-comments": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["gist-comment"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "gists/create-comment": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["gist-comment"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + requestBody: { + content: { + "application/json": { + /** The comment text. */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "gists/get-comment": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["gist-comment"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden_gist"]; + 404: components["responses"]["not_found"]; + }; + }; + "gists/delete-comment": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "gists/update-comment": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["gist-comment"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + requestBody: { + content: { + "application/json": { + /** The comment text. */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "gists/list-commits": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: { + Link?: string; + }; + content: { + "application/json": components["schemas"]["gist-commit"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "gists/list-forks": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["gist-simple"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** **Note**: This was previously `/gists/:gist_id/fork`. */ + "gists/fork": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["base-gist"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "gists/check-is-starred": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** Response if gist is starred */ + 204: never; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + /** Not Found if gist is not starred */ + 404: { + content: { + "application/json": { + [key: string]: any; + }; + }; + }; + }; + }; + /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ + "gists/star": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "gists/unstar": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "gists/get-revision": { + parameters: { + path: { + /** gist_id parameter */ + gist_id: components["parameters"]["gist_id"]; + sha: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["gist-simple"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). */ + "gitignore/get-all-templates": { + parameters: {}; + responses: { + /** Response */ + 200: { + content: { + "application/json": string[]; + }; + }; + 304: components["responses"]["not_modified"]; + }; + }; + /** + * The API also allows fetching the source of a single template. + * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. + */ + "gitignore/get-template": { + parameters: { + path: { + name: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["gitignore-template"]; + }; + }; + 304: components["responses"]["not_modified"]; + }; + }; + /** + * List repositories that an app installation can access. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + "apps/list-repos-accessible-to-installation": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + repositories: components["schemas"]["repository"][]; + repository_selection?: string; + } & { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** + * Revokes the installation token you're using to authenticate as an installation and access this endpoint. + * + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + "apps/revoke-installation-access-token": { + parameters: {}; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * List issues assigned to the authenticated user across all visible repositories including owned repositories, member + * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + * necessarily assigned to you. + * + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + "issues/list": { + parameters: { + query: { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + state?: "open" | "closed" | "all"; + /** A list of comma separated label names. Example: `bug,ui,@high` */ + labels?: components["parameters"]["labels"]; + /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + sort?: "created" | "updated" | "comments"; + /** One of `asc` (ascending) or `desc` (descending). */ + direction?: components["parameters"]["direction"]; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + collab?: boolean; + orgs?: boolean; + owned?: boolean; + pulls?: boolean; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "licenses/get-all-commonly-used": { + parameters: { + query: { + featured?: boolean; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["license-simple"][]; + }; + }; + 304: components["responses"]["not_modified"]; + }; + }; + "licenses/get": { + parameters: { + path: { + license: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["license"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "markdown/render": { + parameters: {}; + responses: { + /** Response */ + 200: { + headers: { + "Content-Length"?: string; + }; + content: { + "text/html": string; + }; + }; + 304: components["responses"]["not_modified"]; + }; + requestBody: { + content: { + "application/json": { + /** The Markdown text to render in HTML. */ + text: string; + /** The rendering mode. */ + mode?: "markdown" | "gfm"; + /** The repository context to use when creating references in `gfm` mode. */ + context?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ + "markdown/render-raw": { + parameters: {}; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "text/html": string; + }; + }; + 304: components["responses"]["not_modified"]; + }; + requestBody: { + content: { + "text/plain": string; + "text/x-markdown": string; + }; + }; + }; + /** + * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + "apps/get-subscription-plan-for-account": { + parameters: { + path: { + /** account_id parameter */ + account_id: components["parameters"]["account_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["marketplace-purchase"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + /** Not Found when the account has not purchased the listing */ + 404: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + /** + * Lists all plans that are part of your GitHub Marketplace listing. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + "apps/list-plans": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["marketplace-listing-plan"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + "apps/list-accounts-for-plan": { + parameters: { + path: { + /** plan_id parameter */ + plan_id: components["parameters"]["plan_id"]; + }; + query: { + /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ + sort?: components["parameters"]["sort"]; + /** To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. */ + direction?: "asc" | "desc"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["marketplace-purchase"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + "apps/get-subscription-plan-for-account-stubbed": { + parameters: { + path: { + /** account_id parameter */ + account_id: components["parameters"]["account_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["marketplace-purchase"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + /** Not Found when the account has not purchased the listing */ + 404: unknown; + }; + }; + /** + * Lists all plans that are part of your GitHub Marketplace listing. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + "apps/list-plans-stubbed": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["marketplace-listing-plan"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + }; + }; + /** + * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + "apps/list-accounts-for-plan-stubbed": { + parameters: { + path: { + /** plan_id parameter */ + plan_id: components["parameters"]["plan_id"]; + }; + query: { + /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ + sort?: components["parameters"]["sort"]; + /** To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. */ + direction?: "asc" | "desc"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["marketplace-purchase"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + }; + }; + /** + * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)." + * + * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. + */ + "meta/get": { + parameters: {}; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["api-overview"]; + }; + }; + 304: components["responses"]["not_modified"]; + }; + }; + "activity/list-public-events-for-repo-network": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["event"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** List all notifications for the current user, sorted by most recently updated. */ + "activity/list-notifications-for-authenticated-user": { + parameters: { + query: { + /** If `true`, show notifications marked as read. */ + all?: components["parameters"]["all"]; + /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ + participating?: components["parameters"]["participating"]; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + before?: components["parameters"]["before"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["thread"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). 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`. */ + "activity/mark-notifications-as-read": { + parameters: {}; + responses: { + /** Response */ + 202: { + content: { + "application/json": { + message?: string; + } & { + [key: string]: any; + }; + }; + }; + /** Reset Content */ + 205: unknown; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + requestBody: { + content: { + "application/json": { + /** Describes the last point that notifications were checked. */ + last_read_at?: string; + /** Whether the notification has been read. */ + read?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + "activity/get-thread": { + parameters: { + path: { + /** thread_id parameter */ + thread_id: components["parameters"]["thread_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["thread"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "activity/mark-thread-as-read": { + parameters: { + path: { + /** thread_id parameter */ + thread_id: components["parameters"]["thread_id"]; + }; + }; + responses: { + /** Reset Content */ + 205: unknown; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** + * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). + * + * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + */ + "activity/get-thread-subscription-for-authenticated-user": { + parameters: { + path: { + /** thread_id parameter */ + thread_id: components["parameters"]["thread_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["thread-subscription"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** + * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. + * + * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. + * + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. + */ + "activity/set-thread-subscription": { + parameters: { + path: { + /** thread_id parameter */ + thread_id: components["parameters"]["thread_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["thread-subscription"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + requestBody: { + content: { + "application/json": { + /** Whether to block all notifications from a thread. */ + ignored?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ + "activity/delete-thread-subscription": { + parameters: { + path: { + /** thread_id parameter */ + thread_id: components["parameters"]["thread_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** Get the octocat as ASCII art */ + "meta/get-octocat": { + parameters: { + query: { + /** The words to show in Octocat's speech bubble */ + s?: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/octocat-stream": string; + }; + }; + }; + }; + /** + * Lists all organizations, in the order that they were created on GitHub. + * + * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. + */ + "orgs/list": { + parameters: { + query: { + /** An organization ID. Only return organizations with an ID greater than this ID. */ + since?: components["parameters"]["since-org"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: { + Link?: string; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + 304: components["responses"]["not_modified"]; + }; + }; + /** + * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * + * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + */ + "orgs/get": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-full"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * + * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. + */ + "orgs/update": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-full"]; + }; + }; + 409: components["responses"]["conflict"]; + 415: components["responses"]["preview_header_missing"]; + /** Validation failed */ + 422: { + content: { + "application/json": (components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"]) & { + [key: string]: any; + }; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** Billing email address. This address is not publicized. */ + billing_email?: string; + /** The company name. */ + company?: string; + /** The publicly visible email address. */ + email?: string; + /** The Twitter username of the company. */ + twitter_username?: string; + /** The location. */ + location?: string; + /** The shorthand name of the company. */ + name?: string; + /** The description of the company. */ + description?: string; + /** Toggles whether an organization can use organization projects. */ + has_organization_projects?: boolean; + /** Toggles whether repositories that belong to the organization can use repository projects. */ + has_repository_projects?: boolean; + /** + * Default permission level members have for organization repositories: + * \* `read` - can pull, but not push to or administer this repository. + * \* `write` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push, and administer this repository. + * \* `none` - no permissions granted by default. + */ + default_repository_permission?: "read" | "write" | "admin" | "none"; + /** + * Toggles the ability of non-admin organization members to create repositories. Can be one of: + * \* `true` - all organization members can create repositories. + * \* `false` - only organization owners can create repositories. + * Default: `true` + * **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. + */ + members_can_create_repositories?: boolean; + /** + * Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: + * \* `true` - all organization members can create internal repositories. + * \* `false` - only organization owners can create internal repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_internal_repositories?: boolean; + /** + * Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: + * \* `true` - all organization members can create private repositories. + * \* `false` - only organization owners can create private repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_private_repositories?: boolean; + /** + * Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: + * \* `true` - all organization members can create public repositories. + * \* `false` - only organization owners can create public repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_public_repositories?: boolean; + /** + * Specifies which types of repositories non-admin organization members can create. Can be one of: + * \* `all` - all organization members can create public and private repositories. + * \* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. + * \* `none` - only admin members can create repositories. + * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + */ + members_allowed_repository_creation_type?: "all" | "private" | "none"; + /** + * Toggles whether organization members can create GitHub Pages sites. Can be one of: + * \* `true` - all organization members can create GitHub Pages sites. + * \* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted. + */ + members_can_create_pages?: boolean; + /** + * Toggles whether organization members can create public GitHub Pages sites. Can be one of: + * \* `true` - all organization members can create public GitHub Pages sites. + * \* `false` - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted. + */ + members_can_create_public_pages?: boolean; + /** + * Toggles whether organization members can create private GitHub Pages sites. Can be one of: + * \* `true` - all organization members can create private GitHub Pages sites. + * \* `false` - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted. + */ + members_can_create_private_pages?: boolean; + blog?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + * + * 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. + */ + "actions/get-github-actions-permissions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-organization-permissions"]; + }; + }; + }; + }; + /** + * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + * + * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. + * + * 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. + */ + "actions/set-github-actions-permissions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + enabled_repositories: components["schemas"]["enabled-repositories"]; + allowed_actions?: components["schemas"]["allowed-actions"]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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)." + * + * 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. + */ + "actions/list-selected-repositories-enabled-github-actions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + repositories: components["schemas"]["repository"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * 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)." + * + * 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. + */ + "actions/set-selected-repositories-enabled-github-actions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + /** List of repository IDs to enable for GitHub Actions. */ + selected_repository_ids: number[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Adds a repository to 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 must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * 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. + */ + "actions/enable-selected-repository-github-actions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + repository_id: components["parameters"]["repository_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Removes a repository from 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)." + * + * 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. + */ + "actions/disable-selected-repository-github-actions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + repository_id: components["parameters"]["repository_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Gets the selected actions 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)."" + * + * 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. + */ + "actions/get-allowed-actions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + }; + }; + /** + * Sets the actions 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)." + * + * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + * + * 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. + * + * 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. + */ + "actions/set-allowed-actions-organization": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/list-self-hosted-runner-groups-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-org"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with 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)." + * + * Creates a new self-hosted runner group for an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/create-self-hosted-runner-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** Name of the runner group. */ + name: string; + /** Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`. */ + visibility?: "selected" | "all" | "private"; + /** List of repository IDs that can access the runner group. */ + selected_repository_ids?: number[]; + /** List of runner IDs to add to the runner group. */ + runners?: number[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Gets a specific self-hosted runner group for an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/get-self-hosted-runner-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Deletes a self-hosted runner group for an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/delete-self-hosted-runner-group-from-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Updates the `name` and `visibility` of a self-hosted runner group in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/update-self-hosted-runner-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** Name of the runner group. */ + name?: string; + /** Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`. */ + visibility?: "selected" | "all" | "private"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with 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)." + * + * Lists the repositories with access to a self-hosted runner group configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + repositories: components["schemas"]["repository"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + /** List of repository IDs that can access the runner group. */ + selected_repository_ids: number[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * + * Adds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` + * scope to use this endpoint. + */ + "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + repository_id: components["parameters"]["repository_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * + * Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + repository_id: components["parameters"]["repository_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Lists self-hosted runners that are in a specific organization group. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/list-self-hosted-runners-in-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * Replaces the list of self-hosted runners that are part of an organization runner group. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/set-self-hosted-runners-in-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + /** List of runner IDs to add to the runner group. */ + runners: number[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * + * Adds a self-hosted runner to a runner group configured in an organization. + * + * You must authenticate using an access token with the `admin:org` + * scope to use this endpoint. + */ + "actions/add-self-hosted-runner-to-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + /** Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + * + * + * Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/remove-self-hosted-runner-from-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner_group_id"]; + /** Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Lists all self-hosted runners configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/list-self-hosted-runners-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/list-runner-applications-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["runner-application"][]; + }; + }; + }; + }; + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` + */ + "actions/create-registration-token-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + }; + /** + * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this + * endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + "actions/create-remove-token-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + }; + /** + * Gets a specific self-hosted runner configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/get-self-hosted-runner-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["runner"]; + }; + }; + }; + }; + /** + * 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. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + "actions/delete-self-hosted-runner-from-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** 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 `secrets` organization permission to use this endpoint. */ + "actions/list-org-secrets": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["organization-actions-secret"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** 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 `secrets` organization permission to use this endpoint. */ + "actions/get-org-public-key": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + /** 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 `secrets` organization permission to use this endpoint. */ + "actions/get-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-actions-secret"]; + }; + }; + }; + }; + /** + * Creates or updates an organization secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + "actions/create-or-update-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** Response when creating a secret */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** Response when updating a secret */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + /** Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint. */ + encrypted_value?: string; + /** ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * Configures the access that repositories have to the organization secret. Can be one of: + * \- `all` - All repositories in an organization can access the secret. + * \- `private` - Private repositories in an organization can access the secret. + * \- `selected` - Only specific repositories can access the secret. + */ + visibility: "all" | "private" | "selected"; + /** An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */ + selected_repository_ids?: string[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** 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. */ + "actions/delete-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** 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 `secrets` organization permission to use this endpoint. */ + "actions/list-selected-repos-for-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** 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/actions#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 `secrets` organization permission to use this endpoint. */ + "actions/set-selected-repos-for-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + /** An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. */ + selected_repository_ids?: number[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Adds a repository to 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/actions#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 `secrets` organization permission to use this endpoint. */ + "actions/add-selected-repo-to-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + repository_id: number; + }; + }; + responses: { + /** No Content when repository was added to the selected list */ + 204: never; + /** Conflict when visibility type is not set to selected */ + 409: unknown; + }; + }; + /** 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/actions#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 `secrets` organization permission to use this endpoint. */ + "actions/remove-selected-repo-from-org-secret": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + repository_id: number; + }; + }; + responses: { + /** Response when repository was removed from the selected list */ + 204: never; + /** Conflict when visibility type not set to selected */ + 409: unknown; + }; + }; + /** + * Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + * + * To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. + */ + "orgs/get-audit-log": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ + phrase?: components["parameters"]["audit-log-phrase"]; + /** + * The event types to include: + * + * - `web` - returns web (non-Git) events + * - `git` - returns Git events + * - `all` - returns both web and Git events + * + * The default is `web`. + */ + include?: components["parameters"]["audit-log-include"]; + /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor. */ + after?: components["parameters"]["audit-log-after"]; + /** A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor. */ + before?: components["parameters"]["audit-log-before"]; + /** + * The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. + */ + order?: components["parameters"]["audit-log-order"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["audit-log-event"][]; + }; + }; + }; + }; + /** List the users blocked by an organization. */ + "orgs/list-blocked-users": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + 415: components["responses"]["preview_header_missing"]; + }; + }; + "orgs/check-blocked-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** If the user is blocked: */ + 204: never; + /** If the user is not blocked: */ + 404: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "orgs/block-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/unblock-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products). + * + * An authenticated organization owner with the `read:org` scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://help.github.com/en/articles/about-authentication-with-saml-single-sign-on). + */ + "orgs/list-saml-sso-authorizations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["credential-authorization"][]; + }; + }; + }; + }; + /** + * Listing and deleting credential authorizations is available to organizations with GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products). + * + * An authenticated organization owner with the `admin:org` scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. + */ + "orgs/remove-saml-sso-authorization": { + parameters: { + path: { + org: components["parameters"]["org"]; + credential_id: number; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + "activity/list-public-org-events": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + /** 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. */ + "orgs/list-failed-invitations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["organization-invitation"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/list-webhooks": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["org-hook"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** Here's how you can create a hook that posts payloads in JSON format: */ + "orgs/create-webhook": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["org-hook"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** Must be passed as "web". */ + name: string; + /** Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). */ + config: { + url: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + username?: string; + password?: string; + } & { + [key: string]: any; + }; + /** Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. */ + events?: string[]; + /** Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. */ + active?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." */ + "orgs/get-webhook": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["org-hook"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/delete-webhook": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." */ + "orgs/update-webhook": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["org-hook"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). */ + config?: { + url: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + } & { + [key: string]: any; + }; + /** Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. */ + events?: string[]; + /** Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. */ + active?: boolean; + name?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." + * + * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + */ + "orgs/get-webhook-config-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + /** + * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." + * + * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + */ + "orgs/update-webhook-config-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + url?: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + }; + }; + }; + /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ + "orgs/ping-webhook": { + parameters: { + path: { + org: components["parameters"]["org"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Enables an authenticated GitHub App to find the organization's installation information. + * + * 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. + */ + "apps/get-org-installation": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["installation"]; + }; + }; + }; + }; + /** Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ + "orgs/list-app-installations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + installations: components["schemas"]["installation"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ + "interactions/get-restrictions-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": (Partial & Partial<{ + [key: string]: any; + }>) & { + [key: string]: any; + }; + }; + }; + }; + }; + /** Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ + "interactions/set-restrictions-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["interaction-limit-response"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": components["schemas"]["interaction-limit"]; + }; + }; + }; + /** Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ + "interactions/remove-restrictions-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ + "orgs/list-pending-invitations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["organization-invitation"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * 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. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "orgs/create-invitation": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["organization-invitation"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ + invitee_id?: number; + /** **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ + email?: string; + /** + * Specify role for new member. Can be one of: + * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * \* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * \* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + */ + role?: "admin" | "direct_member" | "billing_manager"; + /** Specify IDs for the teams you want to invite new members to. */ + team_ids?: number[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). + */ + "orgs/cancel-invitation": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** invitation_id parameter */ + invitation_id: components["parameters"]["invitation_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ + "orgs/list-invitation-teams": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** invitation_id parameter */ + invitation_id: components["parameters"]["invitation_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["team"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * List issues in an organization assigned to the authenticated user. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + "issues/list-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + state?: "open" | "closed" | "all"; + /** A list of comma separated label names. Example: `bug,ui,@high` */ + labels?: components["parameters"]["labels"]; + /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + sort?: "created" | "updated" | "comments"; + /** One of `asc` (ascending) or `desc` (descending). */ + direction?: components["parameters"]["direction"]; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ + "orgs/list-members": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** + * Filter members returned in the list. Can be one of: + * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. + * \* `all` - All members the authenticated user can see. + */ + filter?: "2fa_disabled" | "all"; + /** + * Filter members returned by their role. Can be one of: + * \* `all` - All members of the organization, regardless of role. + * \* `admin` - Organization owners. + * \* `member` - Non-owner organization members. + */ + role?: "all" | "admin" | "member"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + /** Response if requester is not an organization member */ + 302: never; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Check if a user is, publicly or privately, a member of the organization. */ + "orgs/check-membership-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response if requester is an organization member and user is a member */ + 204: never; + /** Response if requester is not an organization member */ + 302: never; + /** Not Found if requester is an organization member and user is not a member */ + 404: unknown; + }; + }; + /** Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ + "orgs/remove-member": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + 403: components["responses"]["forbidden"]; + }; + }; + /** In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ + "orgs/get-membership-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["org-membership"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Only authenticated organization owners can add a member to the organization or update the member's role. + * + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * + * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. + * + * **Rate limits** + * + * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + */ + "orgs/set-membership-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["org-membership"]; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** + * The role to give the user in the organization. Can be one of: + * \* `admin` - The user will become an owner of the organization. + * \* `member` - The user will become a non-owner member of the organization. + */ + role?: "admin" | "member"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. + * + * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + */ + "orgs/remove-membership-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Lists the most recent migrations. */ + "migrations/list-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Exclude attributes from the API response to improve performance */ + exclude?: "repositories"[]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["migration"][]; + }; + }; + }; + }; + /** Initiates the generation of a migration archive. */ + "migrations/start-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["migration"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** A list of arrays indicating which repositories should be migrated. */ + repositories: string[]; + /** Indicates whether repositories should be locked (to prevent manipulation) while migrating data. */ + lock_repositories?: boolean; + /** Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). */ + exclude_attachments?: boolean; + exclude?: "repositories"[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Fetches the status of a migration. + * + * The `state` of a migration can be one of the following values: + * + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. + */ + "migrations/get-status-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** migration_id parameter */ + migration_id: components["parameters"]["migration_id"]; + }; + query: { + /** Exclude attributes from the API response to improve performance */ + exclude?: "repositories"[]; + }; + }; + responses: { + /** + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. + */ + 200: { + content: { + "application/json": components["schemas"]["migration"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** Fetches the URL to a migration archive. */ + "migrations/download-archive-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** migration_id parameter */ + migration_id: components["parameters"]["migration_id"]; + }; + }; + responses: { + /** Response */ + 302: never; + 404: components["responses"]["not_found"]; + }; + }; + /** Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ + "migrations/delete-archive-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** migration_id parameter */ + migration_id: components["parameters"]["migration_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ + "migrations/unlock-repo-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** migration_id parameter */ + migration_id: components["parameters"]["migration_id"]; + /** repo_name parameter */ + repo_name: components["parameters"]["repo_name"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** List all the repositories for this organization migration. */ + "migrations/list-repos-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** migration_id parameter */ + migration_id: components["parameters"]["migration_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** List all users who are outside collaborators of an organization. */ + "orgs/list-outside-collaborators": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** + * Filter the list of outside collaborators. Can be one of: + * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. + * \* `all`: All outside collaborators. + */ + filter?: "2fa_disabled" | "all"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + /** 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://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". */ + "orgs/convert-member-to-outside-collaborator": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** User is getting converted asynchronously */ + 202: { + content: { + "application/json": { + [key: string]: any; + }; + }; + }; + /** User was converted */ + 204: never; + /** Forbidden if user is the last owner of the organization or not a member of the organization */ + 403: unknown; + 404: components["responses"]["not_found"]; + }; + }; + /** Removing a user from this list will remove them from all the organization's repositories. */ + "orgs/remove-outside-collaborator": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + /** Unprocessable Entity if user is a member of the organization */ + 422: { + content: { + "application/json": { + message?: string; + documentation_url?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Gets a specific package in an organization. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/get-package-for-organization": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["package"]; + }; + }; + }; + }; + /** + * 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. + */ + "packages/delete-package-for-org": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 204: never; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Restores an entire package in an organization. + * + * You can restore a deleted package under the following conditions: + * - The package was deleted within the last 30 days. + * - 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scope. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. + */ + "packages/restore-package-for-org": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + org: components["parameters"]["org"]; + }; + query: { + /** package token */ + token?: string; + }; + }; + responses: { + /** Response */ + 204: never; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Returns all package versions for a package owned by an organization. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/get-all-package-versions-for-package-owned-by-org": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + org: components["parameters"]["org"]; + }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** The state of the package, either active or deleted. */ + state?: "active" | "deleted"; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["package-version"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Gets a specific package version in an organization. + * + * You must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/get-package-version-for-organization": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + org: components["parameters"]["org"]; + /** Unique identifier of the package version. */ + package_version_id: components["parameters"]["package_version_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["package-version"]; + }; + }; + }; + }; + /** + * 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. + */ + "packages/delete-package-version-for-org": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + org: components["parameters"]["org"]; + /** Unique identifier of the package version. */ + package_version_id: components["parameters"]["package_version_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Restores a specific package version in an organization. + * + * You can restore a deleted package under the following conditions: + * - The package was deleted within the last 30 days. + * - 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scope. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. + */ + "packages/restore-package-version-for-org": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + org: components["parameters"]["org"]; + /** Unique identifier of the package version. */ + package_version_id: components["parameters"]["package_version_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ + "projects/list-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + state?: "open" | "closed" | "all"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["project"][]; + }; + }; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + /** Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ + "projects/create-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["project"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** The name of the project. */ + name: string; + /** The description of the project. */ + body?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Members of an organization can choose to have their membership publicized or not. */ + "orgs/list-public-members": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "orgs/check-public-membership-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response if user is a public member */ + 204: never; + /** Not Found if user is not a public member */ + 404: unknown; + }; + }; + /** + * The user can publicize their own membership. (A user cannot publicize the membership for another user.) + * + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + "orgs/set-public-membership-for-authenticated-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + 403: components["responses"]["forbidden"]; + }; + }; + "orgs/remove-public-membership-for-authenticated-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** Lists repositories for the specified organization. */ + "repos/list-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token. */ + type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal"; + /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` */ + direction?: "asc" | "desc"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + /** + * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. + * * `repo` scope to create a private repository + */ + "repos/create-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["repository"]; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The name of the repository. */ + name: string; + /** A short description of the repository. */ + description?: string; + /** A URL with more information about the repository. */ + homepage?: string; + /** Whether the repository is private. */ + private?: boolean; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; + /** Either `true` to enable issues for this repository or `false` to disable them. */ + has_issues?: boolean; + /** Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. */ + has_projects?: boolean; + /** Either `true` to enable the wiki for this repository or `false` to disable it. */ + has_wiki?: boolean; + /** Either `true` to make this repo available as a template repository or `false` to prevent it. */ + is_template?: boolean; + /** The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ + team_id?: number; + /** Pass `true` to create an initial commit with empty README. */ + auto_init?: boolean; + /** Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ + gitignore_template?: string; + /** Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ + license_template?: string; + /** Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. */ + allow_squash_merge?: boolean; + /** Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. */ + allow_merge_commit?: boolean; + /** Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. */ + allow_rebase_merge?: boolean; + /** Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ + delete_branch_on_merge?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + "billing/get-github-actions-billing-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-billing-usage"]; + }; + }; + }; + }; + /** + * Gets the free and paid storage usued for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + "billing/get-github-packages-billing-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["packages-billing-usage"]; + }; + }; + }; + }; + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + "billing/get-shared-storage-billing-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["combined-billing-usage"]; + }; + }; + }; + }; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * List IdP groups available in an organization. You can limit your page results using the `per_page` parameter. GitHub generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." + * + * The `per_page` parameter provides pagination for a list of IdP groups the authenticated user can access in an organization. For example, if the user `octocat` wants to see two groups per page in `octo-org` via cURL, it would look like this: + */ + "teams/list-idp-groups-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page token */ + page?: string; + }; + }; + responses: { + /** Response */ + 200: { + headers: { + Link?: string; + }; + content: { + "application/json": components["schemas"]["group-mapping"]; + }; + }; + }; + }; + /** Lists all teams in an organization that are visible to the authenticated user. */ + "teams/list": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["team"][]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + /** + * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." + * + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". + */ + "teams/create": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["team-full"]; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The name of the team. */ + name: string; + /** The description of the team. */ + description?: string; + /** List GitHub IDs for organization members who will become team maintainers. */ + maintainers?: string[]; + /** The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ + repo_names?: string[]; + /** + * The level of privacy this team should have. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + * Default for child team: `closed` + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** The ID of a team to set as the parent team. */ + parent_team_id?: number; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + */ + "teams/get-by-name": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-full"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * To delete a team, the authenticated user must be an organization owner or team maintainer. + * + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + */ + "teams/delete-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + */ + "teams/update-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["team-full"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The name of the team. */ + name?: string; + /** The description of the team. */ + description?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** The ID of a team to set as the parent team. */ + parent_team_id?: number | null; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + */ + "teams/list-discussions-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + }; + query: { + /** One of `asc` (ascending) or `desc` (descending). */ + direction?: components["parameters"]["direction"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Pinned discussions only filter */ + pinned?: string; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["team-discussion"][]; + }; + }; + }; + }; + /** + * 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/). + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + */ + "teams/create-discussion-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The discussion post's title. */ + title: string; + /** The discussion post's body text. */ + body: string; + /** Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ + private?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + "teams/get-discussion-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + }; + /** + * Delete a discussion from 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/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + "teams/delete-discussion-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + "teams/update-discussion-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The discussion post's title. */ + title?: string; + /** The discussion post's body text. */ + body?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + */ + "teams/list-discussion-comments-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + query: { + /** One of `asc` (ascending) or `desc` (descending). */ + direction?: components["parameters"]["direction"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["team-discussion-comment"][]; + }; + }; + }; + }; + /** + * 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/). + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + */ + "teams/create-discussion-comment-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The discussion comment's body text. */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + "teams/get-discussion-comment-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + }; + /** + * Deletes a 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/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + "teams/delete-discussion-comment-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + "teams/update-discussion-comment-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The discussion comment's body text. */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + */ + "reactions/list-for-team-discussion-comment-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + query: { + /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["reaction"][]; + }; + }; + }; + }; + /** + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + */ + "reactions/create-for-team-discussion-comment-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "reactions/delete-for-team-discussion-comment": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + */ + "reactions/list-for-team-discussion-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + query: { + /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["reaction"][]; + }; + }; + }; + }; + /** + * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + */ + "reactions/create-for-team-discussion-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * + * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "reactions/delete-for-team-discussion": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + discussion_number: components["parameters"]["discussion-number"]; + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + */ + "teams/list-pending-invitations-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["organization-invitation"][]; + }; + }; + }; + }; + /** + * Team members will include the members of child teams. + * + * To list members in a team, the team must be visible to the authenticated user. + */ + "teams/list-members-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + }; + query: { + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + /** + * Team members will include the members of child teams. + * + * To get a user's membership with a team, the team must be visible to the authenticated user. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * + * **Note:** + * The response contains the `state` of the membership and the member's `role`. + * + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). + */ + "teams/get-membership-for-user-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-membership"]; + }; + }; + /** if user has no team membership */ + 404: unknown; + }; + }; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. + * + * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + */ + "teams/add-or-update-membership-for-user-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-membership"]; + }; + }; + /** Forbidden if team synchronization is set up */ + 403: unknown; + /** Unprocessable Entity if you attempt to add an organization to a team */ + 422: unknown; + }; + requestBody: { + content: { + "application/json": { + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + */ + "teams/remove-membership-for-user-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + /** Forbidden if team synchronization is set up */ + 403: unknown; + }; + }; + /** + * Lists the organization projects for a team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + */ + "teams/list-projects-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["team-project"][]; + }; + }; + }; + }; + /** + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + "teams/check-permissions-for-project-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-project"]; + }; + }; + /** Not Found if project is not managed by this team */ + 404: unknown; + }; + }; + /** + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + "teams/add-or-update-project-permissions-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + /** Forbidden if the project is not owned by the organization */ + 403: { + content: { + "application/json": { + message?: string; + documentation_url?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + requestBody: { + content: { + "application/json": ({ + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + permission?: "read" | "write" | "admin"; + } & { + [key: string]: any; + }) | null; + }; + }; + }; + /** + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + "teams/remove-project-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Lists a team's repositories visible to the authenticated user. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + */ + "teams/list-repos-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + /** + * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. + * + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * + * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + */ + "teams/check-permissions-for-repo-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Alternative response with repository permissions */ + 200: { + content: { + "application/json": components["schemas"]["team-repository"]; + }; + }; + /** Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ + 204: never; + /** Not Found if team does not have permission for the repository */ + 404: unknown; + }; + }; + /** + * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * + * For more information about the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + */ + "teams/add-or-update-repo-permissions-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * \* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. + * \* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + */ + permission?: "pull" | "push" | "admin" | "maintain" | "triage"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + */ + "teams/remove-repo-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * List IdP groups connected to a team on GitHub. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. + */ + "teams/list-idp-groups-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["group-mapping"]; + }; + }; + }; + }; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. + */ + "teams/create-or-update-idp-group-connections-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["group-mapping"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ + groups?: ({ + /** ID of the IdP group. */ + group_id: string; + /** Name of the IdP group. */ + group_name: string; + /** Description of the IdP group. */ + group_description: string; + } & { + [key: string]: any; + })[]; + }; + }; + }; + }; + /** + * Lists the child teams of the team specified by `{team_slug}`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + */ + "teams/list-child-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** team_slug parameter */ + team_slug: components["parameters"]["team_slug"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** if child teams exist */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["team"][]; + }; + }; + }; + }; + "projects/get-card": { + parameters: { + path: { + /** card_id parameter */ + card_id: components["parameters"]["card_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["project-card"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "projects/delete-card": { + parameters: { + path: { + /** card_id parameter */ + card_id: components["parameters"]["card_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + /** Forbidden */ + 403: { + content: { + "application/json": { + message?: string; + documentation_url?: string; + errors?: string[]; + } & { + [key: string]: any; + }; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "projects/update-card": { + parameters: { + path: { + /** card_id parameter */ + card_id: components["parameters"]["card_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["project-card"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** The project card's note */ + note?: string | null; + /** Whether or not the card is archived */ + archived?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + "projects/move-card": { + parameters: { + path: { + /** card_id parameter */ + card_id: components["parameters"]["card_id"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + /** Forbidden */ + 403: { + content: { + "application/json": { + message?: string; + documentation_url?: string; + errors?: ({ + code?: string; + message?: string; + resource?: string; + field?: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + 422: components["responses"]["validation_failed"]; + /** Response */ + 503: { + content: { + "application/json": { + code?: string; + message?: string; + documentation_url?: string; + errors?: ({ + code?: string; + message?: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The position of the card in a column */ + position: string; + /** The unique identifier of the column the card should be moved to */ + column_id?: number; + } & { + [key: string]: any; + }; + }; + }; + }; + "projects/get-column": { + parameters: { + path: { + /** column_id parameter */ + column_id: components["parameters"]["column_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["project-column"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "projects/delete-column": { + parameters: { + path: { + /** column_id parameter */ + column_id: components["parameters"]["column_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/update-column": { + parameters: { + path: { + /** column_id parameter */ + column_id: components["parameters"]["column_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["project-column"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + requestBody: { + content: { + "application/json": { + /** Name of the project column */ + name: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "projects/list-cards": { + parameters: { + path: { + /** column_id parameter */ + column_id: components["parameters"]["column_id"]; + }; + query: { + /** Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. */ + archived_state?: "all" | "archived" | "not_archived"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["project-card"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/create-card": { + parameters: { + path: { + /** column_id parameter */ + column_id: components["parameters"]["column_id"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["project-card"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + /** Validation failed */ + 422: { + content: { + "application/json": (components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"]) & { + [key: string]: any; + }; + }; + }; + /** Response */ + 503: { + content: { + "application/json": { + code?: string; + message?: string; + documentation_url?: string; + errors?: ({ + code?: string; + message?: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + requestBody: { + content: { + "application/json": (({ + /** The project card's note */ + note: string | null; + } & { + [key: string]: any; + }) | ({ + /** The unique identifier of the content associated with the card */ + content_id: number; + /** The piece of content associated with the card */ + content_type: string; + } & { + [key: string]: any; + })) & { + [key: string]: any; + }; + }; + }; + }; + "projects/move-column": { + parameters: { + path: { + /** column_id parameter */ + column_id: components["parameters"]["column_id"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** The position of the column in a project */ + position: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ + "projects/get": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["project"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ + "projects/delete": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** Delete Success */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + /** Forbidden */ + 403: { + content: { + "application/json": { + message?: string; + documentation_url?: string; + errors?: string[]; + } & { + [key: string]: any; + }; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + /** Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ + "projects/update": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["project"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + /** Forbidden */ + 403: { + content: { + "application/json": { + message?: string; + documentation_url?: string; + errors?: string[]; + } & { + [key: string]: any; + }; + }; + }; + /** Not Found if the authenticated user does not have access to the project */ + 404: unknown; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** Name of the project */ + name?: string; + /** Body of the project */ + body?: string | null; + /** State of the project; either 'open' or 'closed' */ + state?: string; + /** The baseline permission that all organization members have on this project */ + organization_permission?: "read" | "write" | "admin" | "none"; + /** Whether or not this project can be seen by everyone. */ + private?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ + "projects/list-collaborators": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + }; + query: { + /** + * Filters the collaborators by their affiliation. Can be one of: + * \* `outside`: Outside collaborators of a project that are not a member of the project's organization. + * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ + "projects/add-collaborator": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** The permission to grant the collaborator. */ + permission?: "read" | "write" | "admin"; + } & { + [key: string]: any; + }) | null; + }; + }; + }; + /** Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ + "projects/remove-collaborator": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ + "projects/get-permission-for-user": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-collaborator-permission"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/list-columns": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["project-column"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/create-column": { + parameters: { + path: { + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["project-column"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** Name of the project column */ + name: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Note:** Accessing this endpoint does not count against your REST API rate limit. + * + * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + */ + "rate-limit/get": { + parameters: {}; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["rate-limit-overview"]; + }; + }; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). + * + * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). + */ + "reactions/delete-legacy": { + parameters: { + path: { + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 410: components["responses"]["gone"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** + * When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file. + * + * 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. + */ + "repos/get": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["full-repository"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + * + * If an organization owner has configured the organization to prevent members from deleting organization-owned + * repositories, you will get a `403 Forbidden` response. + */ + "repos/delete": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + 307: components["responses"]["temporary_redirect"]; + /** If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ + 403: { + content: { + "application/json": { + message?: string; + documentation_url?: string; + } & { + [key: string]: any; + }; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. */ + "repos/update": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["full-repository"]; + }; + }; + 307: components["responses"]["temporary_redirect"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The name of the repository. */ + name?: string; + /** A short description of the repository. */ + description?: string; + /** A URL with more information about the repository. */ + homepage?: string; + /** + * Either `true` to make the repository private or `false` to make it public. Default: `false`. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + */ + private?: boolean; + /** Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header. */ + visibility?: "public" | "private" | "visibility" | "internal"; + /** Either `true` to enable issues for this repository or `false` to disable them. */ + has_issues?: boolean; + /** Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. */ + has_projects?: boolean; + /** Either `true` to enable the wiki for this repository or `false` to disable it. */ + has_wiki?: boolean; + /** Either `true` to make this repo available as a template repository or `false` to prevent it. */ + is_template?: boolean; + /** Updates the default branch for this repository. */ + default_branch?: string; + /** Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. */ + allow_squash_merge?: boolean; + /** Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. */ + allow_merge_commit?: boolean; + /** Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. */ + allow_rebase_merge?: boolean; + /** Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. */ + delete_branch_on_merge?: boolean; + /** `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. */ + archived?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists all artifacts for 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. */ + "actions/list-artifacts-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + artifacts: components["schemas"]["artifact"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** Gets a specific artifact 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. */ + "actions/get-artifact": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** artifact_id parameter */ + artifact_id: components["parameters"]["artifact_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["artifact"]; + }; + }; + }; + }; + /** Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ + "actions/delete-artifact": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** artifact_id parameter */ + artifact_id: components["parameters"]["artifact_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in + * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to + * the repository can use this endpoint. 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. + */ + "actions/download-artifact": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** artifact_id parameter */ + artifact_id: components["parameters"]["artifact_id"]; + archive_format: string; + }; + }; + responses: { + /** Response */ + 302: never; + }; + }; + /** Gets a specific job in 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. */ + "actions/get-job-for-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** job_id parameter */ + job_id: components["parameters"]["job_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["job"]; + }; + }; + }; + }; + /** + * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look + * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can + * use this endpoint. 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. + */ + "actions/download-job-logs-for-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** job_id parameter */ + job_id: components["parameters"]["job_id"]; + }; + }; + responses: { + /** Response */ + 302: never; + }; + }; + /** + * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. + * + * 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. + */ + "actions/get-github-actions-permissions-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-repository-permissions"]; + }; + }; + }; + }; + /** + * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. + * + * 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, then you cannot override them for the repository. + * + * 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. + */ + "actions/set-github-actions-permissions-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + enabled: components["schemas"]["actions-enabled"]; + allowed_actions?: components["schemas"]["allowed-actions"]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository 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)." + * + * 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. + */ + "actions/get-allowed-actions-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + }; + }; + /** + * Sets the actions 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)." + * + * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + * + * 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. + * + * 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. + */ + "actions/set-allowed-actions-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + }; + /** Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. */ + "actions/list-self-hosted-runners-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + */ + "actions/list-runner-applications-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["runner-application"][]; + }; + }; + }; + }; + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate + * using an access token with the `repo` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN + * ``` + */ + "actions/create-registration-token-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + }; + /** + * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + "actions/create-remove-token-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["authentication-token"]; + }; + }; + }; + }; + /** + * Gets a specific self-hosted runner configured in a repository. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. + */ + "actions/get-self-hosted-runner-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["runner"]; + }; + }; + }; + }; + /** + * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + * + * You must authenticate using an access token with the `repo` + * scope to use this endpoint. + */ + "actions/delete-self-hosted-runner-from-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** Unique identifier of the self-hosted runner. */ + runner_id: components["parameters"]["runner_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * + * 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. + */ + "actions/list-workflow-runs-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ + actor?: components["parameters"]["actor"]; + /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ + branch?: components["parameters"]["workflow-run-branch"]; + /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ + event?: components["parameters"]["event"]; + /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ + status?: components["parameters"]["workflow-run-status"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + workflow_runs: components["schemas"]["workflow-run"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** Gets a specific 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. */ + "actions/get-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["workflow-run"]; + }; + }; + }; + }; + /** + * Delete a specific workflow run. Anyone with write 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:write` permission to use + * this endpoint. + */ + "actions/delete-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** 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. */ + "actions/get-reviews-for-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["environment-approvals"][]; + }; + }; + }; + }; + /** + * **Note:** This endpoint is currently in beta and is subject to change. + * + * 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)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + "actions/approve-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Lists artifacts 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. */ + "actions/list-workflow-run-artifacts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + artifacts: components["schemas"]["artifact"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ + "actions/cancel-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** Response */ + 202: { + content: { + "application/json": { + [key: string]: any; + }; + }; + }; + }; + }; + /** 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). */ + "actions/list-jobs-for-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + query: { + /** + * Filters jobs by their `completed_at` timestamp. Can be one of: + * \* `latest`: Returns jobs from the most recent execution of the workflow run. + * \* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run. + */ + filter?: "latest" | "all"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + jobs: components["schemas"]["job"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for + * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use + * this endpoint. 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. + */ + "actions/download-workflow-run-logs": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** Response */ + 302: never; + }; + }; + /** Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ + "actions/delete-workflow-run-logs": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Get all deployment environments for a workflow run that are waiting for protection rules to pass. + * + * 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. + */ + "actions/get-pending-deployments-for-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["pending-deployment"][]; + }; + }; + }; + }; + /** + * Approve or reject pending deployments that are waiting on approval by a required reviewer. + * + * Anyone with read access to the repository contents and deployments can use this endpoint. + */ + "actions/review-pending-deployments-for-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["deployment"][]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The list of environment ids to approve or reject */ + environment_ids: number[]; + /** Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected` */ + state: "approved" | "rejected"; + /** A comment to accompany the deployment review */ + comment: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ + "actions/re-run-workflow": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * 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. + */ + "actions/get-workflow-run-usage": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The id of the workflow run. */ + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["workflow-run-usage"]; + }; + }; + }; + }; + /** 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. */ + "actions/list-repo-secrets": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** 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 `secrets` repository permission to use this endpoint. */ + "actions/get-repo-public-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + /** 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. */ + "actions/get-repo-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + /** + * Creates or updates a repository secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + "actions/create-or-update-repo-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** Response when creating a secret */ + 201: { + content: { + "application/json": { + [key: string]: any; + }; + }; + }; + /** Response when updating a secret */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + /** Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint. */ + encrypted_value?: string; + /** ID of the key you used to encrypt the secret. */ + key_id?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** 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. */ + "actions/delete-repo-secret": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** 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. */ + "actions/list-repo-workflows": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + workflows: components["schemas"]["workflow"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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. */ + "actions/get-workflow": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The ID of the workflow. You can also pass the workflow file name as a string. */ + workflow_id: components["parameters"]["workflow-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["workflow"]; + }; + }; + }; + }; + /** + * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + "actions/disable-workflow": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The ID of the workflow. You can also pass the workflow file name as a string. */ + workflow_id: components["parameters"]["workflow-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * 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`. + * + * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + */ + "actions/create-workflow-dispatch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The ID of the workflow. You can also pass the workflow file name as a string. */ + workflow_id: components["parameters"]["workflow-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + /** The git reference for the workflow. The reference can be a branch or tag name. */ + ref: string; + /** Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ + inputs?: { + [key: string]: string; + }; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + "actions/enable-workflow": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The ID of the workflow. You can also pass the workflow file name as a string. */ + workflow_id: components["parameters"]["workflow-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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). + * + * 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. + */ + "actions/list-workflow-runs": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The ID of the workflow. You can also pass the workflow file name as a string. */ + workflow_id: components["parameters"]["workflow-id"]; + }; + query: { + /** Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ + actor?: components["parameters"]["actor"]; + /** Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ + branch?: components["parameters"]["workflow-run-branch"]; + /** Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ + event?: components["parameters"]["event"]; + /** Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see "[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." */ + status?: components["parameters"]["workflow-run-status"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + workflow_runs: components["schemas"]["workflow-run"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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. + */ + "actions/get-workflow-usage": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The ID of the workflow. You can also pass the workflow file name as a string. */ + workflow_id: components["parameters"]["workflow-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["workflow-usage"]; + }; + }; + }; + }; + /** Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ + "issues/list-assignees": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Checks if a user has permission to be assigned to an issue in this repository. + * + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + * + * Otherwise a `404` status code is returned. + */ + "issues/check-user-can-be-assigned": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + assignee: string; + }; + }; + responses: { + /** If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ + 204: never; + /** Otherwise a `404` status code is returned. */ + 404: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + /** 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://help.github.com/en/articles/configuring-automated-security-fixes)". */ + "repos/enable-automated-security-fixes": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** 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://help.github.com/en/articles/configuring-automated-security-fixes)". */ + "repos/disable-automated-security-fixes": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + "repos/list-branches": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ + protected?: boolean; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["short-branch"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "repos/get-branch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["branch-with-protection"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + "repos/get-branch-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["branch-protection"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Protecting a branch requires admin or owner permissions to the repository. + * + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * + * **Note**: The list of users, apps, and teams in total is limited to 100 items. + */ + "repos/update-branch-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["protected-branch"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** Require status checks to pass before merging. Set to `null` to disable. */ + required_status_checks: ({ + /** Require branches to be up to date before merging. */ + strict: boolean; + /** The list of status checks to require in order to merge into this branch */ + contexts: string[]; + } & { + [key: string]: any; + }) | null; + /** Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ + enforce_admins: boolean | null; + /** Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ + required_pull_request_reviews: ({ + /** Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ + dismissal_restrictions?: { + /** The list of user `login`s with dismissal access */ + users?: string[]; + /** The list of team `slug`s with dismissal access */ + teams?: string[]; + } & { + [key: string]: any; + }; + /** Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ + dismiss_stale_reviews?: boolean; + /** Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them. */ + require_code_owner_reviews?: boolean; + /** Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6. */ + required_approving_review_count?: number; + } & { + [key: string]: any; + }) | null; + /** Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ + restrictions: ({ + /** The list of user `login`s with push access */ + users: string[]; + /** The list of team `slug`s with push access */ + teams: string[]; + /** The list of app `slug`s with push access */ + apps?: string[]; + } & { + [key: string]: any; + }) | null; + /** Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ + required_linear_history?: boolean; + /** Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ + allow_force_pushes?: boolean | null; + /** Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ + allow_deletions?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + "repos/delete-branch-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 204: never; + 403: components["responses"]["forbidden"]; + }; + }; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + "repos/get-admin-branch-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["protected-branch-admin-enforced"]; + }; + }; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + */ + "repos/set-admin-branch-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["protected-branch-admin-enforced"]; + }; + }; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + */ + "repos/delete-admin-branch-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + "repos/get-pull-request-review-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["protected-branch-pull-request-review"]; + }; + }; + }; + }; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + "repos/delete-pull-request-review-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + */ + "repos/update-pull-request-review-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["protected-branch-pull-request-review"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ + dismissal_restrictions?: { + /** The list of user `login`s with dismissal access */ + users?: string[]; + /** The list of team `slug`s with dismissal access */ + teams?: string[]; + } & { + [key: string]: any; + }; + /** Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ + dismiss_stale_reviews?: boolean; + /** Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed. */ + require_code_owner_reviews?: boolean; + /** Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6. */ + required_approving_review_count?: number; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help. + * + * **Note**: You must enable branch protection to require signed commits. + */ + "repos/get-commit-signature-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["protected-branch-admin-enforced"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. + */ + "repos/create-commit-signature-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["protected-branch-admin-enforced"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. + */ + "repos/delete-commit-signature-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + "repos/get-status-checks-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["status-check-policy"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + "repos/remove-status-check-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + */ + "repos/update-status-check-protection": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["status-check-policy"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** Require branches to be up to date before merging. */ + strict?: boolean; + /** The list of status checks to require in order to merge into this branch */ + contexts?: string[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + "repos/get-all-status-check-contexts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": string[]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + "repos/set-status-check-contexts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": string[]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** contexts parameter */ + contexts: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + "repos/add-status-check-contexts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": string[]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** contexts parameter */ + contexts: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + "repos/remove-status-check-contexts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": string[]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** contexts parameter */ + contexts: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists who has access to this protected branch. + * + * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + */ + "repos/get-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["branch-restriction-policy"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Disables the ability to restrict who can push to this branch. + */ + "repos/delete-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + */ + "repos/get-apps-with-access-to-protected-branch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["integration"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `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. | + */ + "repos/set-app-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["integration"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** apps parameter */ + apps: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `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. | + */ + "repos/add-app-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["integration"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** apps parameter */ + apps: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `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. | + */ + "repos/remove-app-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["integration"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** apps parameter */ + apps: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the teams who have push access to this branch. The list includes child teams. + */ + "repos/get-teams-with-access-to-protected-branch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. + * + * | Type | Description | + * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | + * | `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. | + */ + "repos/set-team-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** teams parameter */ + teams: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified teams push access for this branch. You can also give push access to child teams. + * + * | Type | Description | + * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | + * | `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. | + */ + "repos/add-team-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** teams parameter */ + teams: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of a team to push to this branch. You can also remove push access for child teams. + * + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `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. | + */ + "repos/remove-team-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** teams parameter */ + teams: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the people who have push access to this branch. + */ + "repos/get-users-with-access-to-protected-branch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. + * + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + "repos/set-user-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** users parameter */ + users: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified people push access for this branch. + * + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + "repos/add-user-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** users parameter */ + users: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of a user to push to this branch. + * + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + "repos/remove-user-access-restrictions": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** users parameter */ + users: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** + * Renames a branch in a repository. + * + * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + * + * The permissions required to use this endpoint depends on whether you are renaming the default branch. + * + * To rename a non-default branch: + * + * * Users must have push access. + * * GitHub Apps must have the `contents:write` repository permission. + * + * To rename the default branch: + * + * * Users must have admin or owner permissions. + * * GitHub Apps must have the `administration:write` repository permission. + */ + "repos/rename-branch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the branch. */ + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["branch-with-protection"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The new name of the branch. */ + new_name: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * + * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + */ + "checks/create": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["check-run"]; + }; + }; + }; + requestBody: { + content: { + "application/json": (({ + status: "completed"; + } & { + [key: string]: any; + }) | ({ + status?: "queued" | "in_progress"; + } & { + [key: string]: any; + })) & { + /** The name of the check. For example, "code-coverage". */ + name: string; + /** The SHA of the commit. */ + head_sha: string; + /** The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. */ + details_url?: string; + /** A reference for the run on the integrator's system. */ + external_id?: string; + /** The current status. Can be one of `queued`, `in_progress`, or `completed`. */ + status?: "queued" | "in_progress" | "completed"; + /** The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + started_at?: string; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + */ + conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; + /** The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + completed_at?: string; + /** Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object) description. */ + output?: { + /** The title of the check run. */ + title: string; + /** The summary of the check run. This parameter supports Markdown. */ + summary: string; + /** The details of the check run. This parameter supports Markdown. */ + text?: string; + /** Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see "[About status checks](https://help.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object) description for details about how to use this parameter. */ + annotations?: ({ + /** The path of the file to add an annotation to. For example, `assets/css/main.css`. */ + path: string; + /** The start line of the annotation. */ + start_line: number; + /** The end line of the annotation. */ + end_line: number; + /** The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ + start_column?: number; + /** The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ + end_column?: number; + /** The level of the annotation. Can be one of `notice`, `warning`, or `failure`. */ + annotation_level: "notice" | "warning" | "failure"; + /** A short description of the feedback for these lines of code. The maximum size is 64 KB. */ + message: string; + /** The title that represents the annotation. The maximum size is 255 characters. */ + title?: string; + /** Details about this annotation. The maximum size is 64 KB. */ + raw_details?: string; + } & { + [key: string]: any; + })[]; + /** Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#images-object) description for details. */ + images?: ({ + /** The alternative text for the image. */ + alt: string; + /** The full URL of the image. */ + image_url: string; + /** A short image description. */ + caption?: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + /** Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ + actions?: ({ + /** The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ + label: string; + /** A short explanation of what this action would do. The maximum size is 40 characters. */ + description: string; + /** A reference for the action on the integrator's system. The maximum size is 20 characters. */ + identifier: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + "checks/get": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** check_run_id parameter */ + check_run_id: components["parameters"]["check_run_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["check-run"]; + }; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + */ + "checks/update": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** check_run_id parameter */ + check_run_id: components["parameters"]["check_run_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["check-run"]; + }; + }; + }; + requestBody: { + content: { + "application/json": (Partial<{ + status?: "completed"; + } & { + [key: string]: any; + }> & Partial<{ + status?: "queued" | "in_progress"; + } & { + [key: string]: any; + }>) & { + /** The name of the check. For example, "code-coverage". */ + name?: string; + /** The URL of the integrator's site that has the full details of the check. */ + details_url?: string; + /** A reference for the run on the integrator's system. */ + external_id?: string; + /** This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + started_at?: string; + /** The current status. Can be one of `queued`, `in_progress`, or `completed`. */ + status?: "queued" | "in_progress" | "completed"; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + */ + conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; + /** The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + completed_at?: string; + /** Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description. */ + output?: { + /** **Required**. */ + title?: string; + /** Can contain Markdown. */ + summary: string; + /** Can contain Markdown. */ + text?: string; + /** Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see "[About status checks](https://help.github.com/articles/about-status-checks#checks)". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */ + annotations?: ({ + /** The path of the file to add an annotation to. For example, `assets/css/main.css`. */ + path: string; + /** The start line of the annotation. */ + start_line: number; + /** The end line of the annotation. */ + end_line: number; + /** The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ + start_column?: number; + /** The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ + end_column?: number; + /** The level of the annotation. Can be one of `notice`, `warning`, or `failure`. */ + annotation_level: "notice" | "warning" | "failure"; + /** A short description of the feedback for these lines of code. The maximum size is 64 KB. */ + message: string; + /** The title that represents the annotation. The maximum size is 255 characters. */ + title?: string; + /** Details about this annotation. The maximum size is 64 KB. */ + raw_details?: string; + } & { + [key: string]: any; + })[]; + /** Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details. */ + images?: ({ + /** The alternative text for the image. */ + alt: string; + /** The full URL of the image. */ + image_url: string; + /** A short image description. */ + caption?: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + /** Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ + actions?: ({ + /** The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ + label: string; + /** A short explanation of what this action would do. The maximum size is 40 characters. */ + description: string; + /** A reference for the action on the integrator's system. The maximum size is 20 characters. */ + identifier: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. */ + "checks/list-annotations": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** check_run_id parameter */ + check_run_id: components["parameters"]["check_run_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["check-annotation"][]; + }; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + */ + "checks/create-suite": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** when the suite already existed */ + 200: { + content: { + "application/json": components["schemas"]["check-suite"]; + }; + }; + /** Response when the suite was created */ + 201: { + content: { + "application/json": components["schemas"]["check-suite"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The sha of the head commit. */ + head_sha: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ + "checks/set-suites-preferences": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["check-suite-preference"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details. */ + auto_trigger_checks?: ({ + /** The `id` of the GitHub App. */ + app_id: number; + /** Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. */ + setting: boolean; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. + */ + "checks/get-suite": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** check_suite_id parameter */ + check_suite_id: components["parameters"]["check_suite_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["check-suite"]; + }; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + "checks/list-for-suite": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** check_suite_id parameter */ + check_suite_id: components["parameters"]["check_suite_id"]; + }; + query: { + /** Returns check runs with the specified `name`. */ + check_name?: components["parameters"]["check_name"]; + /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ + status?: components["parameters"]["status"]; + /** Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. */ + filter?: "latest" | "all"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + check_runs: components["schemas"]["check-run"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * + * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. + */ + "checks/rerequest-suite": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** check_suite_id parameter */ + check_suite_id: components["parameters"]["check_suite_id"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Lists all open code scanning alerts for the default branch (usually `main` + * or `master`). You must use an access token with the `security_events` scope to use + * this endpoint. GitHub Apps must have the `security_events` read permission to use + * this endpoint. + * + * The response includes a `most_recent_instance` object. + * This provides details of the most recent instance of this alert + * for the default branch or for the specified Git reference + * (if you used `ref` in the request). + */ + "code-scanning/list-alerts-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ + tool_name?: components["parameters"]["tool_name"]; + /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ + tool_guid?: components["parameters"]["tool_guid"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ + ref?: components["parameters"]["git_ref"]; + /** Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ + state?: components["schemas"]["code-scanning-alert-state"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-alert-items"][]; + }; + }; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * **Deprecation notice**: + * 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`. + */ + "code-scanning/get-alert": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert_number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-alert"]; + }; + }; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. */ + "code-scanning/update-alert": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert_number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-alert"]; + }; + }; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + requestBody: { + content: { + "application/json": { + state: components["schemas"]["code-scanning-alert-set-state"]; + dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. */ + "code-scanning/list-alert-instances": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert_number"]; + }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ + ref?: components["parameters"]["git_ref"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-alert-instance"][]; + }; + }; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Lists the details of all code scanning analyses for a repository, + * starting with the most recent. + * The response is paginated and you can use the `page` and `per_page` parameters + * to list the analyses you're interested in. + * By default 30 analyses are listed per page. + * + * The `rules_count` field in the response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. + * + * You must use an access token with the `security_events` scope to use this endpoint. + * GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + */ + "code-scanning/list-recent-analyses": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ + tool_name?: components["parameters"]["tool_name"]; + /** The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ + tool_guid?: components["parameters"]["tool_guid"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ + ref?: components["schemas"]["code-scanning-ref"]; + /** Filter analyses belonging to the same SARIF upload. */ + sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-analysis"][]; + }; + }; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Gets a specified code scanning analysis for a repository. + * You must use an access token with the `security_events` scope to use this endpoint. + * GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * The default JSON response contains fields that describe the analysis. + * This includes the Git reference and commit SHA to which the analysis relates, + * the datetime of the analysis, the name of the code scanning tool, + * and the number of alerts. + * + * The `rules_count` field in the default response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. + * + * If you use the Accept header `application/sarif+json`, + * the response contains the analysis data that was uploaded. + * This is formatted as + * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + * For an example response, see "[Custom media type for code scanning](#custom-media-type-for-code-scanning)." + * + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + */ + "code-scanning/get-analysis": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ + analysis_id: number; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json+sarif": string; + "application/json": components["schemas"]["code-scanning-analysis"]; + }; + }; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Deletes a specified code scanning analysis from a repository. For + * private repositories, you must use an access token with the `repo` scope. For public repositories, + * you must use an access token with `public_repo` and `repo:security_events` scopes. + * GitHub Apps must have the `security_events` write permission to use this endpoint. + * + * You can delete one analysis at a time. + * To delete a series of analyses, start with the most recent analysis and work backwards. + * Conceptually, the process is similar to the undo function in a text editor. + * + * When you list the analyses for a repository, + * one or more will be identified as deletable in the response: + * + * ``` + * "deletable": true + * ``` + * + * An analysis is deletable when it's the most recent in a set of analyses. + * Typically, a repository will have multiple sets of analyses + * for each enabled code scanning tool, + * where a set is determined by a unique combination of analysis values: + * + * * `ref` + * * `tool` + * * `analysis_key` + * * `environment` + * + * If you attempt to delete an analysis that is not the most recent in a set, + * you'll get a 400 response with the message: + * + * ``` + * Analysis specified is not deletable. + * ``` + * + * The response from a successful `DELETE` operation provides you with + * two alternative URLs for deleting the next analysis in the set + * (see the example default response below). + * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis + * in the set. This is a useful option if you want to preserve at least one analysis + * for the specified tool in your repository. + * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. + * When you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url` + * in the 200 response is `null`. + * + * As an example of the deletion process, + * let's imagine that you added a workflow that configured a particular code scanning tool + * to analyze the code in a repository. This tool has added 15 analyses: + * 10 on the default branch, and another 5 on a topic branch. + * You therefore have two separate sets of analyses for this tool. + * You've now decided that you want to remove all of the analyses for the tool. + * To do this you must make 15 separate deletion requests. + * To start, you must find the deletable analysis for one of the sets, + * step through deleting the analyses in that set, + * and then repeat the process for the second set. + * The procedure therefore consists of a nested loop: + * + * **Outer loop**: + * * List the analyses for the repository, filtered by tool. + * * Parse this list to find a deletable analysis. If found: + * + * **Inner loop**: + * * Delete the identified analysis. + * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. + * + * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + */ + "code-scanning/delete-analysis": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ + analysis_id: number; + }; + query: { + /** Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ + confirm_delete?: string | null; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-analysis-deletion"]; + }; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * 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. GitHub Apps must have the `security_events` write permission to use this endpoint. + * + * There are two places where you can upload code scanning results. + * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + * - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + * + * You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: + * + * ``` + * gzip -c analysis-data.sarif | base64 -w0 + * ``` + * + * SARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries. + * + * The `202 Accepted`, response includes an `id` value. + * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. + * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." + */ + "code-scanning/upload-sarif": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 202: { + content: { + "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; + }; + }; + /** Bad Request if the sarif field is invalid */ + 400: unknown; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + /** Payload Too Large if the sarif field is too large */ + 413: unknown; + 503: components["responses"]["service_unavailable"]; + }; + requestBody: { + content: { + "application/json": { + commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; + ref: components["schemas"]["code-scanning-ref"]; + sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; + /** + * The base directory used in the analysis, as it appears in the SARIF file. + * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. + */ + checkout_uri?: string; + /** The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + started_at?: string; + /** The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ + tool_name?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** 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. GitHub Apps must have the `security_events` read permission to use this endpoint. */ + "code-scanning/get-sarif": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The SARIF ID obtained after uploading. */ + sarif_id: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-sarifs-status"]; + }; + }; + 403: components["responses"]["code_scanning_forbidden_read"]; + /** Not Found if the sarif id does not match any upload */ + 404: unknown; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + * + * Team members will include the members of child teams. + */ + "repos/list-collaborators": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** + * Filter collaborators returned by their affiliation. Can be one of: + * \* `outside`: All outside collaborators of an organization-owned repository. + * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["collaborator"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + * + * Team members will include the members of child teams. + */ + "repos/check-collaborator": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response if user is a collaborator */ + 204: never; + /** Not Found if user is not a collaborator */ + 404: unknown; + }; + }; + /** + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * For more information the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). + * + * **Rate limits** + * + * To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. + */ + "repos/add-collaborator": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response when a new invitation is created */ + 201: { + content: { + "application/json": components["schemas"]["repository-invitation"]; + }; + }; + /** Response when person is already a collaborator */ + 204: never; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** + * The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: + * \* `pull` - can pull, but not push to or administer this repository. + * \* `push` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push and administer this repository. + * \* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. + * \* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. + */ + permission?: "pull" | "push" | "admin" | "maintain" | "triage"; + permissions?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "repos/remove-collaborator": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. */ + "repos/get-collaborator-permission-level": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** if user has admin permissions */ + 200: { + content: { + "application/json": components["schemas"]["repository-collaborator-permission"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * + * Comments are ordered by ascending ID. + */ + "repos/list-commit-comments-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["commit-comment"][]; + }; + }; + }; + }; + "repos/get-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["commit-comment"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "repos/delete-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + "repos/update-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["commit-comment"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + requestBody: { + content: { + "application/json": { + /** The contents of the comment */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ + "reactions/list-for-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + query: { + /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["reaction"][]; + }; + }; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ + "reactions/create-for-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Reaction exists */ + 200: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + /** Reaction created */ + 201: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment. */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * + * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + */ + "reactions/delete-for-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "repos/list-commits": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). */ + sha?: string; + /** Only commits containing this file path will be returned. */ + path?: string; + /** GitHub login or email address by which to filter by commit author. */ + author?: string; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + until?: string; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["commit"][]; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + */ + "repos/list-branches-for-head-commit": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** commit_sha parameter */ + commit_sha: components["parameters"]["commit_sha"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["branch-short"][]; + }; + }; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Use the `:commit_sha` to specify the commit that will have its comments listed. */ + "repos/list-comments-for-commit": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** commit_sha parameter */ + commit_sha: components["parameters"]["commit_sha"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["commit-comment"][]; + }; + }; + }; + }; + /** + * Create a comment for a commit using its `:commit_sha`. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "repos/create-commit-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** commit_sha parameter */ + commit_sha: components["parameters"]["commit_sha"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["commit-comment"]; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The contents of the comment. */ + body: string; + /** Relative path of the file to comment on. */ + path?: string; + /** Line index in the diff to comment on. */ + position?: number; + /** **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + line?: number; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. */ + "repos/list-pull-requests-associated-with-commit": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** commit_sha parameter */ + commit_sha: components["parameters"]["commit_sha"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["pull-request-simple"][]; + }; + }; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** + * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. + * + * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * + * 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. Diffs with binary data will have no `patch` property. + * + * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "repos/get-commit": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** ref parameter */ + ref: string; + }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["commit"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + "checks/list-for-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** ref parameter */ + ref: string; + }; + query: { + /** Returns check runs with the specified `name`. */ + check_name?: components["parameters"]["check_name"]; + /** Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. */ + status?: components["parameters"]["status"]; + /** Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. */ + filter?: "latest" | "all"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + app_id?: number; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + check_runs: components["schemas"]["check-run"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. + */ + "checks/list-suites-for-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** ref parameter */ + ref: string; + }; + query: { + /** Filters check suites by GitHub App `id`. */ + app_id?: number; + /** Returns check runs with the specified `name`. */ + check_name?: components["parameters"]["check_name"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + check_suites: components["schemas"]["check-suite"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** + * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. + * + * The most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts. + * + * Additionally, a combined `state` is returned. The `state` is one of: + * + * * **failure** if any of the contexts report as `error` or `failure` + * * **pending** if there are no statuses or a context is `pending` + * * **success** if the latest status for all contexts is `success` + */ + "repos/get-combined-status-for-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** ref parameter */ + ref: string; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["combined-commit-status"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. + * + * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + */ + "repos/list-commit-statuses-for-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** ref parameter */ + ref: string; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["status"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + }; + }; + /** + * Returns the contents of the repository's code of conduct file, if one is detected. + * + * A code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching. + */ + "codes-of-conduct/get-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["code-of-conduct"]; + }; + }; + }; + }; + /** + * This endpoint will return all community profile metrics, including an + * overall health score, repository description, the presence of documentation, detected + * code of conduct, detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE, + * README, and CONTRIBUTING files. + * + * The `health_percentage` score is defined as a percentage of how many of + * these four documents are present: README, CONTRIBUTING, LICENSE, and + * CODE_OF_CONDUCT. For example, if all four documents are present, then + * the `health_percentage` is `100`. If only one is present, then the + * `health_percentage` is `25`. + * + * `content_reports_enabled` is only returned for organization-owned repositories. + */ + "repos/get-community-profile-metrics": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["community-profile"]; + }; + }; + }; + }; + /** + * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. + * + * The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. 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. + * + * The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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. + * + * **Working with large comparisons** + * + * To process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)." + * + * When calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "repos/compare-commits-with-basehead": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The base branch and head branch to compare. This parameter expects the format `{base}...{head}`. */ + basehead: string; + }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100) */ + per_page?: components["parameters"]["per-page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["commit-comparison"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit + * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. + * + * Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for + * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media + * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent + * object format. + * + * **Note**: + * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). + * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees + * API](https://docs.github.com/rest/reference/git#get-a-tree). + * * This API supports files up to 1 megabyte in size. + * + * #### If the content is a directory + * The response will be an array of objects, one object for each item in the directory. + * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value + * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). + * In the next major version of the API, the type will be returned as "submodule". + * + * #### If the content is a symlink + * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the + * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object + * describing the symlink itself. + * + * #### If the content is a submodule + * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific + * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out + * the submodule at that specific commit. + * + * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the + * github.com URLs (`html_url` and `_links["html"]`) will have null values. + */ + "repos/get-content": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** path parameter */ + path: string; + }; + query: { + /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ + ref?: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/vnd.github.v3.object": components["schemas"]["content-tree"]; + "application/json": (components["schemas"]["content-directory"] | components["schemas"]["content-file"] | components["schemas"]["content-symlink"] | components["schemas"]["content-submodule"]) & { + [key: string]: any; + }; + }; + }; + 302: components["responses"]["found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Creates a new file or replaces an existing file in a repository. */ + "repos/create-or-update-file-contents": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** path parameter */ + path: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["file-commit"]; + }; + }; + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["file-commit"]; + }; + }; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The commit message. */ + message: string; + /** The new file content, using Base64 encoding. */ + content: string; + /** **Required if you are updating a file**. The blob SHA of the file being replaced. */ + sha?: string; + /** The branch name. Default: the repository’s default branch (usually `master`) */ + branch?: string; + /** The person that committed the file. Default: the authenticated user. */ + committer?: { + /** The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ + name: string; + /** The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ + email: string; + date?: string; + } & { + [key: string]: any; + }; + /** The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. */ + author?: { + /** The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ + name: string; + /** The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ + email: string; + date?: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Deletes a file in a repository. + * + * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. + * + * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. + * + * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + */ + "repos/delete-file": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** path parameter */ + path: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["file-commit"]; + }; + }; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; + }; + requestBody: { + content: { + "application/json": { + /** The commit message. */ + message: string; + /** The blob SHA of the file being replaced. */ + sha: string; + /** The branch name. Default: the repository’s default branch (usually `master`) */ + branch?: string; + /** object containing information about the committer. */ + committer?: { + /** The name of the author (or committer) of the commit */ + name?: string; + /** The email of the author (or committer) of the commit */ + email?: string; + } & { + [key: string]: any; + }; + /** object containing information about the author. */ + author?: { + /** The name of the author (or committer) of the commit */ + name?: string; + /** The email of the author (or committer) of the commit */ + email?: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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 v3 caches contributor data to improve performance. + * + * 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. + */ + "repos/list-contributors": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Set to `1` or `true` to include anonymous contributors in results. */ + anon?: string; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** if repository contains content */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["contributor"][]; + }; + }; + /** Response if repository is empty */ + 204: never; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Simple filtering of deployments is available via query parameters: */ + "repos/list-deployments": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** The SHA recorded at creation time. */ + sha?: string; + /** The name of the ref. This can be a branch, tag, or SHA. */ + ref?: string; + /** The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ + task?: string; + /** The name of the environment that was deployed to (e.g., `staging` or `production`). */ + environment?: string | null; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["deployment"][]; + }; + }; + }; + }; + /** + * Deployments offer a few configurable parameters with certain defaults. + * + * The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them + * before we merge a pull request. + * + * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have + * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter + * makes it easier to track which environments have requested deployments. The default environment is `production`. + * + * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If + * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, + * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will + * return a failure response. + * + * By default, [commit statuses](https://docs.github.com/rest/reference/repos#statuses) for every submitted context must be in a `success` + * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to + * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do + * not require any contexts or create any commit statuses, the deployment will always succeed. + * + * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text + * field that will be passed on when a deployment event is dispatched. + * + * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might + * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an + * application with debugging enabled. + * + * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. + * + * #### Merged branch response + * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating + * a deployment. This auto-merge happens when: + * * Auto-merge option is enabled in the repository + * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example + * * There are no merge conflicts + * + * If there are no new commits in the base branch, a new request to create a deployment should give a successful + * response. + * + * #### Merge conflict response + * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + * + * #### Failed commit status checks + * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` + * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + */ + "repos/create-deployment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["deployment"]; + }; + }; + /** Merged branch response */ + 202: { + content: { + "application/json": { + message?: string; + } & { + [key: string]: any; + }; + }; + }; + /** Conflict when there is a merge conflict or the commit's status checks failed */ + 409: unknown; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The ref to deploy. This can be a branch, tag, or SHA. */ + ref: string; + /** Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). */ + task?: string; + /** Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. */ + auto_merge?: boolean; + /** The [status](https://docs.github.com/rest/reference/repos#statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ + required_contexts?: string[]; + payload?: ({ + [key: string]: any; + } | string) & { + [key: string]: any; + }; + /** Name for the target deployment environment (e.g., `production`, `staging`, `qa`). */ + environment?: string; + /** Short description of the deployment. */ + description?: string | null; + /** + * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. + */ + transient_environment?: boolean; + /** + * Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. + */ + production_environment?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + "repos/get-deployment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** deployment_id parameter */ + deployment_id: components["parameters"]["deployment_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["deployment"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment. + * + * To set a deployment as inactive, you must: + * + * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. + * * Mark the active deployment as inactive by adding any non-successful deployment status. + * + * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." + */ + "repos/delete-deployment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** deployment_id parameter */ + deployment_id: components["parameters"]["deployment_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + /** Users with pull access can view deployment statuses for a deployment: */ + "repos/list-deployment-statuses": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** deployment_id parameter */ + deployment_id: components["parameters"]["deployment_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["deployment-status"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Users with `push` access can create deployment statuses for a given deployment. + * + * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. + */ + "repos/create-deployment-status": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** deployment_id parameter */ + deployment_id: components["parameters"]["deployment_id"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["deployment-status"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. */ + state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; + /** The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. */ + target_url?: string; + /** + * The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. + */ + log_url?: string; + /** A short description of the status. The maximum description length is 140 characters. */ + description?: string; + /** Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. */ + environment?: "production" | "staging" | "qa"; + /** + * Sets the URL for accessing your environment. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. + */ + environment_url?: string; + /** + * Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` + * **Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. + */ + auto_inactive?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Users with pull access can view a deployment status for a deployment: */ + "repos/get-deployment-status": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** deployment_id parameter */ + deployment_id: components["parameters"]["deployment_id"]; + status_id: number; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["deployment-status"]; + }; + }; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** + * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." + * + * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. + * + * This endpoint requires write access to the repository by providing either: + * + * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. + * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. + * + * This input example shows how you can use the `client_payload` as a test to debug your workflow. + */ + "repos/create-dispatch-event": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** A custom webhook event name. */ + event_type: string; + /** JSON payload with extra information about the webhook event that your action or worklow may use. */ + client_payload?: { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Get all environments for 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. + */ + "repos/get-all-environments": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + /** The number of environments in this repository */ + total_count?: number; + environments?: components["schemas"]["environment"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** 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. */ + "repos/get-environment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the environment */ + environment_name: components["parameters"]["environment_name"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["environment"]; + }; + }; + }; + }; + /** + * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." + * + * **Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see "[Environments](/actions/reference/environments#deployment-branches)." + * + * **Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)." + * + * You must authenticate using an access token with the repo scope to use this endpoint. + */ + "repos/create-or-update-environment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the environment */ + environment_name: components["parameters"]["environment_name"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["environment"]; + }; + }; + /** Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ + 422: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + wait_timer?: components["schemas"]["wait-timer"]; + /** The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ + reviewers?: ({ + type?: components["schemas"]["deployment-reviewer-type"]; + /** The id of the user or team who can review the deployment */ + id?: number; + } & { + [key: string]: any; + })[] | null; + deployment_branch_policy?: components["schemas"]["deployment_branch_policy"]; + } | null; + }; + }; + }; + /** You must authenticate using an access token with the repo scope to use this endpoint. */ + "repos/delete-an-environment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The name of the environment */ + environment_name: components["parameters"]["environment_name"]; + }; + }; + responses: { + /** Default response */ + 204: never; + }; + }; + "activity/list-repo-events": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + "repos/list-forks": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** The sort order. Can be either `newest`, `oldest`, or `stargazers`. */ + sort?: "newest" | "oldest" | "stargazers" | "watchers"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + 400: components["responses"]["bad_request"]; + }; + }; + /** + * Create a fork for the authenticated user. + * + * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com). + */ + "repos/create-fork": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 202: { + content: { + "application/json": components["schemas"]["full-repository"]; + }; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** Optional parameter to specify the organization name if forking into an organization. */ + organization?: string; + } & { + [key: string]: any; + }) | null; + }; + }; + }; + "git/create-blob": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["short-blob"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The new blob's content. */ + content: string; + /** The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. */ + encoding?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * The `content` in the response will always be Base64 encoded. + * + * _Note_: This API supports blobs up to 100 megabytes in size. + */ + "git/get-blob": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + file_sha: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["blob"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "git/create-commit": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["git-commit"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The commit message */ + message: string; + /** The SHA of the tree object this commit points to */ + tree: string; + /** The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + parents?: string[]; + /** Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ + author?: { + /** The name of the author (or committer) of the commit */ + name: string; + /** The email of the author (or committer) of the commit */ + email: string; + /** Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + date?: string; + } & { + [key: string]: any; + }; + /** Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. */ + committer?: { + /** The name of the author (or committer) of the commit */ + name?: string; + /** The email of the author (or committer) of the commit */ + email?: string; + /** Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + date?: string; + } & { + [key: string]: any; + }; + /** The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. */ + signature?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "git/get-commit": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** commit_sha parameter */ + commit_sha: components["parameters"]["commit_sha"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["git-commit"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. + * + * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. + * + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * + * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + */ + "git/list-matching-refs": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** ref parameter */ + ref: string; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["git-ref"][]; + }; + }; + }; + }; + /** + * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. + * + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + */ + "git/get-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** ref parameter */ + ref: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["git-ref"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ + "git/create-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["git-ref"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. */ + ref: string; + /** The SHA1 value for this reference. */ + sha: string; + key?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "git/delete-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** ref parameter */ + ref: string; + }; + }; + responses: { + /** Response */ + 204: never; + 422: components["responses"]["validation_failed"]; + }; + }; + "git/update-ref": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** ref parameter */ + ref: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["git-ref"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The SHA1 value to set this reference to */ + sha: string; + /** Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. */ + force?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "git/create-tag": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["git-tag"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The tag's name. This is typically a version (e.g., "v0.0.1"). */ + tag: string; + /** The tag message. */ + message: string; + /** The SHA of the git object this is tagging. */ + object: string; + /** The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. */ + type: "commit" | "tree" | "blob"; + /** An object with information about the individual creating the tag. */ + tagger?: { + /** The name of the author of the tag */ + name: string; + /** The email of the author of the tag */ + email: string; + /** When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + date?: string; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "git/get-tag": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + tag_sha: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["git-tag"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. + * + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." + */ + "git/create-tree": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["git-tree"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. */ + tree: ({ + /** The file referenced in the tree. */ + path?: string; + /** The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink. */ + mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + /** Either `blob`, `tree`, or `commit`. */ + type?: "blob" | "tree" | "commit"; + /** + * The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. + * + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. + */ + sha?: string | null; + /** + * The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. + * + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. + */ + content?: string; + } & { + [key: string]: any; + })[]; + /** + * The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. + */ + base_tree?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Returns a single tree using the SHA1 value for that tree. + * + * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. + */ + "git/get-tree": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + tree_sha: string; + }; + query: { + /** Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ + recursive?: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["git-tree"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/list-webhooks": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["hook"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can + * share the same `config` as long as those webhooks do not have any `events` that overlap. + */ + "repos/create-webhook": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["hook"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */ + name?: string; + /** Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ + config?: { + url?: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + token?: string; + digest?: string; + } & { + [key: string]: any; + }; + /** Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. */ + events?: string[]; + /** Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. */ + active?: boolean; + } | null; + }; + }; + }; + /** Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." */ + "repos/get-webhook": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "repos/delete-webhook": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." */ + "repos/update-webhook": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hook"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). */ + config?: { + url: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + address?: string; + room?: string; + } & { + [key: string]: any; + }; + /** Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. */ + events?: string[]; + /** Determines a list of events to be added to the list of events that the Hook triggers for. */ + add_events?: string[]; + /** Determines a list of events to be removed from the list of events that the Hook triggers for. */ + remove_events?: string[]; + /** Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. */ + active?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." + * + * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + */ + "repos/get-webhook-config-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + }; + /** + * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." + * + * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + */ + "repos/update-webhook-config-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["webhook-config"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + url?: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + secret?: components["schemas"]["webhook-config-secret"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + }; + }; + }; + }; + /** This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ + "repos/ping-webhook": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** + * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. + * + * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + */ + "repos/test-push-webhook": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + hook_id: components["parameters"]["hook-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** + * View the progress of an import. + * + * **Import status** + * + * This section includes details about the possible values of the `status` field of the Import Progress response. + * + * An import that does not have errors will progress through these steps: + * + * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. + * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). + * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. + * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". + * * `complete` - the import is complete, and the repository is ready on GitHub. + * + * If there are problems, you will see one of these in the `status` field: + * + * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information. + * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL. + * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * + * **The project_choices field** + * + * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. + * + * **Git LFS related fields** + * + * This section includes details about Git LFS related fields that may be present in the Import Progress response. + * + * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. + * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. + * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. + * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. + */ + "migrations/get-import-status": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["import"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** Start a source import to a GitHub repository using GitHub Importer. */ + "migrations/start-import": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["import"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The URL of the originating repository. */ + vcs_url: string; + /** The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. */ + vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + /** If authentication is required, the username to provide to `vcs_url`. */ + vcs_username?: string; + /** If authentication is required, the password to provide to `vcs_url`. */ + vcs_password?: string; + /** For a tfvc import, the name of the project that is being imported. */ + tfvc_project?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Stop an import for a repository. */ + "migrations/cancel-import": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API + * request. If no parameters are provided, the import will be restarted. + */ + "migrations/update-import": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["import"]; + }; + }; + }; + requestBody: { + content: { + "application/json": ({ + /** The username to provide to the originating repository. */ + vcs_username?: string; + /** The password to provide to the originating repository. */ + vcs_password?: string; + vcs?: string; + tfvc_project?: string; + } & { + [key: string]: any; + }) | null; + }; + }; + }; + /** + * 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 `. + * + * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. + */ + "migrations/get-commit-authors": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** A user ID. Only return users with an ID greater than this ID. */ + since?: components["parameters"]["since-user"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["porter-author"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. */ + "migrations/map-commit-author": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + author_id: number; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["porter-author"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The new Git author email. */ + email?: string; + /** The new Git author name. */ + name?: string; + }; + }; + }; + }; + /** List files larger than 100MB found during the import */ + "migrations/get-large-files": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["porter-large-file"][]; + }; + }; + }; + }; + /** You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/). */ + "migrations/set-lfs-preference": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["import"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import). */ + use_lfs: "opt_in" | "opt_out"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. + * + * 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. + */ + "apps/get-repo-installation": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["installation"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ + "interactions/get-restrictions-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": (Partial & Partial<{ + [key: string]: any; + }>) & { + [key: string]: any; + }; + }; + }; + }; + }; + /** Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ + "interactions/set-restrictions-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["interaction-limit-response"]; + }; + }; + /** Response */ + 409: unknown; + }; + requestBody: { + content: { + "application/json": components["schemas"]["interaction-limit"]; + }; + }; + }; + /** Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ + "interactions/remove-restrictions-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + /** Response */ + 409: unknown; + }; + }; + /** When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ + "repos/list-invitations": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["repository-invitation"][]; + }; + }; + }; + }; + "repos/delete-invitation": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** invitation_id parameter */ + invitation_id: components["parameters"]["invitation_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + "repos/update-invitation": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** invitation_id parameter */ + invitation_id: components["parameters"]["invitation_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-invitation"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. */ + permissions?: "read" | "write" | "maintain" | "triage" | "admin"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * List issues in a repository. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + "issues/list-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ + milestone?: string; + /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + state?: "open" | "closed" | "all"; + /** Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ + assignee?: string; + /** The user that created the issue. */ + creator?: string; + /** A user that's mentioned in the issue. */ + mentioned?: string; + /** A list of comma separated label names. Example: `bug,ui,@high` */ + labels?: components["parameters"]["labels"]; + /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + sort?: "created" | "updated" | "comments"; + /** One of `asc` (ascending) or `desc` (descending). */ + direction?: components["parameters"]["direction"]; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["issue-simple"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + "issues/create": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; + }; + requestBody: { + content: { + "application/json": { + /** The title of the issue. */ + title: (string | number) & { + [key: string]: any; + }; + /** The contents of the issue. */ + body?: string; + /** Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + assignee?: string | null; + milestone?: ((string | number) & { + [key: string]: any; + }) | null; + /** Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ + labels?: ((string | ({ + id?: number; + name?: string; + description?: string | null; + color?: string | null; + } & { + [key: string]: any; + })) & { + [key: string]: any; + })[]; + /** Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ + assignees?: string[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** By default, Issue Comments are ordered by ascending ID. */ + "issues/list-comments-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ + sort?: components["parameters"]["sort"]; + /** Either `asc` or `desc`. Ignored without the `sort` parameter. */ + direction?: "asc" | "desc"; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["issue-comment"][]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/get-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "issues/delete-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + "issues/update-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The contents of the comment. */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). */ + "reactions/list-for-issue-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + query: { + /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["reaction"][]; + }; + }; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ + "reactions/create-for-issue-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Reaction exists */ + 200: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + /** Reaction created */ + 201: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment. */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * + * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + */ + "reactions/delete-for-issue-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + "issues/list-events-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["issue-event"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/get-event": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + event_id: number; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["issue-event"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + /** + * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was + * [transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If + * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe + * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + "issues/get": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + /** Issue owners and users with push access can edit an issue. */ + "issues/update": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; + }; + requestBody: { + content: { + "application/json": { + /** The title of the issue. */ + title?: ((string | number) & { + [key: string]: any; + }) | null; + /** The contents of the issue. */ + body?: string | null; + /** Login for the user that this issue should be assigned to. **This field is deprecated.** */ + assignee?: string | null; + /** State of the issue. Either `open` or `closed`. */ + state?: "open" | "closed"; + milestone?: ((string | number) & { + [key: string]: any; + }) | null; + /** Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ */ + labels?: ((string | ({ + id?: number; + name?: string; + description?: string | null; + color?: string | null; + } & { + [key: string]: any; + })) & { + [key: string]: any; + })[]; + /** Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ + assignees?: string[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ + "issues/add-assignees": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["issue-simple"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ */ + assignees?: string[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Removes one or more assignees from an issue. */ + "issues/remove-assignees": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["issue-simple"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ */ + assignees?: string[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Issue Comments are ordered by ascending ID. */ + "issues/list-comments": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + query: { + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["issue-comment"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + /** This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. */ + "issues/create-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The contents of the comment. */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "issues/list-events": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["issue-event-for-issue"][]; + }; + }; + 410: components["responses"]["gone"]; + }; + }; + "issues/list-labels-on-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["label"][]; + }; + }; + 410: components["responses"]["gone"]; + }; + }; + /** Removes any previous labels and sets the new labels for an issue. */ + "issues/set-labels": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["label"][]; + }; + }; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": (Partial<{ + /** The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. */ + labels?: string[]; + } & { + [key: string]: any; + }> & Partial<{ + labels?: ({ + name: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }>) & { + [key: string]: any; + }; + }; + }; + }; + "issues/add-labels": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["label"][]; + }; + }; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": (({ + /** The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. */ + labels?: string[]; + } & { + [key: string]: any; + }) | ({ + labels?: ({ + name: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + })) & { + [key: string]: any; + }; + }; + }; + }; + "issues/remove-all-labels": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** Response */ + 204: never; + 410: components["responses"]["gone"]; + }; + }; + /** Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ + "issues/remove-label": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + name: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["label"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + /** + * Users with push access can lock an issue or pull request's conversation. + * + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + "issues/lock": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** Response */ + 204: never; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** + * The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: + * \* `off-topic` + * \* `too heated` + * \* `resolved` + * \* `spam` + */ + lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; + } & { + [key: string]: any; + }) | null; + }; + }; + }; + /** Users with push access can unlock an issue's conversation. */ + "issues/unlock": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** Response */ + 204: never; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** List the reactions to an [issue](https://docs.github.com/rest/reference/issues). */ + "reactions/list-for-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + query: { + /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue. */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["reaction"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ + "reactions/create-for-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue. */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * + * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + */ + "reactions/delete-for-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + "issues/list-events-for-timeline": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** issue_number parameter */ + issue_number: components["parameters"]["issue_number"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["issue-event-for-issue"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + "repos/list-deploy-keys": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["deploy-key"][]; + }; + }; + }; + }; + /** You can create a read-only deploy key. */ + "repos/create-deploy-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["deploy-key"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** A name for the key. */ + title?: string; + /** The contents of the key. */ + key: string; + /** + * If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + * + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/)." + */ + read_only?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + "repos/get-deploy-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** key_id parameter */ + key_id: components["parameters"]["key_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["deploy-key"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ + "repos/delete-deploy-key": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** key_id parameter */ + key_id: components["parameters"]["key_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + "issues/list-labels-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["label"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "issues/create-label": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["label"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ + name: string; + /** The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ + color?: string; + /** A short description of the label. */ + description?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "issues/get-label": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["label"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "issues/delete-label": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: string; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + "issues/update-label": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + name: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["label"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ + new_name?: string; + /** The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ + color?: string; + /** A short description of the label. */ + description?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ + "repos/list-languages": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["language"]; + }; + }; + }; + }; + /** + * This method returns the contents of the repository's license file, if one is detected. + * + * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. + */ + "licenses/get-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["license-content"]; + }; + }; + }; + }; + "repos/merge": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Successful Response (The resulting merge commit) */ + 201: { + content: { + "application/json": components["schemas"]["commit"]; + }; + }; + /** Response when already merged */ + 204: never; + 403: components["responses"]["forbidden"]; + /** Not Found when the base or head does not exist */ + 404: unknown; + /** Conflict when there is a merge conflict */ + 409: unknown; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The name of the base branch that the head will be merged into. */ + base: string; + /** The head to merge. This can be a branch name or a commit SHA1. */ + head: string; + /** Commit message to use for the merge commit. If omitted, a default message will be used. */ + commit_message?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "issues/list-milestones": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** The state of the milestone. Either `open`, `closed`, or `all`. */ + state?: "open" | "closed" | "all"; + /** What to sort results by. Either `due_on` or `completeness`. */ + sort?: "due_on" | "completeness"; + /** The direction of the sort. Either `asc` or `desc`. */ + direction?: "asc" | "desc"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["milestone"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "issues/create-milestone": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["milestone"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The title of the milestone. */ + title: string; + /** The state of the milestone. Either `open` or `closed`. */ + state?: "open" | "closed"; + /** A description of the milestone. */ + description?: string; + /** The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + due_on?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "issues/get-milestone": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** milestone_number parameter */ + milestone_number: components["parameters"]["milestone_number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["milestone"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "issues/delete-milestone": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** milestone_number parameter */ + milestone_number: components["parameters"]["milestone_number"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + "issues/update-milestone": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** milestone_number parameter */ + milestone_number: components["parameters"]["milestone_number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["milestone"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The title of the milestone. */ + title?: string; + /** The state of the milestone. Either `open` or `closed`. */ + state?: "open" | "closed"; + /** A description of the milestone. */ + description?: string; + /** The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + due_on?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "issues/list-labels-for-milestone": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** milestone_number parameter */ + milestone_number: components["parameters"]["milestone_number"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["label"][]; + }; + }; + }; + }; + /** List all notifications for the current user. */ + "activity/list-repo-notifications-for-authenticated-user": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** If `true`, show notifications marked as read. */ + all?: components["parameters"]["all"]; + /** If `true`, only shows notifications in which the user is directly participating or mentioned. */ + participating?: components["parameters"]["participating"]; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + before?: components["parameters"]["before"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["thread"][]; + }; + }; + }; + }; + /** Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). 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`. */ + "activity/mark-repo-notifications-as-read": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 202: { + content: { + "application/json": { + message?: string; + url?: string; + } & { + [key: string]: any; + }; + }; + }; + /** Reset Content */ + 205: unknown; + }; + requestBody: { + content: { + "application/json": { + /** Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ + last_read_at?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "repos/get-pages": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["page"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). */ + "repos/update-information-about-pages-site": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": (Partial<{ + [key: string]: any; + }> & Partial<{ + [key: string]: any; + }> & Partial<{ + [key: string]: any; + }> & Partial<{ + [key: string]: any; + }>) & { + /** Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/)." */ + cname?: string | null; + /** Specify whether HTTPS should be enforced for the repository. */ + https_enforced?: boolean; + /** Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan. */ + public?: boolean; + source?: (Partial<"gh-pages" | "master" | "master /docs"> & Partial<{ + /** The repository branch used to publish your site's source files. */ + branch: string; + /** The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. */ + path: "/" | "/docs"; + } & { + [key: string]: any; + }>) & { + [key: string]: any; + }; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." */ + "repos/create-pages-site": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["page"]; + }; + }; + 409: components["responses"]["conflict"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** The source branch and directory used to publish your Pages site. */ + source: { + /** The repository branch used to publish your site's source files. */ + branch: string; + /** The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` */ + path?: "/" | "/docs"; + } & { + [key: string]: any; + }; + } & { + [key: string]: any; + }) | null; + }; + }; + }; + "repos/delete-pages-site": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/list-pages-builds": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["page-build"][]; + }; + }; + }; + }; + /** + * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. + * + * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + */ + "repos/request-pages-build": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["page-build-status"]; + }; + }; + }; + }; + "repos/get-latest-pages-build": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["page-build"]; + }; + }; + }; + }; + "repos/get-pages-build": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + build_id: number; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["page-build"]; + }; + }; + }; + }; + /** + * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. + * + * 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. + * + * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. + */ + "repos/get-pages-health-check": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["pages-health-check"]; + }; + }; + /** Empty response */ + 202: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** Custom domains are not available for GitHub Pages */ + 400: unknown; + 404: components["responses"]["not_found"]; + /** There isn't a CNAME for this page */ + 422: unknown; + }; + }; + /** Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ + "projects/list-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + state?: "open" | "closed" | "all"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["project"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + /** Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ + "projects/create-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["project"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** The name of the project. */ + name: string; + /** The description of the project. */ + body?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ + "pulls/list": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Either `open`, `closed`, or `all` to filter by state. */ + state?: "open" | "closed" | "all"; + /** Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. */ + head?: string; + /** Filter pulls by base branch name. Example: `gh-pages`. */ + base?: string; + /** What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). */ + sort?: "created" | "updated" | "popularity" | "long-running"; + /** The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ + direction?: "asc" | "desc"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["pull-request-simple"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + * + * You can create a new pull request. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "pulls/create": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["pull-request"]; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The title of the new pull request. */ + title?: string; + /** The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ + head: string; + /** The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ + base: string; + /** The contents of the pull request. */ + body?: string; + /** Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ + maintainer_can_modify?: boolean; + /** Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ + draft?: boolean; + issue?: number; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. */ + "pulls/list-review-comments-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + sort?: "created" | "updated" | "created_at"; + /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + direction?: "asc" | "desc"; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["pull-request-review-comment"][]; + }; + }; + }; + }; + /** Provides details for a review comment. */ + "pulls/get-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["pull-request-review-comment"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** Deletes a review comment. */ + "pulls/delete-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + }; + }; + /** Enables you to edit a review comment. */ + "pulls/update-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["pull-request-review-comment"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The text of the reply to the review comment. */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). */ + "reactions/list-for-pull-request-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + query: { + /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["reaction"][]; + }; + }; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ + "reactions/create-for-pull-request-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Reaction exists */ + 200: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + /** Reaction created */ + 201: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment. */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * + * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + */ + "reactions/delete-for-pull-request-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + reaction_id: components["parameters"]["reaction-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists details of a pull request by providing its number. + * + * When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * + * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. + * + * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: + * + * * If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * + * 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. + */ + "pulls/get": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + responses: { + /** 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. */ + 200: { + content: { + "application/json": components["schemas"]["pull-request"]; + }; + }; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + */ + "pulls/update": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["pull-request"]; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The title of the pull request. */ + title?: string; + /** The contents of the pull request. */ + body?: string; + /** State of this Pull Request. Either `open` or `closed`. */ + state?: "open" | "closed"; + /** The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */ + base?: string; + /** Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ + maintainer_can_modify?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists all review comments for a pull request. By default, review comments are in ascending order by ID. */ + "pulls/list-review-comments": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + query: { + /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ + sort?: components["parameters"]["sort"]; + /** Can be either `asc` or `desc`. Ignored without `sort` parameter. */ + direction?: "asc" | "desc"; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["pull-request-review-comment"][]; + }; + }; + }; + }; + /** + * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. + * + * You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices). + * + * **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. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "pulls/create-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["pull-request-review-comment"]; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The text of the review comment. */ + body: string; + /** The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. */ + commit_id?: string; + /** The relative path to the file that necessitates a comment. */ + path?: string; + /** **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. */ + position?: number; + /** **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. */ + side?: "LEFT" | "RIGHT"; + /** **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */ + line?: number; + /** **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ + start_line?: number; + /** **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. */ + start_side?: "LEFT" | "RIGHT" | "side"; + in_reply_to?: number; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * 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. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "pulls/create-reply-for-review-comment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + /** comment_id parameter */ + comment_id: components["parameters"]["comment_id"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["pull-request-review-comment"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + requestBody: { + content: { + "application/json": { + /** The text of the review comment. */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. */ + "pulls/list-commits": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["commit"][]; + }; + }; + }; + }; + /** **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ + "pulls/list-files": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["diff-entry"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + }; + }; + "pulls/check-if-merged": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + responses: { + /** Response if pull request has been merged */ + 204: never; + /** Not Found if pull request has not been merged */ + 404: unknown; + }; + }; + /** 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. */ + "pulls/merge": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + responses: { + /** if merge was successful */ + 200: { + content: { + "application/json": components["schemas"]["pull-request-merge-result"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + /** Method Not Allowed if merge cannot be performed */ + 405: { + content: { + "application/json": { + message?: string; + documentation_url?: string; + } & { + [key: string]: any; + }; + }; + }; + /** Conflict if sha was provided and pull request head did not match */ + 409: { + content: { + "application/json": { + message?: string; + documentation_url?: string; + } & { + [key: string]: any; + }; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** Title for the automatic commit message. */ + commit_title?: string; + /** Extra detail to append to automatic commit message. */ + commit_message?: string; + /** SHA that pull request head must match to allow merge. */ + sha?: string; + /** Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. */ + merge_method?: "merge" | "squash" | "rebase"; + } & { + [key: string]: any; + }) | null; + }; + }; + }; + "pulls/list-requested-reviewers": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["pull-request-review-request"]; + }; + }; + }; + }; + /** 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. */ + "pulls/request-reviewers": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["pull-request-simple"]; + }; + }; + 403: components["responses"]["forbidden"]; + /** Unprocessable Entity if user is not a collaborator */ + 422: unknown; + }; + requestBody: { + content: { + "application/json": (Partial<{ + [key: string]: any; + }> & Partial<{ + [key: string]: any; + }>) & { + /** An array of user `login`s that will be requested. */ + reviewers?: string[]; + /** An array of team `slug`s that will be requested. */ + team_reviewers?: string[]; + } & { + [key: string]: any; + }; + }; + }; + }; + "pulls/remove-requested-reviewers": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["pull-request-simple"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** An array of user `login`s that will be removed. */ + reviewers: string[]; + /** An array of team `slug`s that will be removed. */ + team_reviewers?: string[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** The list of reviews returns in chronological order. */ + "pulls/list-reviews": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** The list of reviews returns in chronological order. */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["pull-request-review"][]; + }; + }; + }; + }; + /** + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * Pull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response. + * + * **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 v3 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. + * + * 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. + */ + "pulls/create-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["pull-request-review"]; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. */ + commit_id?: string; + /** **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ + body?: string; + /** The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready. */ + event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + /** Use the following table to specify the location, destination, and contents of the draft review comment. */ + comments?: ({ + /** The relative path to the file that necessitates a review comment. */ + path: string; + /** The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below. */ + position?: number; + /** Text of the review comment. */ + body: string; + line?: number; + side?: string; + start_line?: number; + start_side?: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + "pulls/get-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + /** review_id parameter */ + review_id: components["parameters"]["review_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["pull-request-review"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** Update the review summary comment with new text. */ + "pulls/update-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + /** review_id parameter */ + review_id: components["parameters"]["review_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["pull-request-review"]; + }; + }; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** The body text of the pull request review. */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "pulls/delete-pending-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + /** review_id parameter */ + review_id: components["parameters"]["review_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["pull-request-review"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + /** List comments for a specific pull request review. */ + "pulls/list-comments-for-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + /** review_id parameter */ + review_id: components["parameters"]["review_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["review-comment"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ + "pulls/dismiss-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + /** review_id parameter */ + review_id: components["parameters"]["review_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["pull-request-review"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** The message for the pull request review dismissal */ + message: string; + event?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "pulls/submit-review": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + /** review_id parameter */ + review_id: components["parameters"]["review_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["pull-request-review"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** The body text of the pull request review */ + body?: string; + /** The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. */ + event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ + "pulls/update-branch": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pull_number: components["parameters"]["pull-number"]; + }; + }; + responses: { + /** Response */ + 202: { + content: { + "application/json": { + message?: string; + url?: string; + } & { + [key: string]: any; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ + expected_head_sha?: string; + } & { + [key: string]: any; + }) | null; + }; + }; + }; + /** + * Gets the preferred README for a repository. + * + * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + */ + "repos/get-readme": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ + ref?: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["content-file"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Gets the README from a repository directory. + * + * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + */ + "repos/get-readme-in-directory": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The alternate path to look for a README file */ + dir: string; + }; + query: { + /** The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) */ + ref?: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["content-file"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). + * + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + */ + "repos/list-releases": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["release"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Users with push access to the repository can create a release. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "repos/create-release": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["release"]; + }; + }; + /** Not Found if the discussion category name is invalid */ + 404: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The name of the tag. */ + tag_name: string; + /** Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */ + target_commitish?: string; + /** The name of the release. */ + name?: string; + /** Text describing the contents of the tag. */ + body?: string; + /** `true` to create a draft (unpublished) release, `false` to create a published one. */ + draft?: boolean; + /** `true` to identify the release as a prerelease. `false` to identify the release as a full release. */ + prerelease?: boolean; + /** If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ + discussion_category_name?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ + "repos/get-release-asset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** asset_id parameter */ + asset_id: components["parameters"]["asset_id"]; + }; + }; + responses: { + /** To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ + 200: { + content: { + "application/json": components["schemas"]["release-asset"]; + }; + }; + 302: components["responses"]["found"]; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + "repos/delete-release-asset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** asset_id parameter */ + asset_id: components["parameters"]["asset_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** Users with push access to the repository can edit a release asset. */ + "repos/update-release-asset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** asset_id parameter */ + asset_id: components["parameters"]["asset_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["release-asset"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The file name of the asset. */ + name?: string; + /** An alternate short description of the asset. Used in place of the filename. */ + label?: string; + state?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * View the latest published full release for the repository. + * + * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + */ + "repos/get-latest-release": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["release"]; + }; + }; + }; + }; + /** Get a published release with the specified tag. */ + "repos/get-release-by-tag": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** tag parameter */ + tag: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["release"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ + "repos/get-release": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** release_id parameter */ + release_id: components["parameters"]["release_id"]; + }; + }; + responses: { + /** **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ + 200: { + content: { + "application/json": components["schemas"]["release"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** Users with push access to the repository can delete a release. */ + "repos/delete-release": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** release_id parameter */ + release_id: components["parameters"]["release_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** Users with push access to the repository can edit a release. */ + "repos/update-release": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** release_id parameter */ + release_id: components["parameters"]["release_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["release"]; + }; + }; + /** Not Found if the discussion category name is invalid */ + 404: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The name of the tag. */ + tag_name?: string; + /** Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). */ + target_commitish?: string; + /** The name of the release. */ + name?: string; + /** Text describing the contents of the tag. */ + body?: string; + /** `true` makes the release a draft, and `false` publishes the release. */ + draft?: boolean; + /** `true` to identify the release as a prerelease, `false` to identify the release as a full release. */ + prerelease?: boolean; + /** If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ + discussion_category_name?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + "repos/list-release-assets": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** release_id parameter */ + release_id: components["parameters"]["release_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["release-asset"][]; + }; + }; + }; + }; + /** + * 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 + * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. + * + * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. + * + * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: + * + * `application/zip` + * + * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, + * you'll still need to pass your authentication to be able to upload an asset. + * + * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. + * + * **Notes:** + * * 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)" + * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact). + * * 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. + */ + "repos/upload-release-asset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** release_id parameter */ + release_id: components["parameters"]["release_id"]; + }; + query: { + name?: string; + label?: string; + }; + }; + responses: { + /** Response for successful upload */ + 201: { + content: { + "application/json": components["schemas"]["release-asset"]; + }; + }; + }; + requestBody: { + content: { + "*/*": string; + }; + }; + }; + /** Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ + "reactions/create-for-release": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** release_id parameter */ + release_id: components["parameters"]["release_id"]; + }; + }; + responses: { + /** Reaction exists */ + 200: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + /** Reaction created */ + 201: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release. */ + content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + */ + "secret-scanning/list-alerts-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ + state?: "open" | "resolved"; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["secret-scanning-alert"][]; + }; + }; + /** Repository is public or secret scanning is disabled for the repository */ + 404: unknown; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + */ + "secret-scanning/get-alert": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert_number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["secret-scanning-alert"]; + }; + }; + /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ + 404: unknown; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + */ + "secret-scanning/update-alert": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert_number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["secret-scanning-alert"]; + }; + }; + /** Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ + 404: unknown; + /** State does not match the resolution */ + 422: unknown; + 503: components["responses"]["service_unavailable"]; + }; + requestBody: { + content: { + "application/json": { + state: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Lists the people that have starred the repository. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + "activity/list-stargazers-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": (Partial & Partial) & { + [key: string]: any; + }; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ + "repos/get-code-frequency-stats": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ + 200: { + content: { + "application/json": components["schemas"]["code-frequency-stat"][]; + }; + }; + 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; + }; + }; + /** Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ + "repos/get-commit-activity-stats": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["commit-activity"][]; + }; + }; + 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; + }; + }; + /** + * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: + * + * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits + */ + "repos/get-contributors-stats": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** + * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits + */ + 200: { + content: { + "application/json": components["schemas"]["contributor-activity"][]; + }; + }; + 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; + }; + }; + /** + * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. + * + * The array order is oldest week (index 0) to most recent week. + */ + "repos/get-participation-stats": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** The array order is oldest week (index 0) to most recent week. */ + 200: { + content: { + "application/json": components["schemas"]["participation-stats"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Each array contains the day number, hour number, and number of commits: + * + * * `0-6`: Sunday - Saturday + * * `0-23`: Hour of day + * * Number of commits + * + * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + */ + "repos/get-punch-card-stats": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ + 200: { + content: { + "application/json": components["schemas"]["code-frequency-stat"][]; + }; + }; + 204: components["responses"]["no_content"]; + }; + }; + /** + * Users with push access in a repository can create commit statuses for a given SHA. + * + * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + */ + "repos/create-commit-status": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + sha: string; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["status"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. */ + state: "error" | "failure" | "pending" | "success"; + /** + * The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` + */ + target_url?: string; + /** A short description of the status. */ + description?: string; + /** A string label to differentiate this status from the status of other systems. This field is case-insensitive. */ + context?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists the people watching the specified repository. */ + "activity/list-watchers-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "activity/get-repo-subscription": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** if you subscribe to the repository */ + 200: { + content: { + "application/json": components["schemas"]["repository-subscription"]; + }; + }; + 403: components["responses"]["forbidden"]; + /** Not Found if you don't subscribe to the repository */ + 404: unknown; + }; + }; + /** If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. */ + "activity/set-repo-subscription": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-subscription"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** Determines if notifications should be received from this repository. */ + subscribed?: boolean; + /** Determines if all notifications should be blocked from this repository. */ + ignored?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). */ + "activity/delete-repo-subscription": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + "repos/list-tags": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["tag"][]; + }; + }; + }; + }; + /** + * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually + * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + * the `Location` header to make a second `GET` request. + * **Note**: For private repositories, these links are temporary and expire after five minutes. + */ + "repos/download-tarball-archive": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + ref: string; + }; + }; + responses: { + /** Response */ + 302: never; + }; + }; + "repos/list-teams": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["team"][]; + }; + }; + }; + }; + "repos/get-all-topics": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["topic"]; + }; + }; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + "repos/replace-all-topics": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["topic"]; + }; + }; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + names: string[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** 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. */ + "repos/get-clones": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Must be one of: `day`, `week`. */ + per?: components["parameters"]["per"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["clone-traffic"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + /** Get the top 10 popular contents over the last 14 days. */ + "repos/get-top-paths": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["content-traffic"][]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + /** Get the top 10 referrers over the last 14 days. */ + "repos/get-top-referrers": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["referrer-traffic"][]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + /** Get the total number of views 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. */ + "repos/get-views": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + query: { + /** Must be one of: `day`, `week`. */ + per?: components["parameters"]["per"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["view-traffic"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + /** A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/). */ + "repos/transfer": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 202: { + content: { + "application/json": components["schemas"]["minimal-repository"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The username or organization name the repository will be transferred to. */ + new_owner: string; + /** ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. */ + team_ids?: number[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ + "repos/check-vulnerability-alerts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response if repository is enabled with vulnerability alerts */ + 204: never; + /** Not Found if repository is not enabled with vulnerability alerts */ + 404: unknown; + }; + }; + /** 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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ + "repos/enable-vulnerability-alerts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** Disables 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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". */ + "repos/disable-vulnerability-alerts": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually + * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + * the `Location` header to make a second `GET` request. + * **Note**: For private repositories, these links are temporary and expire after five minutes. + */ + "repos/download-zipball-archive": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + ref: string; + }; + }; + responses: { + /** Response */ + 302: never; + }; + }; + /** + * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. + * * `repo` scope to create a private repository + */ + "repos/create-using-template": { + parameters: { + path: { + template_owner: string; + template_repo: string; + }; + }; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["repository"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. */ + owner?: string; + /** The name of the new repository. */ + name: string; + /** A short description of the new repository. */ + description?: string; + /** Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. */ + include_all_branches?: boolean; + /** Either `true` to create a new private repository or `false` to create a new public one. */ + private?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Lists all public repositories in the order that they were created. + * + * Note: + * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. + */ + "repos/list-public": { + parameters: { + query: { + /** A repository ID. Only return repositories with an ID greater than this ID. */ + since?: components["parameters"]["since-repo"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: { + Link?: string; + }; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Lists all secrets available in an environment 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. */ + "actions/list-environment-secrets": { + parameters: { + path: { + repository_id: components["parameters"]["repository_id"]; + /** The name of the environment */ + environment_name: components["parameters"]["environment_name"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; + } & { + [key: string]: any; + }; + }; + }; + }; + }; + /** Get the public key for an environment, which you need to encrypt environment 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 `secrets` repository permission to use this endpoint. */ + "actions/get-environment-public-key": { + parameters: { + path: { + repository_id: components["parameters"]["repository_id"]; + /** The name of the environment */ + environment_name: components["parameters"]["environment_name"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + /** Gets a single environment 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. */ + "actions/get-environment-secret": { + parameters: { + path: { + repository_id: components["parameters"]["repository_id"]; + /** The name of the environment */ + environment_name: components["parameters"]["environment_name"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + /** + * Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + "actions/create-or-update-environment-secret": { + parameters: { + path: { + repository_id: components["parameters"]["repository_id"]; + /** The name of the environment */ + environment_name: components["parameters"]["environment_name"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** Response when creating a secret */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** Response when updating a secret */ + 204: never; + }; + requestBody: { + content: { + "application/json": { + /** Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint. */ + encrypted_value?: string; + /** ID of the key you used to encrypt the secret. */ + key_id?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Deletes a secret in an environment 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. */ + "actions/delete-environment-secret": { + parameters: { + path: { + repository_id: components["parameters"]["repository_id"]; + /** The name of the environment */ + environment_name: components["parameters"]["environment_name"]; + /** secret_name parameter */ + secret_name: components["parameters"]["secret_name"]; + }; + }; + responses: { + /** Default response */ + 204: never; + }; + }; + /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ + "enterprise-admin/list-provisioned-groups-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + query: { + /** Used for pagination: the index of the first result to return. */ + startIndex?: components["parameters"]["start_index"]; + /** Used for pagination: the number of results to return. */ + count?: components["parameters"]["count"]; + /** filter results */ + filter?: string; + /** attributes to exclude */ + excludedAttributes?: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["scim-group-list-enterprise"]; + }; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. + */ + "enterprise-admin/provision-and-invite-enterprise-group": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["scim-enterprise-group"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The SCIM schema URIs. */ + schemas: string[]; + /** The name of the SCIM group. This must match the GitHub organization that the group maps to. */ + displayName: string; + members?: ({ + /** The SCIM user ID for a user. */ + value: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ + "enterprise-admin/get-provisioning-information-for-enterprise-group": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Identifier generated by the GitHub SCIM endpoint. */ + scim_group_id: components["parameters"]["scim_group_id"]; + }; + query: { + /** Attributes to exclude. */ + excludedAttributes?: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["scim-enterprise-group"]; + }; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + */ + "enterprise-admin/set-information-for-provisioned-enterprise-group": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Identifier generated by the GitHub SCIM endpoint. */ + scim_group_id: components["parameters"]["scim_group_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["scim-enterprise-group"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The SCIM schema URIs. */ + schemas: string[]; + /** The name of the SCIM group. This must match the GitHub organization that the group maps to. */ + displayName: string; + members?: ({ + /** The SCIM user ID for a user. */ + value: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ + "enterprise-admin/delete-scim-group-from-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Identifier generated by the GitHub SCIM endpoint. */ + scim_group_id: components["parameters"]["scim_group_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + */ + "enterprise-admin/update-attribute-for-enterprise-group": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** Identifier generated by the GitHub SCIM endpoint. */ + scim_group_id: components["parameters"]["scim_group_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["scim-enterprise-group"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The SCIM schema URIs. */ + schemas: string[]; + /** Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ + Operations: ({ + op: "add" | "Add" | "remove" | "Remove" | "replace" | "Replace"; + path?: string; + value?: (string | { + [key: string]: any; + } | any[]) & { + [key: string]: any; + }; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Retrieves a paginated list of all provisioned enterprise members, including pending invitations. + * + * When a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member: + * - When a user with a SCIM-provisioned external identity is removed from an enterprise, the account's metadata is preserved to allow the user to re-join the organization in the future. + * - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). + * - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. + * + * The returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO: + * + * 1. The user is granted access by the IdP and is not a member of the GitHub enterprise. + * + * 1. The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account. + * + * 1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub account: + * - If the user signs in, their GitHub account is linked to this entry. + * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. + */ + "enterprise-admin/list-provisioned-identities-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + query: { + /** Used for pagination: the index of the first result to return. */ + startIndex?: components["parameters"]["start_index"]; + /** Used for pagination: the number of results to return. */ + count?: components["parameters"]["count"]; + /** filter results */ + filter?: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["scim-user-list-enterprise"]; + }; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Provision enterprise membership for a user, and send organization invitation emails to the email address. + * + * You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. + */ + "enterprise-admin/provision-and-invite-enterprise-user": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["scim-enterprise-user"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The SCIM schema URIs. */ + schemas: string[]; + /** The username for the user. */ + userName: string; + name: { + /** The first name of the user. */ + givenName: string; + /** The last name of the user. */ + familyName: string; + } & { + [key: string]: any; + }; + /** List of user emails. */ + emails: ({ + /** The email address. */ + value: string; + /** The type of email address. */ + type: string; + /** Whether this email address is the primary address. */ + primary: boolean; + } & { + [key: string]: any; + })[]; + /** List of SCIM group IDs the user is a member of. */ + groups?: ({ + value?: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ + "enterprise-admin/get-provisioning-information-for-enterprise-user": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** scim_user_id parameter */ + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["scim-enterprise-user"]; + }; + }; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-an-enterprise-scim-user) endpoint instead. + * + * You must at least provide the required values for the user: `userName`, `name`, and `emails`. + * + * **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. + */ + "enterprise-admin/set-information-for-provisioned-enterprise-user": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** scim_user_id parameter */ + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["scim-enterprise-user"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The SCIM schema URIs. */ + schemas: string[]; + /** The username for the user. */ + userName: string; + name: { + /** The first name of the user. */ + givenName: string; + /** The last name of the user. */ + familyName: string; + } & { + [key: string]: any; + }; + /** List of user emails. */ + emails: ({ + /** The email address. */ + value: string; + /** The type of email address. */ + type: string; + /** Whether this email address is the primary address. */ + primary: boolean; + } & { + [key: string]: any; + })[]; + /** List of SCIM group IDs the user is a member of. */ + groups?: ({ + value?: string; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. */ + "enterprise-admin/delete-user-from-enterprise": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** scim_user_id parameter */ + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + * + * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + * + * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * **Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated `:scim_user_id`. + * + * ``` + * { + * "Operations":[{ + * "op":"replace", + * "value":{ + * "active":false + * } + * }] + * } + * ``` + */ + "enterprise-admin/update-attribute-for-enterprise-user": { + parameters: { + path: { + /** The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** scim_user_id parameter */ + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["scim-enterprise-user"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The SCIM schema URIs. */ + schemas: string[]; + /** Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). */ + Operations: { + [key: string]: any; + }[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. + * + * When a user with a SAML-provisioned external identity leaves (or is removed from) an organization, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member: + * - When a user with a SCIM-provisioned external identity is removed from an organization, the account's metadata is preserved to allow the user to re-join the organization in the future. + * - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). + * - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. + * + * The returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO: + * + * 1. The user is granted access by the IdP and is not a member of the GitHub organization. + * + * 1. The user attempts to access the GitHub organization and initiates the SAML SSO process, and is not currently signed in to their GitHub account. + * + * 1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub account: + * - If the user signs in, their GitHub account is linked to this entry. + * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity `null` entry remains in place. + */ + "scim/list-provisioned-identities": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + query: { + /** Used for pagination: the index of the first result to return. */ + startIndex?: number; + /** Used for pagination: the number of results to return. */ + count?: number; + /** + * Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: + * + * `?filter=userName%20eq%20\"Octocat\"`. + * + * To filter results for the identity with the email `octocat@github.com`, you would use this query: + * + * `?filter=emails%20eq%20\"octocat@github.com\"`. + */ + filter?: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/scim+json": components["schemas"]["scim-user-list"]; + }; + }; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["scim_bad_request"]; + 403: components["responses"]["scim_forbidden"]; + 404: components["responses"]["scim_not_found"]; + }; + }; + /** Provision organization membership for a user, and send an activation email to the email address. */ + "scim/provision-and-invite-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/scim+json": components["schemas"]["scim-user"]; + }; + }; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["scim_bad_request"]; + 403: components["responses"]["scim_forbidden"]; + 404: components["responses"]["scim_not_found"]; + 409: components["responses"]["scim_conflict"]; + 500: components["responses"]["scim_internal_error"]; + }; + requestBody: { + content: { + "application/json": { + /** Configured by the admin. Could be an email, login, or username */ + userName: string; + /** The name of the user, suitable for display to end-users */ + displayName?: string; + name: { + givenName: string; + familyName: string; + formatted?: string; + } & { + [key: string]: any; + }; + /** user emails */ + emails: ({ + value: string; + primary?: boolean; + type?: string; + } & { + [key: string]: any; + })[]; + schemas?: string[]; + externalId?: string; + groups?: string[]; + active?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + "scim/get-provisioning-information-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** scim_user_id parameter */ + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/scim+json": components["schemas"]["scim-user"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["scim_forbidden"]; + 404: components["responses"]["scim_not_found"]; + }; + }; + /** + * Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user) endpoint instead. + * + * You must at least provide the required values for the user: `userName`, `name`, and `emails`. + * + * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. + */ + "scim/set-information-for-provisioned-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** scim_user_id parameter */ + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/scim+json": components["schemas"]["scim-user"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["scim_forbidden"]; + 404: components["responses"]["scim_not_found"]; + }; + requestBody: { + content: { + "application/json": { + schemas?: string[]; + /** The name of the user, suitable for display to end-users */ + displayName?: string; + externalId?: string; + groups?: string[]; + active?: boolean; + /** Configured by the admin. Could be an email, login, or username */ + userName: string; + name: { + givenName: string; + familyName: string; + formatted?: string; + } & { + [key: string]: any; + }; + /** user emails */ + emails: ({ + type?: string; + value: string; + primary?: boolean; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + "scim/delete-user-from-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** scim_user_id parameter */ + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["scim_forbidden"]; + 404: components["responses"]["scim_not_found"]; + }; + }; + /** + * Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + * + * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * **Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`. + * + * ``` + * { + * "Operations":[{ + * "op":"replace", + * "value":{ + * "active":false + * } + * }] + * } + * ``` + */ + "scim/update-attribute-for-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** scim_user_id parameter */ + scim_user_id: components["parameters"]["scim_user_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/scim+json": components["schemas"]["scim-user"]; + }; + }; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["scim_bad_request"]; + 403: components["responses"]["scim_forbidden"]; + 404: components["responses"]["scim_not_found"]; + /** Response */ + 429: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + schemas?: string[]; + /** Set of operations to be performed */ + Operations: ({ + op: "add" | "remove" | "replace"; + path?: string; + value?: (({ + active?: boolean | null; + userName?: string | null; + externalId?: string | null; + givenName?: string | null; + familyName?: string | null; + } & { + [key: string]: any; + }) | ({ + value?: string; + primary?: boolean; + } & { + [key: string]: any; + })[] | string) & { + [key: string]: any; + }; + } & { + [key: string]: any; + })[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: + * + * `q=addClass+in:file+language:js+repo:jquery/jquery` + * + * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. + * + * #### Considerations for code search + * + * Due to the complexity of searching code, there are a few restrictions on how searches are performed: + * + * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. + * * Only files smaller than 384 KB are searchable. + * * 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 + * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. + */ + "search/code": { + parameters: { + query: { + /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://help.github.com/articles/searching-code/)" for a detailed list of qualifiers. */ + q: string; + /** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + sort?: "indexed"; + /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ + order?: components["parameters"]["order"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["code-search-result-item"][]; + } & { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * 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 + * metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: + * + * `q=repo:octocat/Spoon-Knife+css` + */ + "search/commits": { + parameters: { + query: { + /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://help.github.com/articles/searching-commits/)" for a detailed list of qualifiers. */ + q: string; + /** Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + sort?: "author-date" | "committer-date"; + /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ + order?: components["parameters"]["order"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["commit-search-result-item"][]; + } & { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** + * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted + * search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. + * + * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + * + * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. + * + * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + */ + "search/issues-and-pull-requests": { + parameters: { + query: { + /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. */ + q: string; + /** Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; + /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ + order?: components["parameters"]["order"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["issue-search-result-item"][]; + } & { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: + * + * `q=bug+defect+enhancement&repository_id=64778136` + * + * The labels that best match the query appear first in the search results. + */ + "search/labels": { + parameters: { + query: { + /** The id of the repository. */ + repository_id: number; + /** The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ + q: string; + /** Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + sort?: "created" | "updated"; + /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ + order?: components["parameters"]["order"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["label-search-result-item"][]; + } & { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: + * + * `q=tetris+language:assembly&sort=stars&order=desc` + * + * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + * + * When you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this: + * + * `q=topic:ruby+topic:rails` + */ + "search/repos": { + parameters: { + query: { + /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ + q: string; + /** Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ + order?: components["parameters"]["order"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["repo-search-result-item"][]; + } & { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://help.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + * + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: + * + * `q=ruby+is:featured` + * + * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + */ + "search/topics": { + parameters: { + query: { + /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). */ + q: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["topic-search-result-item"][]; + } & { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** + * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you're looking for a list of popular users, you might try this query: + * + * `q=tom+repos:%3E42+followers:%3E1000` + * + * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + */ + "search/users": { + parameters: { + query: { + /** The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://help.github.com/articles/searching-users/)" for a detailed list of qualifiers. */ + q: string; + /** Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) */ + sort?: "followers" | "repositories" | "joined"; + /** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ + order?: components["parameters"]["order"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["user-search-result-item"][]; + } & { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint. */ + "teams/get-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-full"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint. + * + * To delete a team, the authenticated user must be an organization owner or team maintainer. + * + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + */ + "teams/delete-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint. + * + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * + * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + */ + "teams/update-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-full"]; + }; + }; + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["team-full"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The name of the team. */ + name: string; + /** The description of the team. */ + description?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** The ID of a team to set as the parent team. */ + parent_team_id?: number | null; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint. + * + * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/list-discussions-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + query: { + /** One of `asc` (ascending) or `desc` (descending). */ + direction?: components["parameters"]["direction"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["team-discussion"][]; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint. + * + * 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/). + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "teams/create-discussion-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The discussion post's title. */ + title: string; + /** The discussion post's body text. */ + body: string; + /** Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. */ + private?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint. + * + * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/get-discussion-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint. + * + * Delete a discussion from 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/). + */ + "teams/delete-discussion-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint. + * + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/update-discussion-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-discussion"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The discussion post's title. */ + title?: string; + /** The discussion post's body text. */ + body?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint. + * + * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/list-discussion-comments-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + query: { + /** One of `asc` (ascending) or `desc` (descending). */ + direction?: components["parameters"]["direction"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["team-discussion-comment"][]; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint. + * + * 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/). + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + "teams/create-discussion-comment-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The discussion comment's body text. */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint. + * + * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/get-discussion-comment-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint. + * + * Deletes a 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/). + */ + "teams/delete-discussion-comment-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint. + * + * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "teams/update-discussion-comment-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-discussion-comment"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The discussion comment's body text. */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * + * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "reactions/list-for-team-discussion-comment-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + query: { + /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["reaction"][]; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + */ + "reactions/create-for-team-discussion-comment-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + comment_number: components["parameters"]["comment-number"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint. + * + * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + "reactions/list-for-team-discussion-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + query: { + /** Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["reaction"][]; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint. + * + * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + */ + "reactions/create-for-team-discussion-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + discussion_number: components["parameters"]["discussion-number"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["reaction"]; + }; + }; + }; + requestBody: { + content: { + "application/json": { + /** The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint. + * + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + */ + "teams/list-pending-invitations-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["organization-invitation"][]; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint. + * + * Team members will include the members of child teams. + */ + "teams/list-members-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + query: { + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * The "Get team member" endpoint (described below) is deprecated. + * + * We recommend using the [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * + * To list members in a team, the team must be visible to the authenticated user. + */ + "teams/get-member-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** if user is a member */ + 204: never; + /** if user is not a member */ + 404: unknown; + }; + }; + /** + * The "Add team member" endpoint (described below) is deprecated. + * + * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + "teams/add-member-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + 403: components["responses"]["forbidden"]; + /** Not Found if team synchronization is set up */ + 404: unknown; + /** Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ + 422: unknown; + }; + }; + /** + * The "Remove team member" endpoint (described below) is deprecated. + * + * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + */ + "teams/remove-member-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + /** Not Found if team synchronization is setup */ + 404: unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint. + * + * Team members will include the members of child teams. + * + * To get a user's membership with a team, the team must be visible to the authenticated user. + * + * **Note:** + * The response contains the `state` of the membership and the member's `role`. + * + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). + */ + "teams/get-membership-for-user-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-membership"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. + * + * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + */ + "teams/add-or-update-membership-for-user-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-membership"]; + }; + }; + /** Forbidden if team synchronization is set up */ + 403: unknown; + 404: components["responses"]["not_found"]; + /** Unprocessable Entity if you attempt to add an organization to a team */ + 422: unknown; + }; + requestBody: { + content: { + "application/json": { + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + */ + "teams/remove-membership-for-user-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + /** if team synchronization is set up */ + 403: unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint. + * + * Lists the organization projects for a team. + */ + "teams/list-projects-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["team-project"][]; + }; + }; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint. + * + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + */ + "teams/check-permissions-for-project-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["team-project"]; + }; + }; + /** Not Found if project is not managed by this team */ + 404: unknown; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint. + * + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + */ + "teams/add-or-update-project-permissions-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + /** Forbidden if the project is not owned by the organization */ + 403: { + content: { + "application/json": { + message?: string; + documentation_url?: string; + } & { + [key: string]: any; + }; + }; + }; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + permission?: "read" | "write" | "admin"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint. + * + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + */ + "teams/remove-project-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + project_id: components["parameters"]["project-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint. */ + "teams/list-repos-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * **Note**: Repositories inherited through a parent team will also be checked. + * + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint. + * + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + "teams/check-permissions-for-repo-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Alternative response with extra repository information */ + 200: { + content: { + "application/json": components["schemas"]["team-repository"]; + }; + }; + /** Response if repository is managed by this team */ + 204: never; + /** Not Found if repository is not managed by this team */ + 404: unknown; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)" endpoint. + * + * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. + * + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + "teams/add-or-update-repo-permissions-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + */ + permission?: "pull" | "push" | "admin"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint. + * + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + */ + "teams/remove-repo-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * List IdP groups connected to a team on GitHub. + */ + "teams/list-idp-groups-for-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["group-mapping"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections) endpoint. + * + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. + */ + "teams/create-or-update-idp-group-connections-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["group-mapping"]; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. */ + groups: ({ + /** ID of the IdP group. */ + group_id: string; + /** Name of the IdP group. */ + group_name: string; + /** Description of the IdP group. */ + group_description: string; + id?: string; + name?: string; + description?: string; + } & { + [key: string]: any; + })[]; + synced_at?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint. */ + "teams/list-child-legacy": { + parameters: { + path: { + team_id: components["parameters"]["team-id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** if child teams exist */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["team"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. + * + * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + */ + "users/get-authenticated": { + parameters: {}; + responses: { + /** Response */ + 200: { + content: { + "application/json": (components["schemas"]["private-user"] | components["schemas"]["public-user"]) & { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ + "users/update-authenticated": { + parameters: {}; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["private-user"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The new name of the user. */ + name?: string; + /** The publicly visible email address of the user. */ + email?: string; + /** The new blog URL of the user. */ + blog?: string; + /** The new Twitter username of the user. */ + twitter_username?: string | null; + /** The new company of the user. */ + company?: string; + /** The new location of the user. */ + location?: string; + /** The new hiring availability of the user. */ + hireable?: boolean; + /** The new short biography of the user. */ + bio?: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** List the users you've blocked on your personal account. */ + "users/list-blocked-by-authenticated": { + parameters: {}; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + "users/check-blocked": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** If the user is blocked: */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + /** If the user is not blocked: */ + 404: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "users/block": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "users/unblock": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Sets the visibility for your primary email addresses. */ + "users/set-primary-email-visibility-for-authenticated": { + parameters: {}; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["email"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** An email address associated with the GitHub user account to manage. */ + email?: string; + /** Denotes whether an email is publically visible. */ + visibility: "public" | "private"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. */ + "users/list-emails-for-authenticated": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["email"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** This endpoint is accessible with the `user` scope. */ + "users/add-email-for-authenticated": { + parameters: {}; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["email"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. */ + emails: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** This endpoint is accessible with the `user` scope. */ + "users/delete-email-for-authenticated": { + parameters: {}; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": ({ + /** Email addresses associated with the GitHub user account. */ + emails: string[]; + } & { + [key: string]: any; + }) & { + [key: string]: any; + }; + }; + }; + }; + /** Lists the people following the authenticated user. */ + "users/list-followers-for-authenticated-user": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** Lists the people who the authenticated user follows. */ + "users/list-followed-by-authenticated": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "users/check-person-is-followed-by-authenticated": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** if the person is followed by the authenticated user */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + /** if the person is not followed by the authenticated user */ + 404: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + /** + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + */ + "users/follow": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ + "users/unfollow": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + "users/list-gpg-keys-for-authenticated": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["gpg-key"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + "users/create-gpg-key-for-authenticated": { + parameters: {}; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["gpg-key"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** A GPG key in ASCII-armored format. */ + armored_public_key: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + "users/get-gpg-key-for-authenticated": { + parameters: { + path: { + /** gpg_key_id parameter */ + gpg_key_id: components["parameters"]["gpg_key_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["gpg-key"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + "users/delete-gpg-key-for-authenticated": { + parameters: { + path: { + /** gpg_key_id parameter */ + gpg_key_id: components["parameters"]["gpg_key_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. + * + * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * + * You can find the permissions for the installation under the `permissions` key. + */ + "apps/list-installations-for-authenticated-user": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** You can find the permissions for the installation under the `permissions` key. */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + installations: components["schemas"]["installation"][]; + } & { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 415: components["responses"]["preview_header_missing"]; + }; + }; + /** + * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * + * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. + * + * The access the user has to each repository is included in the hash under the `permissions` key. + */ + "apps/list-installation-repos-for-authenticated-user": { + parameters: { + path: { + /** installation_id parameter */ + installation_id: components["parameters"]["installation_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** The access the user has to each repository is included in the hash under the `permissions` key. */ + 200: { + headers: {}; + content: { + "application/json": { + total_count: number; + repository_selection?: string; + repositories: components["schemas"]["repository"][]; + } & { + [key: string]: any; + }; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + */ + "apps/add-repo-to-installation": { + parameters: { + path: { + /** installation_id parameter */ + installation_id: components["parameters"]["installation_id"]; + repository_id: components["parameters"]["repository_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Remove a single repository from an installation. The authenticated user must have admin access to the repository. + * + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + */ + "apps/remove-repo-from-installation": { + parameters: { + path: { + /** installation_id parameter */ + installation_id: components["parameters"]["installation_id"]; + repository_id: components["parameters"]["repository_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ + "interactions/get-restrictions-for-authenticated-user": { + responses: { + /** Default response */ + 200: { + content: { + "application/json": (Partial & Partial<{ + [key: string]: any; + }>) & { + [key: string]: any; + }; + }; + }; + /** Response when there are no restrictions */ + 204: never; + }; + }; + /** Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ + "interactions/set-restrictions-for-authenticated-user": { + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["interaction-limit-response"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": components["schemas"]["interaction-limit"]; + }; + }; + }; + /** Removes any interaction restrictions from your public repositories. */ + "interactions/remove-restrictions-for-authenticated-user": { + responses: { + /** Response */ + 204: never; + }; + }; + /** + * List issues across owned and member repositories assigned to the authenticated user. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + "issues/list-for-authenticated-user": { + parameters: { + query: { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + /** Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. */ + state?: "open" | "closed" | "all"; + /** A list of comma separated label names. Example: `bug,ui,@high` */ + labels?: components["parameters"]["labels"]; + /** What to sort results by. Can be either `created`, `updated`, `comments`. */ + sort?: "created" | "updated" | "comments"; + /** One of `asc` (ascending) or `desc` (descending). */ + direction?: components["parameters"]["direction"]; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + "users/list-public-ssh-keys-for-authenticated": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["key"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + "users/create-public-ssh-key-for-authenticated": { + parameters: {}; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["key"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** A descriptive name for the new key. */ + title?: string; + /** The public SSH key to add to your GitHub account. */ + key: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + "users/get-public-ssh-key-for-authenticated": { + parameters: { + path: { + /** key_id parameter */ + key_id: components["parameters"]["key_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["key"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + "users/delete-public-ssh-key-for-authenticated": { + parameters: { + path: { + /** key_id parameter */ + key_id: components["parameters"]["key_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ + "apps/list-subscriptions-for-authenticated-user": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["user-marketplace-purchase"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). */ + "apps/list-subscriptions-for-authenticated-user-stubbed": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["user-marketplace-purchase"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + }; + }; + "orgs/list-memberships-for-authenticated-user": { + parameters: { + query: { + /** Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. */ + state?: "active" | "pending"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["org-membership"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/get-membership-for-authenticated-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["org-membership"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/update-membership-for-authenticated-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["org-membership"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The state that the membership should be in. Only `"active"` will be accepted. */ + state: "active"; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists all migrations a user has started. */ + "migrations/list-for-authenticated-user": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["migration"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** Initiates the generation of a user migration archive. */ + "migrations/start-for-authenticated-user": { + parameters: {}; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["migration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** Lock the repositories being migrated at the start of the migration */ + lock_repositories?: boolean; + /** Do not include attachments in the migration */ + exclude_attachments?: boolean; + /** Exclude attributes from the API response to improve performance */ + exclude?: "repositories"[]; + repositories: string[]; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: + * + * * `pending` - the migration hasn't started yet. + * * `exporting` - the migration is in progress. + * * `exported` - the migration finished successfully. + * * `failed` - the migration failed. + * + * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). + */ + "migrations/get-status-for-authenticated-user": { + parameters: { + path: { + /** migration_id parameter */ + migration_id: components["parameters"]["migration_id"]; + }; + query: { + exclude?: string[]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["migration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: + * + * * attachments + * * bases + * * commit\_comments + * * issue\_comments + * * issue\_events + * * issues + * * milestones + * * organizations + * * projects + * * protected\_branches + * * pull\_request\_reviews + * * pull\_requests + * * releases + * * repositories + * * review\_comments + * * schema + * * users + * + * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. + */ + "migrations/get-archive-for-authenticated-user": { + parameters: { + path: { + /** migration_id parameter */ + migration_id: components["parameters"]["migration_id"]; + }; + }; + responses: { + /** Response */ + 302: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** 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/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ + "migrations/delete-archive-for-authenticated-user": { + parameters: { + path: { + /** migration_id parameter */ + migration_id: components["parameters"]["migration_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#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/reference/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. */ + "migrations/unlock-repo-for-authenticated-user": { + parameters: { + path: { + /** migration_id parameter */ + migration_id: components["parameters"]["migration_id"]; + /** repo_name parameter */ + repo_name: components["parameters"]["repo_name"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Lists all the repositories for this user migration. */ + "migrations/list-repos-for-user": { + parameters: { + path: { + /** migration_id parameter */ + migration_id: components["parameters"]["migration_id"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * List organizations for the authenticated user. + * + * **OAuth scope requirements** + * + * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + */ + "orgs/list-for-authenticated-user": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** + * Gets a specific package for a package owned by the authenticated user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/get-package-for-authenticated-user": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["package"]; + }; + }; + }; + }; + /** + * 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. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/delete-package-for-authenticated-user": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + }; + }; + responses: { + /** Response */ + 204: never; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Restores a package owned by the authenticated user. + * + * You can restore a deleted package under the following conditions: + * - The package was deleted within the last 30 days. + * - 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. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scope. If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/restore-package-for-authenticated-user": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + }; + query: { + /** package token */ + token?: string; + }; + }; + responses: { + /** Response */ + 204: never; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Returns all package versions for a package owned by the authenticated user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + }; + query: { + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** The state of the package, either active or deleted. */ + state?: "active" | "deleted"; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["package-version"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Gets a specific package version for a package owned by the authenticated user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/get-package-version-for-authenticated-user": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + /** Unique identifier of the package version. */ + package_version_id: components["parameters"]["package_version_id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["package-version"]; + }; + }; + }; + }; + /** + * 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/delete-package-version-for-authenticated-user": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + /** Unique identifier of the package version. */ + package_version_id: components["parameters"]["package_version_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Restores a package version owned by the authenticated user. + * + * You can restore a deleted package version under the following conditions: + * - The package was deleted within the last 30 days. + * - 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. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scope. If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/restore-package-version-for-authenticated-user": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + /** Unique identifier of the package version. */ + package_version_id: components["parameters"]["package_version_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "projects/create-for-authenticated-user": { + parameters: {}; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["project"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed_simple"]; + }; + requestBody: { + content: { + "application/json": { + /** Name of the project */ + name: string; + /** Body of the project */ + body?: string | null; + } & { + [key: string]: any; + }; + }; + }; + }; + /** Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ + "users/list-public-emails-for-authenticated": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["email"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + */ + "repos/list-for-authenticated-user": { + parameters: { + query: { + /** Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`. */ + visibility?: "all" | "public" | "private"; + /** + * Comma-separated list of values. Can include: + * \* `owner`: Repositories that are owned by the authenticated user. + * \* `collaborator`: Repositories that the user has been added to as a collaborator. + * \* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. + */ + affiliation?: string; + /** + * Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` + * + * Will cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. + */ + type?: "all" | "owner" | "public" | "private" | "member"; + /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` */ + direction?: "asc" | "desc"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + before?: components["parameters"]["before"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["repository"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Creates a new repository for the authenticated user. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. + * * `repo` scope to create a private repository. + */ + "repos/create-for-authenticated-user": { + parameters: {}; + responses: { + /** Response */ + 201: { + headers: { + Location?: string; + }; + content: { + "application/json": components["schemas"]["repository"]; + }; + }; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The name of the repository. */ + name: string; + /** A short description of the repository. */ + description?: string; + /** A URL with more information about the repository. */ + homepage?: string; + /** Whether the repository is private. */ + private?: boolean; + /** Whether issues are enabled. */ + has_issues?: boolean; + /** Whether projects are enabled. */ + has_projects?: boolean; + /** Whether the wiki is enabled. */ + has_wiki?: boolean; + /** The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ + team_id?: number; + /** Whether the repository is initialized with a minimal README. */ + auto_init?: boolean; + /** The desired language or platform to apply to the .gitignore. */ + gitignore_template?: string; + /** The license keyword of the open source license for this repository. */ + license_template?: string; + /** Whether to allow squash merges for pull requests. */ + allow_squash_merge?: boolean; + /** Whether to allow merge commits for pull requests. */ + allow_merge_commit?: boolean; + /** Whether to allow rebase merges for pull requests. */ + allow_rebase_merge?: boolean; + /** Whether to delete head branches when pull requests are merged */ + delete_branch_on_merge?: boolean; + /** Whether downloads are enabled. */ + has_downloads?: boolean; + /** Whether this repository acts as a template that can be used to generate new repositories. */ + is_template?: boolean; + } & { + [key: string]: any; + }; + }; + }; + }; + /** When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ + "repos/list-invitations-for-authenticated-user": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["repository-invitation"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "repos/decline-invitation": { + parameters: { + path: { + /** invitation_id parameter */ + invitation_id: components["parameters"]["invitation_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "repos/accept-invitation": { + parameters: { + path: { + /** invitation_id parameter */ + invitation_id: components["parameters"]["invitation_id"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Lists repositories the authenticated user has starred. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + "activity/list-repos-starred-by-authenticated-user": { + parameters: { + query: { + /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ + sort?: components["parameters"]["sort"]; + /** One of `asc` (ascending) or `desc` (descending). */ + direction?: components["parameters"]["direction"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["repository"][]; + "application/vnd.github.v3.star+json": components["schemas"]["starred-repository"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "activity/check-repo-is-starred-by-authenticated-user": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response if this repository is starred by you */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + /** Not Found if this repository is not starred by you */ + 404: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + /** Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." */ + "activity/star-repo-for-authenticated-user": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "activity/unstar-repo-for-authenticated-user": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** Response */ + 204: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** Lists repositories the authenticated user is watching. */ + "activity/list-watched-repos-for-authenticated-user": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + /** 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/). */ + "teams/list-for-authenticated-user": { + parameters: { + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["team-full"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. + * + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. + */ + "users/list": { + parameters: { + query: { + /** A user ID. Only return users with an ID greater than this ID. */ + since?: components["parameters"]["since-user"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: { + Link?: string; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + 304: components["responses"]["not_modified"]; + }; + }; + /** + * Provides publicly available information about someone with a GitHub account. + * + * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". + */ + "users/get-by-username": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": (components["schemas"]["private-user"] | components["schemas"]["public-user"]) & { + [key: string]: any; + }; + }; + }; + 202: components["responses"]["accepted"]; + 404: components["responses"]["not_found"]; + }; + }; + /** If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ + "activity/list-events-for-authenticated-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + /** This is the user's organization dashboard. You must be authenticated as the user to view this. */ + "activity/list-org-events-for-authenticated-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + org: components["parameters"]["org"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + "activity/list-public-events-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + /** Lists the people following the specified user. */ + "users/list-followers-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + /** Lists the people who the specified user follows. */ + "users/list-following-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "users/check-following-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + target_user: string; + }; + }; + responses: { + /** if the user follows the target user */ + 204: never; + /** if the user does not follow the target user */ + 404: unknown; + }; + }; + /** Lists public gists for the specified user: */ + "gists/list-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["base-gist"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + }; + /** Lists the GPG keys for a user. This information is accessible by anyone. */ + "users/list-gpg-keys-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["gpg-key"][]; + }; + }; + }; + }; + /** + * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + * + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: + * + * ```shell + * curl -u username:token + * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 + * ``` + */ + "users/get-context-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. */ + subject_type?: "organization" | "repository" | "issue" | "pull_request"; + /** Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ + subject_id?: string; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["hovercard"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Enables an authenticated GitHub App to find the user’s installation information. + * + * 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. + */ + "apps/get-user-installation": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["installation"]; + }; + }; + }; + }; + /** Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ + "users/list-public-keys-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["key-simple"][]; + }; + }; + }; + }; + /** + * List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. + * + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. + */ + "orgs/list-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + /** + * Gets a specific package metadata for a public package owned by a user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/get-package-for-user": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["package"]; + }; + }; + }; + }; + /** + * Returns all package versions for a public package owned by a specified user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/get-all-package-versions-for-package-owned-by-user": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["package-version"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Gets a specific package version for a public package owned by a specified user. + * + * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + "packages/get-package-version-for-user": { + parameters: { + path: { + /** The type of supported package. Can be one of `npm`, `maven`, `rubygems`, `nuget`, `docker`, or `container`. For Docker images that use the package namespace `https://ghcr.io/owner/package-name`, use `container`. */ + package_type: components["parameters"]["package_type"]; + /** The name of the package. */ + package_name: components["parameters"]["package_name"]; + /** Unique identifier of the package version. */ + package_version_id: components["parameters"]["package_version_id"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["package-version"]; + }; + }; + }; + }; + "projects/list-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. */ + state?: "open" | "closed" | "all"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["project"][]; + }; + }; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ + "activity/list-received-events-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + "activity/list-received-public-events-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["event"][]; + }; + }; + }; + }; + /** Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. */ + "repos/list-for-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Can be one of `all`, `owner`, `member`. */ + type?: "all" | "owner" | "member"; + /** Can be one of `created`, `updated`, `pushed`, `full_name`. */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` */ + direction?: "asc" | "desc"; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * Access tokens must have the `user` scope. + */ + "billing/get-github-actions-billing-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["actions-billing-usage"]; + }; + }; + }; + }; + /** + * Gets the free and paid storage used for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `user` scope. + */ + "billing/get-github-packages-billing-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["packages-billing-usage"]; + }; + }; + }; + }; + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `user` scope. + */ + "billing/get-shared-storage-billing-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["combined-billing-usage"]; + }; + }; + }; + }; + /** + * Lists repositories a user has starred. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + "activity/list-repos-starred-by-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** One of `created` (when the repository was starred) or `updated` (when it was last pushed to). */ + sort?: components["parameters"]["sort"]; + /** One of `asc` (ascending) or `desc` (descending). */ + direction?: components["parameters"]["direction"]; + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": (Partial & Partial) & { + [key: string]: any; + }; + }; + }; + }; + }; + /** Lists repositories a user is watching. */ + "activity/list-repos-watched-by-user": { + parameters: { + path: { + username: components["parameters"]["username"]; + }; + query: { + /** Results per page (max 100). */ + per_page?: components["parameters"]["per_page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + headers: {}; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + /** Get a random sentence from the Zen of GitHub */ + "meta/get-zen": { + responses: { + /** Response */ + 200: { + content: { + "text/plain": string; + }; + }; + }; + }; + /** + * **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. + * + * The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. 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. + * + * The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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. + * + * **Working with large comparisons** + * + * To process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)." + * + * When calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + "repos/compare-commits": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + base: string; + head: string; + }; + query: { + /** Results per page (max 100) */ + per_page?: components["parameters"]["per-page"]; + /** Page number of the results to fetch. */ + page?: components["parameters"]["page"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["commit-comparison"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. + * + * The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + "apps/create-content-attachment-for-repo": { + parameters: { + path: { + /** The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event. */ + owner: string; + /** The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event. */ + repo: string; + /** The `id` of the `content_reference` event. */ + content_reference_id: number; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["content-reference-attachment"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The title of the attachment */ + title: string; + /** The body of the attachment */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; + /** + * **Deprecated:** use `apps.createContentAttachmentForRepo()` (`POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments`) instead. Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. + * + * The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + "apps/create-content-attachment": { + parameters: { + path: { + content_reference_id: number; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["content-reference-attachment"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 415: components["responses"]["preview_header_missing"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** The title of the attachment */ + title: string; + /** The body of the attachment */ + body: string; + } & { + [key: string]: any; + }; + }; + }; + }; +} diff --git a/node_modules/@octokit/openapi-types/dist-types/index.d.ts b/node_modules/@octokit/openapi-types/dist-types/index.d.ts new file mode 100644 index 00000000..5d080663 --- /dev/null +++ b/node_modules/@octokit/openapi-types/dist-types/index.d.ts @@ -0,0 +1,2 @@ +export * from "./generated/types"; +export * from "./version"; diff --git a/node_modules/@octokit/openapi-types/dist-types/version.d.ts b/node_modules/@octokit/openapi-types/dist-types/version.d.ts new file mode 100644 index 00000000..1e15d110 --- /dev/null +++ b/node_modules/@octokit/openapi-types/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "7.2.1"; diff --git a/node_modules/@octokit/openapi-types/dist-web/index.js b/node_modules/@octokit/openapi-types/dist-web/index.js new file mode 100644 index 00000000..999749e9 --- /dev/null +++ b/node_modules/@octokit/openapi-types/dist-web/index.js @@ -0,0 +1,4 @@ +const VERSION = "7.2.1"; + +export { VERSION }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/openapi-types/dist-web/index.js.map b/node_modules/@octokit/openapi-types/dist-web/index.js.map new file mode 100644 index 00000000..fac4017c --- /dev/null +++ b/node_modules/@octokit/openapi-types/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js"],"sourcesContent":["export const VERSION = \"7.2.1\";\n"],"names":[],"mappings":"AAAY,MAAC,OAAO,GAAG;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/openapi-types/package.json b/node_modules/@octokit/openapi-types/package.json new file mode 100644 index 00000000..ac3e505e --- /dev/null +++ b/node_modules/@octokit/openapi-types/package.json @@ -0,0 +1,36 @@ +{ + "name": "@octokit/openapi-types", + "description": "Generated TypeScript definitions based on GitHub's OpenAPI spec", + "version": "7.2.1", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [], + "repository": "github:octokit/openapi-types.ts", + "dependencies": {}, + "devDependencies": { + "@octokit/tsconfig": "^1.0.2", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.2", + "@pika/plugin-build-web": "^0.9.2", + "@pika/plugin-ts-standard-pkg": "^0.9.2", + "openapi-typescript": "^3.0.3", + "pika-plugin-merge-properties": "^1.0.6", + "semantic-release-plugin-update-version-in-files": "^1.1.0", + "typescript": "^4.1.5" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "octokit": { + "openapi-version": "2.21.1" + }, + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/plugin-paginate-rest/LICENSE b/node_modules/@octokit/plugin-paginate-rest/LICENSE new file mode 100644 index 00000000..57bee5f1 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/LICENSE @@ -0,0 +1,7 @@ +MIT License Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/@octokit/plugin-paginate-rest/README.md b/node_modules/@octokit/plugin-paginate-rest/README.md new file mode 100644 index 00000000..b158deec --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/README.md @@ -0,0 +1,270 @@ +# plugin-paginate-rest.js + +> Octokit plugin to paginate REST API endpoint responses + +[![@latest](https://img.shields.io/npm/v/@octokit/plugin-paginate-rest.svg)](https://www.npmjs.com/package/@octokit/plugin-paginate-rest) +[![Build Status](https://github.com/octokit/plugin-paginate-rest.js/workflows/Test/badge.svg)](https://github.com/octokit/plugin-paginate-rest.js/actions?workflow=Test) + +## Usage + + + + + + +
+Browsers + + +Load `@octokit/plugin-paginate-rest` and [`@octokit/core`](https://github.com/octokit/core.js) (or core-compatible module) directly from [cdn.skypack.dev](https://cdn.skypack.dev) + +```html + +``` + +
+Node + + +Install with `npm install @octokit/core @octokit/plugin-paginate-rest`. Optionally replace `@octokit/core` with a core-compatible module + +```js +const { Octokit } = require("@octokit/core"); +const { + paginateRest, + composePaginateRest, +} = require("@octokit/plugin-paginate-rest"); +``` + +
+ +```js +const MyOctokit = Octokit.plugin(paginateRest); +const octokit = new MyOctokit({ auth: "secret123" }); + +// See https://developer.github.com/v3/issues/#list-issues-for-a-repository +const issues = await octokit.paginate("GET /repos/{owner}/{repo}/issues", { + owner: "octocat", + repo: "hello-world", + since: "2010-10-01", + per_page: 100, +}); +``` + +If you want to utilize the pagination methods in another plugin, use `composePaginateRest`. + +```js +function myPlugin(octokit, options) { + return { + allStars({owner, repo}) => { + return composePaginateRest( + octokit, + "GET /repos/{owner}/{repo}/stargazers", + {owner, repo } + ) + } + } +} +``` + +## `octokit.paginate()` + +The `paginateRest` plugin adds a new `octokit.paginate()` method which accepts the same parameters as [`octokit.request`](https://github.com/octokit/request.js#request). Only "List ..." endpoints such as [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) are supporting pagination. Their [response includes a Link header](https://developer.github.com/v3/issues/#response-1). For other endpoints, `octokit.paginate()` behaves the same as `octokit.request()`. + +The `per_page` parameter is usually defaulting to `30`, and can be set to up to `100`, which helps retrieving a big amount of data without hitting the rate limits too soon. + +An optional `mapFunction` can be passed to map each page response to a new value, usually an array with only the data you need. This can help to reduce memory usage, as only the relevant data has to be kept in memory until the pagination is complete. + +```js +const issueTitles = await octokit.paginate( + "GET /repos/{owner}/{repo}/issues", + { + owner: "octocat", + repo: "hello-world", + since: "2010-10-01", + per_page: 100, + }, + (response) => response.data.map((issue) => issue.title) +); +``` + +The `mapFunction` gets a 2nd argument `done` which can be called to end the pagination early. + +```js +const issues = await octokit.paginate( + "GET /repos/{owner}/{repo}/issues", + { + owner: "octocat", + repo: "hello-world", + since: "2010-10-01", + per_page: 100, + }, + (response, done) => { + if (response.data.find((issues) => issue.title.includes("something"))) { + done(); + } + return response.data; + } +); +``` + +Alternatively you can pass a `request` method as first argument. This is great when using in combination with [`@octokit/plugin-rest-endpoint-methods`](https://github.com/octokit/plugin-rest-endpoint-methods.js/): + +```js +const issues = await octokit.paginate(octokit.issues.listForRepo, { + owner: "octocat", + repo: "hello-world", + since: "2010-10-01", + per_page: 100, +}); +``` + +## `octokit.paginate.iterator()` + +If your target runtime environments supports async iterators (such as most modern browsers and Node 10+), you can iterate through each response + +```js +const parameters = { + owner: "octocat", + repo: "hello-world", + since: "2010-10-01", + per_page: 100, +}; +for await (const response of octokit.paginate.iterator( + "GET /repos/{owner}/{repo}/issues", + parameters +)) { + // do whatever you want with each response, break out of the loop, etc. + const issues = response.data; + console.log("%d issues found", issues.length); +} +``` + +Alternatively you can pass a `request` method as first argument. This is great when using in combination with [`@octokit/plugin-rest-endpoint-methods`](https://github.com/octokit/plugin-rest-endpoint-methods.js/): + +```js +const parameters = { + owner: "octocat", + repo: "hello-world", + since: "2010-10-01", + per_page: 100, +}; +for await (const response of octokit.paginate.iterator( + octokit.issues.listForRepo, + parameters +)) { + // do whatever you want with each response, break out of the loop, etc. + const issues = response.data; + console.log("%d issues found", issues.length); +} +``` + +## `composePaginateRest` and `composePaginateRest.iterator` + +The `compose*` methods work just like their `octokit.*` counterparts described above, with the differenct that both methods require an `octokit` instance to be passed as first argument + +## How it works + +`octokit.paginate()` wraps `octokit.request()`. As long as a `rel="next"` link value is present in the response's `Link` header, it sends another request for that URL, and so on. + +Most of GitHub's paginating REST API endpoints return an array, but there are a few exceptions which return an object with a key that includes the items array. For example: + +- [Search repositories](https://developer.github.com/v3/search/#example) (key `items`) +- [List check runs for a specific ref](https://developer.github.com/v3/checks/runs/#response-3) (key: `check_runs`) +- [List check suites for a specific ref](https://developer.github.com/v3/checks/suites/#response-1) (key: `check_suites`) +- [List repositories](https://developer.github.com/v3/apps/installations/#list-repositories) for an installation (key: `repositories`) +- [List installations for a user](https://developer.github.com/v3/apps/installations/#response-1) (key `installations`) + +`octokit.paginate()` is working around these inconsistencies so you don't have to worry about it. + +If a response is lacking the `Link` header, `octokit.paginate()` still resolves with an array, even if the response returns a single object. + +## Types + +The plugin also exposes some types and runtime type guards for TypeScript projects. + + + + + + +
+
+Types + + +```typescript +import { + PaginateInterface, + PaginatingEndpoints, +} from "@octokit/plugin-paginate-rest"; +``` + +
+Guards + + +```typescript +import { isPaginatingEndpoint } from "@octokit/plugin-paginate-rest"; +``` + +
+ +### PaginateInterface + +An `interface` that declares all the overloads of the `.paginate` method. + +### PaginatingEndpoints + +An `interface` which describes all API endpoints supported by the plugin. Some overloads of `.paginate()` method and `composePaginateRest()` function depend on `PaginatingEndpoints`, using the `keyof PaginatingEndpoints` as a type for one of its arguments. + +```typescript +import { Octokit } from "@octokit/core"; +import { + PaginatingEndpoints, + composePaginateRest, +} from "@octokit/plugin-paginate-rest"; + +type DataType = "data" extends keyof T ? T["data"] : unknown; + +async function myPaginatePlugin( + octokit: Octokit, + endpoint: E, + parameters?: PaginatingEndpoints[E]["parameters"] +): Promise> { + return await composePaginateRest(octokit, endpoint, parameters); +} +``` + +### isPaginatingEndpoint + +A type guard, `isPaginatingEndpoint(arg)` returns `true` if `arg` is one of the keys in `PaginatingEndpoints` (is `keyof PaginatingEndpoints`). + +```typescript +import { Octokit } from "@octokit/core"; +import { + isPaginatingEndpoint, + composePaginateRest, +} from "@octokit/plugin-paginate-rest"; + +async function myPlugin(octokit: Octokit, arg: unknown) { + if (isPaginatingEndpoint(arg)) { + return await composePaginateRest(octokit, arg); + } + // ... +} +``` + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js b/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js new file mode 100644 index 00000000..5cfb975a --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js @@ -0,0 +1,144 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +const VERSION = "2.13.3"; + +/** + * Some “list” response that can be paginated have a different response structure + * + * They have a `total_count` key in the response (search also has `incomplete_results`, + * /installation/repositories also has `repository_selection`), as well as a key with + * the list of the items which name varies from endpoint to endpoint. + * + * Octokit normalizes these responses so that paginated results are always returned following + * the same structure. One challenge is that if the list response has only one page, no Link + * header is provided, so this header alone is not sufficient to check wether a response is + * paginated or not. + * + * We check if a "total_count" key is present in the response data, but also make sure that + * a "url" property is not, as the "Get the combined status for a specific ref" endpoint would + * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + */ +function normalizePaginatedListResponse(response) { + const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data); + if (!responseNeedsNormalization) return response; // keep the additional properties intact as there is currently no other way + // to retrieve the same information. + + const incompleteResults = response.data.incomplete_results; + const repositorySelection = response.data.repository_selection; + const totalCount = response.data.total_count; + delete response.data.incomplete_results; + delete response.data.repository_selection; + delete response.data.total_count; + const namespaceKey = Object.keys(response.data)[0]; + const data = response.data[namespaceKey]; + response.data = data; + + if (typeof incompleteResults !== "undefined") { + response.data.incomplete_results = incompleteResults; + } + + if (typeof repositorySelection !== "undefined") { + response.data.repository_selection = repositorySelection; + } + + response.data.total_count = totalCount; + return response; +} + +function iterator(octokit, route, parameters) { + const options = typeof route === "function" ? route.endpoint(parameters) : octokit.request.endpoint(route, parameters); + const requestMethod = typeof route === "function" ? route : octokit.request; + const method = options.method; + const headers = options.headers; + let url = options.url; + return { + [Symbol.asyncIterator]: () => ({ + async next() { + if (!url) return { + done: true + }; + const response = await requestMethod({ + method, + url, + headers + }); + const normalizedResponse = normalizePaginatedListResponse(response); // `response.headers.link` format: + // '; rel="next", ; rel="last"' + // sets `url` to undefined if "next" URL is not present or `link` header is not set + + url = ((normalizedResponse.headers.link || "").match(/<([^>]+)>;\s*rel="next"/) || [])[1]; + return { + value: normalizedResponse + }; + } + + }) + }; +} + +function paginate(octokit, route, parameters, mapFn) { + if (typeof parameters === "function") { + mapFn = parameters; + parameters = undefined; + } + + return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn); +} + +function gather(octokit, results, iterator, mapFn) { + return iterator.next().then(result => { + if (result.done) { + return results; + } + + let earlyExit = false; + + function done() { + earlyExit = true; + } + + results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data); + + if (earlyExit) { + return results; + } + + return gather(octokit, results, iterator, mapFn); + }); +} + +const composePaginateRest = Object.assign(paginate, { + iterator +}); + +const paginatingEndpoints = ["GET /app/installations", "GET /applications/grants", "GET /authorizations", "GET /enterprises/{enterprise}/actions/permissions/organizations", "GET /enterprises/{enterprise}/actions/runner-groups", "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", "GET /enterprises/{enterprise}/actions/runners", "GET /enterprises/{enterprise}/actions/runners/downloads", "GET /events", "GET /gists", "GET /gists/public", "GET /gists/starred", "GET /gists/{gist_id}/comments", "GET /gists/{gist_id}/commits", "GET /gists/{gist_id}/forks", "GET /installation/repositories", "GET /issues", "GET /marketplace_listing/plans", "GET /marketplace_listing/plans/{plan_id}/accounts", "GET /marketplace_listing/stubbed/plans", "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts", "GET /networks/{owner}/{repo}/events", "GET /notifications", "GET /organizations", "GET /orgs/{org}/actions/permissions/repositories", "GET /orgs/{org}/actions/runner-groups", "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners", "GET /orgs/{org}/actions/runners", "GET /orgs/{org}/actions/runners/downloads", "GET /orgs/{org}/actions/secrets", "GET /orgs/{org}/actions/secrets/{secret_name}/repositories", "GET /orgs/{org}/blocks", "GET /orgs/{org}/credential-authorizations", "GET /orgs/{org}/events", "GET /orgs/{org}/failed_invitations", "GET /orgs/{org}/hooks", "GET /orgs/{org}/installations", "GET /orgs/{org}/invitations", "GET /orgs/{org}/invitations/{invitation_id}/teams", "GET /orgs/{org}/issues", "GET /orgs/{org}/members", "GET /orgs/{org}/migrations", "GET /orgs/{org}/migrations/{migration_id}/repositories", "GET /orgs/{org}/outside_collaborators", "GET /orgs/{org}/projects", "GET /orgs/{org}/public_members", "GET /orgs/{org}/repos", "GET /orgs/{org}/team-sync/groups", "GET /orgs/{org}/teams", "GET /orgs/{org}/teams/{team_slug}/discussions", "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "GET /orgs/{org}/teams/{team_slug}/invitations", "GET /orgs/{org}/teams/{team_slug}/members", "GET /orgs/{org}/teams/{team_slug}/projects", "GET /orgs/{org}/teams/{team_slug}/repos", "GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings", "GET /orgs/{org}/teams/{team_slug}/teams", "GET /projects/columns/{column_id}/cards", "GET /projects/{project_id}/collaborators", "GET /projects/{project_id}/columns", "GET /repos/{owner}/{repo}/actions/artifacts", "GET /repos/{owner}/{repo}/actions/runners", "GET /repos/{owner}/{repo}/actions/runners/downloads", "GET /repos/{owner}/{repo}/actions/runs", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "GET /repos/{owner}/{repo}/actions/secrets", "GET /repos/{owner}/{repo}/actions/workflows", "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", "GET /repos/{owner}/{repo}/assignees", "GET /repos/{owner}/{repo}/branches", "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", "GET /repos/{owner}/{repo}/code-scanning/alerts", "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", "GET /repos/{owner}/{repo}/code-scanning/analyses", "GET /repos/{owner}/{repo}/collaborators", "GET /repos/{owner}/{repo}/comments", "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", "GET /repos/{owner}/{repo}/commits", "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments", "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", "GET /repos/{owner}/{repo}/commits/{ref}/check-runs", "GET /repos/{owner}/{repo}/commits/{ref}/check-suites", "GET /repos/{owner}/{repo}/commits/{ref}/statuses", "GET /repos/{owner}/{repo}/contributors", "GET /repos/{owner}/{repo}/deployments", "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "GET /repos/{owner}/{repo}/events", "GET /repos/{owner}/{repo}/forks", "GET /repos/{owner}/{repo}/git/matching-refs/{ref}", "GET /repos/{owner}/{repo}/hooks", "GET /repos/{owner}/{repo}/invitations", "GET /repos/{owner}/{repo}/issues", "GET /repos/{owner}/{repo}/issues/comments", "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "GET /repos/{owner}/{repo}/issues/events", "GET /repos/{owner}/{repo}/issues/{issue_number}/comments", "GET /repos/{owner}/{repo}/issues/{issue_number}/events", "GET /repos/{owner}/{repo}/issues/{issue_number}/labels", "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", "GET /repos/{owner}/{repo}/keys", "GET /repos/{owner}/{repo}/labels", "GET /repos/{owner}/{repo}/milestones", "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels", "GET /repos/{owner}/{repo}/notifications", "GET /repos/{owner}/{repo}/pages/builds", "GET /repos/{owner}/{repo}/projects", "GET /repos/{owner}/{repo}/pulls", "GET /repos/{owner}/{repo}/pulls/comments", "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments", "GET /repos/{owner}/{repo}/pulls/{pull_number}/commits", "GET /repos/{owner}/{repo}/pulls/{pull_number}/files", "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews", "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", "GET /repos/{owner}/{repo}/releases", "GET /repos/{owner}/{repo}/releases/{release_id}/assets", "GET /repos/{owner}/{repo}/secret-scanning/alerts", "GET /repos/{owner}/{repo}/stargazers", "GET /repos/{owner}/{repo}/subscribers", "GET /repos/{owner}/{repo}/tags", "GET /repos/{owner}/{repo}/teams", "GET /repositories", "GET /repositories/{repository_id}/environments/{environment_name}/secrets", "GET /scim/v2/enterprises/{enterprise}/Groups", "GET /scim/v2/enterprises/{enterprise}/Users", "GET /scim/v2/organizations/{org}/Users", "GET /search/code", "GET /search/commits", "GET /search/issues", "GET /search/labels", "GET /search/repositories", "GET /search/topics", "GET /search/users", "GET /teams/{team_id}/discussions", "GET /teams/{team_id}/discussions/{discussion_number}/comments", "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", "GET /teams/{team_id}/discussions/{discussion_number}/reactions", "GET /teams/{team_id}/invitations", "GET /teams/{team_id}/members", "GET /teams/{team_id}/projects", "GET /teams/{team_id}/repos", "GET /teams/{team_id}/team-sync/group-mappings", "GET /teams/{team_id}/teams", "GET /user/blocks", "GET /user/emails", "GET /user/followers", "GET /user/following", "GET /user/gpg_keys", "GET /user/installations", "GET /user/installations/{installation_id}/repositories", "GET /user/issues", "GET /user/keys", "GET /user/marketplace_purchases", "GET /user/marketplace_purchases/stubbed", "GET /user/memberships/orgs", "GET /user/migrations", "GET /user/migrations/{migration_id}/repositories", "GET /user/orgs", "GET /user/public_emails", "GET /user/repos", "GET /user/repository_invitations", "GET /user/starred", "GET /user/subscriptions", "GET /user/teams", "GET /users", "GET /users/{username}/events", "GET /users/{username}/events/orgs/{org}", "GET /users/{username}/events/public", "GET /users/{username}/followers", "GET /users/{username}/following", "GET /users/{username}/gists", "GET /users/{username}/gpg_keys", "GET /users/{username}/keys", "GET /users/{username}/orgs", "GET /users/{username}/projects", "GET /users/{username}/received_events", "GET /users/{username}/received_events/public", "GET /users/{username}/repos", "GET /users/{username}/starred", "GET /users/{username}/subscriptions"]; + +function isPaginatingEndpoint(arg) { + if (typeof arg === "string") { + return paginatingEndpoints.includes(arg); + } else { + return false; + } +} + +/** + * @param octokit Octokit instance + * @param options Options passed to Octokit constructor + */ + +function paginateRest(octokit) { + return { + paginate: Object.assign(paginate.bind(null, octokit), { + iterator: iterator.bind(null, octokit) + }) + }; +} +paginateRest.VERSION = VERSION; + +exports.composePaginateRest = composePaginateRest; +exports.isPaginatingEndpoint = isPaginatingEndpoint; +exports.paginateRest = paginateRest; +exports.paginatingEndpoints = paginatingEndpoints; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map b/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map new file mode 100644 index 00000000..088f86c0 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/normalize-paginated-list-response.js","../dist-src/iterator.js","../dist-src/paginate.js","../dist-src/compose-paginate.js","../dist-src/generated/paginating-endpoints.js","../dist-src/paginating-endpoints.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"2.13.3\";\n","/**\n * Some “list” response that can be paginated have a different response structure\n *\n * They have a `total_count` key in the response (search also has `incomplete_results`,\n * /installation/repositories also has `repository_selection`), as well as a key with\n * the list of the items which name varies from endpoint to endpoint.\n *\n * Octokit normalizes these responses so that paginated results are always returned following\n * the same structure. One challenge is that if the list response has only one page, no Link\n * header is provided, so this header alone is not sufficient to check wether a response is\n * paginated or not.\n *\n * We check if a \"total_count\" key is present in the response data, but also make sure that\n * a \"url\" property is not, as the \"Get the combined status for a specific ref\" endpoint would\n * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref\n */\nexport function normalizePaginatedListResponse(response) {\n const responseNeedsNormalization = \"total_count\" in response.data && !(\"url\" in response.data);\n if (!responseNeedsNormalization)\n return response;\n // keep the additional properties intact as there is currently no other way\n // to retrieve the same information.\n const incompleteResults = response.data.incomplete_results;\n const repositorySelection = response.data.repository_selection;\n const totalCount = response.data.total_count;\n delete response.data.incomplete_results;\n delete response.data.repository_selection;\n delete response.data.total_count;\n const namespaceKey = Object.keys(response.data)[0];\n const data = response.data[namespaceKey];\n response.data = data;\n if (typeof incompleteResults !== \"undefined\") {\n response.data.incomplete_results = incompleteResults;\n }\n if (typeof repositorySelection !== \"undefined\") {\n response.data.repository_selection = repositorySelection;\n }\n response.data.total_count = totalCount;\n return response;\n}\n","import { normalizePaginatedListResponse } from \"./normalize-paginated-list-response\";\nexport function iterator(octokit, route, parameters) {\n const options = typeof route === \"function\"\n ? route.endpoint(parameters)\n : octokit.request.endpoint(route, parameters);\n const requestMethod = typeof route === \"function\" ? route : octokit.request;\n const method = options.method;\n const headers = options.headers;\n let url = options.url;\n return {\n [Symbol.asyncIterator]: () => ({\n async next() {\n if (!url)\n return { done: true };\n const response = await requestMethod({ method, url, headers });\n const normalizedResponse = normalizePaginatedListResponse(response);\n // `response.headers.link` format:\n // '; rel=\"next\", ; rel=\"last\"'\n // sets `url` to undefined if \"next\" URL is not present or `link` header is not set\n url = ((normalizedResponse.headers.link || \"\").match(/<([^>]+)>;\\s*rel=\"next\"/) || [])[1];\n return { value: normalizedResponse };\n },\n }),\n };\n}\n","import { iterator } from \"./iterator\";\nexport function paginate(octokit, route, parameters, mapFn) {\n if (typeof parameters === \"function\") {\n mapFn = parameters;\n parameters = undefined;\n }\n return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn);\n}\nfunction gather(octokit, results, iterator, mapFn) {\n return iterator.next().then((result) => {\n if (result.done) {\n return results;\n }\n let earlyExit = false;\n function done() {\n earlyExit = true;\n }\n results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data);\n if (earlyExit) {\n return results;\n }\n return gather(octokit, results, iterator, mapFn);\n });\n}\n","import { paginate } from \"./paginate\";\nimport { iterator } from \"./iterator\";\nexport const composePaginateRest = Object.assign(paginate, {\n iterator,\n});\n","export const paginatingEndpoints = [\n \"GET /app/installations\",\n \"GET /applications/grants\",\n \"GET /authorizations\",\n \"GET /enterprises/{enterprise}/actions/permissions/organizations\",\n \"GET /enterprises/{enterprise}/actions/runner-groups\",\n \"GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations\",\n \"GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners\",\n \"GET /enterprises/{enterprise}/actions/runners\",\n \"GET /enterprises/{enterprise}/actions/runners/downloads\",\n \"GET /events\",\n \"GET /gists\",\n \"GET /gists/public\",\n \"GET /gists/starred\",\n \"GET /gists/{gist_id}/comments\",\n \"GET /gists/{gist_id}/commits\",\n \"GET /gists/{gist_id}/forks\",\n \"GET /installation/repositories\",\n \"GET /issues\",\n \"GET /marketplace_listing/plans\",\n \"GET /marketplace_listing/plans/{plan_id}/accounts\",\n \"GET /marketplace_listing/stubbed/plans\",\n \"GET /marketplace_listing/stubbed/plans/{plan_id}/accounts\",\n \"GET /networks/{owner}/{repo}/events\",\n \"GET /notifications\",\n \"GET /organizations\",\n \"GET /orgs/{org}/actions/permissions/repositories\",\n \"GET /orgs/{org}/actions/runner-groups\",\n \"GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories\",\n \"GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners\",\n \"GET /orgs/{org}/actions/runners\",\n \"GET /orgs/{org}/actions/runners/downloads\",\n \"GET /orgs/{org}/actions/secrets\",\n \"GET /orgs/{org}/actions/secrets/{secret_name}/repositories\",\n \"GET /orgs/{org}/blocks\",\n \"GET /orgs/{org}/credential-authorizations\",\n \"GET /orgs/{org}/events\",\n \"GET /orgs/{org}/failed_invitations\",\n \"GET /orgs/{org}/hooks\",\n \"GET /orgs/{org}/installations\",\n \"GET /orgs/{org}/invitations\",\n \"GET /orgs/{org}/invitations/{invitation_id}/teams\",\n \"GET /orgs/{org}/issues\",\n \"GET /orgs/{org}/members\",\n \"GET /orgs/{org}/migrations\",\n \"GET /orgs/{org}/migrations/{migration_id}/repositories\",\n \"GET /orgs/{org}/outside_collaborators\",\n \"GET /orgs/{org}/projects\",\n \"GET /orgs/{org}/public_members\",\n \"GET /orgs/{org}/repos\",\n \"GET /orgs/{org}/team-sync/groups\",\n \"GET /orgs/{org}/teams\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions\",\n \"GET /orgs/{org}/teams/{team_slug}/invitations\",\n \"GET /orgs/{org}/teams/{team_slug}/members\",\n \"GET /orgs/{org}/teams/{team_slug}/projects\",\n \"GET /orgs/{org}/teams/{team_slug}/repos\",\n \"GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings\",\n \"GET /orgs/{org}/teams/{team_slug}/teams\",\n \"GET /projects/columns/{column_id}/cards\",\n \"GET /projects/{project_id}/collaborators\",\n \"GET /projects/{project_id}/columns\",\n \"GET /repos/{owner}/{repo}/actions/artifacts\",\n \"GET /repos/{owner}/{repo}/actions/runners\",\n \"GET /repos/{owner}/{repo}/actions/runners/downloads\",\n \"GET /repos/{owner}/{repo}/actions/runs\",\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts\",\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs\",\n \"GET /repos/{owner}/{repo}/actions/secrets\",\n \"GET /repos/{owner}/{repo}/actions/workflows\",\n \"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs\",\n \"GET /repos/{owner}/{repo}/assignees\",\n \"GET /repos/{owner}/{repo}/branches\",\n \"GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations\",\n \"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs\",\n \"GET /repos/{owner}/{repo}/code-scanning/alerts\",\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances\",\n \"GET /repos/{owner}/{repo}/code-scanning/analyses\",\n \"GET /repos/{owner}/{repo}/collaborators\",\n \"GET /repos/{owner}/{repo}/comments\",\n \"GET /repos/{owner}/{repo}/comments/{comment_id}/reactions\",\n \"GET /repos/{owner}/{repo}/commits\",\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head\",\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/comments\",\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/check-runs\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/check-suites\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/statuses\",\n \"GET /repos/{owner}/{repo}/contributors\",\n \"GET /repos/{owner}/{repo}/deployments\",\n \"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses\",\n \"GET /repos/{owner}/{repo}/events\",\n \"GET /repos/{owner}/{repo}/forks\",\n \"GET /repos/{owner}/{repo}/git/matching-refs/{ref}\",\n \"GET /repos/{owner}/{repo}/hooks\",\n \"GET /repos/{owner}/{repo}/invitations\",\n \"GET /repos/{owner}/{repo}/issues\",\n \"GET /repos/{owner}/{repo}/issues/comments\",\n \"GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions\",\n \"GET /repos/{owner}/{repo}/issues/events\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/comments\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/events\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/labels\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/reactions\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/timeline\",\n \"GET /repos/{owner}/{repo}/keys\",\n \"GET /repos/{owner}/{repo}/labels\",\n \"GET /repos/{owner}/{repo}/milestones\",\n \"GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels\",\n \"GET /repos/{owner}/{repo}/notifications\",\n \"GET /repos/{owner}/{repo}/pages/builds\",\n \"GET /repos/{owner}/{repo}/projects\",\n \"GET /repos/{owner}/{repo}/pulls\",\n \"GET /repos/{owner}/{repo}/pulls/comments\",\n \"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/comments\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/commits\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/files\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments\",\n \"GET /repos/{owner}/{repo}/releases\",\n \"GET /repos/{owner}/{repo}/releases/{release_id}/assets\",\n \"GET /repos/{owner}/{repo}/secret-scanning/alerts\",\n \"GET /repos/{owner}/{repo}/stargazers\",\n \"GET /repos/{owner}/{repo}/subscribers\",\n \"GET /repos/{owner}/{repo}/tags\",\n \"GET /repos/{owner}/{repo}/teams\",\n \"GET /repositories\",\n \"GET /repositories/{repository_id}/environments/{environment_name}/secrets\",\n \"GET /scim/v2/enterprises/{enterprise}/Groups\",\n \"GET /scim/v2/enterprises/{enterprise}/Users\",\n \"GET /scim/v2/organizations/{org}/Users\",\n \"GET /search/code\",\n \"GET /search/commits\",\n \"GET /search/issues\",\n \"GET /search/labels\",\n \"GET /search/repositories\",\n \"GET /search/topics\",\n \"GET /search/users\",\n \"GET /teams/{team_id}/discussions\",\n \"GET /teams/{team_id}/discussions/{discussion_number}/comments\",\n \"GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n \"GET /teams/{team_id}/discussions/{discussion_number}/reactions\",\n \"GET /teams/{team_id}/invitations\",\n \"GET /teams/{team_id}/members\",\n \"GET /teams/{team_id}/projects\",\n \"GET /teams/{team_id}/repos\",\n \"GET /teams/{team_id}/team-sync/group-mappings\",\n \"GET /teams/{team_id}/teams\",\n \"GET /user/blocks\",\n \"GET /user/emails\",\n \"GET /user/followers\",\n \"GET /user/following\",\n \"GET /user/gpg_keys\",\n \"GET /user/installations\",\n \"GET /user/installations/{installation_id}/repositories\",\n \"GET /user/issues\",\n \"GET /user/keys\",\n \"GET /user/marketplace_purchases\",\n \"GET /user/marketplace_purchases/stubbed\",\n \"GET /user/memberships/orgs\",\n \"GET /user/migrations\",\n \"GET /user/migrations/{migration_id}/repositories\",\n \"GET /user/orgs\",\n \"GET /user/public_emails\",\n \"GET /user/repos\",\n \"GET /user/repository_invitations\",\n \"GET /user/starred\",\n \"GET /user/subscriptions\",\n \"GET /user/teams\",\n \"GET /users\",\n \"GET /users/{username}/events\",\n \"GET /users/{username}/events/orgs/{org}\",\n \"GET /users/{username}/events/public\",\n \"GET /users/{username}/followers\",\n \"GET /users/{username}/following\",\n \"GET /users/{username}/gists\",\n \"GET /users/{username}/gpg_keys\",\n \"GET /users/{username}/keys\",\n \"GET /users/{username}/orgs\",\n \"GET /users/{username}/projects\",\n \"GET /users/{username}/received_events\",\n \"GET /users/{username}/received_events/public\",\n \"GET /users/{username}/repos\",\n \"GET /users/{username}/starred\",\n \"GET /users/{username}/subscriptions\",\n];\n","import { paginatingEndpoints, } from \"./generated/paginating-endpoints\";\nexport { paginatingEndpoints } from \"./generated/paginating-endpoints\";\nexport function isPaginatingEndpoint(arg) {\n if (typeof arg === \"string\") {\n return paginatingEndpoints.includes(arg);\n }\n else {\n return false;\n }\n}\n","import { VERSION } from \"./version\";\nimport { paginate } from \"./paginate\";\nimport { iterator } from \"./iterator\";\nexport { composePaginateRest } from \"./compose-paginate\";\nexport { isPaginatingEndpoint, paginatingEndpoints, } from \"./paginating-endpoints\";\n/**\n * @param octokit Octokit instance\n * @param options Options passed to Octokit constructor\n */\nexport function paginateRest(octokit) {\n return {\n paginate: Object.assign(paginate.bind(null, octokit), {\n iterator: iterator.bind(null, octokit),\n }),\n };\n}\npaginateRest.VERSION = VERSION;\n"],"names":["VERSION","normalizePaginatedListResponse","response","responseNeedsNormalization","data","incompleteResults","incomplete_results","repositorySelection","repository_selection","totalCount","total_count","namespaceKey","Object","keys","iterator","octokit","route","parameters","options","endpoint","request","requestMethod","method","headers","url","Symbol","asyncIterator","next","done","normalizedResponse","link","match","value","paginate","mapFn","undefined","gather","results","then","result","earlyExit","concat","composePaginateRest","assign","paginatingEndpoints","isPaginatingEndpoint","arg","includes","paginateRest","bind"],"mappings":";;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACAP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,AAAO,SAASC,8BAAT,CAAwCC,QAAxC,EAAkD;AACrD,QAAMC,0BAA0B,GAAG,iBAAiBD,QAAQ,CAACE,IAA1B,IAAkC,EAAE,SAASF,QAAQ,CAACE,IAApB,CAArE;AACA,MAAI,CAACD,0BAAL,EACI,OAAOD,QAAP,CAHiD;AAKrD;;AACA,QAAMG,iBAAiB,GAAGH,QAAQ,CAACE,IAAT,CAAcE,kBAAxC;AACA,QAAMC,mBAAmB,GAAGL,QAAQ,CAACE,IAAT,CAAcI,oBAA1C;AACA,QAAMC,UAAU,GAAGP,QAAQ,CAACE,IAAT,CAAcM,WAAjC;AACA,SAAOR,QAAQ,CAACE,IAAT,CAAcE,kBAArB;AACA,SAAOJ,QAAQ,CAACE,IAAT,CAAcI,oBAArB;AACA,SAAON,QAAQ,CAACE,IAAT,CAAcM,WAArB;AACA,QAAMC,YAAY,GAAGC,MAAM,CAACC,IAAP,CAAYX,QAAQ,CAACE,IAArB,EAA2B,CAA3B,CAArB;AACA,QAAMA,IAAI,GAAGF,QAAQ,CAACE,IAAT,CAAcO,YAAd,CAAb;AACAT,EAAAA,QAAQ,CAACE,IAAT,GAAgBA,IAAhB;;AACA,MAAI,OAAOC,iBAAP,KAA6B,WAAjC,EAA8C;AAC1CH,IAAAA,QAAQ,CAACE,IAAT,CAAcE,kBAAd,GAAmCD,iBAAnC;AACH;;AACD,MAAI,OAAOE,mBAAP,KAA+B,WAAnC,EAAgD;AAC5CL,IAAAA,QAAQ,CAACE,IAAT,CAAcI,oBAAd,GAAqCD,mBAArC;AACH;;AACDL,EAAAA,QAAQ,CAACE,IAAT,CAAcM,WAAd,GAA4BD,UAA5B;AACA,SAAOP,QAAP;AACH;;ACtCM,SAASY,QAAT,CAAkBC,OAAlB,EAA2BC,KAA3B,EAAkCC,UAAlC,EAA8C;AACjD,QAAMC,OAAO,GAAG,OAAOF,KAAP,KAAiB,UAAjB,GACVA,KAAK,CAACG,QAAN,CAAeF,UAAf,CADU,GAEVF,OAAO,CAACK,OAAR,CAAgBD,QAAhB,CAAyBH,KAAzB,EAAgCC,UAAhC,CAFN;AAGA,QAAMI,aAAa,GAAG,OAAOL,KAAP,KAAiB,UAAjB,GAA8BA,KAA9B,GAAsCD,OAAO,CAACK,OAApE;AACA,QAAME,MAAM,GAAGJ,OAAO,CAACI,MAAvB;AACA,QAAMC,OAAO,GAAGL,OAAO,CAACK,OAAxB;AACA,MAAIC,GAAG,GAAGN,OAAO,CAACM,GAAlB;AACA,SAAO;AACH,KAACC,MAAM,CAACC,aAAR,GAAwB,OAAO;AAC3B,YAAMC,IAAN,GAAa;AACT,YAAI,CAACH,GAAL,EACI,OAAO;AAAEI,UAAAA,IAAI,EAAE;AAAR,SAAP;AACJ,cAAM1B,QAAQ,GAAG,MAAMmB,aAAa,CAAC;AAAEC,UAAAA,MAAF;AAAUE,UAAAA,GAAV;AAAeD,UAAAA;AAAf,SAAD,CAApC;AACA,cAAMM,kBAAkB,GAAG5B,8BAA8B,CAACC,QAAD,CAAzD,CAJS;AAMT;AACA;;AACAsB,QAAAA,GAAG,GAAG,CAAC,CAACK,kBAAkB,CAACN,OAAnB,CAA2BO,IAA3B,IAAmC,EAApC,EAAwCC,KAAxC,CAA8C,yBAA9C,KAA4E,EAA7E,EAAiF,CAAjF,CAAN;AACA,eAAO;AAAEC,UAAAA,KAAK,EAAEH;AAAT,SAAP;AACH;;AAX0B,KAAP;AADrB,GAAP;AAeH;;ACvBM,SAASI,QAAT,CAAkBlB,OAAlB,EAA2BC,KAA3B,EAAkCC,UAAlC,EAA8CiB,KAA9C,EAAqD;AACxD,MAAI,OAAOjB,UAAP,KAAsB,UAA1B,EAAsC;AAClCiB,IAAAA,KAAK,GAAGjB,UAAR;AACAA,IAAAA,UAAU,GAAGkB,SAAb;AACH;;AACD,SAAOC,MAAM,CAACrB,OAAD,EAAU,EAAV,EAAcD,QAAQ,CAACC,OAAD,EAAUC,KAAV,EAAiBC,UAAjB,CAAR,CAAqCQ,MAAM,CAACC,aAA5C,GAAd,EAA4EQ,KAA5E,CAAb;AACH;;AACD,SAASE,MAAT,CAAgBrB,OAAhB,EAAyBsB,OAAzB,EAAkCvB,QAAlC,EAA4CoB,KAA5C,EAAmD;AAC/C,SAAOpB,QAAQ,CAACa,IAAT,GAAgBW,IAAhB,CAAsBC,MAAD,IAAY;AACpC,QAAIA,MAAM,CAACX,IAAX,EAAiB;AACb,aAAOS,OAAP;AACH;;AACD,QAAIG,SAAS,GAAG,KAAhB;;AACA,aAASZ,IAAT,GAAgB;AACZY,MAAAA,SAAS,GAAG,IAAZ;AACH;;AACDH,IAAAA,OAAO,GAAGA,OAAO,CAACI,MAAR,CAAeP,KAAK,GAAGA,KAAK,CAACK,MAAM,CAACP,KAAR,EAAeJ,IAAf,CAAR,GAA+BW,MAAM,CAACP,KAAP,CAAa5B,IAAhE,CAAV;;AACA,QAAIoC,SAAJ,EAAe;AACX,aAAOH,OAAP;AACH;;AACD,WAAOD,MAAM,CAACrB,OAAD,EAAUsB,OAAV,EAAmBvB,QAAnB,EAA6BoB,KAA7B,CAAb;AACH,GAbM,CAAP;AAcH;;MCrBYQ,mBAAmB,GAAG9B,MAAM,CAAC+B,MAAP,CAAcV,QAAd,EAAwB;AACvDnB,EAAAA;AADuD,CAAxB,CAA5B;;MCFM8B,mBAAmB,GAAG,CAC/B,wBAD+B,EAE/B,0BAF+B,EAG/B,qBAH+B,EAI/B,iEAJ+B,EAK/B,qDAL+B,EAM/B,qFAN+B,EAO/B,+EAP+B,EAQ/B,+CAR+B,EAS/B,yDAT+B,EAU/B,aAV+B,EAW/B,YAX+B,EAY/B,mBAZ+B,EAa/B,oBAb+B,EAc/B,+BAd+B,EAe/B,8BAf+B,EAgB/B,4BAhB+B,EAiB/B,gCAjB+B,EAkB/B,aAlB+B,EAmB/B,gCAnB+B,EAoB/B,mDApB+B,EAqB/B,wCArB+B,EAsB/B,2DAtB+B,EAuB/B,qCAvB+B,EAwB/B,oBAxB+B,EAyB/B,oBAzB+B,EA0B/B,kDA1B+B,EA2B/B,uCA3B+B,EA4B/B,sEA5B+B,EA6B/B,iEA7B+B,EA8B/B,iCA9B+B,EA+B/B,2CA/B+B,EAgC/B,iCAhC+B,EAiC/B,4DAjC+B,EAkC/B,wBAlC+B,EAmC/B,2CAnC+B,EAoC/B,wBApC+B,EAqC/B,oCArC+B,EAsC/B,uBAtC+B,EAuC/B,+BAvC+B,EAwC/B,6BAxC+B,EAyC/B,mDAzC+B,EA0C/B,wBA1C+B,EA2C/B,yBA3C+B,EA4C/B,4BA5C+B,EA6C/B,wDA7C+B,EA8C/B,uCA9C+B,EA+C/B,0BA/C+B,EAgD/B,gCAhD+B,EAiD/B,uBAjD+B,EAkD/B,kCAlD+B,EAmD/B,uBAnD+B,EAoD/B,+CApD+B,EAqD/B,4EArD+B,EAsD/B,uGAtD+B,EAuD/B,6EAvD+B,EAwD/B,+CAxD+B,EAyD/B,2CAzD+B,EA0D/B,4CA1D+B,EA2D/B,yCA3D+B,EA4D/B,4DA5D+B,EA6D/B,yCA7D+B,EA8D/B,yCA9D+B,EA+D/B,0CA/D+B,EAgE/B,oCAhE+B,EAiE/B,6CAjE+B,EAkE/B,2CAlE+B,EAmE/B,qDAnE+B,EAoE/B,wCApE+B,EAqE/B,2DArE+B,EAsE/B,sDAtE+B,EAuE/B,2CAvE+B,EAwE/B,6CAxE+B,EAyE/B,gEAzE+B,EA0E/B,qCA1E+B,EA2E/B,oCA3E+B,EA4E/B,iEA5E+B,EA6E/B,oEA7E+B,EA8E/B,gDA9E+B,EA+E/B,yEA/E+B,EAgF/B,kDAhF+B,EAiF/B,yCAjF+B,EAkF/B,oCAlF+B,EAmF/B,2DAnF+B,EAoF/B,mCApF+B,EAqF/B,oEArF+B,EAsF/B,yDAtF+B,EAuF/B,sDAvF+B,EAwF/B,oDAxF+B,EAyF/B,sDAzF+B,EA0F/B,kDA1F+B,EA2F/B,wCA3F+B,EA4F/B,uCA5F+B,EA6F/B,gEA7F+B,EA8F/B,kCA9F+B,EA+F/B,iCA/F+B,EAgG/B,mDAhG+B,EAiG/B,iCAjG+B,EAkG/B,uCAlG+B,EAmG/B,kCAnG+B,EAoG/B,2CApG+B,EAqG/B,kEArG+B,EAsG/B,yCAtG+B,EAuG/B,0DAvG+B,EAwG/B,wDAxG+B,EAyG/B,wDAzG+B,EA0G/B,2DA1G+B,EA2G/B,0DA3G+B,EA4G/B,gCA5G+B,EA6G/B,kCA7G+B,EA8G/B,sCA9G+B,EA+G/B,gEA/G+B,EAgH/B,yCAhH+B,EAiH/B,wCAjH+B,EAkH/B,oCAlH+B,EAmH/B,iCAnH+B,EAoH/B,0CApH+B,EAqH/B,iEArH+B,EAsH/B,wDAtH+B,EAuH/B,uDAvH+B,EAwH/B,qDAxH+B,EAyH/B,mEAzH+B,EA0H/B,uDA1H+B,EA2H/B,4EA3H+B,EA4H/B,oCA5H+B,EA6H/B,wDA7H+B,EA8H/B,kDA9H+B,EA+H/B,sCA/H+B,EAgI/B,uCAhI+B,EAiI/B,gCAjI+B,EAkI/B,iCAlI+B,EAmI/B,mBAnI+B,EAoI/B,2EApI+B,EAqI/B,8CArI+B,EAsI/B,6CAtI+B,EAuI/B,wCAvI+B,EAwI/B,kBAxI+B,EAyI/B,qBAzI+B,EA0I/B,oBA1I+B,EA2I/B,oBA3I+B,EA4I/B,0BA5I+B,EA6I/B,oBA7I+B,EA8I/B,mBA9I+B,EA+I/B,kCA/I+B,EAgJ/B,+DAhJ+B,EAiJ/B,0FAjJ+B,EAkJ/B,gEAlJ+B,EAmJ/B,kCAnJ+B,EAoJ/B,8BApJ+B,EAqJ/B,+BArJ+B,EAsJ/B,4BAtJ+B,EAuJ/B,+CAvJ+B,EAwJ/B,4BAxJ+B,EAyJ/B,kBAzJ+B,EA0J/B,kBA1J+B,EA2J/B,qBA3J+B,EA4J/B,qBA5J+B,EA6J/B,oBA7J+B,EA8J/B,yBA9J+B,EA+J/B,wDA/J+B,EAgK/B,kBAhK+B,EAiK/B,gBAjK+B,EAkK/B,iCAlK+B,EAmK/B,yCAnK+B,EAoK/B,4BApK+B,EAqK/B,sBArK+B,EAsK/B,kDAtK+B,EAuK/B,gBAvK+B,EAwK/B,yBAxK+B,EAyK/B,iBAzK+B,EA0K/B,kCA1K+B,EA2K/B,mBA3K+B,EA4K/B,yBA5K+B,EA6K/B,iBA7K+B,EA8K/B,YA9K+B,EA+K/B,8BA/K+B,EAgL/B,yCAhL+B,EAiL/B,qCAjL+B,EAkL/B,iCAlL+B,EAmL/B,iCAnL+B,EAoL/B,6BApL+B,EAqL/B,gCArL+B,EAsL/B,4BAtL+B,EAuL/B,4BAvL+B,EAwL/B,gCAxL+B,EAyL/B,uCAzL+B,EA0L/B,8CA1L+B,EA2L/B,6BA3L+B,EA4L/B,+BA5L+B,EA6L/B,qCA7L+B,CAA5B;;ACEA,SAASC,oBAAT,CAA8BC,GAA9B,EAAmC;AACtC,MAAI,OAAOA,GAAP,KAAe,QAAnB,EAA6B;AACzB,WAAOF,mBAAmB,CAACG,QAApB,CAA6BD,GAA7B,CAAP;AACH,GAFD,MAGK;AACD,WAAO,KAAP;AACH;AACJ;;ACJD;AACA;AACA;AACA;;AACA,AAAO,SAASE,YAAT,CAAsBjC,OAAtB,EAA+B;AAClC,SAAO;AACHkB,IAAAA,QAAQ,EAAErB,MAAM,CAAC+B,MAAP,CAAcV,QAAQ,CAACgB,IAAT,CAAc,IAAd,EAAoBlC,OAApB,CAAd,EAA4C;AAClDD,MAAAA,QAAQ,EAAEA,QAAQ,CAACmC,IAAT,CAAc,IAAd,EAAoBlC,OAApB;AADwC,KAA5C;AADP,GAAP;AAKH;AACDiC,YAAY,CAAChD,OAAb,GAAuBA,OAAvB;;;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js new file mode 100644 index 00000000..09ca53f6 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/compose-paginate.js @@ -0,0 +1,5 @@ +import { paginate } from "./paginate"; +import { iterator } from "./iterator"; +export const composePaginateRest = Object.assign(paginate, { + iterator, +}); diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js new file mode 100644 index 00000000..e4c8355e --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/generated/paginating-endpoints.js @@ -0,0 +1,191 @@ +export const paginatingEndpoints = [ + "GET /app/installations", + "GET /applications/grants", + "GET /authorizations", + "GET /enterprises/{enterprise}/actions/permissions/organizations", + "GET /enterprises/{enterprise}/actions/runner-groups", + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", + "GET /enterprises/{enterprise}/actions/runners", + "GET /enterprises/{enterprise}/actions/runners/downloads", + "GET /events", + "GET /gists", + "GET /gists/public", + "GET /gists/starred", + "GET /gists/{gist_id}/comments", + "GET /gists/{gist_id}/commits", + "GET /gists/{gist_id}/forks", + "GET /installation/repositories", + "GET /issues", + "GET /marketplace_listing/plans", + "GET /marketplace_listing/plans/{plan_id}/accounts", + "GET /marketplace_listing/stubbed/plans", + "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts", + "GET /networks/{owner}/{repo}/events", + "GET /notifications", + "GET /organizations", + "GET /orgs/{org}/actions/permissions/repositories", + "GET /orgs/{org}/actions/runner-groups", + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners", + "GET /orgs/{org}/actions/runners", + "GET /orgs/{org}/actions/runners/downloads", + "GET /orgs/{org}/actions/secrets", + "GET /orgs/{org}/actions/secrets/{secret_name}/repositories", + "GET /orgs/{org}/blocks", + "GET /orgs/{org}/credential-authorizations", + "GET /orgs/{org}/events", + "GET /orgs/{org}/failed_invitations", + "GET /orgs/{org}/hooks", + "GET /orgs/{org}/installations", + "GET /orgs/{org}/invitations", + "GET /orgs/{org}/invitations/{invitation_id}/teams", + "GET /orgs/{org}/issues", + "GET /orgs/{org}/members", + "GET /orgs/{org}/migrations", + "GET /orgs/{org}/migrations/{migration_id}/repositories", + "GET /orgs/{org}/outside_collaborators", + "GET /orgs/{org}/projects", + "GET /orgs/{org}/public_members", + "GET /orgs/{org}/repos", + "GET /orgs/{org}/team-sync/groups", + "GET /orgs/{org}/teams", + "GET /orgs/{org}/teams/{team_slug}/discussions", + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + "GET /orgs/{org}/teams/{team_slug}/invitations", + "GET /orgs/{org}/teams/{team_slug}/members", + "GET /orgs/{org}/teams/{team_slug}/projects", + "GET /orgs/{org}/teams/{team_slug}/repos", + "GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings", + "GET /orgs/{org}/teams/{team_slug}/teams", + "GET /projects/columns/{column_id}/cards", + "GET /projects/{project_id}/collaborators", + "GET /projects/{project_id}/columns", + "GET /repos/{owner}/{repo}/actions/artifacts", + "GET /repos/{owner}/{repo}/actions/runners", + "GET /repos/{owner}/{repo}/actions/runners/downloads", + "GET /repos/{owner}/{repo}/actions/runs", + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", + "GET /repos/{owner}/{repo}/actions/secrets", + "GET /repos/{owner}/{repo}/actions/workflows", + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", + "GET /repos/{owner}/{repo}/assignees", + "GET /repos/{owner}/{repo}/branches", + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + "GET /repos/{owner}/{repo}/code-scanning/alerts", + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", + "GET /repos/{owner}/{repo}/code-scanning/analyses", + "GET /repos/{owner}/{repo}/collaborators", + "GET /repos/{owner}/{repo}/comments", + "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", + "GET /repos/{owner}/{repo}/commits", + "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", + "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments", + "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", + "GET /repos/{owner}/{repo}/commits/{ref}/check-runs", + "GET /repos/{owner}/{repo}/commits/{ref}/check-suites", + "GET /repos/{owner}/{repo}/commits/{ref}/statuses", + "GET /repos/{owner}/{repo}/contributors", + "GET /repos/{owner}/{repo}/deployments", + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + "GET /repos/{owner}/{repo}/events", + "GET /repos/{owner}/{repo}/forks", + "GET /repos/{owner}/{repo}/git/matching-refs/{ref}", + "GET /repos/{owner}/{repo}/hooks", + "GET /repos/{owner}/{repo}/invitations", + "GET /repos/{owner}/{repo}/issues", + "GET /repos/{owner}/{repo}/issues/comments", + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + "GET /repos/{owner}/{repo}/issues/events", + "GET /repos/{owner}/{repo}/issues/{issue_number}/comments", + "GET /repos/{owner}/{repo}/issues/{issue_number}/events", + "GET /repos/{owner}/{repo}/issues/{issue_number}/labels", + "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", + "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", + "GET /repos/{owner}/{repo}/keys", + "GET /repos/{owner}/{repo}/labels", + "GET /repos/{owner}/{repo}/milestones", + "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels", + "GET /repos/{owner}/{repo}/notifications", + "GET /repos/{owner}/{repo}/pages/builds", + "GET /repos/{owner}/{repo}/projects", + "GET /repos/{owner}/{repo}/pulls", + "GET /repos/{owner}/{repo}/pulls/comments", + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments", + "GET /repos/{owner}/{repo}/pulls/{pull_number}/commits", + "GET /repos/{owner}/{repo}/pulls/{pull_number}/files", + "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews", + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", + "GET /repos/{owner}/{repo}/releases", + "GET /repos/{owner}/{repo}/releases/{release_id}/assets", + "GET /repos/{owner}/{repo}/secret-scanning/alerts", + "GET /repos/{owner}/{repo}/stargazers", + "GET /repos/{owner}/{repo}/subscribers", + "GET /repos/{owner}/{repo}/tags", + "GET /repos/{owner}/{repo}/teams", + "GET /repositories", + "GET /repositories/{repository_id}/environments/{environment_name}/secrets", + "GET /scim/v2/enterprises/{enterprise}/Groups", + "GET /scim/v2/enterprises/{enterprise}/Users", + "GET /scim/v2/organizations/{org}/Users", + "GET /search/code", + "GET /search/commits", + "GET /search/issues", + "GET /search/labels", + "GET /search/repositories", + "GET /search/topics", + "GET /search/users", + "GET /teams/{team_id}/discussions", + "GET /teams/{team_id}/discussions/{discussion_number}/comments", + "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "GET /teams/{team_id}/discussions/{discussion_number}/reactions", + "GET /teams/{team_id}/invitations", + "GET /teams/{team_id}/members", + "GET /teams/{team_id}/projects", + "GET /teams/{team_id}/repos", + "GET /teams/{team_id}/team-sync/group-mappings", + "GET /teams/{team_id}/teams", + "GET /user/blocks", + "GET /user/emails", + "GET /user/followers", + "GET /user/following", + "GET /user/gpg_keys", + "GET /user/installations", + "GET /user/installations/{installation_id}/repositories", + "GET /user/issues", + "GET /user/keys", + "GET /user/marketplace_purchases", + "GET /user/marketplace_purchases/stubbed", + "GET /user/memberships/orgs", + "GET /user/migrations", + "GET /user/migrations/{migration_id}/repositories", + "GET /user/orgs", + "GET /user/public_emails", + "GET /user/repos", + "GET /user/repository_invitations", + "GET /user/starred", + "GET /user/subscriptions", + "GET /user/teams", + "GET /users", + "GET /users/{username}/events", + "GET /users/{username}/events/orgs/{org}", + "GET /users/{username}/events/public", + "GET /users/{username}/followers", + "GET /users/{username}/following", + "GET /users/{username}/gists", + "GET /users/{username}/gpg_keys", + "GET /users/{username}/keys", + "GET /users/{username}/orgs", + "GET /users/{username}/projects", + "GET /users/{username}/received_events", + "GET /users/{username}/received_events/public", + "GET /users/{username}/repos", + "GET /users/{username}/starred", + "GET /users/{username}/subscriptions", +]; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/index.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/index.js new file mode 100644 index 00000000..5ba74def --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/index.js @@ -0,0 +1,17 @@ +import { VERSION } from "./version"; +import { paginate } from "./paginate"; +import { iterator } from "./iterator"; +export { composePaginateRest } from "./compose-paginate"; +export { isPaginatingEndpoint, paginatingEndpoints, } from "./paginating-endpoints"; +/** + * @param octokit Octokit instance + * @param options Options passed to Octokit constructor + */ +export function paginateRest(octokit) { + return { + paginate: Object.assign(paginate.bind(null, octokit), { + iterator: iterator.bind(null, octokit), + }), + }; +} +paginateRest.VERSION = VERSION; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js new file mode 100644 index 00000000..14684db4 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/iterator.js @@ -0,0 +1,25 @@ +import { normalizePaginatedListResponse } from "./normalize-paginated-list-response"; +export function iterator(octokit, route, parameters) { + const options = typeof route === "function" + ? route.endpoint(parameters) + : octokit.request.endpoint(route, parameters); + const requestMethod = typeof route === "function" ? route : octokit.request; + const method = options.method; + const headers = options.headers; + let url = options.url; + return { + [Symbol.asyncIterator]: () => ({ + async next() { + if (!url) + return { done: true }; + const response = await requestMethod({ method, url, headers }); + const normalizedResponse = normalizePaginatedListResponse(response); + // `response.headers.link` format: + // '; rel="next", ; rel="last"' + // sets `url` to undefined if "next" URL is not present or `link` header is not set + url = ((normalizedResponse.headers.link || "").match(/<([^>]+)>;\s*rel="next"/) || [])[1]; + return { value: normalizedResponse }; + }, + }), + }; +} diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js new file mode 100644 index 00000000..d29c6777 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/normalize-paginated-list-response.js @@ -0,0 +1,40 @@ +/** + * Some “list” response that can be paginated have a different response structure + * + * They have a `total_count` key in the response (search also has `incomplete_results`, + * /installation/repositories also has `repository_selection`), as well as a key with + * the list of the items which name varies from endpoint to endpoint. + * + * Octokit normalizes these responses so that paginated results are always returned following + * the same structure. One challenge is that if the list response has only one page, no Link + * header is provided, so this header alone is not sufficient to check wether a response is + * paginated or not. + * + * We check if a "total_count" key is present in the response data, but also make sure that + * a "url" property is not, as the "Get the combined status for a specific ref" endpoint would + * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + */ +export function normalizePaginatedListResponse(response) { + const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data); + if (!responseNeedsNormalization) + return response; + // keep the additional properties intact as there is currently no other way + // to retrieve the same information. + const incompleteResults = response.data.incomplete_results; + const repositorySelection = response.data.repository_selection; + const totalCount = response.data.total_count; + delete response.data.incomplete_results; + delete response.data.repository_selection; + delete response.data.total_count; + const namespaceKey = Object.keys(response.data)[0]; + const data = response.data[namespaceKey]; + response.data = data; + if (typeof incompleteResults !== "undefined") { + response.data.incomplete_results = incompleteResults; + } + if (typeof repositorySelection !== "undefined") { + response.data.repository_selection = repositorySelection; + } + response.data.total_count = totalCount; + return response; +} diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js new file mode 100644 index 00000000..8d18a60f --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/paginate.js @@ -0,0 +1,24 @@ +import { iterator } from "./iterator"; +export function paginate(octokit, route, parameters, mapFn) { + if (typeof parameters === "function") { + mapFn = parameters; + parameters = undefined; + } + return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn); +} +function gather(octokit, results, iterator, mapFn) { + return iterator.next().then((result) => { + if (result.done) { + return results; + } + let earlyExit = false; + function done() { + earlyExit = true; + } + results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data); + if (earlyExit) { + return results; + } + return gather(octokit, results, iterator, mapFn); + }); +} diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/paginating-endpoints.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/paginating-endpoints.js new file mode 100644 index 00000000..1e528993 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/paginating-endpoints.js @@ -0,0 +1,10 @@ +import { paginatingEndpoints, } from "./generated/paginating-endpoints"; +export { paginatingEndpoints } from "./generated/paginating-endpoints"; +export function isPaginatingEndpoint(arg) { + if (typeof arg === "string") { + return paginatingEndpoints.includes(arg); + } + else { + return false; + } +} diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/types.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/types.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-src/version.js b/node_modules/@octokit/plugin-paginate-rest/dist-src/version.js new file mode 100644 index 00000000..4c8535ad --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "2.13.3"; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts new file mode 100644 index 00000000..38a7432f --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/compose-paginate.d.ts @@ -0,0 +1,2 @@ +import { ComposePaginateInterface } from "./types"; +export declare const composePaginateRest: ComposePaginateInterface; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts new file mode 100644 index 00000000..e690626f --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/generated/paginating-endpoints.d.ts @@ -0,0 +1,1411 @@ +import { Endpoints } from "@octokit/types"; +export interface PaginatingEndpoints { + /** + * @see https://docs.github.com/rest/reference/apps/#list-installations-for-the-authenticated-app + */ + "GET /app/installations": { + parameters: Endpoints["GET /app/installations"]["parameters"]; + response: Endpoints["GET /app/installations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#list-your-grants + */ + "GET /applications/grants": { + parameters: Endpoints["GET /applications/grants"]["parameters"]; + response: Endpoints["GET /applications/grants"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations + */ + "GET /authorizations": { + parameters: Endpoints["GET /authorizations"]["parameters"]; + response: Endpoints["GET /authorizations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/permissions/organizations": { + parameters: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["parameters"]; + response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["response"] & { + data: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["response"]["data"]["organizations"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups": { + parameters: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups"]["parameters"]; + response: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups"]["response"] & { + data: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups"]["response"]["data"]["runner_groups"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + parameters: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations"]["parameters"]; + response: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations"]["response"] & { + data: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations"]["response"]["data"]["organizations"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + parameters: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners"]["parameters"]; + response: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners"]["response"] & { + data: Endpoints["GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners"]["response"]["data"]["runners"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runners": { + parameters: Endpoints["GET /enterprises/{enterprise}/actions/runners"]["parameters"]; + response: Endpoints["GET /enterprises/{enterprise}/actions/runners"]["response"] & { + data: Endpoints["GET /enterprises/{enterprise}/actions/runners"]["response"]["data"]["runners"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-runner-applications-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runners/downloads": { + parameters: Endpoints["GET /enterprises/{enterprise}/actions/runners/downloads"]["parameters"]; + response: Endpoints["GET /enterprises/{enterprise}/actions/runners/downloads"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events + */ + "GET /events": { + parameters: Endpoints["GET /events"]["parameters"]; + response: Endpoints["GET /events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/gists/#list-gists-for-the-authenticated-user + */ + "GET /gists": { + parameters: Endpoints["GET /gists"]["parameters"]; + response: Endpoints["GET /gists"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/gists/#list-public-gists + */ + "GET /gists/public": { + parameters: Endpoints["GET /gists/public"]["parameters"]; + response: Endpoints["GET /gists/public"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/gists/#list-starred-gists + */ + "GET /gists/starred": { + parameters: Endpoints["GET /gists/starred"]["parameters"]; + response: Endpoints["GET /gists/starred"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/gists#list-gist-comments + */ + "GET /gists/{gist_id}/comments": { + parameters: Endpoints["GET /gists/{gist_id}/comments"]["parameters"]; + response: Endpoints["GET /gists/{gist_id}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/gists/#list-gist-commits + */ + "GET /gists/{gist_id}/commits": { + parameters: Endpoints["GET /gists/{gist_id}/commits"]["parameters"]; + response: Endpoints["GET /gists/{gist_id}/commits"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/gists/#list-gist-forks + */ + "GET /gists/{gist_id}/forks": { + parameters: Endpoints["GET /gists/{gist_id}/forks"]["parameters"]; + response: Endpoints["GET /gists/{gist_id}/forks"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-app-installation + */ + "GET /installation/repositories": { + parameters: Endpoints["GET /installation/repositories"]["parameters"]; + response: Endpoints["GET /installation/repositories"]["response"] & { + data: Endpoints["GET /installation/repositories"]["response"]["data"]["repositories"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/issues/#list-issues-assigned-to-the-authenticated-user + */ + "GET /issues": { + parameters: Endpoints["GET /issues"]["parameters"]; + response: Endpoints["GET /issues"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-plans + */ + "GET /marketplace_listing/plans": { + parameters: Endpoints["GET /marketplace_listing/plans"]["parameters"]; + response: Endpoints["GET /marketplace_listing/plans"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan + */ + "GET /marketplace_listing/plans/{plan_id}/accounts": { + parameters: Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["parameters"]; + response: Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-plans-stubbed + */ + "GET /marketplace_listing/stubbed/plans": { + parameters: Endpoints["GET /marketplace_listing/stubbed/plans"]["parameters"]; + response: Endpoints["GET /marketplace_listing/stubbed/plans"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan-stubbed + */ + "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts": { + parameters: Endpoints["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"]["parameters"]; + response: Endpoints["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories + */ + "GET /networks/{owner}/{repo}/events": { + parameters: Endpoints["GET /networks/{owner}/{repo}/events"]["parameters"]; + response: Endpoints["GET /networks/{owner}/{repo}/events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user + */ + "GET /notifications": { + parameters: Endpoints["GET /notifications"]["parameters"]; + response: Endpoints["GET /notifications"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs/#list-organizations + */ + "GET /organizations": { + parameters: Endpoints["GET /organizations"]["parameters"]; + response: Endpoints["GET /organizations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization + */ + "GET /orgs/{org}/actions/permissions/repositories": { + parameters: Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["response"]["data"]["repositories"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runner-groups-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups": { + parameters: Endpoints["GET /orgs/{org}/actions/runner-groups"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/runner-groups"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/runner-groups"]["response"]["data"]["runner_groups"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + parameters: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories"]["response"]["data"]["repositories"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-in-a-group-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + parameters: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners"]["response"]["data"]["runners"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization + */ + "GET /orgs/{org}/actions/runners": { + parameters: Endpoints["GET /orgs/{org}/actions/runners"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/runners"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/runners"]["response"]["data"]["runners"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization + */ + "GET /orgs/{org}/actions/runners/downloads": { + parameters: Endpoints["GET /orgs/{org}/actions/runners/downloads"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/runners/downloads"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-organization-secrets + */ + "GET /orgs/{org}/actions/secrets": { + parameters: Endpoints["GET /orgs/{org}/actions/secrets"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/secrets"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/secrets"]["response"]["data"]["secrets"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret + */ + "GET /orgs/{org}/actions/secrets/{secret_name}/repositories": { + parameters: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"]["parameters"]; + response: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"]["response"] & { + data: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"]["response"]["data"]["repositories"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-users-blocked-by-an-organization + */ + "GET /orgs/{org}/blocks": { + parameters: Endpoints["GET /orgs/{org}/blocks"]["parameters"]; + response: Endpoints["GET /orgs/{org}/blocks"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs/#list-saml-sso-authorizations-for-an-organization + */ + "GET /orgs/{org}/credential-authorizations": { + parameters: Endpoints["GET /orgs/{org}/credential-authorizations"]["parameters"]; + response: Endpoints["GET /orgs/{org}/credential-authorizations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-organization-events + */ + "GET /orgs/{org}/events": { + parameters: Endpoints["GET /orgs/{org}/events"]["parameters"]; + response: Endpoints["GET /orgs/{org}/events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-failed-organization-invitations + */ + "GET /orgs/{org}/failed_invitations": { + parameters: Endpoints["GET /orgs/{org}/failed_invitations"]["parameters"]; + response: Endpoints["GET /orgs/{org}/failed_invitations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-webhooks + */ + "GET /orgs/{org}/hooks": { + parameters: Endpoints["GET /orgs/{org}/hooks"]["parameters"]; + response: Endpoints["GET /orgs/{org}/hooks"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs/#list-app-installations-for-an-organization + */ + "GET /orgs/{org}/installations": { + parameters: Endpoints["GET /orgs/{org}/installations"]["parameters"]; + response: Endpoints["GET /orgs/{org}/installations"]["response"] & { + data: Endpoints["GET /orgs/{org}/installations"]["response"]["data"]["installations"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-pending-organization-invitations + */ + "GET /orgs/{org}/invitations": { + parameters: Endpoints["GET /orgs/{org}/invitations"]["parameters"]; + response: Endpoints["GET /orgs/{org}/invitations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-invitation-teams + */ + "GET /orgs/{org}/invitations/{invitation_id}/teams": { + parameters: Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["parameters"]; + response: Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues/#list-organization-issues-assigned-to-the-authenticated-user + */ + "GET /orgs/{org}/issues": { + parameters: Endpoints["GET /orgs/{org}/issues"]["parameters"]; + response: Endpoints["GET /orgs/{org}/issues"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-members + */ + "GET /orgs/{org}/members": { + parameters: Endpoints["GET /orgs/{org}/members"]["parameters"]; + response: Endpoints["GET /orgs/{org}/members"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/migrations#list-organization-migrations + */ + "GET /orgs/{org}/migrations": { + parameters: Endpoints["GET /orgs/{org}/migrations"]["parameters"]; + response: Endpoints["GET /orgs/{org}/migrations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/migrations#list-repositories-in-an-organization-migration + */ + "GET /orgs/{org}/migrations/{migration_id}/repositories": { + parameters: Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["parameters"]; + response: Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-outside-collaborators-for-an-organization + */ + "GET /orgs/{org}/outside_collaborators": { + parameters: Endpoints["GET /orgs/{org}/outside_collaborators"]["parameters"]; + response: Endpoints["GET /orgs/{org}/outside_collaborators"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/projects/#list-organization-projects + */ + "GET /orgs/{org}/projects": { + parameters: Endpoints["GET /orgs/{org}/projects"]["parameters"]; + response: Endpoints["GET /orgs/{org}/projects"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-public-organization-members + */ + "GET /orgs/{org}/public_members": { + parameters: Endpoints["GET /orgs/{org}/public_members"]["parameters"]; + response: Endpoints["GET /orgs/{org}/public_members"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos/#list-organization-repositories + */ + "GET /orgs/{org}/repos": { + parameters: Endpoints["GET /orgs/{org}/repos"]["parameters"]; + response: Endpoints["GET /orgs/{org}/repos"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-an-organization + */ + "GET /orgs/{org}/team-sync/groups": { + parameters: Endpoints["GET /orgs/{org}/team-sync/groups"]["parameters"]; + response: Endpoints["GET /orgs/{org}/team-sync/groups"]["response"] & { + data: Endpoints["GET /orgs/{org}/team-sync/groups"]["response"]["data"]["groups"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/teams/#list-teams + */ + "GET /orgs/{org}/teams": { + parameters: Endpoints["GET /orgs/{org}/teams"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussions + */ + "GET /orgs/{org}/teams/{team_slug}/discussions": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussion-comments + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-pending-team-invitations + */ + "GET /orgs/{org}/teams/{team_slug}/invitations": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/invitations"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/invitations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-team-members + */ + "GET /orgs/{org}/teams/{team_slug}/members": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/members"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/members"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams/#list-team-projects + */ + "GET /orgs/{org}/teams/{team_slug}/projects": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams/#list-team-repositories + */ + "GET /orgs/{org}/teams/{team_slug}/repos": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team + */ + "GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings"]["response"] & { + data: Endpoints["GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings"]["response"]["data"]["groups"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/teams/#list-child-teams + */ + "GET /orgs/{org}/teams/{team_slug}/teams": { + parameters: Endpoints["GET /orgs/{org}/teams/{team_slug}/teams"]["parameters"]; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/teams"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/projects#list-project-cards + */ + "GET /projects/columns/{column_id}/cards": { + parameters: Endpoints["GET /projects/columns/{column_id}/cards"]["parameters"]; + response: Endpoints["GET /projects/columns/{column_id}/cards"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/projects#list-project-collaborators + */ + "GET /projects/{project_id}/collaborators": { + parameters: Endpoints["GET /projects/{project_id}/collaborators"]["parameters"]; + response: Endpoints["GET /projects/{project_id}/collaborators"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/projects#list-project-columns + */ + "GET /projects/{project_id}/columns": { + parameters: Endpoints["GET /projects/{project_id}/columns"]["parameters"]; + response: Endpoints["GET /projects/{project_id}/columns"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/artifacts": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts"]["response"]["data"]["artifacts"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runners": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runners"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/runners"]["response"]["data"]["runners"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runners/downloads": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runners/downloads"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners/downloads"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-workflow-runs-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runs": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["response"]["data"]["workflow_runs"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-workflow-run-artifacts + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["response"]["data"]["artifacts"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["response"]["data"]["jobs"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-repository-secrets + */ + "GET /repos/{owner}/{repo}/actions/secrets": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/secrets"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/secrets"]["response"]["data"]["secrets"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-repository-workflows + */ + "GET /repos/{owner}/{repo}/actions/workflows": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"]["data"]["workflows"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-workflow-runs + */ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + parameters: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"]["response"]["data"]["workflow_runs"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-assignees + */ + "GET /repos/{owner}/{repo}/assignees": { + parameters: Endpoints["GET /repos/{owner}/{repo}/assignees"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/assignees"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-branches + */ + "GET /repos/{owner}/{repo}/branches": { + parameters: Endpoints["GET /repos/{owner}/{repo}/branches"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/branches"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-run-annotations + */ + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + parameters: Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite + */ + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + parameters: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"]["response"]["data"]["check_runs"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository + */ + "GET /repos/{owner}/{repo}/code-scanning/alerts": { + parameters: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert + */ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + parameters: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository + */ + "GET /repos/{owner}/{repo}/code-scanning/analyses": { + parameters: Endpoints["GET /repos/{owner}/{repo}/code-scanning/analyses"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/analyses"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-collaborators + */ + "GET /repos/{owner}/{repo}/collaborators": { + parameters: Endpoints["GET /repos/{owner}/{repo}/collaborators"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/collaborators"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-commit-comments-for-a-repository + */ + "GET /repos/{owner}/{repo}/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-commit-comment + */ + "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions": { + parameters: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-commits + */ + "GET /repos/{owner}/{repo}/commits": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-branches-for-head-commit + */ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-commit-comments + */ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-pull-requests-associated-with-a-commit + */ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/check-runs": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"]["response"]["data"]["check_runs"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/check-suites": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["response"]["data"]["check_suites"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-commit-statuses-for-a-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/statuses": { + parameters: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/statuses"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/statuses"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos/#list-repository-contributors + */ + "GET /repos/{owner}/{repo}/contributors": { + parameters: Endpoints["GET /repos/{owner}/{repo}/contributors"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/contributors"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-deployments + */ + "GET /repos/{owner}/{repo}/deployments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/deployments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/deployments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-deployment-statuses + */ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + parameters: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-repository-events + */ + "GET /repos/{owner}/{repo}/events": { + parameters: Endpoints["GET /repos/{owner}/{repo}/events"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-forks + */ + "GET /repos/{owner}/{repo}/forks": { + parameters: Endpoints["GET /repos/{owner}/{repo}/forks"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/forks"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/git#list-matching-references + */ + "GET /repos/{owner}/{repo}/git/matching-refs/{ref}": { + parameters: Endpoints["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-webhooks + */ + "GET /repos/{owner}/{repo}/hooks": { + parameters: Endpoints["GET /repos/{owner}/{repo}/hooks"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/hooks"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-invitations + */ + "GET /repos/{owner}/{repo}/invitations": { + parameters: Endpoints["GET /repos/{owner}/{repo}/invitations"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/invitations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues/#list-repository-issues + */ + "GET /repos/{owner}/{repo}/issues": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-comments-for-a-repository + */ + "GET /repos/{owner}/{repo}/issues/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-an-issue-comment + */ + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-events-for-a-repository + */ + "GET /repos/{owner}/{repo}/issues/events": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/events"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-comments + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-events + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/events": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/events"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-labels-for-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/labels": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-timeline-events-for-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline": { + parameters: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-deploy-keys + */ + "GET /repos/{owner}/{repo}/keys": { + parameters: Endpoints["GET /repos/{owner}/{repo}/keys"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/keys"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-labels-for-a-repository + */ + "GET /repos/{owner}/{repo}/labels": { + parameters: Endpoints["GET /repos/{owner}/{repo}/labels"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/labels"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-milestones + */ + "GET /repos/{owner}/{repo}/milestones": { + parameters: Endpoints["GET /repos/{owner}/{repo}/milestones"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/milestones"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/issues#list-labels-for-issues-in-a-milestone + */ + "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + parameters: Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user + */ + "GET /repos/{owner}/{repo}/notifications": { + parameters: Endpoints["GET /repos/{owner}/{repo}/notifications"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/notifications"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-github-pages-builds + */ + "GET /repos/{owner}/{repo}/pages/builds": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pages/builds"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pages/builds"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/projects/#list-repository-projects + */ + "GET /repos/{owner}/{repo}/projects": { + parameters: Endpoints["GET /repos/{owner}/{repo}/projects"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/projects"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/pulls/#list-pull-requests + */ + "GET /repos/{owner}/{repo}/pulls": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/pulls#list-review-comments-in-a-repository + */ + "GET /repos/{owner}/{repo}/pulls/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-pull-request-review-comment + */ + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/pulls#list-review-comments-on-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/pulls/#list-commits-on-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/commits": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/pulls/#list-pull-requests-files + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/files": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"] & { + data: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"]["data"]["users"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/pulls#list-reviews-for-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/pulls#list-comments-for-a-pull-request-review + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + parameters: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-releases + */ + "GET /repos/{owner}/{repo}/releases": { + parameters: Endpoints["GET /repos/{owner}/{repo}/releases"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/releases"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-release-assets + */ + "GET /repos/{owner}/{repo}/releases/{release_id}/assets": { + parameters: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/assets"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/assets"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository + */ + "GET /repos/{owner}/{repo}/secret-scanning/alerts": { + parameters: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-stargazers + */ + "GET /repos/{owner}/{repo}/stargazers": { + parameters: Endpoints["GET /repos/{owner}/{repo}/stargazers"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/stargazers"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-watchers + */ + "GET /repos/{owner}/{repo}/subscribers": { + parameters: Endpoints["GET /repos/{owner}/{repo}/subscribers"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/subscribers"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos/#list-repository-tags + */ + "GET /repos/{owner}/{repo}/tags": { + parameters: Endpoints["GET /repos/{owner}/{repo}/tags"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/tags"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos/#list-repository-teams + */ + "GET /repos/{owner}/{repo}/teams": { + parameters: Endpoints["GET /repos/{owner}/{repo}/teams"]["parameters"]; + response: Endpoints["GET /repos/{owner}/{repo}/teams"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos/#list-public-repositories + */ + "GET /repositories": { + parameters: Endpoints["GET /repositories"]["parameters"]; + response: Endpoints["GET /repositories"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/actions#list-environment-secrets + */ + "GET /repositories/{repository_id}/environments/{environment_name}/secrets": { + parameters: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets"]["parameters"]; + response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets"]["response"] & { + data: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets"]["response"]["data"]["secrets"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise + */ + "GET /scim/v2/enterprises/{enterprise}/Groups": { + parameters: Endpoints["GET /scim/v2/enterprises/{enterprise}/Groups"]["parameters"]; + response: Endpoints["GET /scim/v2/enterprises/{enterprise}/Groups"]["response"] & { + data: Endpoints["GET /scim/v2/enterprises/{enterprise}/Groups"]["response"]["data"]["Resources"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-scim-provisioned-identities-for-an-enterprise + */ + "GET /scim/v2/enterprises/{enterprise}/Users": { + parameters: Endpoints["GET /scim/v2/enterprises/{enterprise}/Users"]["parameters"]; + response: Endpoints["GET /scim/v2/enterprises/{enterprise}/Users"]["response"] & { + data: Endpoints["GET /scim/v2/enterprises/{enterprise}/Users"]["response"]["data"]["Resources"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/scim/#list-scim-provisioned-identities + */ + "GET /scim/v2/organizations/{org}/Users": { + parameters: Endpoints["GET /scim/v2/organizations/{org}/Users"]["parameters"]; + response: Endpoints["GET /scim/v2/organizations/{org}/Users"]["response"] & { + data: Endpoints["GET /scim/v2/organizations/{org}/Users"]["response"]["data"]["Resources"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/search/#search-code + */ + "GET /search/code": { + parameters: Endpoints["GET /search/code"]["parameters"]; + response: Endpoints["GET /search/code"]["response"] & { + data: Endpoints["GET /search/code"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/search/#search-commits + */ + "GET /search/commits": { + parameters: Endpoints["GET /search/commits"]["parameters"]; + response: Endpoints["GET /search/commits"]["response"] & { + data: Endpoints["GET /search/commits"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/search/#search-issues-and-pull-requests + */ + "GET /search/issues": { + parameters: Endpoints["GET /search/issues"]["parameters"]; + response: Endpoints["GET /search/issues"]["response"] & { + data: Endpoints["GET /search/issues"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/search/#search-labels + */ + "GET /search/labels": { + parameters: Endpoints["GET /search/labels"]["parameters"]; + response: Endpoints["GET /search/labels"]["response"] & { + data: Endpoints["GET /search/labels"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/search/#search-repositories + */ + "GET /search/repositories": { + parameters: Endpoints["GET /search/repositories"]["parameters"]; + response: Endpoints["GET /search/repositories"]["response"] & { + data: Endpoints["GET /search/repositories"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/search/#search-topics + */ + "GET /search/topics": { + parameters: Endpoints["GET /search/topics"]["parameters"]; + response: Endpoints["GET /search/topics"]["response"] & { + data: Endpoints["GET /search/topics"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/search/#search-users + */ + "GET /search/users": { + parameters: Endpoints["GET /search/users"]["parameters"]; + response: Endpoints["GET /search/users"]["response"] & { + data: Endpoints["GET /search/users"]["response"]["data"]["items"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussions-legacy + */ + "GET /teams/{team_id}/discussions": { + parameters: Endpoints["GET /teams/{team_id}/discussions"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/discussions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussion-comments-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/comments": { + parameters: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/comments"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/comments"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/reactions": { + parameters: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/reactions"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/discussions/{discussion_number}/reactions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-pending-team-invitations-legacy + */ + "GET /teams/{team_id}/invitations": { + parameters: Endpoints["GET /teams/{team_id}/invitations"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/invitations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-team-members-legacy + */ + "GET /teams/{team_id}/members": { + parameters: Endpoints["GET /teams/{team_id}/members"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/members"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams/#list-team-projects-legacy + */ + "GET /teams/{team_id}/projects": { + parameters: Endpoints["GET /teams/{team_id}/projects"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/projects"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams/#list-team-repositories-legacy + */ + "GET /teams/{team_id}/repos": { + parameters: Endpoints["GET /teams/{team_id}/repos"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/repos"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team-legacy + */ + "GET /teams/{team_id}/team-sync/group-mappings": { + parameters: Endpoints["GET /teams/{team_id}/team-sync/group-mappings"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/team-sync/group-mappings"]["response"] & { + data: Endpoints["GET /teams/{team_id}/team-sync/group-mappings"]["response"]["data"]["groups"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/teams/#list-child-teams-legacy + */ + "GET /teams/{team_id}/teams": { + parameters: Endpoints["GET /teams/{team_id}/teams"]["parameters"]; + response: Endpoints["GET /teams/{team_id}/teams"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user + */ + "GET /user/blocks": { + parameters: Endpoints["GET /user/blocks"]["parameters"]; + response: Endpoints["GET /user/blocks"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user + */ + "GET /user/emails": { + parameters: Endpoints["GET /user/emails"]["parameters"]; + response: Endpoints["GET /user/emails"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-followers-of-the-authenticated-user + */ + "GET /user/followers": { + parameters: Endpoints["GET /user/followers"]["parameters"]; + response: Endpoints["GET /user/followers"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows + */ + "GET /user/following": { + parameters: Endpoints["GET /user/following"]["parameters"]; + response: Endpoints["GET /user/following"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user + */ + "GET /user/gpg_keys": { + parameters: Endpoints["GET /user/gpg_keys"]["parameters"]; + response: Endpoints["GET /user/gpg_keys"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token + */ + "GET /user/installations": { + parameters: Endpoints["GET /user/installations"]["parameters"]; + response: Endpoints["GET /user/installations"]["response"] & { + data: Endpoints["GET /user/installations"]["response"]["data"]["installations"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-user-access-token + */ + "GET /user/installations/{installation_id}/repositories": { + parameters: Endpoints["GET /user/installations/{installation_id}/repositories"]["parameters"]; + response: Endpoints["GET /user/installations/{installation_id}/repositories"]["response"] & { + data: Endpoints["GET /user/installations/{installation_id}/repositories"]["response"]["data"]["repositories"]; + }; + }; + /** + * @see https://docs.github.com/rest/reference/issues/#list-user-account-issues-assigned-to-the-authenticated-user + */ + "GET /user/issues": { + parameters: Endpoints["GET /user/issues"]["parameters"]; + response: Endpoints["GET /user/issues"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user + */ + "GET /user/keys": { + parameters: Endpoints["GET /user/keys"]["parameters"]; + response: Endpoints["GET /user/keys"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user + */ + "GET /user/marketplace_purchases": { + parameters: Endpoints["GET /user/marketplace_purchases"]["parameters"]; + response: Endpoints["GET /user/marketplace_purchases"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user-stubbed + */ + "GET /user/marketplace_purchases/stubbed": { + parameters: Endpoints["GET /user/marketplace_purchases/stubbed"]["parameters"]; + response: Endpoints["GET /user/marketplace_purchases/stubbed"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user + */ + "GET /user/memberships/orgs": { + parameters: Endpoints["GET /user/memberships/orgs"]["parameters"]; + response: Endpoints["GET /user/memberships/orgs"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/migrations#list-user-migrations + */ + "GET /user/migrations": { + parameters: Endpoints["GET /user/migrations"]["parameters"]; + response: Endpoints["GET /user/migrations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration + */ + "GET /user/migrations/{migration_id}/repositories": { + parameters: Endpoints["GET /user/migrations/{migration_id}/repositories"]["parameters"]; + response: Endpoints["GET /user/migrations/{migration_id}/repositories"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs/#list-organizations-for-the-authenticated-user + */ + "GET /user/orgs": { + parameters: Endpoints["GET /user/orgs"]["parameters"]; + response: Endpoints["GET /user/orgs"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user + */ + "GET /user/public_emails": { + parameters: Endpoints["GET /user/public_emails"]["parameters"]; + response: Endpoints["GET /user/public_emails"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos/#list-repositories-for-the-authenticated-user + */ + "GET /user/repos": { + parameters: Endpoints["GET /user/repos"]["parameters"]; + response: Endpoints["GET /user/repos"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-invitations-for-the-authenticated-user + */ + "GET /user/repository_invitations": { + parameters: Endpoints["GET /user/repository_invitations"]["parameters"]; + response: Endpoints["GET /user/repository_invitations"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user + */ + "GET /user/starred": { + parameters: Endpoints["GET /user/starred"]["parameters"]; + response: Endpoints["GET /user/starred"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-watched-by-the-authenticated-user + */ + "GET /user/subscriptions": { + parameters: Endpoints["GET /user/subscriptions"]["parameters"]; + response: Endpoints["GET /user/subscriptions"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/teams/#list-teams-for-the-authenticated-user + */ + "GET /user/teams": { + parameters: Endpoints["GET /user/teams"]["parameters"]; + response: Endpoints["GET /user/teams"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users/#list-users + */ + "GET /users": { + parameters: Endpoints["GET /users"]["parameters"]; + response: Endpoints["GET /users"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-events-for-the-authenticated-user + */ + "GET /users/{username}/events": { + parameters: Endpoints["GET /users/{username}/events"]["parameters"]; + response: Endpoints["GET /users/{username}/events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-organization-events-for-the-authenticated-user + */ + "GET /users/{username}/events/orgs/{org}": { + parameters: Endpoints["GET /users/{username}/events/orgs/{org}"]["parameters"]; + response: Endpoints["GET /users/{username}/events/orgs/{org}"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events-for-a-user + */ + "GET /users/{username}/events/public": { + parameters: Endpoints["GET /users/{username}/events/public"]["parameters"]; + response: Endpoints["GET /users/{username}/events/public"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-followers-of-a-user + */ + "GET /users/{username}/followers": { + parameters: Endpoints["GET /users/{username}/followers"]["parameters"]; + response: Endpoints["GET /users/{username}/followers"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-the-people-a-user-follows + */ + "GET /users/{username}/following": { + parameters: Endpoints["GET /users/{username}/following"]["parameters"]; + response: Endpoints["GET /users/{username}/following"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/gists/#list-gists-for-a-user + */ + "GET /users/{username}/gists": { + parameters: Endpoints["GET /users/{username}/gists"]["parameters"]; + response: Endpoints["GET /users/{username}/gists"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-gpg-keys-for-a-user + */ + "GET /users/{username}/gpg_keys": { + parameters: Endpoints["GET /users/{username}/gpg_keys"]["parameters"]; + response: Endpoints["GET /users/{username}/gpg_keys"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/users#list-public-keys-for-a-user + */ + "GET /users/{username}/keys": { + parameters: Endpoints["GET /users/{username}/keys"]["parameters"]; + response: Endpoints["GET /users/{username}/keys"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/orgs/#list-organizations-for-a-user + */ + "GET /users/{username}/orgs": { + parameters: Endpoints["GET /users/{username}/orgs"]["parameters"]; + response: Endpoints["GET /users/{username}/orgs"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/projects/#list-user-projects + */ + "GET /users/{username}/projects": { + parameters: Endpoints["GET /users/{username}/projects"]["parameters"]; + response: Endpoints["GET /users/{username}/projects"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-events-received-by-the-authenticated-user + */ + "GET /users/{username}/received_events": { + parameters: Endpoints["GET /users/{username}/received_events"]["parameters"]; + response: Endpoints["GET /users/{username}/received_events"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user + */ + "GET /users/{username}/received_events/public": { + parameters: Endpoints["GET /users/{username}/received_events/public"]["parameters"]; + response: Endpoints["GET /users/{username}/received_events/public"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/repos/#list-repositories-for-a-user + */ + "GET /users/{username}/repos": { + parameters: Endpoints["GET /users/{username}/repos"]["parameters"]; + response: Endpoints["GET /users/{username}/repos"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user + */ + "GET /users/{username}/starred": { + parameters: Endpoints["GET /users/{username}/starred"]["parameters"]; + response: Endpoints["GET /users/{username}/starred"]["response"]; + }; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-watched-by-a-user + */ + "GET /users/{username}/subscriptions": { + parameters: Endpoints["GET /users/{username}/subscriptions"]["parameters"]; + response: Endpoints["GET /users/{username}/subscriptions"]["response"]; + }; +} +export declare const paginatingEndpoints: (keyof PaginatingEndpoints)[]; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts new file mode 100644 index 00000000..4d84aae3 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/index.d.ts @@ -0,0 +1,16 @@ +import { Octokit } from "@octokit/core"; +import { PaginateInterface } from "./types"; +export { PaginateInterface } from "./types"; +export { PaginatingEndpoints } from "./types"; +export { composePaginateRest } from "./compose-paginate"; +export { isPaginatingEndpoint, paginatingEndpoints, } from "./paginating-endpoints"; +/** + * @param octokit Octokit instance + * @param options Options passed to Octokit constructor + */ +export declare function paginateRest(octokit: Octokit): { + paginate: PaginateInterface; +}; +export declare namespace paginateRest { + var VERSION: string; +} diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts new file mode 100644 index 00000000..276f6d96 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/iterator.d.ts @@ -0,0 +1,13 @@ +import { Octokit } from "@octokit/core"; +import { RequestInterface, RequestParameters, Route } from "./types"; +export declare function iterator(octokit: Octokit, route: Route | RequestInterface, parameters?: RequestParameters): { + [Symbol.asyncIterator]: () => { + next(): Promise<{ + done: boolean; + value?: undefined; + } | { + value: import("@octokit/types/dist-types/OctokitResponse").OctokitResponse; + done?: undefined; + }>; + }; +}; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts new file mode 100644 index 00000000..f948a78f --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/normalize-paginated-list-response.d.ts @@ -0,0 +1,18 @@ +/** + * Some “list” response that can be paginated have a different response structure + * + * They have a `total_count` key in the response (search also has `incomplete_results`, + * /installation/repositories also has `repository_selection`), as well as a key with + * the list of the items which name varies from endpoint to endpoint. + * + * Octokit normalizes these responses so that paginated results are always returned following + * the same structure. One challenge is that if the list response has only one page, no Link + * header is provided, so this header alone is not sufficient to check wether a response is + * paginated or not. + * + * We check if a "total_count" key is present in the response data, but also make sure that + * a "url" property is not, as the "Get the combined status for a specific ref" endpoint would + * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + */ +import { OctokitResponse } from "./types"; +export declare function normalizePaginatedListResponse(response: OctokitResponse): OctokitResponse; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts new file mode 100644 index 00000000..774c6041 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/paginate.d.ts @@ -0,0 +1,3 @@ +import { Octokit } from "@octokit/core"; +import { MapFunction, PaginationResults, RequestParameters, Route, RequestInterface } from "./types"; +export declare function paginate(octokit: Octokit, route: Route | RequestInterface, parameters?: RequestParameters, mapFn?: MapFunction): Promise>; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/paginating-endpoints.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/paginating-endpoints.d.ts new file mode 100644 index 00000000..f6a4d7b5 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/paginating-endpoints.d.ts @@ -0,0 +1,3 @@ +import { PaginatingEndpoints } from "./generated/paginating-endpoints"; +export { paginatingEndpoints } from "./generated/paginating-endpoints"; +export declare function isPaginatingEndpoint(arg: unknown): arg is keyof PaginatingEndpoints; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts new file mode 100644 index 00000000..2dcc8778 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/types.d.ts @@ -0,0 +1,242 @@ +import { Octokit } from "@octokit/core"; +import * as OctokitTypes from "@octokit/types"; +export { EndpointOptions, RequestInterface, OctokitResponse, RequestParameters, Route, } from "@octokit/types"; +export { PaginatingEndpoints } from "./generated/paginating-endpoints"; +import { PaginatingEndpoints } from "./generated/paginating-endpoints"; +declare type KnownKeys = Extract<{ + [K in keyof T]: string extends K ? never : number extends K ? never : K; +} extends { + [_ in keyof T]: infer U; +} ? U : never, keyof T>; +declare type KeysMatching = { + [K in keyof T]: T[K] extends V ? K : never; +}[keyof T]; +declare type KnownKeysMatching = KeysMatching>, V>; +declare type GetResultsType = T extends { + data: any[]; +} ? T["data"] : T extends { + data: object; +} ? T["data"][KnownKeysMatching] : never; +declare type NormalizeResponse = T & { + data: GetResultsType; +}; +declare type DataType = "data" extends keyof T ? T["data"] : unknown; +export interface MapFunction>, R = unknown[]> { + (response: T, done: () => void): R; +} +export declare type PaginationResults = T[]; +export interface PaginateInterface { + /** + * Paginate a request using endpoint options and map each response to a custom array + * + * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * @param {function} mapFn Optional method to map each response to a custom array + */ + (options: OctokitTypes.EndpointOptions, mapFn: MapFunction>, R[]>): Promise>; + /** + * Paginate a request using endpoint options + * + * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: OctokitTypes.EndpointOptions): Promise>; + /** + * Paginate a request using a known endpoint route string and map each response to a custom array + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {function} mapFn Optional method to map each response to a custom array + */ + (route: R, mapFn: MapFunction): Promise; + /** + * Paginate a request using a known endpoint route string and parameters, and map each response to a custom array + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * @param {function} mapFn Optional method to map each response to a custom array + */ + (route: R, parameters: PaginatingEndpoints[R]["parameters"], mapFn: MapFunction): Promise; + /** + * Paginate a request using an known endpoint route string + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: R, parameters?: PaginatingEndpoints[R]["parameters"]): Promise>; + /** + * Paginate a request using an unknown endpoint route string + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: R, parameters?: R extends keyof PaginatingEndpoints ? PaginatingEndpoints[R]["parameters"] : OctokitTypes.RequestParameters): Promise; + /** + * Paginate a request using an endpoint method and a map function + * + * @param {string} request Request method (`octokit.request` or `@octokit/request`) + * @param {function} mapFn? Optional method to map each response to a custom array + */ + (request: R, mapFn: MapFunction>, MR>): Promise; + /** + * Paginate a request using an endpoint method, parameters, and a map function + * + * @param {string} request Request method (`octokit.request` or `@octokit/request`) + * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * @param {function} mapFn? Optional method to map each response to a custom array + */ + (request: R, parameters: Parameters[0], mapFn: MapFunction>, MR>): Promise; + /** + * Paginate a request using an endpoint method and parameters + * + * @param {string} request Request method (`octokit.request` or `@octokit/request`) + * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: R, parameters?: Parameters[0]): Promise>["data"]>; + iterator: { + /** + * Get an async iterator to paginate a request using endpoint options + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: OctokitTypes.EndpointOptions): AsyncIterableIterator>>; + /** + * Get an async iterator to paginate a request using a known endpoint route string and optional parameters + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: R, parameters?: PaginatingEndpoints[R]["parameters"]): AsyncIterableIterator>>; + /** + * Get an async iterator to paginate a request using an unknown endpoint route string and optional parameters + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: R, parameters?: R extends keyof PaginatingEndpoints ? PaginatingEndpoints[R]["parameters"] : OctokitTypes.RequestParameters): AsyncIterableIterator>>; + /** + * Get an async iterator to paginate a request using a request method and optional parameters + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * @param {string} request `@octokit/request` or `octokit.request` method + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: R, parameters?: Parameters[0]): AsyncIterableIterator>>; + }; +} +export interface ComposePaginateInterface { + /** + * Paginate a request using endpoint options and map each response to a custom array + * + * @param {object} octokit Octokit instance + * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * @param {function} mapFn Optional method to map each response to a custom array + */ + (octokit: Octokit, options: OctokitTypes.EndpointOptions, mapFn: MapFunction>, R[]>): Promise>; + /** + * Paginate a request using endpoint options + * + * @param {object} octokit Octokit instance + * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, options: OctokitTypes.EndpointOptions): Promise>; + /** + * Paginate a request using a known endpoint route string and map each response to a custom array + * + * @param {object} octokit Octokit instance + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {function} mapFn Optional method to map each response to a custom array + */ + (octokit: Octokit, route: R, mapFn: MapFunction): Promise; + /** + * Paginate a request using a known endpoint route string and parameters, and map each response to a custom array + * + * @param {object} octokit Octokit instance + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * @param {function} mapFn Optional method to map each response to a custom array + */ + (octokit: Octokit, route: R, parameters: PaginatingEndpoints[R]["parameters"], mapFn: MapFunction): Promise; + /** + * Paginate a request using an known endpoint route string + * + * @param {object} octokit Octokit instance + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, route: R, parameters?: PaginatingEndpoints[R]["parameters"]): Promise>; + /** + * Paginate a request using an unknown endpoint route string + * + * @param {object} octokit Octokit instance + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, route: R, parameters?: R extends keyof PaginatingEndpoints ? PaginatingEndpoints[R]["parameters"] : OctokitTypes.RequestParameters): Promise; + /** + * Paginate a request using an endpoint method and a map function + * + * @param {object} octokit Octokit instance + * @param {string} request Request method (`octokit.request` or `@octokit/request`) + * @param {function} mapFn? Optional method to map each response to a custom array + */ + (octokit: Octokit, request: R, mapFn: MapFunction>, MR>): Promise; + /** + * Paginate a request using an endpoint method, parameters, and a map function + * + * @param {object} octokit Octokit instance + * @param {string} request Request method (`octokit.request` or `@octokit/request`) + * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * @param {function} mapFn? Optional method to map each response to a custom array + */ + (octokit: Octokit, request: R, parameters: Parameters[0], mapFn: MapFunction>, MR>): Promise; + /** + * Paginate a request using an endpoint method and parameters + * + * @param {object} octokit Octokit instance + * @param {string} request Request method (`octokit.request` or `@octokit/request`) + * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, request: R, parameters?: Parameters[0]): Promise>["data"]>; + iterator: { + /** + * Get an async iterator to paginate a request using endpoint options + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * + * @param {object} octokit Octokit instance + * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, options: OctokitTypes.EndpointOptions): AsyncIterableIterator>>; + /** + * Get an async iterator to paginate a request using a known endpoint route string and optional parameters + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * + * @param {object} octokit Octokit instance + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, route: R, parameters?: PaginatingEndpoints[R]["parameters"]): AsyncIterableIterator>>; + /** + * Get an async iterator to paginate a request using an unknown endpoint route string and optional parameters + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * + * @param {object} octokit Octokit instance + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, route: R, parameters?: R extends keyof PaginatingEndpoints ? PaginatingEndpoints[R]["parameters"] : OctokitTypes.RequestParameters): AsyncIterableIterator>>; + /** + * Get an async iterator to paginate a request using a request method and optional parameters + * + * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of + * + * @param {object} octokit Octokit instance + * @param {string} request `@octokit/request` or `octokit.request` method + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (octokit: Octokit, request: R, parameters?: Parameters[0]): AsyncIterableIterator>>; + }; +} diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-types/version.d.ts b/node_modules/@octokit/plugin-paginate-rest/dist-types/version.d.ts new file mode 100644 index 00000000..0a015050 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "2.13.3"; diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js b/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js new file mode 100644 index 00000000..b81c5aa5 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js @@ -0,0 +1,312 @@ +const VERSION = "2.13.3"; + +/** + * Some “list” response that can be paginated have a different response structure + * + * They have a `total_count` key in the response (search also has `incomplete_results`, + * /installation/repositories also has `repository_selection`), as well as a key with + * the list of the items which name varies from endpoint to endpoint. + * + * Octokit normalizes these responses so that paginated results are always returned following + * the same structure. One challenge is that if the list response has only one page, no Link + * header is provided, so this header alone is not sufficient to check wether a response is + * paginated or not. + * + * We check if a "total_count" key is present in the response data, but also make sure that + * a "url" property is not, as the "Get the combined status for a specific ref" endpoint would + * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + */ +function normalizePaginatedListResponse(response) { + const responseNeedsNormalization = "total_count" in response.data && !("url" in response.data); + if (!responseNeedsNormalization) + return response; + // keep the additional properties intact as there is currently no other way + // to retrieve the same information. + const incompleteResults = response.data.incomplete_results; + const repositorySelection = response.data.repository_selection; + const totalCount = response.data.total_count; + delete response.data.incomplete_results; + delete response.data.repository_selection; + delete response.data.total_count; + const namespaceKey = Object.keys(response.data)[0]; + const data = response.data[namespaceKey]; + response.data = data; + if (typeof incompleteResults !== "undefined") { + response.data.incomplete_results = incompleteResults; + } + if (typeof repositorySelection !== "undefined") { + response.data.repository_selection = repositorySelection; + } + response.data.total_count = totalCount; + return response; +} + +function iterator(octokit, route, parameters) { + const options = typeof route === "function" + ? route.endpoint(parameters) + : octokit.request.endpoint(route, parameters); + const requestMethod = typeof route === "function" ? route : octokit.request; + const method = options.method; + const headers = options.headers; + let url = options.url; + return { + [Symbol.asyncIterator]: () => ({ + async next() { + if (!url) + return { done: true }; + const response = await requestMethod({ method, url, headers }); + const normalizedResponse = normalizePaginatedListResponse(response); + // `response.headers.link` format: + // '; rel="next", ; rel="last"' + // sets `url` to undefined if "next" URL is not present or `link` header is not set + url = ((normalizedResponse.headers.link || "").match(/<([^>]+)>;\s*rel="next"/) || [])[1]; + return { value: normalizedResponse }; + }, + }), + }; +} + +function paginate(octokit, route, parameters, mapFn) { + if (typeof parameters === "function") { + mapFn = parameters; + parameters = undefined; + } + return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn); +} +function gather(octokit, results, iterator, mapFn) { + return iterator.next().then((result) => { + if (result.done) { + return results; + } + let earlyExit = false; + function done() { + earlyExit = true; + } + results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data); + if (earlyExit) { + return results; + } + return gather(octokit, results, iterator, mapFn); + }); +} + +const composePaginateRest = Object.assign(paginate, { + iterator, +}); + +const paginatingEndpoints = [ + "GET /app/installations", + "GET /applications/grants", + "GET /authorizations", + "GET /enterprises/{enterprise}/actions/permissions/organizations", + "GET /enterprises/{enterprise}/actions/runner-groups", + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", + "GET /enterprises/{enterprise}/actions/runners", + "GET /enterprises/{enterprise}/actions/runners/downloads", + "GET /events", + "GET /gists", + "GET /gists/public", + "GET /gists/starred", + "GET /gists/{gist_id}/comments", + "GET /gists/{gist_id}/commits", + "GET /gists/{gist_id}/forks", + "GET /installation/repositories", + "GET /issues", + "GET /marketplace_listing/plans", + "GET /marketplace_listing/plans/{plan_id}/accounts", + "GET /marketplace_listing/stubbed/plans", + "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts", + "GET /networks/{owner}/{repo}/events", + "GET /notifications", + "GET /organizations", + "GET /orgs/{org}/actions/permissions/repositories", + "GET /orgs/{org}/actions/runner-groups", + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners", + "GET /orgs/{org}/actions/runners", + "GET /orgs/{org}/actions/runners/downloads", + "GET /orgs/{org}/actions/secrets", + "GET /orgs/{org}/actions/secrets/{secret_name}/repositories", + "GET /orgs/{org}/blocks", + "GET /orgs/{org}/credential-authorizations", + "GET /orgs/{org}/events", + "GET /orgs/{org}/failed_invitations", + "GET /orgs/{org}/hooks", + "GET /orgs/{org}/installations", + "GET /orgs/{org}/invitations", + "GET /orgs/{org}/invitations/{invitation_id}/teams", + "GET /orgs/{org}/issues", + "GET /orgs/{org}/members", + "GET /orgs/{org}/migrations", + "GET /orgs/{org}/migrations/{migration_id}/repositories", + "GET /orgs/{org}/outside_collaborators", + "GET /orgs/{org}/projects", + "GET /orgs/{org}/public_members", + "GET /orgs/{org}/repos", + "GET /orgs/{org}/team-sync/groups", + "GET /orgs/{org}/teams", + "GET /orgs/{org}/teams/{team_slug}/discussions", + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + "GET /orgs/{org}/teams/{team_slug}/invitations", + "GET /orgs/{org}/teams/{team_slug}/members", + "GET /orgs/{org}/teams/{team_slug}/projects", + "GET /orgs/{org}/teams/{team_slug}/repos", + "GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings", + "GET /orgs/{org}/teams/{team_slug}/teams", + "GET /projects/columns/{column_id}/cards", + "GET /projects/{project_id}/collaborators", + "GET /projects/{project_id}/columns", + "GET /repos/{owner}/{repo}/actions/artifacts", + "GET /repos/{owner}/{repo}/actions/runners", + "GET /repos/{owner}/{repo}/actions/runners/downloads", + "GET /repos/{owner}/{repo}/actions/runs", + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", + "GET /repos/{owner}/{repo}/actions/secrets", + "GET /repos/{owner}/{repo}/actions/workflows", + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", + "GET /repos/{owner}/{repo}/assignees", + "GET /repos/{owner}/{repo}/branches", + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + "GET /repos/{owner}/{repo}/code-scanning/alerts", + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", + "GET /repos/{owner}/{repo}/code-scanning/analyses", + "GET /repos/{owner}/{repo}/collaborators", + "GET /repos/{owner}/{repo}/comments", + "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", + "GET /repos/{owner}/{repo}/commits", + "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", + "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments", + "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", + "GET /repos/{owner}/{repo}/commits/{ref}/check-runs", + "GET /repos/{owner}/{repo}/commits/{ref}/check-suites", + "GET /repos/{owner}/{repo}/commits/{ref}/statuses", + "GET /repos/{owner}/{repo}/contributors", + "GET /repos/{owner}/{repo}/deployments", + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + "GET /repos/{owner}/{repo}/events", + "GET /repos/{owner}/{repo}/forks", + "GET /repos/{owner}/{repo}/git/matching-refs/{ref}", + "GET /repos/{owner}/{repo}/hooks", + "GET /repos/{owner}/{repo}/invitations", + "GET /repos/{owner}/{repo}/issues", + "GET /repos/{owner}/{repo}/issues/comments", + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + "GET /repos/{owner}/{repo}/issues/events", + "GET /repos/{owner}/{repo}/issues/{issue_number}/comments", + "GET /repos/{owner}/{repo}/issues/{issue_number}/events", + "GET /repos/{owner}/{repo}/issues/{issue_number}/labels", + "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", + "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", + "GET /repos/{owner}/{repo}/keys", + "GET /repos/{owner}/{repo}/labels", + "GET /repos/{owner}/{repo}/milestones", + "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels", + "GET /repos/{owner}/{repo}/notifications", + "GET /repos/{owner}/{repo}/pages/builds", + "GET /repos/{owner}/{repo}/projects", + "GET /repos/{owner}/{repo}/pulls", + "GET /repos/{owner}/{repo}/pulls/comments", + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments", + "GET /repos/{owner}/{repo}/pulls/{pull_number}/commits", + "GET /repos/{owner}/{repo}/pulls/{pull_number}/files", + "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews", + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", + "GET /repos/{owner}/{repo}/releases", + "GET /repos/{owner}/{repo}/releases/{release_id}/assets", + "GET /repos/{owner}/{repo}/secret-scanning/alerts", + "GET /repos/{owner}/{repo}/stargazers", + "GET /repos/{owner}/{repo}/subscribers", + "GET /repos/{owner}/{repo}/tags", + "GET /repos/{owner}/{repo}/teams", + "GET /repositories", + "GET /repositories/{repository_id}/environments/{environment_name}/secrets", + "GET /scim/v2/enterprises/{enterprise}/Groups", + "GET /scim/v2/enterprises/{enterprise}/Users", + "GET /scim/v2/organizations/{org}/Users", + "GET /search/code", + "GET /search/commits", + "GET /search/issues", + "GET /search/labels", + "GET /search/repositories", + "GET /search/topics", + "GET /search/users", + "GET /teams/{team_id}/discussions", + "GET /teams/{team_id}/discussions/{discussion_number}/comments", + "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "GET /teams/{team_id}/discussions/{discussion_number}/reactions", + "GET /teams/{team_id}/invitations", + "GET /teams/{team_id}/members", + "GET /teams/{team_id}/projects", + "GET /teams/{team_id}/repos", + "GET /teams/{team_id}/team-sync/group-mappings", + "GET /teams/{team_id}/teams", + "GET /user/blocks", + "GET /user/emails", + "GET /user/followers", + "GET /user/following", + "GET /user/gpg_keys", + "GET /user/installations", + "GET /user/installations/{installation_id}/repositories", + "GET /user/issues", + "GET /user/keys", + "GET /user/marketplace_purchases", + "GET /user/marketplace_purchases/stubbed", + "GET /user/memberships/orgs", + "GET /user/migrations", + "GET /user/migrations/{migration_id}/repositories", + "GET /user/orgs", + "GET /user/public_emails", + "GET /user/repos", + "GET /user/repository_invitations", + "GET /user/starred", + "GET /user/subscriptions", + "GET /user/teams", + "GET /users", + "GET /users/{username}/events", + "GET /users/{username}/events/orgs/{org}", + "GET /users/{username}/events/public", + "GET /users/{username}/followers", + "GET /users/{username}/following", + "GET /users/{username}/gists", + "GET /users/{username}/gpg_keys", + "GET /users/{username}/keys", + "GET /users/{username}/orgs", + "GET /users/{username}/projects", + "GET /users/{username}/received_events", + "GET /users/{username}/received_events/public", + "GET /users/{username}/repos", + "GET /users/{username}/starred", + "GET /users/{username}/subscriptions", +]; + +function isPaginatingEndpoint(arg) { + if (typeof arg === "string") { + return paginatingEndpoints.includes(arg); + } + else { + return false; + } +} + +/** + * @param octokit Octokit instance + * @param options Options passed to Octokit constructor + */ +function paginateRest(octokit) { + return { + paginate: Object.assign(paginate.bind(null, octokit), { + iterator: iterator.bind(null, octokit), + }), + }; +} +paginateRest.VERSION = VERSION; + +export { composePaginateRest, isPaginatingEndpoint, paginateRest, paginatingEndpoints }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js.map b/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js.map new file mode 100644 index 00000000..3d0a4977 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/normalize-paginated-list-response.js","../dist-src/iterator.js","../dist-src/paginate.js","../dist-src/compose-paginate.js","../dist-src/generated/paginating-endpoints.js","../dist-src/paginating-endpoints.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"2.13.3\";\n","/**\n * Some “list” response that can be paginated have a different response structure\n *\n * They have a `total_count` key in the response (search also has `incomplete_results`,\n * /installation/repositories also has `repository_selection`), as well as a key with\n * the list of the items which name varies from endpoint to endpoint.\n *\n * Octokit normalizes these responses so that paginated results are always returned following\n * the same structure. One challenge is that if the list response has only one page, no Link\n * header is provided, so this header alone is not sufficient to check wether a response is\n * paginated or not.\n *\n * We check if a \"total_count\" key is present in the response data, but also make sure that\n * a \"url\" property is not, as the \"Get the combined status for a specific ref\" endpoint would\n * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref\n */\nexport function normalizePaginatedListResponse(response) {\n const responseNeedsNormalization = \"total_count\" in response.data && !(\"url\" in response.data);\n if (!responseNeedsNormalization)\n return response;\n // keep the additional properties intact as there is currently no other way\n // to retrieve the same information.\n const incompleteResults = response.data.incomplete_results;\n const repositorySelection = response.data.repository_selection;\n const totalCount = response.data.total_count;\n delete response.data.incomplete_results;\n delete response.data.repository_selection;\n delete response.data.total_count;\n const namespaceKey = Object.keys(response.data)[0];\n const data = response.data[namespaceKey];\n response.data = data;\n if (typeof incompleteResults !== \"undefined\") {\n response.data.incomplete_results = incompleteResults;\n }\n if (typeof repositorySelection !== \"undefined\") {\n response.data.repository_selection = repositorySelection;\n }\n response.data.total_count = totalCount;\n return response;\n}\n","import { normalizePaginatedListResponse } from \"./normalize-paginated-list-response\";\nexport function iterator(octokit, route, parameters) {\n const options = typeof route === \"function\"\n ? route.endpoint(parameters)\n : octokit.request.endpoint(route, parameters);\n const requestMethod = typeof route === \"function\" ? route : octokit.request;\n const method = options.method;\n const headers = options.headers;\n let url = options.url;\n return {\n [Symbol.asyncIterator]: () => ({\n async next() {\n if (!url)\n return { done: true };\n const response = await requestMethod({ method, url, headers });\n const normalizedResponse = normalizePaginatedListResponse(response);\n // `response.headers.link` format:\n // '; rel=\"next\", ; rel=\"last\"'\n // sets `url` to undefined if \"next\" URL is not present or `link` header is not set\n url = ((normalizedResponse.headers.link || \"\").match(/<([^>]+)>;\\s*rel=\"next\"/) || [])[1];\n return { value: normalizedResponse };\n },\n }),\n };\n}\n","import { iterator } from \"./iterator\";\nexport function paginate(octokit, route, parameters, mapFn) {\n if (typeof parameters === \"function\") {\n mapFn = parameters;\n parameters = undefined;\n }\n return gather(octokit, [], iterator(octokit, route, parameters)[Symbol.asyncIterator](), mapFn);\n}\nfunction gather(octokit, results, iterator, mapFn) {\n return iterator.next().then((result) => {\n if (result.done) {\n return results;\n }\n let earlyExit = false;\n function done() {\n earlyExit = true;\n }\n results = results.concat(mapFn ? mapFn(result.value, done) : result.value.data);\n if (earlyExit) {\n return results;\n }\n return gather(octokit, results, iterator, mapFn);\n });\n}\n","import { paginate } from \"./paginate\";\nimport { iterator } from \"./iterator\";\nexport const composePaginateRest = Object.assign(paginate, {\n iterator,\n});\n","export const paginatingEndpoints = [\n \"GET /app/installations\",\n \"GET /applications/grants\",\n \"GET /authorizations\",\n \"GET /enterprises/{enterprise}/actions/permissions/organizations\",\n \"GET /enterprises/{enterprise}/actions/runner-groups\",\n \"GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations\",\n \"GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners\",\n \"GET /enterprises/{enterprise}/actions/runners\",\n \"GET /enterprises/{enterprise}/actions/runners/downloads\",\n \"GET /events\",\n \"GET /gists\",\n \"GET /gists/public\",\n \"GET /gists/starred\",\n \"GET /gists/{gist_id}/comments\",\n \"GET /gists/{gist_id}/commits\",\n \"GET /gists/{gist_id}/forks\",\n \"GET /installation/repositories\",\n \"GET /issues\",\n \"GET /marketplace_listing/plans\",\n \"GET /marketplace_listing/plans/{plan_id}/accounts\",\n \"GET /marketplace_listing/stubbed/plans\",\n \"GET /marketplace_listing/stubbed/plans/{plan_id}/accounts\",\n \"GET /networks/{owner}/{repo}/events\",\n \"GET /notifications\",\n \"GET /organizations\",\n \"GET /orgs/{org}/actions/permissions/repositories\",\n \"GET /orgs/{org}/actions/runner-groups\",\n \"GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories\",\n \"GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners\",\n \"GET /orgs/{org}/actions/runners\",\n \"GET /orgs/{org}/actions/runners/downloads\",\n \"GET /orgs/{org}/actions/secrets\",\n \"GET /orgs/{org}/actions/secrets/{secret_name}/repositories\",\n \"GET /orgs/{org}/blocks\",\n \"GET /orgs/{org}/credential-authorizations\",\n \"GET /orgs/{org}/events\",\n \"GET /orgs/{org}/failed_invitations\",\n \"GET /orgs/{org}/hooks\",\n \"GET /orgs/{org}/installations\",\n \"GET /orgs/{org}/invitations\",\n \"GET /orgs/{org}/invitations/{invitation_id}/teams\",\n \"GET /orgs/{org}/issues\",\n \"GET /orgs/{org}/members\",\n \"GET /orgs/{org}/migrations\",\n \"GET /orgs/{org}/migrations/{migration_id}/repositories\",\n \"GET /orgs/{org}/outside_collaborators\",\n \"GET /orgs/{org}/projects\",\n \"GET /orgs/{org}/public_members\",\n \"GET /orgs/{org}/repos\",\n \"GET /orgs/{org}/team-sync/groups\",\n \"GET /orgs/{org}/teams\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions\",\n \"GET /orgs/{org}/teams/{team_slug}/invitations\",\n \"GET /orgs/{org}/teams/{team_slug}/members\",\n \"GET /orgs/{org}/teams/{team_slug}/projects\",\n \"GET /orgs/{org}/teams/{team_slug}/repos\",\n \"GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings\",\n \"GET /orgs/{org}/teams/{team_slug}/teams\",\n \"GET /projects/columns/{column_id}/cards\",\n \"GET /projects/{project_id}/collaborators\",\n \"GET /projects/{project_id}/columns\",\n \"GET /repos/{owner}/{repo}/actions/artifacts\",\n \"GET /repos/{owner}/{repo}/actions/runners\",\n \"GET /repos/{owner}/{repo}/actions/runners/downloads\",\n \"GET /repos/{owner}/{repo}/actions/runs\",\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts\",\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs\",\n \"GET /repos/{owner}/{repo}/actions/secrets\",\n \"GET /repos/{owner}/{repo}/actions/workflows\",\n \"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs\",\n \"GET /repos/{owner}/{repo}/assignees\",\n \"GET /repos/{owner}/{repo}/branches\",\n \"GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations\",\n \"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs\",\n \"GET /repos/{owner}/{repo}/code-scanning/alerts\",\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances\",\n \"GET /repos/{owner}/{repo}/code-scanning/analyses\",\n \"GET /repos/{owner}/{repo}/collaborators\",\n \"GET /repos/{owner}/{repo}/comments\",\n \"GET /repos/{owner}/{repo}/comments/{comment_id}/reactions\",\n \"GET /repos/{owner}/{repo}/commits\",\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head\",\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/comments\",\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/check-runs\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/check-suites\",\n \"GET /repos/{owner}/{repo}/commits/{ref}/statuses\",\n \"GET /repos/{owner}/{repo}/contributors\",\n \"GET /repos/{owner}/{repo}/deployments\",\n \"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses\",\n \"GET /repos/{owner}/{repo}/events\",\n \"GET /repos/{owner}/{repo}/forks\",\n \"GET /repos/{owner}/{repo}/git/matching-refs/{ref}\",\n \"GET /repos/{owner}/{repo}/hooks\",\n \"GET /repos/{owner}/{repo}/invitations\",\n \"GET /repos/{owner}/{repo}/issues\",\n \"GET /repos/{owner}/{repo}/issues/comments\",\n \"GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions\",\n \"GET /repos/{owner}/{repo}/issues/events\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/comments\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/events\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/labels\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/reactions\",\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/timeline\",\n \"GET /repos/{owner}/{repo}/keys\",\n \"GET /repos/{owner}/{repo}/labels\",\n \"GET /repos/{owner}/{repo}/milestones\",\n \"GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels\",\n \"GET /repos/{owner}/{repo}/notifications\",\n \"GET /repos/{owner}/{repo}/pages/builds\",\n \"GET /repos/{owner}/{repo}/projects\",\n \"GET /repos/{owner}/{repo}/pulls\",\n \"GET /repos/{owner}/{repo}/pulls/comments\",\n \"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/comments\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/commits\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/files\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews\",\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments\",\n \"GET /repos/{owner}/{repo}/releases\",\n \"GET /repos/{owner}/{repo}/releases/{release_id}/assets\",\n \"GET /repos/{owner}/{repo}/secret-scanning/alerts\",\n \"GET /repos/{owner}/{repo}/stargazers\",\n \"GET /repos/{owner}/{repo}/subscribers\",\n \"GET /repos/{owner}/{repo}/tags\",\n \"GET /repos/{owner}/{repo}/teams\",\n \"GET /repositories\",\n \"GET /repositories/{repository_id}/environments/{environment_name}/secrets\",\n \"GET /scim/v2/enterprises/{enterprise}/Groups\",\n \"GET /scim/v2/enterprises/{enterprise}/Users\",\n \"GET /scim/v2/organizations/{org}/Users\",\n \"GET /search/code\",\n \"GET /search/commits\",\n \"GET /search/issues\",\n \"GET /search/labels\",\n \"GET /search/repositories\",\n \"GET /search/topics\",\n \"GET /search/users\",\n \"GET /teams/{team_id}/discussions\",\n \"GET /teams/{team_id}/discussions/{discussion_number}/comments\",\n \"GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n \"GET /teams/{team_id}/discussions/{discussion_number}/reactions\",\n \"GET /teams/{team_id}/invitations\",\n \"GET /teams/{team_id}/members\",\n \"GET /teams/{team_id}/projects\",\n \"GET /teams/{team_id}/repos\",\n \"GET /teams/{team_id}/team-sync/group-mappings\",\n \"GET /teams/{team_id}/teams\",\n \"GET /user/blocks\",\n \"GET /user/emails\",\n \"GET /user/followers\",\n \"GET /user/following\",\n \"GET /user/gpg_keys\",\n \"GET /user/installations\",\n \"GET /user/installations/{installation_id}/repositories\",\n \"GET /user/issues\",\n \"GET /user/keys\",\n \"GET /user/marketplace_purchases\",\n \"GET /user/marketplace_purchases/stubbed\",\n \"GET /user/memberships/orgs\",\n \"GET /user/migrations\",\n \"GET /user/migrations/{migration_id}/repositories\",\n \"GET /user/orgs\",\n \"GET /user/public_emails\",\n \"GET /user/repos\",\n \"GET /user/repository_invitations\",\n \"GET /user/starred\",\n \"GET /user/subscriptions\",\n \"GET /user/teams\",\n \"GET /users\",\n \"GET /users/{username}/events\",\n \"GET /users/{username}/events/orgs/{org}\",\n \"GET /users/{username}/events/public\",\n \"GET /users/{username}/followers\",\n \"GET /users/{username}/following\",\n \"GET /users/{username}/gists\",\n \"GET /users/{username}/gpg_keys\",\n \"GET /users/{username}/keys\",\n \"GET /users/{username}/orgs\",\n \"GET /users/{username}/projects\",\n \"GET /users/{username}/received_events\",\n \"GET /users/{username}/received_events/public\",\n \"GET /users/{username}/repos\",\n \"GET /users/{username}/starred\",\n \"GET /users/{username}/subscriptions\",\n];\n","import { paginatingEndpoints, } from \"./generated/paginating-endpoints\";\nexport { paginatingEndpoints } from \"./generated/paginating-endpoints\";\nexport function isPaginatingEndpoint(arg) {\n if (typeof arg === \"string\") {\n return paginatingEndpoints.includes(arg);\n }\n else {\n return false;\n }\n}\n","import { VERSION } from \"./version\";\nimport { paginate } from \"./paginate\";\nimport { iterator } from \"./iterator\";\nexport { composePaginateRest } from \"./compose-paginate\";\nexport { isPaginatingEndpoint, paginatingEndpoints, } from \"./paginating-endpoints\";\n/**\n * @param octokit Octokit instance\n * @param options Options passed to Octokit constructor\n */\nexport function paginateRest(octokit) {\n return {\n paginate: Object.assign(paginate.bind(null, octokit), {\n iterator: iterator.bind(null, octokit),\n }),\n };\n}\npaginateRest.VERSION = VERSION;\n"],"names":[],"mappings":"AAAO,MAAM,OAAO,GAAG,mBAAmB;;ACA1C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,AAAO,SAAS,8BAA8B,CAAC,QAAQ,EAAE;AACzD,IAAI,MAAM,0BAA0B,GAAG,aAAa,IAAI,QAAQ,CAAC,IAAI,IAAI,EAAE,KAAK,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;AACnG,IAAI,IAAI,CAAC,0BAA0B;AACnC,QAAQ,OAAO,QAAQ,CAAC;AACxB;AACA;AACA,IAAI,MAAM,iBAAiB,GAAG,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC;AAC/D,IAAI,MAAM,mBAAmB,GAAG,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC;AACnE,IAAI,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;AACjD,IAAI,OAAO,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC;AAC5C,IAAI,OAAO,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC;AAC9C,IAAI,OAAO,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;AACrC,IAAI,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACvD,IAAI,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AAC7C,IAAI,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;AACzB,IAAI,IAAI,OAAO,iBAAiB,KAAK,WAAW,EAAE;AAClD,QAAQ,QAAQ,CAAC,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;AAC7D,KAAK;AACL,IAAI,IAAI,OAAO,mBAAmB,KAAK,WAAW,EAAE;AACpD,QAAQ,QAAQ,CAAC,IAAI,CAAC,oBAAoB,GAAG,mBAAmB,CAAC;AACjE,KAAK;AACL,IAAI,QAAQ,CAAC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;AAC3C,IAAI,OAAO,QAAQ,CAAC;AACpB,CAAC;;ACtCM,SAAS,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE;AACrD,IAAI,MAAM,OAAO,GAAG,OAAO,KAAK,KAAK,UAAU;AAC/C,UAAU,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC;AACpC,UAAU,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AACtD,IAAI,MAAM,aAAa,GAAG,OAAO,KAAK,KAAK,UAAU,GAAG,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC;AAChF,IAAI,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AAClC,IAAI,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;AACpC,IAAI,IAAI,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;AAC1B,IAAI,OAAO;AACX,QAAQ,CAAC,MAAM,CAAC,aAAa,GAAG,OAAO;AACvC,YAAY,MAAM,IAAI,GAAG;AACzB,gBAAgB,IAAI,CAAC,GAAG;AACxB,oBAAoB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAC1C,gBAAgB,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;AAC/E,gBAAgB,MAAM,kBAAkB,GAAG,8BAA8B,CAAC,QAAQ,CAAC,CAAC;AACpF;AACA;AACA;AACA,gBAAgB,GAAG,GAAG,CAAC,CAAC,kBAAkB,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,EAAE,KAAK,CAAC,yBAAyB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;AAC1G,gBAAgB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;AACrD,aAAa;AACb,SAAS,CAAC;AACV,KAAK,CAAC;AACN,CAAC;;ACvBM,SAAS,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE;AAC5D,IAAI,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE;AAC1C,QAAQ,KAAK,GAAG,UAAU,CAAC;AAC3B,QAAQ,UAAU,GAAG,SAAS,CAAC;AAC/B,KAAK;AACL,IAAI,OAAO,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AACpG,CAAC;AACD,SAAS,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE;AACnD,IAAI,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK;AAC5C,QAAQ,IAAI,MAAM,CAAC,IAAI,EAAE;AACzB,YAAY,OAAO,OAAO,CAAC;AAC3B,SAAS;AACT,QAAQ,IAAI,SAAS,GAAG,KAAK,CAAC;AAC9B,QAAQ,SAAS,IAAI,GAAG;AACxB,YAAY,SAAS,GAAG,IAAI,CAAC;AAC7B,SAAS;AACT,QAAQ,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACxF,QAAQ,IAAI,SAAS,EAAE;AACvB,YAAY,OAAO,OAAO,CAAC;AAC3B,SAAS;AACT,QAAQ,OAAO,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AACzD,KAAK,CAAC,CAAC;AACP,CAAC;;ACrBW,MAAC,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;AAC3D,IAAI,QAAQ;AACZ,CAAC,CAAC;;ACJU,MAAC,mBAAmB,GAAG;AACnC,IAAI,wBAAwB;AAC5B,IAAI,0BAA0B;AAC9B,IAAI,qBAAqB;AACzB,IAAI,iEAAiE;AACrE,IAAI,qDAAqD;AACzD,IAAI,qFAAqF;AACzF,IAAI,+EAA+E;AACnF,IAAI,+CAA+C;AACnD,IAAI,yDAAyD;AAC7D,IAAI,aAAa;AACjB,IAAI,YAAY;AAChB,IAAI,mBAAmB;AACvB,IAAI,oBAAoB;AACxB,IAAI,+BAA+B;AACnC,IAAI,8BAA8B;AAClC,IAAI,4BAA4B;AAChC,IAAI,gCAAgC;AACpC,IAAI,aAAa;AACjB,IAAI,gCAAgC;AACpC,IAAI,mDAAmD;AACvD,IAAI,wCAAwC;AAC5C,IAAI,2DAA2D;AAC/D,IAAI,qCAAqC;AACzC,IAAI,oBAAoB;AACxB,IAAI,oBAAoB;AACxB,IAAI,kDAAkD;AACtD,IAAI,uCAAuC;AAC3C,IAAI,sEAAsE;AAC1E,IAAI,iEAAiE;AACrE,IAAI,iCAAiC;AACrC,IAAI,2CAA2C;AAC/C,IAAI,iCAAiC;AACrC,IAAI,4DAA4D;AAChE,IAAI,wBAAwB;AAC5B,IAAI,2CAA2C;AAC/C,IAAI,wBAAwB;AAC5B,IAAI,oCAAoC;AACxC,IAAI,uBAAuB;AAC3B,IAAI,+BAA+B;AACnC,IAAI,6BAA6B;AACjC,IAAI,mDAAmD;AACvD,IAAI,wBAAwB;AAC5B,IAAI,yBAAyB;AAC7B,IAAI,4BAA4B;AAChC,IAAI,wDAAwD;AAC5D,IAAI,uCAAuC;AAC3C,IAAI,0BAA0B;AAC9B,IAAI,gCAAgC;AACpC,IAAI,uBAAuB;AAC3B,IAAI,kCAAkC;AACtC,IAAI,uBAAuB;AAC3B,IAAI,+CAA+C;AACnD,IAAI,4EAA4E;AAChF,IAAI,uGAAuG;AAC3G,IAAI,6EAA6E;AACjF,IAAI,+CAA+C;AACnD,IAAI,2CAA2C;AAC/C,IAAI,4CAA4C;AAChD,IAAI,yCAAyC;AAC7C,IAAI,4DAA4D;AAChE,IAAI,yCAAyC;AAC7C,IAAI,yCAAyC;AAC7C,IAAI,0CAA0C;AAC9C,IAAI,oCAAoC;AACxC,IAAI,6CAA6C;AACjD,IAAI,2CAA2C;AAC/C,IAAI,qDAAqD;AACzD,IAAI,wCAAwC;AAC5C,IAAI,2DAA2D;AAC/D,IAAI,sDAAsD;AAC1D,IAAI,2CAA2C;AAC/C,IAAI,6CAA6C;AACjD,IAAI,gEAAgE;AACpE,IAAI,qCAAqC;AACzC,IAAI,oCAAoC;AACxC,IAAI,iEAAiE;AACrE,IAAI,oEAAoE;AACxE,IAAI,gDAAgD;AACpD,IAAI,yEAAyE;AAC7E,IAAI,kDAAkD;AACtD,IAAI,yCAAyC;AAC7C,IAAI,oCAAoC;AACxC,IAAI,2DAA2D;AAC/D,IAAI,mCAAmC;AACvC,IAAI,oEAAoE;AACxE,IAAI,yDAAyD;AAC7D,IAAI,sDAAsD;AAC1D,IAAI,oDAAoD;AACxD,IAAI,sDAAsD;AAC1D,IAAI,kDAAkD;AACtD,IAAI,wCAAwC;AAC5C,IAAI,uCAAuC;AAC3C,IAAI,gEAAgE;AACpE,IAAI,kCAAkC;AACtC,IAAI,iCAAiC;AACrC,IAAI,mDAAmD;AACvD,IAAI,iCAAiC;AACrC,IAAI,uCAAuC;AAC3C,IAAI,kCAAkC;AACtC,IAAI,2CAA2C;AAC/C,IAAI,kEAAkE;AACtE,IAAI,yCAAyC;AAC7C,IAAI,0DAA0D;AAC9D,IAAI,wDAAwD;AAC5D,IAAI,wDAAwD;AAC5D,IAAI,2DAA2D;AAC/D,IAAI,0DAA0D;AAC9D,IAAI,gCAAgC;AACpC,IAAI,kCAAkC;AACtC,IAAI,sCAAsC;AAC1C,IAAI,gEAAgE;AACpE,IAAI,yCAAyC;AAC7C,IAAI,wCAAwC;AAC5C,IAAI,oCAAoC;AACxC,IAAI,iCAAiC;AACrC,IAAI,0CAA0C;AAC9C,IAAI,iEAAiE;AACrE,IAAI,wDAAwD;AAC5D,IAAI,uDAAuD;AAC3D,IAAI,qDAAqD;AACzD,IAAI,mEAAmE;AACvE,IAAI,uDAAuD;AAC3D,IAAI,4EAA4E;AAChF,IAAI,oCAAoC;AACxC,IAAI,wDAAwD;AAC5D,IAAI,kDAAkD;AACtD,IAAI,sCAAsC;AAC1C,IAAI,uCAAuC;AAC3C,IAAI,gCAAgC;AACpC,IAAI,iCAAiC;AACrC,IAAI,mBAAmB;AACvB,IAAI,2EAA2E;AAC/E,IAAI,8CAA8C;AAClD,IAAI,6CAA6C;AACjD,IAAI,wCAAwC;AAC5C,IAAI,kBAAkB;AACtB,IAAI,qBAAqB;AACzB,IAAI,oBAAoB;AACxB,IAAI,oBAAoB;AACxB,IAAI,0BAA0B;AAC9B,IAAI,oBAAoB;AACxB,IAAI,mBAAmB;AACvB,IAAI,kCAAkC;AACtC,IAAI,+DAA+D;AACnE,IAAI,0FAA0F;AAC9F,IAAI,gEAAgE;AACpE,IAAI,kCAAkC;AACtC,IAAI,8BAA8B;AAClC,IAAI,+BAA+B;AACnC,IAAI,4BAA4B;AAChC,IAAI,+CAA+C;AACnD,IAAI,4BAA4B;AAChC,IAAI,kBAAkB;AACtB,IAAI,kBAAkB;AACtB,IAAI,qBAAqB;AACzB,IAAI,qBAAqB;AACzB,IAAI,oBAAoB;AACxB,IAAI,yBAAyB;AAC7B,IAAI,wDAAwD;AAC5D,IAAI,kBAAkB;AACtB,IAAI,gBAAgB;AACpB,IAAI,iCAAiC;AACrC,IAAI,yCAAyC;AAC7C,IAAI,4BAA4B;AAChC,IAAI,sBAAsB;AAC1B,IAAI,kDAAkD;AACtD,IAAI,gBAAgB;AACpB,IAAI,yBAAyB;AAC7B,IAAI,iBAAiB;AACrB,IAAI,kCAAkC;AACtC,IAAI,mBAAmB;AACvB,IAAI,yBAAyB;AAC7B,IAAI,iBAAiB;AACrB,IAAI,YAAY;AAChB,IAAI,8BAA8B;AAClC,IAAI,yCAAyC;AAC7C,IAAI,qCAAqC;AACzC,IAAI,iCAAiC;AACrC,IAAI,iCAAiC;AACrC,IAAI,6BAA6B;AACjC,IAAI,gCAAgC;AACpC,IAAI,4BAA4B;AAChC,IAAI,4BAA4B;AAChC,IAAI,gCAAgC;AACpC,IAAI,uCAAuC;AAC3C,IAAI,8CAA8C;AAClD,IAAI,6BAA6B;AACjC,IAAI,+BAA+B;AACnC,IAAI,qCAAqC;AACzC,CAAC;;AC5LM,SAAS,oBAAoB,CAAC,GAAG,EAAE;AAC1C,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;AACjC,QAAQ,OAAO,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AACjD,KAAK;AACL,SAAS;AACT,QAAQ,OAAO,KAAK,CAAC;AACrB,KAAK;AACL,CAAC;;ACJD;AACA;AACA;AACA;AACA,AAAO,SAAS,YAAY,CAAC,OAAO,EAAE;AACtC,IAAI,OAAO;AACX,QAAQ,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE;AAC9D,YAAY,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC;AAClD,SAAS,CAAC;AACV,KAAK,CAAC;AACN,CAAC;AACD,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/plugin-paginate-rest/package.json b/node_modules/@octokit/plugin-paginate-rest/package.json new file mode 100644 index 00000000..a9748957 --- /dev/null +++ b/node_modules/@octokit/plugin-paginate-rest/package.json @@ -0,0 +1,51 @@ +{ + "name": "@octokit/plugin-paginate-rest", + "description": "Octokit plugin to paginate REST API endpoint responses", + "version": "2.13.3", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "github", + "api", + "sdk", + "toolkit" + ], + "repository": "github:octokit/plugin-paginate-rest.js", + "dependencies": { + "@octokit/types": "^6.11.0" + }, + "peerDependencies": { + "@octokit/core": ">=2" + }, + "devDependencies": { + "@octokit/core": "^3.0.0", + "@octokit/plugin-rest-endpoint-methods": "^4.0.0", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/fetch-mock": "^7.3.1", + "@types/jest": "^26.0.0", + "@types/node": "^14.0.4", + "fetch-mock": "^9.0.0", + "jest": "^26.0.1", + "npm-run-all": "^4.1.5", + "prettier": "^2.0.4", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "ts-jest": "^26.0.0", + "typescript": "^4.0.2" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/LICENSE b/node_modules/@octokit/plugin-rest-endpoint-methods/LICENSE new file mode 100644 index 00000000..57bee5f1 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/LICENSE @@ -0,0 +1,7 @@ +MIT License Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/README.md b/node_modules/@octokit/plugin-rest-endpoint-methods/README.md new file mode 100644 index 00000000..8a17a79a --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/README.md @@ -0,0 +1,76 @@ +# plugin-rest-endpoint-methods.js + +> Octokit plugin adding one method for all of api.github.com REST API endpoints + +[![@latest](https://img.shields.io/npm/v/@octokit/plugin-rest-endpoint-methods.svg)](https://www.npmjs.com/package/@octokit/plugin-rest-endpoint-methods) +[![Build Status](https://github.com/octokit/plugin-rest-endpoint-methods.js/workflows/Test/badge.svg)](https://github.com/octokit/plugin-rest-endpoint-methods.js/actions?workflow=Test) + +## Usage + + + + + + +
+Browsers + + +Load `@octokit/plugin-rest-endpoint-methods` and [`@octokit/core`](https://github.com/octokit/core.js) (or core-compatible module) directly from [cdn.skypack.dev](https://cdn.skypack.dev) + +```html + +``` + +
+Node + + +Install with `npm install @octokit/core @octokit/plugin-rest-endpoint-methods`. Optionally replace `@octokit/core` with a compatible module + +```js +const { Octokit } = require("@octokit/core"); +const { + restEndpointMethods, +} = require("@octokit/plugin-rest-endpoint-methods"); +``` + +
+ +```js +const MyOctokit = Octokit.plugin(restEndpointMethods); +const octokit = new MyOctokit({ auth: "secret123" }); + +// https://developer.github.com/v3/users/#get-the-authenticated-user +octokit.rest.users.getAuthenticated(); +``` + +There is one method for each REST API endpoint documented at [https://developer.github.com/v3](https://developer.github.com/v3). All endpoint methods are documented in the [docs/](docs/) folder, e.g. [docs/users/getAuthenticated.md](docs/users/getAuthenticated.md) + +## TypeScript + +Parameter and response types for all endpoint methods exported as `{ RestEndpointMethodTypes }`. + +Example + +```ts +import { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods"; + +type UpdateLabelParameters = + RestEndpointMethodTypes["issues"]["updateLabel"]["parameters"]; +type UpdateLabelResponse = + RestEndpointMethodTypes["issues"]["updateLabel"]["response"]; +``` + +In order to get types beyond parameters and responses, check out [`@octokit/openapi-types`](https://github.com/octokit/openapi-types.ts/#readme), which is a direct transpliation from GitHub's official OpenAPI specification. + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js new file mode 100644 index 00000000..f1b5ae42 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js @@ -0,0 +1,1257 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +function ownKeys(object, enumerableOnly) { + var keys = Object.keys(object); + + if (Object.getOwnPropertySymbols) { + var symbols = Object.getOwnPropertySymbols(object); + + if (enumerableOnly) { + symbols = symbols.filter(function (sym) { + return Object.getOwnPropertyDescriptor(object, sym).enumerable; + }); + } + + keys.push.apply(keys, symbols); + } + + return keys; +} + +function _objectSpread2(target) { + for (var i = 1; i < arguments.length; i++) { + var source = arguments[i] != null ? arguments[i] : {}; + + if (i % 2) { + ownKeys(Object(source), true).forEach(function (key) { + _defineProperty(target, key, source[key]); + }); + } else if (Object.getOwnPropertyDescriptors) { + Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); + } else { + ownKeys(Object(source)).forEach(function (key) { + Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); + }); + } + } + + return target; +} + +function _defineProperty(obj, key, value) { + if (key in obj) { + Object.defineProperty(obj, key, { + value: value, + enumerable: true, + configurable: true, + writable: true + }); + } else { + obj[key] = value; + } + + return obj; +} + +const Endpoints = { + actions: { + addSelectedRepoToOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"], + approveWorkflowRun: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve"], + cancelWorkflowRun: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel"], + createOrUpdateEnvironmentSecret: ["PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"], + createOrUpdateOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}"], + createOrUpdateRepoSecret: ["PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}"], + createRegistrationTokenForOrg: ["POST /orgs/{org}/actions/runners/registration-token"], + createRegistrationTokenForRepo: ["POST /repos/{owner}/{repo}/actions/runners/registration-token"], + createRemoveTokenForOrg: ["POST /orgs/{org}/actions/runners/remove-token"], + createRemoveTokenForRepo: ["POST /repos/{owner}/{repo}/actions/runners/remove-token"], + createWorkflowDispatch: ["POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches"], + deleteArtifact: ["DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"], + deleteEnvironmentSecret: ["DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"], + deleteOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}"], + deleteRepoSecret: ["DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}"], + deleteSelfHostedRunnerFromOrg: ["DELETE /orgs/{org}/actions/runners/{runner_id}"], + deleteSelfHostedRunnerFromRepo: ["DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}"], + deleteWorkflowRun: ["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}"], + deleteWorkflowRunLogs: ["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs"], + disableSelectedRepositoryGithubActionsOrganization: ["DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}"], + disableWorkflow: ["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable"], + downloadArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}"], + downloadJobLogsForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"], + downloadWorkflowRunLogs: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs"], + enableSelectedRepositoryGithubActionsOrganization: ["PUT /orgs/{org}/actions/permissions/repositories/{repository_id}"], + enableWorkflow: ["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable"], + getAllowedActionsOrganization: ["GET /orgs/{org}/actions/permissions/selected-actions"], + getAllowedActionsRepository: ["GET /repos/{owner}/{repo}/actions/permissions/selected-actions"], + getArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"], + getEnvironmentPublicKey: ["GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key"], + getEnvironmentSecret: ["GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"], + getGithubActionsPermissionsOrganization: ["GET /orgs/{org}/actions/permissions"], + getGithubActionsPermissionsRepository: ["GET /repos/{owner}/{repo}/actions/permissions"], + getJobForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"], + getOrgPublicKey: ["GET /orgs/{org}/actions/secrets/public-key"], + getOrgSecret: ["GET /orgs/{org}/actions/secrets/{secret_name}"], + getPendingDeploymentsForRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"], + getRepoPermissions: ["GET /repos/{owner}/{repo}/actions/permissions", {}, { + renamed: ["actions", "getGithubActionsPermissionsRepository"] + }], + getRepoPublicKey: ["GET /repos/{owner}/{repo}/actions/secrets/public-key"], + getRepoSecret: ["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"], + getReviewsForRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals"], + getSelfHostedRunnerForOrg: ["GET /orgs/{org}/actions/runners/{runner_id}"], + getSelfHostedRunnerForRepo: ["GET /repos/{owner}/{repo}/actions/runners/{runner_id}"], + getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], + getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], + getWorkflowRunUsage: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing"], + getWorkflowUsage: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing"], + listArtifactsForRepo: ["GET /repos/{owner}/{repo}/actions/artifacts"], + listEnvironmentSecrets: ["GET /repositories/{repository_id}/environments/{environment_name}/secrets"], + listJobsForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"], + listOrgSecrets: ["GET /orgs/{org}/actions/secrets"], + listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], + listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], + listRunnerApplicationsForOrg: ["GET /orgs/{org}/actions/runners/downloads"], + listRunnerApplicationsForRepo: ["GET /repos/{owner}/{repo}/actions/runners/downloads"], + listSelectedReposForOrgSecret: ["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"], + listSelectedRepositoriesEnabledGithubActionsOrganization: ["GET /orgs/{org}/actions/permissions/repositories"], + listSelfHostedRunnersForOrg: ["GET /orgs/{org}/actions/runners"], + listSelfHostedRunnersForRepo: ["GET /repos/{owner}/{repo}/actions/runners"], + listWorkflowRunArtifacts: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"], + listWorkflowRuns: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"], + listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"], + reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"], + removeSelectedRepoFromOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"], + reviewPendingDeploymentsForRun: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"], + setAllowedActionsOrganization: ["PUT /orgs/{org}/actions/permissions/selected-actions"], + setAllowedActionsRepository: ["PUT /repos/{owner}/{repo}/actions/permissions/selected-actions"], + setGithubActionsPermissionsOrganization: ["PUT /orgs/{org}/actions/permissions"], + setGithubActionsPermissionsRepository: ["PUT /repos/{owner}/{repo}/actions/permissions"], + setSelectedReposForOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories"], + setSelectedRepositoriesEnabledGithubActionsOrganization: ["PUT /orgs/{org}/actions/permissions/repositories"] + }, + activity: { + checkRepoIsStarredByAuthenticatedUser: ["GET /user/starred/{owner}/{repo}"], + deleteRepoSubscription: ["DELETE /repos/{owner}/{repo}/subscription"], + deleteThreadSubscription: ["DELETE /notifications/threads/{thread_id}/subscription"], + getFeeds: ["GET /feeds"], + getRepoSubscription: ["GET /repos/{owner}/{repo}/subscription"], + getThread: ["GET /notifications/threads/{thread_id}"], + getThreadSubscriptionForAuthenticatedUser: ["GET /notifications/threads/{thread_id}/subscription"], + listEventsForAuthenticatedUser: ["GET /users/{username}/events"], + listNotificationsForAuthenticatedUser: ["GET /notifications"], + listOrgEventsForAuthenticatedUser: ["GET /users/{username}/events/orgs/{org}"], + listPublicEvents: ["GET /events"], + listPublicEventsForRepoNetwork: ["GET /networks/{owner}/{repo}/events"], + listPublicEventsForUser: ["GET /users/{username}/events/public"], + listPublicOrgEvents: ["GET /orgs/{org}/events"], + listReceivedEventsForUser: ["GET /users/{username}/received_events"], + listReceivedPublicEventsForUser: ["GET /users/{username}/received_events/public"], + listRepoEvents: ["GET /repos/{owner}/{repo}/events"], + listRepoNotificationsForAuthenticatedUser: ["GET /repos/{owner}/{repo}/notifications"], + listReposStarredByAuthenticatedUser: ["GET /user/starred"], + listReposStarredByUser: ["GET /users/{username}/starred"], + listReposWatchedByUser: ["GET /users/{username}/subscriptions"], + listStargazersForRepo: ["GET /repos/{owner}/{repo}/stargazers"], + listWatchedReposForAuthenticatedUser: ["GET /user/subscriptions"], + listWatchersForRepo: ["GET /repos/{owner}/{repo}/subscribers"], + markNotificationsAsRead: ["PUT /notifications"], + markRepoNotificationsAsRead: ["PUT /repos/{owner}/{repo}/notifications"], + markThreadAsRead: ["PATCH /notifications/threads/{thread_id}"], + setRepoSubscription: ["PUT /repos/{owner}/{repo}/subscription"], + setThreadSubscription: ["PUT /notifications/threads/{thread_id}/subscription"], + starRepoForAuthenticatedUser: ["PUT /user/starred/{owner}/{repo}"], + unstarRepoForAuthenticatedUser: ["DELETE /user/starred/{owner}/{repo}"] + }, + apps: { + addRepoToInstallation: ["PUT /user/installations/{installation_id}/repositories/{repository_id}"], + checkToken: ["POST /applications/{client_id}/token"], + createContentAttachment: ["POST /content_references/{content_reference_id}/attachments", { + mediaType: { + previews: ["corsair"] + } + }], + createContentAttachmentForRepo: ["POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", { + mediaType: { + previews: ["corsair"] + } + }], + createFromManifest: ["POST /app-manifests/{code}/conversions"], + createInstallationAccessToken: ["POST /app/installations/{installation_id}/access_tokens"], + deleteAuthorization: ["DELETE /applications/{client_id}/grant"], + deleteInstallation: ["DELETE /app/installations/{installation_id}"], + deleteToken: ["DELETE /applications/{client_id}/token"], + getAuthenticated: ["GET /app"], + getBySlug: ["GET /apps/{app_slug}"], + getInstallation: ["GET /app/installations/{installation_id}"], + getOrgInstallation: ["GET /orgs/{org}/installation"], + getRepoInstallation: ["GET /repos/{owner}/{repo}/installation"], + getSubscriptionPlanForAccount: ["GET /marketplace_listing/accounts/{account_id}"], + getSubscriptionPlanForAccountStubbed: ["GET /marketplace_listing/stubbed/accounts/{account_id}"], + getUserInstallation: ["GET /users/{username}/installation"], + getWebhookConfigForApp: ["GET /app/hook/config"], + listAccountsForPlan: ["GET /marketplace_listing/plans/{plan_id}/accounts"], + listAccountsForPlanStubbed: ["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"], + listInstallationReposForAuthenticatedUser: ["GET /user/installations/{installation_id}/repositories"], + listInstallations: ["GET /app/installations"], + listInstallationsForAuthenticatedUser: ["GET /user/installations"], + listPlans: ["GET /marketplace_listing/plans"], + listPlansStubbed: ["GET /marketplace_listing/stubbed/plans"], + listReposAccessibleToInstallation: ["GET /installation/repositories"], + listSubscriptionsForAuthenticatedUser: ["GET /user/marketplace_purchases"], + listSubscriptionsForAuthenticatedUserStubbed: ["GET /user/marketplace_purchases/stubbed"], + removeRepoFromInstallation: ["DELETE /user/installations/{installation_id}/repositories/{repository_id}"], + resetToken: ["PATCH /applications/{client_id}/token"], + revokeInstallationAccessToken: ["DELETE /installation/token"], + scopeToken: ["POST /applications/{client_id}/token/scoped"], + suspendInstallation: ["PUT /app/installations/{installation_id}/suspended"], + unsuspendInstallation: ["DELETE /app/installations/{installation_id}/suspended"], + updateWebhookConfigForApp: ["PATCH /app/hook/config"] + }, + billing: { + getGithubActionsBillingOrg: ["GET /orgs/{org}/settings/billing/actions"], + getGithubActionsBillingUser: ["GET /users/{username}/settings/billing/actions"], + getGithubPackagesBillingOrg: ["GET /orgs/{org}/settings/billing/packages"], + getGithubPackagesBillingUser: ["GET /users/{username}/settings/billing/packages"], + getSharedStorageBillingOrg: ["GET /orgs/{org}/settings/billing/shared-storage"], + getSharedStorageBillingUser: ["GET /users/{username}/settings/billing/shared-storage"] + }, + checks: { + create: ["POST /repos/{owner}/{repo}/check-runs"], + createSuite: ["POST /repos/{owner}/{repo}/check-suites"], + get: ["GET /repos/{owner}/{repo}/check-runs/{check_run_id}"], + getSuite: ["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}"], + listAnnotations: ["GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"], + listForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"], + listForSuite: ["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"], + listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"], + rerequestSuite: ["POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"], + setSuitesPreferences: ["PATCH /repos/{owner}/{repo}/check-suites/preferences"], + update: ["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"] + }, + codeScanning: { + deleteAnalysis: ["DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}"], + getAlert: ["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", {}, { + renamedParameters: { + alert_id: "alert_number" + } + }], + getAnalysis: ["GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}"], + getSarif: ["GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"], + listAlertInstances: ["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"], + listAlertsForRepo: ["GET /repos/{owner}/{repo}/code-scanning/alerts"], + listAlertsInstances: ["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", {}, { + renamed: ["codeScanning", "listAlertInstances"] + }], + listRecentAnalyses: ["GET /repos/{owner}/{repo}/code-scanning/analyses"], + updateAlert: ["PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"], + uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"] + }, + codesOfConduct: { + getAllCodesOfConduct: ["GET /codes_of_conduct", { + mediaType: { + previews: ["scarlet-witch"] + } + }], + getConductCode: ["GET /codes_of_conduct/{key}", { + mediaType: { + previews: ["scarlet-witch"] + } + }], + getForRepo: ["GET /repos/{owner}/{repo}/community/code_of_conduct", { + mediaType: { + previews: ["scarlet-witch"] + } + }] + }, + emojis: { + get: ["GET /emojis"] + }, + enterpriseAdmin: { + disableSelectedOrganizationGithubActionsEnterprise: ["DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"], + enableSelectedOrganizationGithubActionsEnterprise: ["PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"], + getAllowedActionsEnterprise: ["GET /enterprises/{enterprise}/actions/permissions/selected-actions"], + getGithubActionsPermissionsEnterprise: ["GET /enterprises/{enterprise}/actions/permissions"], + listSelectedOrganizationsEnabledGithubActionsEnterprise: ["GET /enterprises/{enterprise}/actions/permissions/organizations"], + setAllowedActionsEnterprise: ["PUT /enterprises/{enterprise}/actions/permissions/selected-actions"], + setGithubActionsPermissionsEnterprise: ["PUT /enterprises/{enterprise}/actions/permissions"], + setSelectedOrganizationsEnabledGithubActionsEnterprise: ["PUT /enterprises/{enterprise}/actions/permissions/organizations"] + }, + gists: { + checkIsStarred: ["GET /gists/{gist_id}/star"], + create: ["POST /gists"], + createComment: ["POST /gists/{gist_id}/comments"], + delete: ["DELETE /gists/{gist_id}"], + deleteComment: ["DELETE /gists/{gist_id}/comments/{comment_id}"], + fork: ["POST /gists/{gist_id}/forks"], + get: ["GET /gists/{gist_id}"], + getComment: ["GET /gists/{gist_id}/comments/{comment_id}"], + getRevision: ["GET /gists/{gist_id}/{sha}"], + list: ["GET /gists"], + listComments: ["GET /gists/{gist_id}/comments"], + listCommits: ["GET /gists/{gist_id}/commits"], + listForUser: ["GET /users/{username}/gists"], + listForks: ["GET /gists/{gist_id}/forks"], + listPublic: ["GET /gists/public"], + listStarred: ["GET /gists/starred"], + star: ["PUT /gists/{gist_id}/star"], + unstar: ["DELETE /gists/{gist_id}/star"], + update: ["PATCH /gists/{gist_id}"], + updateComment: ["PATCH /gists/{gist_id}/comments/{comment_id}"] + }, + git: { + createBlob: ["POST /repos/{owner}/{repo}/git/blobs"], + createCommit: ["POST /repos/{owner}/{repo}/git/commits"], + createRef: ["POST /repos/{owner}/{repo}/git/refs"], + createTag: ["POST /repos/{owner}/{repo}/git/tags"], + createTree: ["POST /repos/{owner}/{repo}/git/trees"], + deleteRef: ["DELETE /repos/{owner}/{repo}/git/refs/{ref}"], + getBlob: ["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"], + getCommit: ["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"], + getRef: ["GET /repos/{owner}/{repo}/git/ref/{ref}"], + getTag: ["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"], + getTree: ["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"], + listMatchingRefs: ["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"], + updateRef: ["PATCH /repos/{owner}/{repo}/git/refs/{ref}"] + }, + gitignore: { + getAllTemplates: ["GET /gitignore/templates"], + getTemplate: ["GET /gitignore/templates/{name}"] + }, + interactions: { + getRestrictionsForAuthenticatedUser: ["GET /user/interaction-limits"], + getRestrictionsForOrg: ["GET /orgs/{org}/interaction-limits"], + getRestrictionsForRepo: ["GET /repos/{owner}/{repo}/interaction-limits"], + getRestrictionsForYourPublicRepos: ["GET /user/interaction-limits", {}, { + renamed: ["interactions", "getRestrictionsForAuthenticatedUser"] + }], + removeRestrictionsForAuthenticatedUser: ["DELETE /user/interaction-limits"], + removeRestrictionsForOrg: ["DELETE /orgs/{org}/interaction-limits"], + removeRestrictionsForRepo: ["DELETE /repos/{owner}/{repo}/interaction-limits"], + removeRestrictionsForYourPublicRepos: ["DELETE /user/interaction-limits", {}, { + renamed: ["interactions", "removeRestrictionsForAuthenticatedUser"] + }], + setRestrictionsForAuthenticatedUser: ["PUT /user/interaction-limits"], + setRestrictionsForOrg: ["PUT /orgs/{org}/interaction-limits"], + setRestrictionsForRepo: ["PUT /repos/{owner}/{repo}/interaction-limits"], + setRestrictionsForYourPublicRepos: ["PUT /user/interaction-limits", {}, { + renamed: ["interactions", "setRestrictionsForAuthenticatedUser"] + }] + }, + issues: { + addAssignees: ["POST /repos/{owner}/{repo}/issues/{issue_number}/assignees"], + addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"], + checkUserCanBeAssigned: ["GET /repos/{owner}/{repo}/assignees/{assignee}"], + create: ["POST /repos/{owner}/{repo}/issues"], + createComment: ["POST /repos/{owner}/{repo}/issues/{issue_number}/comments"], + createLabel: ["POST /repos/{owner}/{repo}/labels"], + createMilestone: ["POST /repos/{owner}/{repo}/milestones"], + deleteComment: ["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}"], + deleteLabel: ["DELETE /repos/{owner}/{repo}/labels/{name}"], + deleteMilestone: ["DELETE /repos/{owner}/{repo}/milestones/{milestone_number}"], + get: ["GET /repos/{owner}/{repo}/issues/{issue_number}"], + getComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"], + getEvent: ["GET /repos/{owner}/{repo}/issues/events/{event_id}"], + getLabel: ["GET /repos/{owner}/{repo}/labels/{name}"], + getMilestone: ["GET /repos/{owner}/{repo}/milestones/{milestone_number}"], + list: ["GET /issues"], + listAssignees: ["GET /repos/{owner}/{repo}/assignees"], + listComments: ["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"], + listCommentsForRepo: ["GET /repos/{owner}/{repo}/issues/comments"], + listEvents: ["GET /repos/{owner}/{repo}/issues/{issue_number}/events"], + listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"], + listEventsForTimeline: ["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", { + mediaType: { + previews: ["mockingbird"] + } + }], + listForAuthenticatedUser: ["GET /user/issues"], + listForOrg: ["GET /orgs/{org}/issues"], + listForRepo: ["GET /repos/{owner}/{repo}/issues"], + listLabelsForMilestone: ["GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels"], + listLabelsForRepo: ["GET /repos/{owner}/{repo}/labels"], + listLabelsOnIssue: ["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"], + listMilestones: ["GET /repos/{owner}/{repo}/milestones"], + lock: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"], + removeAllLabels: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels"], + removeAssignees: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees"], + removeLabel: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}"], + setLabels: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"], + unlock: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"], + update: ["PATCH /repos/{owner}/{repo}/issues/{issue_number}"], + updateComment: ["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"], + updateLabel: ["PATCH /repos/{owner}/{repo}/labels/{name}"], + updateMilestone: ["PATCH /repos/{owner}/{repo}/milestones/{milestone_number}"] + }, + licenses: { + get: ["GET /licenses/{license}"], + getAllCommonlyUsed: ["GET /licenses"], + getForRepo: ["GET /repos/{owner}/{repo}/license"] + }, + markdown: { + render: ["POST /markdown"], + renderRaw: ["POST /markdown/raw", { + headers: { + "content-type": "text/plain; charset=utf-8" + } + }] + }, + meta: { + get: ["GET /meta"], + getOctocat: ["GET /octocat"], + getZen: ["GET /zen"], + root: ["GET /"] + }, + migrations: { + cancelImport: ["DELETE /repos/{owner}/{repo}/import"], + deleteArchiveForAuthenticatedUser: ["DELETE /user/migrations/{migration_id}/archive", { + mediaType: { + previews: ["wyandotte"] + } + }], + deleteArchiveForOrg: ["DELETE /orgs/{org}/migrations/{migration_id}/archive", { + mediaType: { + previews: ["wyandotte"] + } + }], + downloadArchiveForOrg: ["GET /orgs/{org}/migrations/{migration_id}/archive", { + mediaType: { + previews: ["wyandotte"] + } + }], + getArchiveForAuthenticatedUser: ["GET /user/migrations/{migration_id}/archive", { + mediaType: { + previews: ["wyandotte"] + } + }], + getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"], + getImportStatus: ["GET /repos/{owner}/{repo}/import"], + getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"], + getStatusForAuthenticatedUser: ["GET /user/migrations/{migration_id}", { + mediaType: { + previews: ["wyandotte"] + } + }], + getStatusForOrg: ["GET /orgs/{org}/migrations/{migration_id}", { + mediaType: { + previews: ["wyandotte"] + } + }], + listForAuthenticatedUser: ["GET /user/migrations", { + mediaType: { + previews: ["wyandotte"] + } + }], + listForOrg: ["GET /orgs/{org}/migrations", { + mediaType: { + previews: ["wyandotte"] + } + }], + listReposForOrg: ["GET /orgs/{org}/migrations/{migration_id}/repositories", { + mediaType: { + previews: ["wyandotte"] + } + }], + listReposForUser: ["GET /user/migrations/{migration_id}/repositories", { + mediaType: { + previews: ["wyandotte"] + } + }], + mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"], + setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"], + startForAuthenticatedUser: ["POST /user/migrations"], + startForOrg: ["POST /orgs/{org}/migrations"], + startImport: ["PUT /repos/{owner}/{repo}/import"], + unlockRepoForAuthenticatedUser: ["DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock", { + mediaType: { + previews: ["wyandotte"] + } + }], + unlockRepoForOrg: ["DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", { + mediaType: { + previews: ["wyandotte"] + } + }], + updateImport: ["PATCH /repos/{owner}/{repo}/import"] + }, + orgs: { + blockUser: ["PUT /orgs/{org}/blocks/{username}"], + cancelInvitation: ["DELETE /orgs/{org}/invitations/{invitation_id}"], + checkBlockedUser: ["GET /orgs/{org}/blocks/{username}"], + checkMembershipForUser: ["GET /orgs/{org}/members/{username}"], + checkPublicMembershipForUser: ["GET /orgs/{org}/public_members/{username}"], + convertMemberToOutsideCollaborator: ["PUT /orgs/{org}/outside_collaborators/{username}"], + createInvitation: ["POST /orgs/{org}/invitations"], + createWebhook: ["POST /orgs/{org}/hooks"], + deleteWebhook: ["DELETE /orgs/{org}/hooks/{hook_id}"], + get: ["GET /orgs/{org}"], + getMembershipForAuthenticatedUser: ["GET /user/memberships/orgs/{org}"], + getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], + getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], + getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"], + list: ["GET /organizations"], + listAppInstallations: ["GET /orgs/{org}/installations"], + listBlockedUsers: ["GET /orgs/{org}/blocks"], + listFailedInvitations: ["GET /orgs/{org}/failed_invitations"], + listForAuthenticatedUser: ["GET /user/orgs"], + listForUser: ["GET /users/{username}/orgs"], + listInvitationTeams: ["GET /orgs/{org}/invitations/{invitation_id}/teams"], + listMembers: ["GET /orgs/{org}/members"], + listMembershipsForAuthenticatedUser: ["GET /user/memberships/orgs"], + listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], + listPendingInvitations: ["GET /orgs/{org}/invitations"], + listPublicMembers: ["GET /orgs/{org}/public_members"], + listWebhooks: ["GET /orgs/{org}/hooks"], + pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], + removeMember: ["DELETE /orgs/{org}/members/{username}"], + removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"], + removeOutsideCollaborator: ["DELETE /orgs/{org}/outside_collaborators/{username}"], + removePublicMembershipForAuthenticatedUser: ["DELETE /orgs/{org}/public_members/{username}"], + setMembershipForUser: ["PUT /orgs/{org}/memberships/{username}"], + setPublicMembershipForAuthenticatedUser: ["PUT /orgs/{org}/public_members/{username}"], + unblockUser: ["DELETE /orgs/{org}/blocks/{username}"], + update: ["PATCH /orgs/{org}"], + updateMembershipForAuthenticatedUser: ["PATCH /user/memberships/orgs/{org}"], + updateWebhook: ["PATCH /orgs/{org}/hooks/{hook_id}"], + updateWebhookConfigForOrg: ["PATCH /orgs/{org}/hooks/{hook_id}/config"] + }, + packages: { + deletePackageForAuthenticatedUser: ["DELETE /user/packages/{package_type}/{package_name}"], + deletePackageForOrg: ["DELETE /orgs/{org}/packages/{package_type}/{package_name}"], + deletePackageVersionForAuthenticatedUser: ["DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}"], + deletePackageVersionForOrg: ["DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"], + getAllPackageVersionsForAPackageOwnedByAnOrg: ["GET /orgs/{org}/packages/{package_type}/{package_name}/versions", {}, { + renamed: ["packages", "getAllPackageVersionsForPackageOwnedByOrg"] + }], + getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser: ["GET /user/packages/{package_type}/{package_name}/versions", {}, { + renamed: ["packages", "getAllPackageVersionsForPackageOwnedByAuthenticatedUser"] + }], + getAllPackageVersionsForPackageOwnedByAuthenticatedUser: ["GET /user/packages/{package_type}/{package_name}/versions"], + getAllPackageVersionsForPackageOwnedByOrg: ["GET /orgs/{org}/packages/{package_type}/{package_name}/versions"], + getAllPackageVersionsForPackageOwnedByUser: ["GET /users/{username}/packages/{package_type}/{package_name}/versions"], + getPackageForAuthenticatedUser: ["GET /user/packages/{package_type}/{package_name}"], + getPackageForOrganization: ["GET /orgs/{org}/packages/{package_type}/{package_name}"], + getPackageForUser: ["GET /users/{username}/packages/{package_type}/{package_name}"], + getPackageVersionForAuthenticatedUser: ["GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}"], + getPackageVersionForOrganization: ["GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"], + getPackageVersionForUser: ["GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"], + restorePackageForAuthenticatedUser: ["POST /user/packages/{package_type}/{package_name}/restore{?token}"], + restorePackageForOrg: ["POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}"], + restorePackageVersionForAuthenticatedUser: ["POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"], + restorePackageVersionForOrg: ["POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"] + }, + projects: { + addCollaborator: ["PUT /projects/{project_id}/collaborators/{username}", { + mediaType: { + previews: ["inertia"] + } + }], + createCard: ["POST /projects/columns/{column_id}/cards", { + mediaType: { + previews: ["inertia"] + } + }], + createColumn: ["POST /projects/{project_id}/columns", { + mediaType: { + previews: ["inertia"] + } + }], + createForAuthenticatedUser: ["POST /user/projects", { + mediaType: { + previews: ["inertia"] + } + }], + createForOrg: ["POST /orgs/{org}/projects", { + mediaType: { + previews: ["inertia"] + } + }], + createForRepo: ["POST /repos/{owner}/{repo}/projects", { + mediaType: { + previews: ["inertia"] + } + }], + delete: ["DELETE /projects/{project_id}", { + mediaType: { + previews: ["inertia"] + } + }], + deleteCard: ["DELETE /projects/columns/cards/{card_id}", { + mediaType: { + previews: ["inertia"] + } + }], + deleteColumn: ["DELETE /projects/columns/{column_id}", { + mediaType: { + previews: ["inertia"] + } + }], + get: ["GET /projects/{project_id}", { + mediaType: { + previews: ["inertia"] + } + }], + getCard: ["GET /projects/columns/cards/{card_id}", { + mediaType: { + previews: ["inertia"] + } + }], + getColumn: ["GET /projects/columns/{column_id}", { + mediaType: { + previews: ["inertia"] + } + }], + getPermissionForUser: ["GET /projects/{project_id}/collaborators/{username}/permission", { + mediaType: { + previews: ["inertia"] + } + }], + listCards: ["GET /projects/columns/{column_id}/cards", { + mediaType: { + previews: ["inertia"] + } + }], + listCollaborators: ["GET /projects/{project_id}/collaborators", { + mediaType: { + previews: ["inertia"] + } + }], + listColumns: ["GET /projects/{project_id}/columns", { + mediaType: { + previews: ["inertia"] + } + }], + listForOrg: ["GET /orgs/{org}/projects", { + mediaType: { + previews: ["inertia"] + } + }], + listForRepo: ["GET /repos/{owner}/{repo}/projects", { + mediaType: { + previews: ["inertia"] + } + }], + listForUser: ["GET /users/{username}/projects", { + mediaType: { + previews: ["inertia"] + } + }], + moveCard: ["POST /projects/columns/cards/{card_id}/moves", { + mediaType: { + previews: ["inertia"] + } + }], + moveColumn: ["POST /projects/columns/{column_id}/moves", { + mediaType: { + previews: ["inertia"] + } + }], + removeCollaborator: ["DELETE /projects/{project_id}/collaborators/{username}", { + mediaType: { + previews: ["inertia"] + } + }], + update: ["PATCH /projects/{project_id}", { + mediaType: { + previews: ["inertia"] + } + }], + updateCard: ["PATCH /projects/columns/cards/{card_id}", { + mediaType: { + previews: ["inertia"] + } + }], + updateColumn: ["PATCH /projects/columns/{column_id}", { + mediaType: { + previews: ["inertia"] + } + }] + }, + pulls: { + checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + create: ["POST /repos/{owner}/{repo}/pulls"], + createReplyForReviewComment: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"], + createReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + createReviewComment: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments"], + deletePendingReview: ["DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"], + deleteReviewComment: ["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}"], + dismissReview: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals"], + get: ["GET /repos/{owner}/{repo}/pulls/{pull_number}"], + getReview: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"], + getReviewComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"], + list: ["GET /repos/{owner}/{repo}/pulls"], + listCommentsForReview: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments"], + listCommits: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"], + listFiles: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"], + listRequestedReviewers: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"], + listReviewComments: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"], + listReviewCommentsForRepo: ["GET /repos/{owner}/{repo}/pulls/comments"], + listReviews: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + merge: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + removeRequestedReviewers: ["DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"], + requestReviewers: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"], + submitReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"], + update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"], + updateBranch: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch", { + mediaType: { + previews: ["lydian"] + } + }], + updateReview: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"], + updateReviewComment: ["PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}"] + }, + rateLimit: { + get: ["GET /rate_limit"] + }, + reactions: { + createForCommitComment: ["POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + createForIssue: ["POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + createForIssueComment: ["POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + createForPullRequestReviewComment: ["POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + createForRelease: ["POST /repos/{owner}/{repo}/releases/{release_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + createForTeamDiscussionCommentInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + createForTeamDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteForCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteForIssue: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteForIssueComment: ["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteForPullRequestComment: ["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteForTeamDiscussion: ["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteForTeamDiscussionComment: ["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + deleteLegacy: ["DELETE /reactions/{reaction_id}", { + mediaType: { + previews: ["squirrel-girl"] + } + }, { + deprecated: "octokit.rest.reactions.deleteLegacy() is deprecated, see https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy" + }], + listForCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + listForIssue: ["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + listForIssueComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + listForPullRequestReviewComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + listForTeamDiscussionCommentInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }], + listForTeamDiscussionInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", { + mediaType: { + previews: ["squirrel-girl"] + } + }] + }, + repos: { + acceptInvitation: ["PATCH /user/repository_invitations/{invitation_id}"], + addAppAccessRestrictions: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", {}, { + mapToData: "apps" + }], + addCollaborator: ["PUT /repos/{owner}/{repo}/collaborators/{username}"], + addStatusCheckContexts: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", {}, { + mapToData: "contexts" + }], + addTeamAccessRestrictions: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", {}, { + mapToData: "teams" + }], + addUserAccessRestrictions: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", {}, { + mapToData: "users" + }], + checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], + checkVulnerabilityAlerts: ["GET /repos/{owner}/{repo}/vulnerability-alerts", { + mediaType: { + previews: ["dorian"] + } + }], + compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], + compareCommitsWithBasehead: ["GET /repos/{owner}/{repo}/compare/{basehead}"], + createCommitComment: ["POST /repos/{owner}/{repo}/commits/{commit_sha}/comments"], + createCommitSignatureProtection: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", { + mediaType: { + previews: ["zzzax"] + } + }], + createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"], + createDeployKey: ["POST /repos/{owner}/{repo}/keys"], + createDeployment: ["POST /repos/{owner}/{repo}/deployments"], + createDeploymentStatus: ["POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"], + createDispatchEvent: ["POST /repos/{owner}/{repo}/dispatches"], + createForAuthenticatedUser: ["POST /user/repos"], + createFork: ["POST /repos/{owner}/{repo}/forks"], + createInOrg: ["POST /orgs/{org}/repos"], + createOrUpdateEnvironment: ["PUT /repos/{owner}/{repo}/environments/{environment_name}"], + createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], + createPagesSite: ["POST /repos/{owner}/{repo}/pages", { + mediaType: { + previews: ["switcheroo"] + } + }], + createRelease: ["POST /repos/{owner}/{repo}/releases"], + createUsingTemplate: ["POST /repos/{template_owner}/{template_repo}/generate", { + mediaType: { + previews: ["baptiste"] + } + }], + createWebhook: ["POST /repos/{owner}/{repo}/hooks"], + declineInvitation: ["DELETE /user/repository_invitations/{invitation_id}"], + delete: ["DELETE /repos/{owner}/{repo}"], + deleteAccessRestrictions: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"], + deleteAdminBranchProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"], + deleteAnEnvironment: ["DELETE /repos/{owner}/{repo}/environments/{environment_name}"], + deleteBranchProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection"], + deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"], + deleteCommitSignatureProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", { + mediaType: { + previews: ["zzzax"] + } + }], + deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"], + deleteDeployment: ["DELETE /repos/{owner}/{repo}/deployments/{deployment_id}"], + deleteFile: ["DELETE /repos/{owner}/{repo}/contents/{path}"], + deleteInvitation: ["DELETE /repos/{owner}/{repo}/invitations/{invitation_id}"], + deletePagesSite: ["DELETE /repos/{owner}/{repo}/pages", { + mediaType: { + previews: ["switcheroo"] + } + }], + deletePullRequestReviewProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"], + deleteRelease: ["DELETE /repos/{owner}/{repo}/releases/{release_id}"], + deleteReleaseAsset: ["DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}"], + deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], + disableAutomatedSecurityFixes: ["DELETE /repos/{owner}/{repo}/automated-security-fixes", { + mediaType: { + previews: ["london"] + } + }], + disableVulnerabilityAlerts: ["DELETE /repos/{owner}/{repo}/vulnerability-alerts", { + mediaType: { + previews: ["dorian"] + } + }], + downloadArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}", {}, { + renamed: ["repos", "downloadZipballArchive"] + }], + downloadTarballArchive: ["GET /repos/{owner}/{repo}/tarball/{ref}"], + downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"], + enableAutomatedSecurityFixes: ["PUT /repos/{owner}/{repo}/automated-security-fixes", { + mediaType: { + previews: ["london"] + } + }], + enableVulnerabilityAlerts: ["PUT /repos/{owner}/{repo}/vulnerability-alerts", { + mediaType: { + previews: ["dorian"] + } + }], + get: ["GET /repos/{owner}/{repo}"], + getAccessRestrictions: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"], + getAdminBranchProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"], + getAllEnvironments: ["GET /repos/{owner}/{repo}/environments"], + getAllStatusCheckContexts: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"], + getAllTopics: ["GET /repos/{owner}/{repo}/topics", { + mediaType: { + previews: ["mercy"] + } + }], + getAppsWithAccessToProtectedBranch: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"], + getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"], + getBranchProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection"], + getClones: ["GET /repos/{owner}/{repo}/traffic/clones"], + getCodeFrequencyStats: ["GET /repos/{owner}/{repo}/stats/code_frequency"], + getCollaboratorPermissionLevel: ["GET /repos/{owner}/{repo}/collaborators/{username}/permission"], + getCombinedStatusForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/status"], + getCommit: ["GET /repos/{owner}/{repo}/commits/{ref}"], + getCommitActivityStats: ["GET /repos/{owner}/{repo}/stats/commit_activity"], + getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"], + getCommitSignatureProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", { + mediaType: { + previews: ["zzzax"] + } + }], + getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"], + getContent: ["GET /repos/{owner}/{repo}/contents/{path}"], + getContributorsStats: ["GET /repos/{owner}/{repo}/stats/contributors"], + getDeployKey: ["GET /repos/{owner}/{repo}/keys/{key_id}"], + getDeployment: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}"], + getDeploymentStatus: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}"], + getEnvironment: ["GET /repos/{owner}/{repo}/environments/{environment_name}"], + getLatestPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/latest"], + getLatestRelease: ["GET /repos/{owner}/{repo}/releases/latest"], + getPages: ["GET /repos/{owner}/{repo}/pages"], + getPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/{build_id}"], + getPagesHealthCheck: ["GET /repos/{owner}/{repo}/pages/health"], + getParticipationStats: ["GET /repos/{owner}/{repo}/stats/participation"], + getPullRequestReviewProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"], + getPunchCardStats: ["GET /repos/{owner}/{repo}/stats/punch_card"], + getReadme: ["GET /repos/{owner}/{repo}/readme"], + getReadmeInDirectory: ["GET /repos/{owner}/{repo}/readme/{dir}"], + getRelease: ["GET /repos/{owner}/{repo}/releases/{release_id}"], + getReleaseAsset: ["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"], + getReleaseByTag: ["GET /repos/{owner}/{repo}/releases/tags/{tag}"], + getStatusChecksProtection: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"], + getTeamsWithAccessToProtectedBranch: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"], + getTopPaths: ["GET /repos/{owner}/{repo}/traffic/popular/paths"], + getTopReferrers: ["GET /repos/{owner}/{repo}/traffic/popular/referrers"], + getUsersWithAccessToProtectedBranch: ["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"], + getViews: ["GET /repos/{owner}/{repo}/traffic/views"], + getWebhook: ["GET /repos/{owner}/{repo}/hooks/{hook_id}"], + getWebhookConfigForRepo: ["GET /repos/{owner}/{repo}/hooks/{hook_id}/config"], + listBranches: ["GET /repos/{owner}/{repo}/branches"], + listBranchesForHeadCommit: ["GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", { + mediaType: { + previews: ["groot"] + } + }], + listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"], + listCommentsForCommit: ["GET /repos/{owner}/{repo}/commits/{commit_sha}/comments"], + listCommitCommentsForRepo: ["GET /repos/{owner}/{repo}/comments"], + listCommitStatusesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/statuses"], + listCommits: ["GET /repos/{owner}/{repo}/commits"], + listContributors: ["GET /repos/{owner}/{repo}/contributors"], + listDeployKeys: ["GET /repos/{owner}/{repo}/keys"], + listDeploymentStatuses: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"], + listDeployments: ["GET /repos/{owner}/{repo}/deployments"], + listForAuthenticatedUser: ["GET /user/repos"], + listForOrg: ["GET /orgs/{org}/repos"], + listForUser: ["GET /users/{username}/repos"], + listForks: ["GET /repos/{owner}/{repo}/forks"], + listInvitations: ["GET /repos/{owner}/{repo}/invitations"], + listInvitationsForAuthenticatedUser: ["GET /user/repository_invitations"], + listLanguages: ["GET /repos/{owner}/{repo}/languages"], + listPagesBuilds: ["GET /repos/{owner}/{repo}/pages/builds"], + listPublic: ["GET /repositories"], + listPullRequestsAssociatedWithCommit: ["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", { + mediaType: { + previews: ["groot"] + } + }], + listReleaseAssets: ["GET /repos/{owner}/{repo}/releases/{release_id}/assets"], + listReleases: ["GET /repos/{owner}/{repo}/releases"], + listTags: ["GET /repos/{owner}/{repo}/tags"], + listTeams: ["GET /repos/{owner}/{repo}/teams"], + listWebhooks: ["GET /repos/{owner}/{repo}/hooks"], + merge: ["POST /repos/{owner}/{repo}/merges"], + pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"], + removeAppAccessRestrictions: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", {}, { + mapToData: "apps" + }], + removeCollaborator: ["DELETE /repos/{owner}/{repo}/collaborators/{username}"], + removeStatusCheckContexts: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", {}, { + mapToData: "contexts" + }], + removeStatusCheckProtection: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"], + removeTeamAccessRestrictions: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", {}, { + mapToData: "teams" + }], + removeUserAccessRestrictions: ["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", {}, { + mapToData: "users" + }], + renameBranch: ["POST /repos/{owner}/{repo}/branches/{branch}/rename"], + replaceAllTopics: ["PUT /repos/{owner}/{repo}/topics", { + mediaType: { + previews: ["mercy"] + } + }], + requestPagesBuild: ["POST /repos/{owner}/{repo}/pages/builds"], + setAdminBranchProtection: ["POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"], + setAppAccessRestrictions: ["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", {}, { + mapToData: "apps" + }], + setStatusCheckContexts: ["PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", {}, { + mapToData: "contexts" + }], + setTeamAccessRestrictions: ["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", {}, { + mapToData: "teams" + }], + setUserAccessRestrictions: ["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", {}, { + mapToData: "users" + }], + testPushWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"], + transfer: ["POST /repos/{owner}/{repo}/transfer"], + update: ["PATCH /repos/{owner}/{repo}"], + updateBranchProtection: ["PUT /repos/{owner}/{repo}/branches/{branch}/protection"], + updateCommitComment: ["PATCH /repos/{owner}/{repo}/comments/{comment_id}"], + updateInformationAboutPagesSite: ["PUT /repos/{owner}/{repo}/pages"], + updateInvitation: ["PATCH /repos/{owner}/{repo}/invitations/{invitation_id}"], + updatePullRequestReviewProtection: ["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"], + updateRelease: ["PATCH /repos/{owner}/{repo}/releases/{release_id}"], + updateReleaseAsset: ["PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}"], + updateStatusCheckPotection: ["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", {}, { + renamed: ["repos", "updateStatusCheckProtection"] + }], + updateStatusCheckProtection: ["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"], + updateWebhook: ["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"], + updateWebhookConfigForRepo: ["PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config"], + uploadReleaseAsset: ["POST /repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", { + baseUrl: "https://uploads.github.com" + }] + }, + search: { + code: ["GET /search/code"], + commits: ["GET /search/commits", { + mediaType: { + previews: ["cloak"] + } + }], + issuesAndPullRequests: ["GET /search/issues"], + labels: ["GET /search/labels"], + repos: ["GET /search/repositories"], + topics: ["GET /search/topics", { + mediaType: { + previews: ["mercy"] + } + }], + users: ["GET /search/users"] + }, + secretScanning: { + getAlert: ["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"], + listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], + updateAlert: ["PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"] + }, + teams: { + addOrUpdateMembershipForUserInOrg: ["PUT /orgs/{org}/teams/{team_slug}/memberships/{username}"], + addOrUpdateProjectPermissionsInOrg: ["PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", { + mediaType: { + previews: ["inertia"] + } + }], + addOrUpdateRepoPermissionsInOrg: ["PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"], + checkPermissionsForProjectInOrg: ["GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", { + mediaType: { + previews: ["inertia"] + } + }], + checkPermissionsForRepoInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"], + create: ["POST /orgs/{org}/teams"], + createDiscussionCommentInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"], + createDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions"], + deleteDiscussionCommentInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"], + deleteDiscussionInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"], + deleteInOrg: ["DELETE /orgs/{org}/teams/{team_slug}"], + getByName: ["GET /orgs/{org}/teams/{team_slug}"], + getDiscussionCommentInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"], + getDiscussionInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"], + getMembershipForUserInOrg: ["GET /orgs/{org}/teams/{team_slug}/memberships/{username}"], + list: ["GET /orgs/{org}/teams"], + listChildInOrg: ["GET /orgs/{org}/teams/{team_slug}/teams"], + listDiscussionCommentsInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"], + listDiscussionsInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions"], + listForAuthenticatedUser: ["GET /user/teams"], + listMembersInOrg: ["GET /orgs/{org}/teams/{team_slug}/members"], + listPendingInvitationsInOrg: ["GET /orgs/{org}/teams/{team_slug}/invitations"], + listProjectsInOrg: ["GET /orgs/{org}/teams/{team_slug}/projects", { + mediaType: { + previews: ["inertia"] + } + }], + listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], + removeMembershipForUserInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}"], + removeProjectInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}"], + removeRepoInOrg: ["DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"], + updateDiscussionCommentInOrg: ["PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"], + updateDiscussionInOrg: ["PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"], + updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"] + }, + users: { + addEmailForAuthenticated: ["POST /user/emails"], + block: ["PUT /user/blocks/{username}"], + checkBlocked: ["GET /user/blocks/{username}"], + checkFollowingForUser: ["GET /users/{username}/following/{target_user}"], + checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"], + createGpgKeyForAuthenticated: ["POST /user/gpg_keys"], + createPublicSshKeyForAuthenticated: ["POST /user/keys"], + deleteEmailForAuthenticated: ["DELETE /user/emails"], + deleteGpgKeyForAuthenticated: ["DELETE /user/gpg_keys/{gpg_key_id}"], + deletePublicSshKeyForAuthenticated: ["DELETE /user/keys/{key_id}"], + follow: ["PUT /user/following/{username}"], + getAuthenticated: ["GET /user"], + getByUsername: ["GET /users/{username}"], + getContextForUser: ["GET /users/{username}/hovercard"], + getGpgKeyForAuthenticated: ["GET /user/gpg_keys/{gpg_key_id}"], + getPublicSshKeyForAuthenticated: ["GET /user/keys/{key_id}"], + list: ["GET /users"], + listBlockedByAuthenticated: ["GET /user/blocks"], + listEmailsForAuthenticated: ["GET /user/emails"], + listFollowedByAuthenticated: ["GET /user/following"], + listFollowersForAuthenticatedUser: ["GET /user/followers"], + listFollowersForUser: ["GET /users/{username}/followers"], + listFollowingForUser: ["GET /users/{username}/following"], + listGpgKeysForAuthenticated: ["GET /user/gpg_keys"], + listGpgKeysForUser: ["GET /users/{username}/gpg_keys"], + listPublicEmailsForAuthenticated: ["GET /user/public_emails"], + listPublicKeysForUser: ["GET /users/{username}/keys"], + listPublicSshKeysForAuthenticated: ["GET /user/keys"], + setPrimaryEmailVisibilityForAuthenticated: ["PATCH /user/email/visibility"], + unblock: ["DELETE /user/blocks/{username}"], + unfollow: ["DELETE /user/following/{username}"], + updateAuthenticated: ["PATCH /user"] + } +}; + +const VERSION = "5.3.0"; + +function endpointsToMethods(octokit, endpointsMap) { + const newMethods = {}; + + for (const [scope, endpoints] of Object.entries(endpointsMap)) { + for (const [methodName, endpoint] of Object.entries(endpoints)) { + const [route, defaults, decorations] = endpoint; + const [method, url] = route.split(/ /); + const endpointDefaults = Object.assign({ + method, + url + }, defaults); + + if (!newMethods[scope]) { + newMethods[scope] = {}; + } + + const scopeMethods = newMethods[scope]; + + if (decorations) { + scopeMethods[methodName] = decorate(octokit, scope, methodName, endpointDefaults, decorations); + continue; + } + + scopeMethods[methodName] = octokit.request.defaults(endpointDefaults); + } + } + + return newMethods; +} + +function decorate(octokit, scope, methodName, defaults, decorations) { + const requestWithDefaults = octokit.request.defaults(defaults); + /* istanbul ignore next */ + + function withDecorations(...args) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + let options = requestWithDefaults.endpoint.merge(...args); // There are currently no other decorations than `.mapToData` + + if (decorations.mapToData) { + options = Object.assign({}, options, { + data: options[decorations.mapToData], + [decorations.mapToData]: undefined + }); + return requestWithDefaults(options); + } + + if (decorations.renamed) { + const [newScope, newMethodName] = decorations.renamed; + octokit.log.warn(`octokit.${scope}.${methodName}() has been renamed to octokit.${newScope}.${newMethodName}()`); + } + + if (decorations.deprecated) { + octokit.log.warn(decorations.deprecated); + } + + if (decorations.renamedParameters) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + const options = requestWithDefaults.endpoint.merge(...args); + + for (const [name, alias] of Object.entries(decorations.renamedParameters)) { + if (name in options) { + octokit.log.warn(`"${name}" parameter is deprecated for "octokit.${scope}.${methodName}()". Use "${alias}" instead`); + + if (!(alias in options)) { + options[alias] = options[name]; + } + + delete options[name]; + } + } + + return requestWithDefaults(options); + } // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + + + return requestWithDefaults(...args); + } + + return Object.assign(withDecorations, requestWithDefaults); +} + +function restEndpointMethods(octokit) { + const api = endpointsToMethods(octokit, Endpoints); + return { + rest: api + }; +} +restEndpointMethods.VERSION = VERSION; +function legacyRestEndpointMethods(octokit) { + const api = endpointsToMethods(octokit, Endpoints); + return _objectSpread2(_objectSpread2({}, api), {}, { + rest: api + }); +} +legacyRestEndpointMethods.VERSION = VERSION; + +exports.legacyRestEndpointMethods = legacyRestEndpointMethods; +exports.restEndpointMethods = restEndpointMethods; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js.map b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js.map new file mode 100644 index 00000000..07e21390 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/generated/endpoints.js","../dist-src/version.js","../dist-src/endpoints-to-methods.js","../dist-src/index.js"],"sourcesContent":["const Endpoints = {\n actions: {\n addSelectedRepoToOrgSecret: [\n \"PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}\",\n ],\n approveWorkflowRun: [\n \"POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve\",\n ],\n cancelWorkflowRun: [\n \"POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel\",\n ],\n createOrUpdateEnvironmentSecret: [\n \"PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}\",\n ],\n createOrUpdateOrgSecret: [\"PUT /orgs/{org}/actions/secrets/{secret_name}\"],\n createOrUpdateRepoSecret: [\n \"PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}\",\n ],\n createRegistrationTokenForOrg: [\n \"POST /orgs/{org}/actions/runners/registration-token\",\n ],\n createRegistrationTokenForRepo: [\n \"POST /repos/{owner}/{repo}/actions/runners/registration-token\",\n ],\n createRemoveTokenForOrg: [\"POST /orgs/{org}/actions/runners/remove-token\"],\n createRemoveTokenForRepo: [\n \"POST /repos/{owner}/{repo}/actions/runners/remove-token\",\n ],\n createWorkflowDispatch: [\n \"POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches\",\n ],\n deleteArtifact: [\n \"DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}\",\n ],\n deleteEnvironmentSecret: [\n \"DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}\",\n ],\n deleteOrgSecret: [\"DELETE /orgs/{org}/actions/secrets/{secret_name}\"],\n deleteRepoSecret: [\n \"DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}\",\n ],\n deleteSelfHostedRunnerFromOrg: [\n \"DELETE /orgs/{org}/actions/runners/{runner_id}\",\n ],\n deleteSelfHostedRunnerFromRepo: [\n \"DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}\",\n ],\n deleteWorkflowRun: [\"DELETE /repos/{owner}/{repo}/actions/runs/{run_id}\"],\n deleteWorkflowRunLogs: [\n \"DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs\",\n ],\n disableSelectedRepositoryGithubActionsOrganization: [\n \"DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}\",\n ],\n disableWorkflow: [\n \"PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable\",\n ],\n downloadArtifact: [\n \"GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}\",\n ],\n downloadJobLogsForWorkflowRun: [\n \"GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs\",\n ],\n downloadWorkflowRunLogs: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs\",\n ],\n enableSelectedRepositoryGithubActionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions/repositories/{repository_id}\",\n ],\n enableWorkflow: [\n \"PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable\",\n ],\n getAllowedActionsOrganization: [\n \"GET /orgs/{org}/actions/permissions/selected-actions\",\n ],\n getAllowedActionsRepository: [\n \"GET /repos/{owner}/{repo}/actions/permissions/selected-actions\",\n ],\n getArtifact: [\"GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}\"],\n getEnvironmentPublicKey: [\n \"GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key\",\n ],\n getEnvironmentSecret: [\n \"GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}\",\n ],\n getGithubActionsPermissionsOrganization: [\n \"GET /orgs/{org}/actions/permissions\",\n ],\n getGithubActionsPermissionsRepository: [\n \"GET /repos/{owner}/{repo}/actions/permissions\",\n ],\n getJobForWorkflowRun: [\"GET /repos/{owner}/{repo}/actions/jobs/{job_id}\"],\n getOrgPublicKey: [\"GET /orgs/{org}/actions/secrets/public-key\"],\n getOrgSecret: [\"GET /orgs/{org}/actions/secrets/{secret_name}\"],\n getPendingDeploymentsForRun: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments\",\n ],\n getRepoPermissions: [\n \"GET /repos/{owner}/{repo}/actions/permissions\",\n {},\n { renamed: [\"actions\", \"getGithubActionsPermissionsRepository\"] },\n ],\n getRepoPublicKey: [\"GET /repos/{owner}/{repo}/actions/secrets/public-key\"],\n getRepoSecret: [\"GET /repos/{owner}/{repo}/actions/secrets/{secret_name}\"],\n getReviewsForRun: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals\",\n ],\n getSelfHostedRunnerForOrg: [\"GET /orgs/{org}/actions/runners/{runner_id}\"],\n getSelfHostedRunnerForRepo: [\n \"GET /repos/{owner}/{repo}/actions/runners/{runner_id}\",\n ],\n getWorkflow: [\"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}\"],\n getWorkflowRun: [\"GET /repos/{owner}/{repo}/actions/runs/{run_id}\"],\n getWorkflowRunUsage: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing\",\n ],\n getWorkflowUsage: [\n \"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing\",\n ],\n listArtifactsForRepo: [\"GET /repos/{owner}/{repo}/actions/artifacts\"],\n listEnvironmentSecrets: [\n \"GET /repositories/{repository_id}/environments/{environment_name}/secrets\",\n ],\n listJobsForWorkflowRun: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs\",\n ],\n listOrgSecrets: [\"GET /orgs/{org}/actions/secrets\"],\n listRepoSecrets: [\"GET /repos/{owner}/{repo}/actions/secrets\"],\n listRepoWorkflows: [\"GET /repos/{owner}/{repo}/actions/workflows\"],\n listRunnerApplicationsForOrg: [\"GET /orgs/{org}/actions/runners/downloads\"],\n listRunnerApplicationsForRepo: [\n \"GET /repos/{owner}/{repo}/actions/runners/downloads\",\n ],\n listSelectedReposForOrgSecret: [\n \"GET /orgs/{org}/actions/secrets/{secret_name}/repositories\",\n ],\n listSelectedRepositoriesEnabledGithubActionsOrganization: [\n \"GET /orgs/{org}/actions/permissions/repositories\",\n ],\n listSelfHostedRunnersForOrg: [\"GET /orgs/{org}/actions/runners\"],\n listSelfHostedRunnersForRepo: [\"GET /repos/{owner}/{repo}/actions/runners\"],\n listWorkflowRunArtifacts: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts\",\n ],\n listWorkflowRuns: [\n \"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs\",\n ],\n listWorkflowRunsForRepo: [\"GET /repos/{owner}/{repo}/actions/runs\"],\n reRunWorkflow: [\"POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun\"],\n removeSelectedRepoFromOrgSecret: [\n \"DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}\",\n ],\n reviewPendingDeploymentsForRun: [\n \"POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments\",\n ],\n setAllowedActionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions/selected-actions\",\n ],\n setAllowedActionsRepository: [\n \"PUT /repos/{owner}/{repo}/actions/permissions/selected-actions\",\n ],\n setGithubActionsPermissionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions\",\n ],\n setGithubActionsPermissionsRepository: [\n \"PUT /repos/{owner}/{repo}/actions/permissions\",\n ],\n setSelectedReposForOrgSecret: [\n \"PUT /orgs/{org}/actions/secrets/{secret_name}/repositories\",\n ],\n setSelectedRepositoriesEnabledGithubActionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions/repositories\",\n ],\n },\n activity: {\n checkRepoIsStarredByAuthenticatedUser: [\"GET /user/starred/{owner}/{repo}\"],\n deleteRepoSubscription: [\"DELETE /repos/{owner}/{repo}/subscription\"],\n deleteThreadSubscription: [\n \"DELETE /notifications/threads/{thread_id}/subscription\",\n ],\n getFeeds: [\"GET /feeds\"],\n getRepoSubscription: [\"GET /repos/{owner}/{repo}/subscription\"],\n getThread: [\"GET /notifications/threads/{thread_id}\"],\n getThreadSubscriptionForAuthenticatedUser: [\n \"GET /notifications/threads/{thread_id}/subscription\",\n ],\n listEventsForAuthenticatedUser: [\"GET /users/{username}/events\"],\n listNotificationsForAuthenticatedUser: [\"GET /notifications\"],\n listOrgEventsForAuthenticatedUser: [\n \"GET /users/{username}/events/orgs/{org}\",\n ],\n listPublicEvents: [\"GET /events\"],\n listPublicEventsForRepoNetwork: [\"GET /networks/{owner}/{repo}/events\"],\n listPublicEventsForUser: [\"GET /users/{username}/events/public\"],\n listPublicOrgEvents: [\"GET /orgs/{org}/events\"],\n listReceivedEventsForUser: [\"GET /users/{username}/received_events\"],\n listReceivedPublicEventsForUser: [\n \"GET /users/{username}/received_events/public\",\n ],\n listRepoEvents: [\"GET /repos/{owner}/{repo}/events\"],\n listRepoNotificationsForAuthenticatedUser: [\n \"GET /repos/{owner}/{repo}/notifications\",\n ],\n listReposStarredByAuthenticatedUser: [\"GET /user/starred\"],\n listReposStarredByUser: [\"GET /users/{username}/starred\"],\n listReposWatchedByUser: [\"GET /users/{username}/subscriptions\"],\n listStargazersForRepo: [\"GET /repos/{owner}/{repo}/stargazers\"],\n listWatchedReposForAuthenticatedUser: [\"GET /user/subscriptions\"],\n listWatchersForRepo: [\"GET /repos/{owner}/{repo}/subscribers\"],\n markNotificationsAsRead: [\"PUT /notifications\"],\n markRepoNotificationsAsRead: [\"PUT /repos/{owner}/{repo}/notifications\"],\n markThreadAsRead: [\"PATCH /notifications/threads/{thread_id}\"],\n setRepoSubscription: [\"PUT /repos/{owner}/{repo}/subscription\"],\n setThreadSubscription: [\n \"PUT /notifications/threads/{thread_id}/subscription\",\n ],\n starRepoForAuthenticatedUser: [\"PUT /user/starred/{owner}/{repo}\"],\n unstarRepoForAuthenticatedUser: [\"DELETE /user/starred/{owner}/{repo}\"],\n },\n apps: {\n addRepoToInstallation: [\n \"PUT /user/installations/{installation_id}/repositories/{repository_id}\",\n ],\n checkToken: [\"POST /applications/{client_id}/token\"],\n createContentAttachment: [\n \"POST /content_references/{content_reference_id}/attachments\",\n { mediaType: { previews: [\"corsair\"] } },\n ],\n createContentAttachmentForRepo: [\n \"POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments\",\n { mediaType: { previews: [\"corsair\"] } },\n ],\n createFromManifest: [\"POST /app-manifests/{code}/conversions\"],\n createInstallationAccessToken: [\n \"POST /app/installations/{installation_id}/access_tokens\",\n ],\n deleteAuthorization: [\"DELETE /applications/{client_id}/grant\"],\n deleteInstallation: [\"DELETE /app/installations/{installation_id}\"],\n deleteToken: [\"DELETE /applications/{client_id}/token\"],\n getAuthenticated: [\"GET /app\"],\n getBySlug: [\"GET /apps/{app_slug}\"],\n getInstallation: [\"GET /app/installations/{installation_id}\"],\n getOrgInstallation: [\"GET /orgs/{org}/installation\"],\n getRepoInstallation: [\"GET /repos/{owner}/{repo}/installation\"],\n getSubscriptionPlanForAccount: [\n \"GET /marketplace_listing/accounts/{account_id}\",\n ],\n getSubscriptionPlanForAccountStubbed: [\n \"GET /marketplace_listing/stubbed/accounts/{account_id}\",\n ],\n getUserInstallation: [\"GET /users/{username}/installation\"],\n getWebhookConfigForApp: [\"GET /app/hook/config\"],\n listAccountsForPlan: [\"GET /marketplace_listing/plans/{plan_id}/accounts\"],\n listAccountsForPlanStubbed: [\n \"GET /marketplace_listing/stubbed/plans/{plan_id}/accounts\",\n ],\n listInstallationReposForAuthenticatedUser: [\n \"GET /user/installations/{installation_id}/repositories\",\n ],\n listInstallations: [\"GET /app/installations\"],\n listInstallationsForAuthenticatedUser: [\"GET /user/installations\"],\n listPlans: [\"GET /marketplace_listing/plans\"],\n listPlansStubbed: [\"GET /marketplace_listing/stubbed/plans\"],\n listReposAccessibleToInstallation: [\"GET /installation/repositories\"],\n listSubscriptionsForAuthenticatedUser: [\"GET /user/marketplace_purchases\"],\n listSubscriptionsForAuthenticatedUserStubbed: [\n \"GET /user/marketplace_purchases/stubbed\",\n ],\n removeRepoFromInstallation: [\n \"DELETE /user/installations/{installation_id}/repositories/{repository_id}\",\n ],\n resetToken: [\"PATCH /applications/{client_id}/token\"],\n revokeInstallationAccessToken: [\"DELETE /installation/token\"],\n scopeToken: [\"POST /applications/{client_id}/token/scoped\"],\n suspendInstallation: [\"PUT /app/installations/{installation_id}/suspended\"],\n unsuspendInstallation: [\n \"DELETE /app/installations/{installation_id}/suspended\",\n ],\n updateWebhookConfigForApp: [\"PATCH /app/hook/config\"],\n },\n billing: {\n getGithubActionsBillingOrg: [\"GET /orgs/{org}/settings/billing/actions\"],\n getGithubActionsBillingUser: [\n \"GET /users/{username}/settings/billing/actions\",\n ],\n getGithubPackagesBillingOrg: [\"GET /orgs/{org}/settings/billing/packages\"],\n getGithubPackagesBillingUser: [\n \"GET /users/{username}/settings/billing/packages\",\n ],\n getSharedStorageBillingOrg: [\n \"GET /orgs/{org}/settings/billing/shared-storage\",\n ],\n getSharedStorageBillingUser: [\n \"GET /users/{username}/settings/billing/shared-storage\",\n ],\n },\n checks: {\n create: [\"POST /repos/{owner}/{repo}/check-runs\"],\n createSuite: [\"POST /repos/{owner}/{repo}/check-suites\"],\n get: [\"GET /repos/{owner}/{repo}/check-runs/{check_run_id}\"],\n getSuite: [\"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}\"],\n listAnnotations: [\n \"GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations\",\n ],\n listForRef: [\"GET /repos/{owner}/{repo}/commits/{ref}/check-runs\"],\n listForSuite: [\n \"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs\",\n ],\n listSuitesForRef: [\"GET /repos/{owner}/{repo}/commits/{ref}/check-suites\"],\n rerequestSuite: [\n \"POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest\",\n ],\n setSuitesPreferences: [\n \"PATCH /repos/{owner}/{repo}/check-suites/preferences\",\n ],\n update: [\"PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}\"],\n },\n codeScanning: {\n deleteAnalysis: [\n \"DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}\",\n ],\n getAlert: [\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}\",\n {},\n { renamedParameters: { alert_id: \"alert_number\" } },\n ],\n getAnalysis: [\n \"GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}\",\n ],\n getSarif: [\"GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}\"],\n listAlertInstances: [\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances\",\n ],\n listAlertsForRepo: [\"GET /repos/{owner}/{repo}/code-scanning/alerts\"],\n listAlertsInstances: [\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances\",\n {},\n { renamed: [\"codeScanning\", \"listAlertInstances\"] },\n ],\n listRecentAnalyses: [\"GET /repos/{owner}/{repo}/code-scanning/analyses\"],\n updateAlert: [\n \"PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}\",\n ],\n uploadSarif: [\"POST /repos/{owner}/{repo}/code-scanning/sarifs\"],\n },\n codesOfConduct: {\n getAllCodesOfConduct: [\n \"GET /codes_of_conduct\",\n { mediaType: { previews: [\"scarlet-witch\"] } },\n ],\n getConductCode: [\n \"GET /codes_of_conduct/{key}\",\n { mediaType: { previews: [\"scarlet-witch\"] } },\n ],\n getForRepo: [\n \"GET /repos/{owner}/{repo}/community/code_of_conduct\",\n { mediaType: { previews: [\"scarlet-witch\"] } },\n ],\n },\n emojis: { get: [\"GET /emojis\"] },\n enterpriseAdmin: {\n disableSelectedOrganizationGithubActionsEnterprise: [\n \"DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}\",\n ],\n enableSelectedOrganizationGithubActionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}\",\n ],\n getAllowedActionsEnterprise: [\n \"GET /enterprises/{enterprise}/actions/permissions/selected-actions\",\n ],\n getGithubActionsPermissionsEnterprise: [\n \"GET /enterprises/{enterprise}/actions/permissions\",\n ],\n listSelectedOrganizationsEnabledGithubActionsEnterprise: [\n \"GET /enterprises/{enterprise}/actions/permissions/organizations\",\n ],\n setAllowedActionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions/selected-actions\",\n ],\n setGithubActionsPermissionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions\",\n ],\n setSelectedOrganizationsEnabledGithubActionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions/organizations\",\n ],\n },\n gists: {\n checkIsStarred: [\"GET /gists/{gist_id}/star\"],\n create: [\"POST /gists\"],\n createComment: [\"POST /gists/{gist_id}/comments\"],\n delete: [\"DELETE /gists/{gist_id}\"],\n deleteComment: [\"DELETE /gists/{gist_id}/comments/{comment_id}\"],\n fork: [\"POST /gists/{gist_id}/forks\"],\n get: [\"GET /gists/{gist_id}\"],\n getComment: [\"GET /gists/{gist_id}/comments/{comment_id}\"],\n getRevision: [\"GET /gists/{gist_id}/{sha}\"],\n list: [\"GET /gists\"],\n listComments: [\"GET /gists/{gist_id}/comments\"],\n listCommits: [\"GET /gists/{gist_id}/commits\"],\n listForUser: [\"GET /users/{username}/gists\"],\n listForks: [\"GET /gists/{gist_id}/forks\"],\n listPublic: [\"GET /gists/public\"],\n listStarred: [\"GET /gists/starred\"],\n star: [\"PUT /gists/{gist_id}/star\"],\n unstar: [\"DELETE /gists/{gist_id}/star\"],\n update: [\"PATCH /gists/{gist_id}\"],\n updateComment: [\"PATCH /gists/{gist_id}/comments/{comment_id}\"],\n },\n git: {\n createBlob: [\"POST /repos/{owner}/{repo}/git/blobs\"],\n createCommit: [\"POST /repos/{owner}/{repo}/git/commits\"],\n createRef: [\"POST /repos/{owner}/{repo}/git/refs\"],\n createTag: [\"POST /repos/{owner}/{repo}/git/tags\"],\n createTree: [\"POST /repos/{owner}/{repo}/git/trees\"],\n deleteRef: [\"DELETE /repos/{owner}/{repo}/git/refs/{ref}\"],\n getBlob: [\"GET /repos/{owner}/{repo}/git/blobs/{file_sha}\"],\n getCommit: [\"GET /repos/{owner}/{repo}/git/commits/{commit_sha}\"],\n getRef: [\"GET /repos/{owner}/{repo}/git/ref/{ref}\"],\n getTag: [\"GET /repos/{owner}/{repo}/git/tags/{tag_sha}\"],\n getTree: [\"GET /repos/{owner}/{repo}/git/trees/{tree_sha}\"],\n listMatchingRefs: [\"GET /repos/{owner}/{repo}/git/matching-refs/{ref}\"],\n updateRef: [\"PATCH /repos/{owner}/{repo}/git/refs/{ref}\"],\n },\n gitignore: {\n getAllTemplates: [\"GET /gitignore/templates\"],\n getTemplate: [\"GET /gitignore/templates/{name}\"],\n },\n interactions: {\n getRestrictionsForAuthenticatedUser: [\"GET /user/interaction-limits\"],\n getRestrictionsForOrg: [\"GET /orgs/{org}/interaction-limits\"],\n getRestrictionsForRepo: [\"GET /repos/{owner}/{repo}/interaction-limits\"],\n getRestrictionsForYourPublicRepos: [\n \"GET /user/interaction-limits\",\n {},\n { renamed: [\"interactions\", \"getRestrictionsForAuthenticatedUser\"] },\n ],\n removeRestrictionsForAuthenticatedUser: [\"DELETE /user/interaction-limits\"],\n removeRestrictionsForOrg: [\"DELETE /orgs/{org}/interaction-limits\"],\n removeRestrictionsForRepo: [\n \"DELETE /repos/{owner}/{repo}/interaction-limits\",\n ],\n removeRestrictionsForYourPublicRepos: [\n \"DELETE /user/interaction-limits\",\n {},\n { renamed: [\"interactions\", \"removeRestrictionsForAuthenticatedUser\"] },\n ],\n setRestrictionsForAuthenticatedUser: [\"PUT /user/interaction-limits\"],\n setRestrictionsForOrg: [\"PUT /orgs/{org}/interaction-limits\"],\n setRestrictionsForRepo: [\"PUT /repos/{owner}/{repo}/interaction-limits\"],\n setRestrictionsForYourPublicRepos: [\n \"PUT /user/interaction-limits\",\n {},\n { renamed: [\"interactions\", \"setRestrictionsForAuthenticatedUser\"] },\n ],\n },\n issues: {\n addAssignees: [\n \"POST /repos/{owner}/{repo}/issues/{issue_number}/assignees\",\n ],\n addLabels: [\"POST /repos/{owner}/{repo}/issues/{issue_number}/labels\"],\n checkUserCanBeAssigned: [\"GET /repos/{owner}/{repo}/assignees/{assignee}\"],\n create: [\"POST /repos/{owner}/{repo}/issues\"],\n createComment: [\n \"POST /repos/{owner}/{repo}/issues/{issue_number}/comments\",\n ],\n createLabel: [\"POST /repos/{owner}/{repo}/labels\"],\n createMilestone: [\"POST /repos/{owner}/{repo}/milestones\"],\n deleteComment: [\n \"DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}\",\n ],\n deleteLabel: [\"DELETE /repos/{owner}/{repo}/labels/{name}\"],\n deleteMilestone: [\n \"DELETE /repos/{owner}/{repo}/milestones/{milestone_number}\",\n ],\n get: [\"GET /repos/{owner}/{repo}/issues/{issue_number}\"],\n getComment: [\"GET /repos/{owner}/{repo}/issues/comments/{comment_id}\"],\n getEvent: [\"GET /repos/{owner}/{repo}/issues/events/{event_id}\"],\n getLabel: [\"GET /repos/{owner}/{repo}/labels/{name}\"],\n getMilestone: [\"GET /repos/{owner}/{repo}/milestones/{milestone_number}\"],\n list: [\"GET /issues\"],\n listAssignees: [\"GET /repos/{owner}/{repo}/assignees\"],\n listComments: [\"GET /repos/{owner}/{repo}/issues/{issue_number}/comments\"],\n listCommentsForRepo: [\"GET /repos/{owner}/{repo}/issues/comments\"],\n listEvents: [\"GET /repos/{owner}/{repo}/issues/{issue_number}/events\"],\n listEventsForRepo: [\"GET /repos/{owner}/{repo}/issues/events\"],\n listEventsForTimeline: [\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/timeline\",\n { mediaType: { previews: [\"mockingbird\"] } },\n ],\n listForAuthenticatedUser: [\"GET /user/issues\"],\n listForOrg: [\"GET /orgs/{org}/issues\"],\n listForRepo: [\"GET /repos/{owner}/{repo}/issues\"],\n listLabelsForMilestone: [\n \"GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels\",\n ],\n listLabelsForRepo: [\"GET /repos/{owner}/{repo}/labels\"],\n listLabelsOnIssue: [\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/labels\",\n ],\n listMilestones: [\"GET /repos/{owner}/{repo}/milestones\"],\n lock: [\"PUT /repos/{owner}/{repo}/issues/{issue_number}/lock\"],\n removeAllLabels: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels\",\n ],\n removeAssignees: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees\",\n ],\n removeLabel: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}\",\n ],\n setLabels: [\"PUT /repos/{owner}/{repo}/issues/{issue_number}/labels\"],\n unlock: [\"DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock\"],\n update: [\"PATCH /repos/{owner}/{repo}/issues/{issue_number}\"],\n updateComment: [\"PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}\"],\n updateLabel: [\"PATCH /repos/{owner}/{repo}/labels/{name}\"],\n updateMilestone: [\n \"PATCH /repos/{owner}/{repo}/milestones/{milestone_number}\",\n ],\n },\n licenses: {\n get: [\"GET /licenses/{license}\"],\n getAllCommonlyUsed: [\"GET /licenses\"],\n getForRepo: [\"GET /repos/{owner}/{repo}/license\"],\n },\n markdown: {\n render: [\"POST /markdown\"],\n renderRaw: [\n \"POST /markdown/raw\",\n { headers: { \"content-type\": \"text/plain; charset=utf-8\" } },\n ],\n },\n meta: {\n get: [\"GET /meta\"],\n getOctocat: [\"GET /octocat\"],\n getZen: [\"GET /zen\"],\n root: [\"GET /\"],\n },\n migrations: {\n cancelImport: [\"DELETE /repos/{owner}/{repo}/import\"],\n deleteArchiveForAuthenticatedUser: [\n \"DELETE /user/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n deleteArchiveForOrg: [\n \"DELETE /orgs/{org}/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n downloadArchiveForOrg: [\n \"GET /orgs/{org}/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n getArchiveForAuthenticatedUser: [\n \"GET /user/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n getCommitAuthors: [\"GET /repos/{owner}/{repo}/import/authors\"],\n getImportStatus: [\"GET /repos/{owner}/{repo}/import\"],\n getLargeFiles: [\"GET /repos/{owner}/{repo}/import/large_files\"],\n getStatusForAuthenticatedUser: [\n \"GET /user/migrations/{migration_id}\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n getStatusForOrg: [\n \"GET /orgs/{org}/migrations/{migration_id}\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listForAuthenticatedUser: [\n \"GET /user/migrations\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listForOrg: [\n \"GET /orgs/{org}/migrations\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listReposForOrg: [\n \"GET /orgs/{org}/migrations/{migration_id}/repositories\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listReposForUser: [\n \"GET /user/migrations/{migration_id}/repositories\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n mapCommitAuthor: [\"PATCH /repos/{owner}/{repo}/import/authors/{author_id}\"],\n setLfsPreference: [\"PATCH /repos/{owner}/{repo}/import/lfs\"],\n startForAuthenticatedUser: [\"POST /user/migrations\"],\n startForOrg: [\"POST /orgs/{org}/migrations\"],\n startImport: [\"PUT /repos/{owner}/{repo}/import\"],\n unlockRepoForAuthenticatedUser: [\n \"DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n unlockRepoForOrg: [\n \"DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n updateImport: [\"PATCH /repos/{owner}/{repo}/import\"],\n },\n orgs: {\n blockUser: [\"PUT /orgs/{org}/blocks/{username}\"],\n cancelInvitation: [\"DELETE /orgs/{org}/invitations/{invitation_id}\"],\n checkBlockedUser: [\"GET /orgs/{org}/blocks/{username}\"],\n checkMembershipForUser: [\"GET /orgs/{org}/members/{username}\"],\n checkPublicMembershipForUser: [\"GET /orgs/{org}/public_members/{username}\"],\n convertMemberToOutsideCollaborator: [\n \"PUT /orgs/{org}/outside_collaborators/{username}\",\n ],\n createInvitation: [\"POST /orgs/{org}/invitations\"],\n createWebhook: [\"POST /orgs/{org}/hooks\"],\n deleteWebhook: [\"DELETE /orgs/{org}/hooks/{hook_id}\"],\n get: [\"GET /orgs/{org}\"],\n getMembershipForAuthenticatedUser: [\"GET /user/memberships/orgs/{org}\"],\n getMembershipForUser: [\"GET /orgs/{org}/memberships/{username}\"],\n getWebhook: [\"GET /orgs/{org}/hooks/{hook_id}\"],\n getWebhookConfigForOrg: [\"GET /orgs/{org}/hooks/{hook_id}/config\"],\n list: [\"GET /organizations\"],\n listAppInstallations: [\"GET /orgs/{org}/installations\"],\n listBlockedUsers: [\"GET /orgs/{org}/blocks\"],\n listFailedInvitations: [\"GET /orgs/{org}/failed_invitations\"],\n listForAuthenticatedUser: [\"GET /user/orgs\"],\n listForUser: [\"GET /users/{username}/orgs\"],\n listInvitationTeams: [\"GET /orgs/{org}/invitations/{invitation_id}/teams\"],\n listMembers: [\"GET /orgs/{org}/members\"],\n listMembershipsForAuthenticatedUser: [\"GET /user/memberships/orgs\"],\n listOutsideCollaborators: [\"GET /orgs/{org}/outside_collaborators\"],\n listPendingInvitations: [\"GET /orgs/{org}/invitations\"],\n listPublicMembers: [\"GET /orgs/{org}/public_members\"],\n listWebhooks: [\"GET /orgs/{org}/hooks\"],\n pingWebhook: [\"POST /orgs/{org}/hooks/{hook_id}/pings\"],\n removeMember: [\"DELETE /orgs/{org}/members/{username}\"],\n removeMembershipForUser: [\"DELETE /orgs/{org}/memberships/{username}\"],\n removeOutsideCollaborator: [\n \"DELETE /orgs/{org}/outside_collaborators/{username}\",\n ],\n removePublicMembershipForAuthenticatedUser: [\n \"DELETE /orgs/{org}/public_members/{username}\",\n ],\n setMembershipForUser: [\"PUT /orgs/{org}/memberships/{username}\"],\n setPublicMembershipForAuthenticatedUser: [\n \"PUT /orgs/{org}/public_members/{username}\",\n ],\n unblockUser: [\"DELETE /orgs/{org}/blocks/{username}\"],\n update: [\"PATCH /orgs/{org}\"],\n updateMembershipForAuthenticatedUser: [\n \"PATCH /user/memberships/orgs/{org}\",\n ],\n updateWebhook: [\"PATCH /orgs/{org}/hooks/{hook_id}\"],\n updateWebhookConfigForOrg: [\"PATCH /orgs/{org}/hooks/{hook_id}/config\"],\n },\n packages: {\n deletePackageForAuthenticatedUser: [\n \"DELETE /user/packages/{package_type}/{package_name}\",\n ],\n deletePackageForOrg: [\n \"DELETE /orgs/{org}/packages/{package_type}/{package_name}\",\n ],\n deletePackageVersionForAuthenticatedUser: [\n \"DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}\",\n ],\n deletePackageVersionForOrg: [\n \"DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}\",\n ],\n getAllPackageVersionsForAPackageOwnedByAnOrg: [\n \"GET /orgs/{org}/packages/{package_type}/{package_name}/versions\",\n {},\n { renamed: [\"packages\", \"getAllPackageVersionsForPackageOwnedByOrg\"] },\n ],\n getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser: [\n \"GET /user/packages/{package_type}/{package_name}/versions\",\n {},\n {\n renamed: [\n \"packages\",\n \"getAllPackageVersionsForPackageOwnedByAuthenticatedUser\",\n ],\n },\n ],\n getAllPackageVersionsForPackageOwnedByAuthenticatedUser: [\n \"GET /user/packages/{package_type}/{package_name}/versions\",\n ],\n getAllPackageVersionsForPackageOwnedByOrg: [\n \"GET /orgs/{org}/packages/{package_type}/{package_name}/versions\",\n ],\n getAllPackageVersionsForPackageOwnedByUser: [\n \"GET /users/{username}/packages/{package_type}/{package_name}/versions\",\n ],\n getPackageForAuthenticatedUser: [\n \"GET /user/packages/{package_type}/{package_name}\",\n ],\n getPackageForOrganization: [\n \"GET /orgs/{org}/packages/{package_type}/{package_name}\",\n ],\n getPackageForUser: [\n \"GET /users/{username}/packages/{package_type}/{package_name}\",\n ],\n getPackageVersionForAuthenticatedUser: [\n \"GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}\",\n ],\n getPackageVersionForOrganization: [\n \"GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}\",\n ],\n getPackageVersionForUser: [\n \"GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}\",\n ],\n restorePackageForAuthenticatedUser: [\n \"POST /user/packages/{package_type}/{package_name}/restore{?token}\",\n ],\n restorePackageForOrg: [\n \"POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}\",\n ],\n restorePackageVersionForAuthenticatedUser: [\n \"POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore\",\n ],\n restorePackageVersionForOrg: [\n \"POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore\",\n ],\n },\n projects: {\n addCollaborator: [\n \"PUT /projects/{project_id}/collaborators/{username}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createCard: [\n \"POST /projects/columns/{column_id}/cards\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createColumn: [\n \"POST /projects/{project_id}/columns\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createForAuthenticatedUser: [\n \"POST /user/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createForOrg: [\n \"POST /orgs/{org}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createForRepo: [\n \"POST /repos/{owner}/{repo}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n delete: [\n \"DELETE /projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n deleteCard: [\n \"DELETE /projects/columns/cards/{card_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n deleteColumn: [\n \"DELETE /projects/columns/{column_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n get: [\n \"GET /projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n getCard: [\n \"GET /projects/columns/cards/{card_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n getColumn: [\n \"GET /projects/columns/{column_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n getPermissionForUser: [\n \"GET /projects/{project_id}/collaborators/{username}/permission\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listCards: [\n \"GET /projects/columns/{column_id}/cards\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listCollaborators: [\n \"GET /projects/{project_id}/collaborators\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listColumns: [\n \"GET /projects/{project_id}/columns\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listForOrg: [\n \"GET /orgs/{org}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listForRepo: [\n \"GET /repos/{owner}/{repo}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listForUser: [\n \"GET /users/{username}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n moveCard: [\n \"POST /projects/columns/cards/{card_id}/moves\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n moveColumn: [\n \"POST /projects/columns/{column_id}/moves\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n removeCollaborator: [\n \"DELETE /projects/{project_id}/collaborators/{username}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n update: [\n \"PATCH /projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n updateCard: [\n \"PATCH /projects/columns/cards/{card_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n updateColumn: [\n \"PATCH /projects/columns/{column_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n },\n pulls: {\n checkIfMerged: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/merge\"],\n create: [\"POST /repos/{owner}/{repo}/pulls\"],\n createReplyForReviewComment: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies\",\n ],\n createReview: [\"POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews\"],\n createReviewComment: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/comments\",\n ],\n deletePendingReview: [\n \"DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}\",\n ],\n deleteReviewComment: [\n \"DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}\",\n ],\n dismissReview: [\n \"PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals\",\n ],\n get: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}\"],\n getReview: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}\",\n ],\n getReviewComment: [\"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}\"],\n list: [\"GET /repos/{owner}/{repo}/pulls\"],\n listCommentsForReview: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments\",\n ],\n listCommits: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/commits\"],\n listFiles: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/files\"],\n listRequestedReviewers: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n ],\n listReviewComments: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/comments\",\n ],\n listReviewCommentsForRepo: [\"GET /repos/{owner}/{repo}/pulls/comments\"],\n listReviews: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews\"],\n merge: [\"PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge\"],\n removeRequestedReviewers: [\n \"DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n ],\n requestReviewers: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n ],\n submitReview: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events\",\n ],\n update: [\"PATCH /repos/{owner}/{repo}/pulls/{pull_number}\"],\n updateBranch: [\n \"PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch\",\n { mediaType: { previews: [\"lydian\"] } },\n ],\n updateReview: [\n \"PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}\",\n ],\n updateReviewComment: [\n \"PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}\",\n ],\n },\n rateLimit: { get: [\"GET /rate_limit\"] },\n reactions: {\n createForCommitComment: [\n \"POST /repos/{owner}/{repo}/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForIssue: [\n \"POST /repos/{owner}/{repo}/issues/{issue_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForIssueComment: [\n \"POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForPullRequestReviewComment: [\n \"POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForRelease: [\n \"POST /repos/{owner}/{repo}/releases/{release_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForTeamDiscussionCommentInOrg: [\n \"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForTeamDiscussionInOrg: [\n \"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForCommitComment: [\n \"DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForIssue: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForIssueComment: [\n \"DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForPullRequestComment: [\n \"DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForTeamDiscussion: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForTeamDiscussionComment: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteLegacy: [\n \"DELETE /reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n {\n deprecated: \"octokit.rest.reactions.deleteLegacy() is deprecated, see https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy\",\n },\n ],\n listForCommitComment: [\n \"GET /repos/{owner}/{repo}/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForIssue: [\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForIssueComment: [\n \"GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForPullRequestReviewComment: [\n \"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForTeamDiscussionCommentInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForTeamDiscussionInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n },\n repos: {\n acceptInvitation: [\"PATCH /user/repository_invitations/{invitation_id}\"],\n addAppAccessRestrictions: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n {},\n { mapToData: \"apps\" },\n ],\n addCollaborator: [\"PUT /repos/{owner}/{repo}/collaborators/{username}\"],\n addStatusCheckContexts: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n {},\n { mapToData: \"contexts\" },\n ],\n addTeamAccessRestrictions: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n {},\n { mapToData: \"teams\" },\n ],\n addUserAccessRestrictions: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n {},\n { mapToData: \"users\" },\n ],\n checkCollaborator: [\"GET /repos/{owner}/{repo}/collaborators/{username}\"],\n checkVulnerabilityAlerts: [\n \"GET /repos/{owner}/{repo}/vulnerability-alerts\",\n { mediaType: { previews: [\"dorian\"] } },\n ],\n compareCommits: [\"GET /repos/{owner}/{repo}/compare/{base}...{head}\"],\n compareCommitsWithBasehead: [\n \"GET /repos/{owner}/{repo}/compare/{basehead}\",\n ],\n createCommitComment: [\n \"POST /repos/{owner}/{repo}/commits/{commit_sha}/comments\",\n ],\n createCommitSignatureProtection: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures\",\n { mediaType: { previews: [\"zzzax\"] } },\n ],\n createCommitStatus: [\"POST /repos/{owner}/{repo}/statuses/{sha}\"],\n createDeployKey: [\"POST /repos/{owner}/{repo}/keys\"],\n createDeployment: [\"POST /repos/{owner}/{repo}/deployments\"],\n createDeploymentStatus: [\n \"POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses\",\n ],\n createDispatchEvent: [\"POST /repos/{owner}/{repo}/dispatches\"],\n createForAuthenticatedUser: [\"POST /user/repos\"],\n createFork: [\"POST /repos/{owner}/{repo}/forks\"],\n createInOrg: [\"POST /orgs/{org}/repos\"],\n createOrUpdateEnvironment: [\n \"PUT /repos/{owner}/{repo}/environments/{environment_name}\",\n ],\n createOrUpdateFileContents: [\"PUT /repos/{owner}/{repo}/contents/{path}\"],\n createPagesSite: [\n \"POST /repos/{owner}/{repo}/pages\",\n { mediaType: { previews: [\"switcheroo\"] } },\n ],\n createRelease: [\"POST /repos/{owner}/{repo}/releases\"],\n createUsingTemplate: [\n \"POST /repos/{template_owner}/{template_repo}/generate\",\n { mediaType: { previews: [\"baptiste\"] } },\n ],\n createWebhook: [\"POST /repos/{owner}/{repo}/hooks\"],\n declineInvitation: [\"DELETE /user/repository_invitations/{invitation_id}\"],\n delete: [\"DELETE /repos/{owner}/{repo}\"],\n deleteAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions\",\n ],\n deleteAdminBranchProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins\",\n ],\n deleteAnEnvironment: [\n \"DELETE /repos/{owner}/{repo}/environments/{environment_name}\",\n ],\n deleteBranchProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection\",\n ],\n deleteCommitComment: [\"DELETE /repos/{owner}/{repo}/comments/{comment_id}\"],\n deleteCommitSignatureProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures\",\n { mediaType: { previews: [\"zzzax\"] } },\n ],\n deleteDeployKey: [\"DELETE /repos/{owner}/{repo}/keys/{key_id}\"],\n deleteDeployment: [\n \"DELETE /repos/{owner}/{repo}/deployments/{deployment_id}\",\n ],\n deleteFile: [\"DELETE /repos/{owner}/{repo}/contents/{path}\"],\n deleteInvitation: [\n \"DELETE /repos/{owner}/{repo}/invitations/{invitation_id}\",\n ],\n deletePagesSite: [\n \"DELETE /repos/{owner}/{repo}/pages\",\n { mediaType: { previews: [\"switcheroo\"] } },\n ],\n deletePullRequestReviewProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews\",\n ],\n deleteRelease: [\"DELETE /repos/{owner}/{repo}/releases/{release_id}\"],\n deleteReleaseAsset: [\n \"DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}\",\n ],\n deleteWebhook: [\"DELETE /repos/{owner}/{repo}/hooks/{hook_id}\"],\n disableAutomatedSecurityFixes: [\n \"DELETE /repos/{owner}/{repo}/automated-security-fixes\",\n { mediaType: { previews: [\"london\"] } },\n ],\n disableVulnerabilityAlerts: [\n \"DELETE /repos/{owner}/{repo}/vulnerability-alerts\",\n { mediaType: { previews: [\"dorian\"] } },\n ],\n downloadArchive: [\n \"GET /repos/{owner}/{repo}/zipball/{ref}\",\n {},\n { renamed: [\"repos\", \"downloadZipballArchive\"] },\n ],\n downloadTarballArchive: [\"GET /repos/{owner}/{repo}/tarball/{ref}\"],\n downloadZipballArchive: [\"GET /repos/{owner}/{repo}/zipball/{ref}\"],\n enableAutomatedSecurityFixes: [\n \"PUT /repos/{owner}/{repo}/automated-security-fixes\",\n { mediaType: { previews: [\"london\"] } },\n ],\n enableVulnerabilityAlerts: [\n \"PUT /repos/{owner}/{repo}/vulnerability-alerts\",\n { mediaType: { previews: [\"dorian\"] } },\n ],\n get: [\"GET /repos/{owner}/{repo}\"],\n getAccessRestrictions: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions\",\n ],\n getAdminBranchProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins\",\n ],\n getAllEnvironments: [\"GET /repos/{owner}/{repo}/environments\"],\n getAllStatusCheckContexts: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n ],\n getAllTopics: [\n \"GET /repos/{owner}/{repo}/topics\",\n { mediaType: { previews: [\"mercy\"] } },\n ],\n getAppsWithAccessToProtectedBranch: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n ],\n getBranch: [\"GET /repos/{owner}/{repo}/branches/{branch}\"],\n getBranchProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection\",\n ],\n getClones: [\"GET /repos/{owner}/{repo}/traffic/clones\"],\n getCodeFrequencyStats: [\"GET /repos/{owner}/{repo}/stats/code_frequency\"],\n getCollaboratorPermissionLevel: [\n \"GET /repos/{owner}/{repo}/collaborators/{username}/permission\",\n ],\n getCombinedStatusForRef: [\"GET /repos/{owner}/{repo}/commits/{ref}/status\"],\n getCommit: [\"GET /repos/{owner}/{repo}/commits/{ref}\"],\n getCommitActivityStats: [\"GET /repos/{owner}/{repo}/stats/commit_activity\"],\n getCommitComment: [\"GET /repos/{owner}/{repo}/comments/{comment_id}\"],\n getCommitSignatureProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures\",\n { mediaType: { previews: [\"zzzax\"] } },\n ],\n getCommunityProfileMetrics: [\"GET /repos/{owner}/{repo}/community/profile\"],\n getContent: [\"GET /repos/{owner}/{repo}/contents/{path}\"],\n getContributorsStats: [\"GET /repos/{owner}/{repo}/stats/contributors\"],\n getDeployKey: [\"GET /repos/{owner}/{repo}/keys/{key_id}\"],\n getDeployment: [\"GET /repos/{owner}/{repo}/deployments/{deployment_id}\"],\n getDeploymentStatus: [\n \"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}\",\n ],\n getEnvironment: [\n \"GET /repos/{owner}/{repo}/environments/{environment_name}\",\n ],\n getLatestPagesBuild: [\"GET /repos/{owner}/{repo}/pages/builds/latest\"],\n getLatestRelease: [\"GET /repos/{owner}/{repo}/releases/latest\"],\n getPages: [\"GET /repos/{owner}/{repo}/pages\"],\n getPagesBuild: [\"GET /repos/{owner}/{repo}/pages/builds/{build_id}\"],\n getPagesHealthCheck: [\"GET /repos/{owner}/{repo}/pages/health\"],\n getParticipationStats: [\"GET /repos/{owner}/{repo}/stats/participation\"],\n getPullRequestReviewProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews\",\n ],\n getPunchCardStats: [\"GET /repos/{owner}/{repo}/stats/punch_card\"],\n getReadme: [\"GET /repos/{owner}/{repo}/readme\"],\n getReadmeInDirectory: [\"GET /repos/{owner}/{repo}/readme/{dir}\"],\n getRelease: [\"GET /repos/{owner}/{repo}/releases/{release_id}\"],\n getReleaseAsset: [\"GET /repos/{owner}/{repo}/releases/assets/{asset_id}\"],\n getReleaseByTag: [\"GET /repos/{owner}/{repo}/releases/tags/{tag}\"],\n getStatusChecksProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n ],\n getTeamsWithAccessToProtectedBranch: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n ],\n getTopPaths: [\"GET /repos/{owner}/{repo}/traffic/popular/paths\"],\n getTopReferrers: [\"GET /repos/{owner}/{repo}/traffic/popular/referrers\"],\n getUsersWithAccessToProtectedBranch: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n ],\n getViews: [\"GET /repos/{owner}/{repo}/traffic/views\"],\n getWebhook: [\"GET /repos/{owner}/{repo}/hooks/{hook_id}\"],\n getWebhookConfigForRepo: [\n \"GET /repos/{owner}/{repo}/hooks/{hook_id}/config\",\n ],\n listBranches: [\"GET /repos/{owner}/{repo}/branches\"],\n listBranchesForHeadCommit: [\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head\",\n { mediaType: { previews: [\"groot\"] } },\n ],\n listCollaborators: [\"GET /repos/{owner}/{repo}/collaborators\"],\n listCommentsForCommit: [\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/comments\",\n ],\n listCommitCommentsForRepo: [\"GET /repos/{owner}/{repo}/comments\"],\n listCommitStatusesForRef: [\n \"GET /repos/{owner}/{repo}/commits/{ref}/statuses\",\n ],\n listCommits: [\"GET /repos/{owner}/{repo}/commits\"],\n listContributors: [\"GET /repos/{owner}/{repo}/contributors\"],\n listDeployKeys: [\"GET /repos/{owner}/{repo}/keys\"],\n listDeploymentStatuses: [\n \"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses\",\n ],\n listDeployments: [\"GET /repos/{owner}/{repo}/deployments\"],\n listForAuthenticatedUser: [\"GET /user/repos\"],\n listForOrg: [\"GET /orgs/{org}/repos\"],\n listForUser: [\"GET /users/{username}/repos\"],\n listForks: [\"GET /repos/{owner}/{repo}/forks\"],\n listInvitations: [\"GET /repos/{owner}/{repo}/invitations\"],\n listInvitationsForAuthenticatedUser: [\"GET /user/repository_invitations\"],\n listLanguages: [\"GET /repos/{owner}/{repo}/languages\"],\n listPagesBuilds: [\"GET /repos/{owner}/{repo}/pages/builds\"],\n listPublic: [\"GET /repositories\"],\n listPullRequestsAssociatedWithCommit: [\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls\",\n { mediaType: { previews: [\"groot\"] } },\n ],\n listReleaseAssets: [\n \"GET /repos/{owner}/{repo}/releases/{release_id}/assets\",\n ],\n listReleases: [\"GET /repos/{owner}/{repo}/releases\"],\n listTags: [\"GET /repos/{owner}/{repo}/tags\"],\n listTeams: [\"GET /repos/{owner}/{repo}/teams\"],\n listWebhooks: [\"GET /repos/{owner}/{repo}/hooks\"],\n merge: [\"POST /repos/{owner}/{repo}/merges\"],\n pingWebhook: [\"POST /repos/{owner}/{repo}/hooks/{hook_id}/pings\"],\n removeAppAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n {},\n { mapToData: \"apps\" },\n ],\n removeCollaborator: [\n \"DELETE /repos/{owner}/{repo}/collaborators/{username}\",\n ],\n removeStatusCheckContexts: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n {},\n { mapToData: \"contexts\" },\n ],\n removeStatusCheckProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n ],\n removeTeamAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n {},\n { mapToData: \"teams\" },\n ],\n removeUserAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n {},\n { mapToData: \"users\" },\n ],\n renameBranch: [\"POST /repos/{owner}/{repo}/branches/{branch}/rename\"],\n replaceAllTopics: [\n \"PUT /repos/{owner}/{repo}/topics\",\n { mediaType: { previews: [\"mercy\"] } },\n ],\n requestPagesBuild: [\"POST /repos/{owner}/{repo}/pages/builds\"],\n setAdminBranchProtection: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins\",\n ],\n setAppAccessRestrictions: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n {},\n { mapToData: \"apps\" },\n ],\n setStatusCheckContexts: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n {},\n { mapToData: \"contexts\" },\n ],\n setTeamAccessRestrictions: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n {},\n { mapToData: \"teams\" },\n ],\n setUserAccessRestrictions: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n {},\n { mapToData: \"users\" },\n ],\n testPushWebhook: [\"POST /repos/{owner}/{repo}/hooks/{hook_id}/tests\"],\n transfer: [\"POST /repos/{owner}/{repo}/transfer\"],\n update: [\"PATCH /repos/{owner}/{repo}\"],\n updateBranchProtection: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection\",\n ],\n updateCommitComment: [\"PATCH /repos/{owner}/{repo}/comments/{comment_id}\"],\n updateInformationAboutPagesSite: [\"PUT /repos/{owner}/{repo}/pages\"],\n updateInvitation: [\n \"PATCH /repos/{owner}/{repo}/invitations/{invitation_id}\",\n ],\n updatePullRequestReviewProtection: [\n \"PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews\",\n ],\n updateRelease: [\"PATCH /repos/{owner}/{repo}/releases/{release_id}\"],\n updateReleaseAsset: [\n \"PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}\",\n ],\n updateStatusCheckPotection: [\n \"PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n {},\n { renamed: [\"repos\", \"updateStatusCheckProtection\"] },\n ],\n updateStatusCheckProtection: [\n \"PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n ],\n updateWebhook: [\"PATCH /repos/{owner}/{repo}/hooks/{hook_id}\"],\n updateWebhookConfigForRepo: [\n \"PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config\",\n ],\n uploadReleaseAsset: [\n \"POST /repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}\",\n { baseUrl: \"https://uploads.github.com\" },\n ],\n },\n search: {\n code: [\"GET /search/code\"],\n commits: [\"GET /search/commits\", { mediaType: { previews: [\"cloak\"] } }],\n issuesAndPullRequests: [\"GET /search/issues\"],\n labels: [\"GET /search/labels\"],\n repos: [\"GET /search/repositories\"],\n topics: [\"GET /search/topics\", { mediaType: { previews: [\"mercy\"] } }],\n users: [\"GET /search/users\"],\n },\n secretScanning: {\n getAlert: [\n \"GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}\",\n ],\n listAlertsForRepo: [\"GET /repos/{owner}/{repo}/secret-scanning/alerts\"],\n updateAlert: [\n \"PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}\",\n ],\n },\n teams: {\n addOrUpdateMembershipForUserInOrg: [\n \"PUT /orgs/{org}/teams/{team_slug}/memberships/{username}\",\n ],\n addOrUpdateProjectPermissionsInOrg: [\n \"PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n addOrUpdateRepoPermissionsInOrg: [\n \"PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}\",\n ],\n checkPermissionsForProjectInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n checkPermissionsForRepoInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}\",\n ],\n create: [\"POST /orgs/{org}/teams\"],\n createDiscussionCommentInOrg: [\n \"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments\",\n ],\n createDiscussionInOrg: [\"POST /orgs/{org}/teams/{team_slug}/discussions\"],\n deleteDiscussionCommentInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}\",\n ],\n deleteDiscussionInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}\",\n ],\n deleteInOrg: [\"DELETE /orgs/{org}/teams/{team_slug}\"],\n getByName: [\"GET /orgs/{org}/teams/{team_slug}\"],\n getDiscussionCommentInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}\",\n ],\n getDiscussionInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}\",\n ],\n getMembershipForUserInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/memberships/{username}\",\n ],\n list: [\"GET /orgs/{org}/teams\"],\n listChildInOrg: [\"GET /orgs/{org}/teams/{team_slug}/teams\"],\n listDiscussionCommentsInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments\",\n ],\n listDiscussionsInOrg: [\"GET /orgs/{org}/teams/{team_slug}/discussions\"],\n listForAuthenticatedUser: [\"GET /user/teams\"],\n listMembersInOrg: [\"GET /orgs/{org}/teams/{team_slug}/members\"],\n listPendingInvitationsInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/invitations\",\n ],\n listProjectsInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listReposInOrg: [\"GET /orgs/{org}/teams/{team_slug}/repos\"],\n removeMembershipForUserInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}\",\n ],\n removeProjectInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}\",\n ],\n removeRepoInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}\",\n ],\n updateDiscussionCommentInOrg: [\n \"PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}\",\n ],\n updateDiscussionInOrg: [\n \"PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}\",\n ],\n updateInOrg: [\"PATCH /orgs/{org}/teams/{team_slug}\"],\n },\n users: {\n addEmailForAuthenticated: [\"POST /user/emails\"],\n block: [\"PUT /user/blocks/{username}\"],\n checkBlocked: [\"GET /user/blocks/{username}\"],\n checkFollowingForUser: [\"GET /users/{username}/following/{target_user}\"],\n checkPersonIsFollowedByAuthenticated: [\"GET /user/following/{username}\"],\n createGpgKeyForAuthenticated: [\"POST /user/gpg_keys\"],\n createPublicSshKeyForAuthenticated: [\"POST /user/keys\"],\n deleteEmailForAuthenticated: [\"DELETE /user/emails\"],\n deleteGpgKeyForAuthenticated: [\"DELETE /user/gpg_keys/{gpg_key_id}\"],\n deletePublicSshKeyForAuthenticated: [\"DELETE /user/keys/{key_id}\"],\n follow: [\"PUT /user/following/{username}\"],\n getAuthenticated: [\"GET /user\"],\n getByUsername: [\"GET /users/{username}\"],\n getContextForUser: [\"GET /users/{username}/hovercard\"],\n getGpgKeyForAuthenticated: [\"GET /user/gpg_keys/{gpg_key_id}\"],\n getPublicSshKeyForAuthenticated: [\"GET /user/keys/{key_id}\"],\n list: [\"GET /users\"],\n listBlockedByAuthenticated: [\"GET /user/blocks\"],\n listEmailsForAuthenticated: [\"GET /user/emails\"],\n listFollowedByAuthenticated: [\"GET /user/following\"],\n listFollowersForAuthenticatedUser: [\"GET /user/followers\"],\n listFollowersForUser: [\"GET /users/{username}/followers\"],\n listFollowingForUser: [\"GET /users/{username}/following\"],\n listGpgKeysForAuthenticated: [\"GET /user/gpg_keys\"],\n listGpgKeysForUser: [\"GET /users/{username}/gpg_keys\"],\n listPublicEmailsForAuthenticated: [\"GET /user/public_emails\"],\n listPublicKeysForUser: [\"GET /users/{username}/keys\"],\n listPublicSshKeysForAuthenticated: [\"GET /user/keys\"],\n setPrimaryEmailVisibilityForAuthenticated: [\"PATCH /user/email/visibility\"],\n unblock: [\"DELETE /user/blocks/{username}\"],\n unfollow: [\"DELETE /user/following/{username}\"],\n updateAuthenticated: [\"PATCH /user\"],\n },\n};\nexport default Endpoints;\n","export const VERSION = \"5.3.0\";\n","export function endpointsToMethods(octokit, endpointsMap) {\n const newMethods = {};\n for (const [scope, endpoints] of Object.entries(endpointsMap)) {\n for (const [methodName, endpoint] of Object.entries(endpoints)) {\n const [route, defaults, decorations] = endpoint;\n const [method, url] = route.split(/ /);\n const endpointDefaults = Object.assign({ method, url }, defaults);\n if (!newMethods[scope]) {\n newMethods[scope] = {};\n }\n const scopeMethods = newMethods[scope];\n if (decorations) {\n scopeMethods[methodName] = decorate(octokit, scope, methodName, endpointDefaults, decorations);\n continue;\n }\n scopeMethods[methodName] = octokit.request.defaults(endpointDefaults);\n }\n }\n return newMethods;\n}\nfunction decorate(octokit, scope, methodName, defaults, decorations) {\n const requestWithDefaults = octokit.request.defaults(defaults);\n /* istanbul ignore next */\n function withDecorations(...args) {\n // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488\n let options = requestWithDefaults.endpoint.merge(...args);\n // There are currently no other decorations than `.mapToData`\n if (decorations.mapToData) {\n options = Object.assign({}, options, {\n data: options[decorations.mapToData],\n [decorations.mapToData]: undefined,\n });\n return requestWithDefaults(options);\n }\n if (decorations.renamed) {\n const [newScope, newMethodName] = decorations.renamed;\n octokit.log.warn(`octokit.${scope}.${methodName}() has been renamed to octokit.${newScope}.${newMethodName}()`);\n }\n if (decorations.deprecated) {\n octokit.log.warn(decorations.deprecated);\n }\n if (decorations.renamedParameters) {\n // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488\n const options = requestWithDefaults.endpoint.merge(...args);\n for (const [name, alias] of Object.entries(decorations.renamedParameters)) {\n if (name in options) {\n octokit.log.warn(`\"${name}\" parameter is deprecated for \"octokit.${scope}.${methodName}()\". Use \"${alias}\" instead`);\n if (!(alias in options)) {\n options[alias] = options[name];\n }\n delete options[name];\n }\n }\n return requestWithDefaults(options);\n }\n // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488\n return requestWithDefaults(...args);\n }\n return Object.assign(withDecorations, requestWithDefaults);\n}\n","import ENDPOINTS from \"./generated/endpoints\";\nimport { VERSION } from \"./version\";\nimport { endpointsToMethods } from \"./endpoints-to-methods\";\nexport function restEndpointMethods(octokit) {\n const api = endpointsToMethods(octokit, ENDPOINTS);\n return {\n rest: api,\n };\n}\nrestEndpointMethods.VERSION = VERSION;\nexport function legacyRestEndpointMethods(octokit) {\n const api = endpointsToMethods(octokit, ENDPOINTS);\n return {\n ...api,\n rest: api,\n };\n}\nlegacyRestEndpointMethods.VERSION = VERSION;\n"],"names":["Endpoints","actions","addSelectedRepoToOrgSecret","approveWorkflowRun","cancelWorkflowRun","createOrUpdateEnvironmentSecret","createOrUpdateOrgSecret","createOrUpdateRepoSecret","createRegistrationTokenForOrg","createRegistrationTokenForRepo","createRemoveTokenForOrg","createRemoveTokenForRepo","createWorkflowDispatch","deleteArtifact","deleteEnvironmentSecret","deleteOrgSecret","deleteRepoSecret","deleteSelfHostedRunnerFromOrg","deleteSelfHostedRunnerFromRepo","deleteWorkflowRun","deleteWorkflowRunLogs","disableSelectedRepositoryGithubActionsOrganization","disableWorkflow","downloadArtifact","downloadJobLogsForWorkflowRun","downloadWorkflowRunLogs","enableSelectedRepositoryGithubActionsOrganization","enableWorkflow","getAllowedActionsOrganization","getAllowedActionsRepository","getArtifact","getEnvironmentPublicKey","getEnvironmentSecret","getGithubActionsPermissionsOrganization","getGithubActionsPermissionsRepository","getJobForWorkflowRun","getOrgPublicKey","getOrgSecret","getPendingDeploymentsForRun","getRepoPermissions","renamed","getRepoPublicKey","getRepoSecret","getReviewsForRun","getSelfHostedRunnerForOrg","getSelfHostedRunnerForRepo","getWorkflow","getWorkflowRun","getWorkflowRunUsage","getWorkflowUsage","listArtifactsForRepo","listEnvironmentSecrets","listJobsForWorkflowRun","listOrgSecrets","listRepoSecrets","listRepoWorkflows","listRunnerApplicationsForOrg","listRunnerApplicationsForRepo","listSelectedReposForOrgSecret","listSelectedRepositoriesEnabledGithubActionsOrganization","listSelfHostedRunnersForOrg","listSelfHostedRunnersForRepo","listWorkflowRunArtifacts","listWorkflowRuns","listWorkflowRunsForRepo","reRunWorkflow","removeSelectedRepoFromOrgSecret","reviewPendingDeploymentsForRun","setAllowedActionsOrganization","setAllowedActionsRepository","setGithubActionsPermissionsOrganization","setGithubActionsPermissionsRepository","setSelectedReposForOrgSecret","setSelectedRepositoriesEnabledGithubActionsOrganization","activity","checkRepoIsStarredByAuthenticatedUser","deleteRepoSubscription","deleteThreadSubscription","getFeeds","getRepoSubscription","getThread","getThreadSubscriptionForAuthenticatedUser","listEventsForAuthenticatedUser","listNotificationsForAuthenticatedUser","listOrgEventsForAuthenticatedUser","listPublicEvents","listPublicEventsForRepoNetwork","listPublicEventsForUser","listPublicOrgEvents","listReceivedEventsForUser","listReceivedPublicEventsForUser","listRepoEvents","listRepoNotificationsForAuthenticatedUser","listReposStarredByAuthenticatedUser","listReposStarredByUser","listReposWatchedByUser","listStargazersForRepo","listWatchedReposForAuthenticatedUser","listWatchersForRepo","markNotificationsAsRead","markRepoNotificationsAsRead","markThreadAsRead","setRepoSubscription","setThreadSubscription","starRepoForAuthenticatedUser","unstarRepoForAuthenticatedUser","apps","addRepoToInstallation","checkToken","createContentAttachment","mediaType","previews","createContentAttachmentForRepo","createFromManifest","createInstallationAccessToken","deleteAuthorization","deleteInstallation","deleteToken","getAuthenticated","getBySlug","getInstallation","getOrgInstallation","getRepoInstallation","getSubscriptionPlanForAccount","getSubscriptionPlanForAccountStubbed","getUserInstallation","getWebhookConfigForApp","listAccountsForPlan","listAccountsForPlanStubbed","listInstallationReposForAuthenticatedUser","listInstallations","listInstallationsForAuthenticatedUser","listPlans","listPlansStubbed","listReposAccessibleToInstallation","listSubscriptionsForAuthenticatedUser","listSubscriptionsForAuthenticatedUserStubbed","removeRepoFromInstallation","resetToken","revokeInstallationAccessToken","scopeToken","suspendInstallation","unsuspendInstallation","updateWebhookConfigForApp","billing","getGithubActionsBillingOrg","getGithubActionsBillingUser","getGithubPackagesBillingOrg","getGithubPackagesBillingUser","getSharedStorageBillingOrg","getSharedStorageBillingUser","checks","create","createSuite","get","getSuite","listAnnotations","listForRef","listForSuite","listSuitesForRef","rerequestSuite","setSuitesPreferences","update","codeScanning","deleteAnalysis","getAlert","renamedParameters","alert_id","getAnalysis","getSarif","listAlertInstances","listAlertsForRepo","listAlertsInstances","listRecentAnalyses","updateAlert","uploadSarif","codesOfConduct","getAllCodesOfConduct","getConductCode","getForRepo","emojis","enterpriseAdmin","disableSelectedOrganizationGithubActionsEnterprise","enableSelectedOrganizationGithubActionsEnterprise","getAllowedActionsEnterprise","getGithubActionsPermissionsEnterprise","listSelectedOrganizationsEnabledGithubActionsEnterprise","setAllowedActionsEnterprise","setGithubActionsPermissionsEnterprise","setSelectedOrganizationsEnabledGithubActionsEnterprise","gists","checkIsStarred","createComment","delete","deleteComment","fork","getComment","getRevision","list","listComments","listCommits","listForUser","listForks","listPublic","listStarred","star","unstar","updateComment","git","createBlob","createCommit","createRef","createTag","createTree","deleteRef","getBlob","getCommit","getRef","getTag","getTree","listMatchingRefs","updateRef","gitignore","getAllTemplates","getTemplate","interactions","getRestrictionsForAuthenticatedUser","getRestrictionsForOrg","getRestrictionsForRepo","getRestrictionsForYourPublicRepos","removeRestrictionsForAuthenticatedUser","removeRestrictionsForOrg","removeRestrictionsForRepo","removeRestrictionsForYourPublicRepos","setRestrictionsForAuthenticatedUser","setRestrictionsForOrg","setRestrictionsForRepo","setRestrictionsForYourPublicRepos","issues","addAssignees","addLabels","checkUserCanBeAssigned","createLabel","createMilestone","deleteLabel","deleteMilestone","getEvent","getLabel","getMilestone","listAssignees","listCommentsForRepo","listEvents","listEventsForRepo","listEventsForTimeline","listForAuthenticatedUser","listForOrg","listForRepo","listLabelsForMilestone","listLabelsForRepo","listLabelsOnIssue","listMilestones","lock","removeAllLabels","removeAssignees","removeLabel","setLabels","unlock","updateLabel","updateMilestone","licenses","getAllCommonlyUsed","markdown","render","renderRaw","headers","meta","getOctocat","getZen","root","migrations","cancelImport","deleteArchiveForAuthenticatedUser","deleteArchiveForOrg","downloadArchiveForOrg","getArchiveForAuthenticatedUser","getCommitAuthors","getImportStatus","getLargeFiles","getStatusForAuthenticatedUser","getStatusForOrg","listReposForOrg","listReposForUser","mapCommitAuthor","setLfsPreference","startForAuthenticatedUser","startForOrg","startImport","unlockRepoForAuthenticatedUser","unlockRepoForOrg","updateImport","orgs","blockUser","cancelInvitation","checkBlockedUser","checkMembershipForUser","checkPublicMembershipForUser","convertMemberToOutsideCollaborator","createInvitation","createWebhook","deleteWebhook","getMembershipForAuthenticatedUser","getMembershipForUser","getWebhook","getWebhookConfigForOrg","listAppInstallations","listBlockedUsers","listFailedInvitations","listInvitationTeams","listMembers","listMembershipsForAuthenticatedUser","listOutsideCollaborators","listPendingInvitations","listPublicMembers","listWebhooks","pingWebhook","removeMember","removeMembershipForUser","removeOutsideCollaborator","removePublicMembershipForAuthenticatedUser","setMembershipForUser","setPublicMembershipForAuthenticatedUser","unblockUser","updateMembershipForAuthenticatedUser","updateWebhook","updateWebhookConfigForOrg","packages","deletePackageForAuthenticatedUser","deletePackageForOrg","deletePackageVersionForAuthenticatedUser","deletePackageVersionForOrg","getAllPackageVersionsForAPackageOwnedByAnOrg","getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser","getAllPackageVersionsForPackageOwnedByAuthenticatedUser","getAllPackageVersionsForPackageOwnedByOrg","getAllPackageVersionsForPackageOwnedByUser","getPackageForAuthenticatedUser","getPackageForOrganization","getPackageForUser","getPackageVersionForAuthenticatedUser","getPackageVersionForOrganization","getPackageVersionForUser","restorePackageForAuthenticatedUser","restorePackageForOrg","restorePackageVersionForAuthenticatedUser","restorePackageVersionForOrg","projects","addCollaborator","createCard","createColumn","createForAuthenticatedUser","createForOrg","createForRepo","deleteCard","deleteColumn","getCard","getColumn","getPermissionForUser","listCards","listCollaborators","listColumns","moveCard","moveColumn","removeCollaborator","updateCard","updateColumn","pulls","checkIfMerged","createReplyForReviewComment","createReview","createReviewComment","deletePendingReview","deleteReviewComment","dismissReview","getReview","getReviewComment","listCommentsForReview","listFiles","listRequestedReviewers","listReviewComments","listReviewCommentsForRepo","listReviews","merge","removeRequestedReviewers","requestReviewers","submitReview","updateBranch","updateReview","updateReviewComment","rateLimit","reactions","createForCommitComment","createForIssue","createForIssueComment","createForPullRequestReviewComment","createForRelease","createForTeamDiscussionCommentInOrg","createForTeamDiscussionInOrg","deleteForCommitComment","deleteForIssue","deleteForIssueComment","deleteForPullRequestComment","deleteForTeamDiscussion","deleteForTeamDiscussionComment","deleteLegacy","deprecated","listForCommitComment","listForIssue","listForIssueComment","listForPullRequestReviewComment","listForTeamDiscussionCommentInOrg","listForTeamDiscussionInOrg","repos","acceptInvitation","addAppAccessRestrictions","mapToData","addStatusCheckContexts","addTeamAccessRestrictions","addUserAccessRestrictions","checkCollaborator","checkVulnerabilityAlerts","compareCommits","compareCommitsWithBasehead","createCommitComment","createCommitSignatureProtection","createCommitStatus","createDeployKey","createDeployment","createDeploymentStatus","createDispatchEvent","createFork","createInOrg","createOrUpdateEnvironment","createOrUpdateFileContents","createPagesSite","createRelease","createUsingTemplate","declineInvitation","deleteAccessRestrictions","deleteAdminBranchProtection","deleteAnEnvironment","deleteBranchProtection","deleteCommitComment","deleteCommitSignatureProtection","deleteDeployKey","deleteDeployment","deleteFile","deleteInvitation","deletePagesSite","deletePullRequestReviewProtection","deleteRelease","deleteReleaseAsset","disableAutomatedSecurityFixes","disableVulnerabilityAlerts","downloadArchive","downloadTarballArchive","downloadZipballArchive","enableAutomatedSecurityFixes","enableVulnerabilityAlerts","getAccessRestrictions","getAdminBranchProtection","getAllEnvironments","getAllStatusCheckContexts","getAllTopics","getAppsWithAccessToProtectedBranch","getBranch","getBranchProtection","getClones","getCodeFrequencyStats","getCollaboratorPermissionLevel","getCombinedStatusForRef","getCommitActivityStats","getCommitComment","getCommitSignatureProtection","getCommunityProfileMetrics","getContent","getContributorsStats","getDeployKey","getDeployment","getDeploymentStatus","getEnvironment","getLatestPagesBuild","getLatestRelease","getPages","getPagesBuild","getPagesHealthCheck","getParticipationStats","getPullRequestReviewProtection","getPunchCardStats","getReadme","getReadmeInDirectory","getRelease","getReleaseAsset","getReleaseByTag","getStatusChecksProtection","getTeamsWithAccessToProtectedBranch","getTopPaths","getTopReferrers","getUsersWithAccessToProtectedBranch","getViews","getWebhookConfigForRepo","listBranches","listBranchesForHeadCommit","listCommentsForCommit","listCommitCommentsForRepo","listCommitStatusesForRef","listContributors","listDeployKeys","listDeploymentStatuses","listDeployments","listInvitations","listInvitationsForAuthenticatedUser","listLanguages","listPagesBuilds","listPullRequestsAssociatedWithCommit","listReleaseAssets","listReleases","listTags","listTeams","removeAppAccessRestrictions","removeStatusCheckContexts","removeStatusCheckProtection","removeTeamAccessRestrictions","removeUserAccessRestrictions","renameBranch","replaceAllTopics","requestPagesBuild","setAdminBranchProtection","setAppAccessRestrictions","setStatusCheckContexts","setTeamAccessRestrictions","setUserAccessRestrictions","testPushWebhook","transfer","updateBranchProtection","updateCommitComment","updateInformationAboutPagesSite","updateInvitation","updatePullRequestReviewProtection","updateRelease","updateReleaseAsset","updateStatusCheckPotection","updateStatusCheckProtection","updateWebhookConfigForRepo","uploadReleaseAsset","baseUrl","search","code","commits","issuesAndPullRequests","labels","topics","users","secretScanning","teams","addOrUpdateMembershipForUserInOrg","addOrUpdateProjectPermissionsInOrg","addOrUpdateRepoPermissionsInOrg","checkPermissionsForProjectInOrg","checkPermissionsForRepoInOrg","createDiscussionCommentInOrg","createDiscussionInOrg","deleteDiscussionCommentInOrg","deleteDiscussionInOrg","deleteInOrg","getByName","getDiscussionCommentInOrg","getDiscussionInOrg","getMembershipForUserInOrg","listChildInOrg","listDiscussionCommentsInOrg","listDiscussionsInOrg","listMembersInOrg","listPendingInvitationsInOrg","listProjectsInOrg","listReposInOrg","removeMembershipForUserInOrg","removeProjectInOrg","removeRepoInOrg","updateDiscussionCommentInOrg","updateDiscussionInOrg","updateInOrg","addEmailForAuthenticated","block","checkBlocked","checkFollowingForUser","checkPersonIsFollowedByAuthenticated","createGpgKeyForAuthenticated","createPublicSshKeyForAuthenticated","deleteEmailForAuthenticated","deleteGpgKeyForAuthenticated","deletePublicSshKeyForAuthenticated","follow","getByUsername","getContextForUser","getGpgKeyForAuthenticated","getPublicSshKeyForAuthenticated","listBlockedByAuthenticated","listEmailsForAuthenticated","listFollowedByAuthenticated","listFollowersForAuthenticatedUser","listFollowersForUser","listFollowingForUser","listGpgKeysForAuthenticated","listGpgKeysForUser","listPublicEmailsForAuthenticated","listPublicKeysForUser","listPublicSshKeysForAuthenticated","setPrimaryEmailVisibilityForAuthenticated","unblock","unfollow","updateAuthenticated","VERSION","endpointsToMethods","octokit","endpointsMap","newMethods","scope","endpoints","Object","entries","methodName","endpoint","route","defaults","decorations","method","url","split","endpointDefaults","assign","scopeMethods","decorate","request","requestWithDefaults","withDecorations","args","options","data","undefined","newScope","newMethodName","log","warn","name","alias","restEndpointMethods","api","ENDPOINTS","rest","legacyRestEndpointMethods"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,MAAMA,SAAS,GAAG;AACdC,EAAAA,OAAO,EAAE;AACLC,IAAAA,0BAA0B,EAAE,CACxB,4EADwB,CADvB;AAILC,IAAAA,kBAAkB,EAAE,CAChB,0DADgB,CAJf;AAOLC,IAAAA,iBAAiB,EAAE,CACf,yDADe,CAPd;AAULC,IAAAA,+BAA+B,EAAE,CAC7B,yFAD6B,CAV5B;AAaLC,IAAAA,uBAAuB,EAAE,CAAC,+CAAD,CAbpB;AAcLC,IAAAA,wBAAwB,EAAE,CACtB,yDADsB,CAdrB;AAiBLC,IAAAA,6BAA6B,EAAE,CAC3B,qDAD2B,CAjB1B;AAoBLC,IAAAA,8BAA8B,EAAE,CAC5B,+DAD4B,CApB3B;AAuBLC,IAAAA,uBAAuB,EAAE,CAAC,+CAAD,CAvBpB;AAwBLC,IAAAA,wBAAwB,EAAE,CACtB,yDADsB,CAxBrB;AA2BLC,IAAAA,sBAAsB,EAAE,CACpB,uEADoB,CA3BnB;AA8BLC,IAAAA,cAAc,EAAE,CACZ,8DADY,CA9BX;AAiCLC,IAAAA,uBAAuB,EAAE,CACrB,4FADqB,CAjCpB;AAoCLC,IAAAA,eAAe,EAAE,CAAC,kDAAD,CApCZ;AAqCLC,IAAAA,gBAAgB,EAAE,CACd,4DADc,CArCb;AAwCLC,IAAAA,6BAA6B,EAAE,CAC3B,gDAD2B,CAxC1B;AA2CLC,IAAAA,8BAA8B,EAAE,CAC5B,0DAD4B,CA3C3B;AA8CLC,IAAAA,iBAAiB,EAAE,CAAC,oDAAD,CA9Cd;AA+CLC,IAAAA,qBAAqB,EAAE,CACnB,yDADmB,CA/ClB;AAkDLC,IAAAA,kDAAkD,EAAE,CAChD,qEADgD,CAlD/C;AAqDLC,IAAAA,eAAe,EAAE,CACb,mEADa,CArDZ;AAwDLC,IAAAA,gBAAgB,EAAE,CACd,4EADc,CAxDb;AA2DLC,IAAAA,6BAA6B,EAAE,CAC3B,sDAD2B,CA3D1B;AA8DLC,IAAAA,uBAAuB,EAAE,CACrB,sDADqB,CA9DpB;AAiELC,IAAAA,iDAAiD,EAAE,CAC/C,kEAD+C,CAjE9C;AAoELC,IAAAA,cAAc,EAAE,CACZ,kEADY,CApEX;AAuELC,IAAAA,6BAA6B,EAAE,CAC3B,sDAD2B,CAvE1B;AA0ELC,IAAAA,2BAA2B,EAAE,CACzB,gEADyB,CA1ExB;AA6ELC,IAAAA,WAAW,EAAE,CAAC,2DAAD,CA7ER;AA8ELC,IAAAA,uBAAuB,EAAE,CACrB,sFADqB,CA9EpB;AAiFLC,IAAAA,oBAAoB,EAAE,CAClB,yFADkB,CAjFjB;AAoFLC,IAAAA,uCAAuC,EAAE,CACrC,qCADqC,CApFpC;AAuFLC,IAAAA,qCAAqC,EAAE,CACnC,+CADmC,CAvFlC;AA0FLC,IAAAA,oBAAoB,EAAE,CAAC,iDAAD,CA1FjB;AA2FLC,IAAAA,eAAe,EAAE,CAAC,4CAAD,CA3FZ;AA4FLC,IAAAA,YAAY,EAAE,CAAC,+CAAD,CA5FT;AA6FLC,IAAAA,2BAA2B,EAAE,CACzB,qEADyB,CA7FxB;AAgGLC,IAAAA,kBAAkB,EAAE,CAChB,+CADgB,EAEhB,EAFgB,EAGhB;AAAEC,MAAAA,OAAO,EAAE,CAAC,SAAD,EAAY,uCAAZ;AAAX,KAHgB,CAhGf;AAqGLC,IAAAA,gBAAgB,EAAE,CAAC,sDAAD,CArGb;AAsGLC,IAAAA,aAAa,EAAE,CAAC,yDAAD,CAtGV;AAuGLC,IAAAA,gBAAgB,EAAE,CACd,2DADc,CAvGb;AA0GLC,IAAAA,yBAAyB,EAAE,CAAC,6CAAD,CA1GtB;AA2GLC,IAAAA,0BAA0B,EAAE,CACxB,uDADwB,CA3GvB;AA8GLC,IAAAA,WAAW,EAAE,CAAC,2DAAD,CA9GR;AA+GLC,IAAAA,cAAc,EAAE,CAAC,iDAAD,CA/GX;AAgHLC,IAAAA,mBAAmB,EAAE,CACjB,wDADiB,CAhHhB;AAmHLC,IAAAA,gBAAgB,EAAE,CACd,kEADc,CAnHb;AAsHLC,IAAAA,oBAAoB,EAAE,CAAC,6CAAD,CAtHjB;AAuHLC,IAAAA,sBAAsB,EAAE,CACpB,2EADoB,CAvHnB;AA0HLC,IAAAA,sBAAsB,EAAE,CACpB,sDADoB,CA1HnB;AA6HLC,IAAAA,cAAc,EAAE,CAAC,iCAAD,CA7HX;AA8HLC,IAAAA,eAAe,EAAE,CAAC,2CAAD,CA9HZ;AA+HLC,IAAAA,iBAAiB,EAAE,CAAC,6CAAD,CA/Hd;AAgILC,IAAAA,4BAA4B,EAAE,CAAC,2CAAD,CAhIzB;AAiILC,IAAAA,6BAA6B,EAAE,CAC3B,qDAD2B,CAjI1B;AAoILC,IAAAA,6BAA6B,EAAE,CAC3B,4DAD2B,CApI1B;AAuILC,IAAAA,wDAAwD,EAAE,CACtD,kDADsD,CAvIrD;AA0ILC,IAAAA,2BAA2B,EAAE,CAAC,iCAAD,CA1IxB;AA2ILC,IAAAA,4BAA4B,EAAE,CAAC,2CAAD,CA3IzB;AA4ILC,IAAAA,wBAAwB,EAAE,CACtB,2DADsB,CA5IrB;AA+ILC,IAAAA,gBAAgB,EAAE,CACd,gEADc,CA/Ib;AAkJLC,IAAAA,uBAAuB,EAAE,CAAC,wCAAD,CAlJpB;AAmJLC,IAAAA,aAAa,EAAE,CAAC,wDAAD,CAnJV;AAoJLC,IAAAA,+BAA+B,EAAE,CAC7B,+EAD6B,CApJ5B;AAuJLC,IAAAA,8BAA8B,EAAE,CAC5B,sEAD4B,CAvJ3B;AA0JLC,IAAAA,6BAA6B,EAAE,CAC3B,sDAD2B,CA1J1B;AA6JLC,IAAAA,2BAA2B,EAAE,CACzB,gEADyB,CA7JxB;AAgKLC,IAAAA,uCAAuC,EAAE,CACrC,qCADqC,CAhKpC;AAmKLC,IAAAA,qCAAqC,EAAE,CACnC,+CADmC,CAnKlC;AAsKLC,IAAAA,4BAA4B,EAAE,CAC1B,4DAD0B,CAtKzB;AAyKLC,IAAAA,uDAAuD,EAAE,CACrD,kDADqD;AAzKpD,GADK;AA8KdC,EAAAA,QAAQ,EAAE;AACNC,IAAAA,qCAAqC,EAAE,CAAC,kCAAD,CADjC;AAENC,IAAAA,sBAAsB,EAAE,CAAC,2CAAD,CAFlB;AAGNC,IAAAA,wBAAwB,EAAE,CACtB,wDADsB,CAHpB;AAMNC,IAAAA,QAAQ,EAAE,CAAC,YAAD,CANJ;AAONC,IAAAA,mBAAmB,EAAE,CAAC,wCAAD,CAPf;AAQNC,IAAAA,SAAS,EAAE,CAAC,wCAAD,CARL;AASNC,IAAAA,yCAAyC,EAAE,CACvC,qDADuC,CATrC;AAYNC,IAAAA,8BAA8B,EAAE,CAAC,8BAAD,CAZ1B;AAaNC,IAAAA,qCAAqC,EAAE,CAAC,oBAAD,CAbjC;AAcNC,IAAAA,iCAAiC,EAAE,CAC/B,yCAD+B,CAd7B;AAiBNC,IAAAA,gBAAgB,EAAE,CAAC,aAAD,CAjBZ;AAkBNC,IAAAA,8BAA8B,EAAE,CAAC,qCAAD,CAlB1B;AAmBNC,IAAAA,uBAAuB,EAAE,CAAC,qCAAD,CAnBnB;AAoBNC,IAAAA,mBAAmB,EAAE,CAAC,wBAAD,CApBf;AAqBNC,IAAAA,yBAAyB,EAAE,CAAC,uCAAD,CArBrB;AAsBNC,IAAAA,+BAA+B,EAAE,CAC7B,8CAD6B,CAtB3B;AAyBNC,IAAAA,cAAc,EAAE,CAAC,kCAAD,CAzBV;AA0BNC,IAAAA,yCAAyC,EAAE,CACvC,yCADuC,CA1BrC;AA6BNC,IAAAA,mCAAmC,EAAE,CAAC,mBAAD,CA7B/B;AA8BNC,IAAAA,sBAAsB,EAAE,CAAC,+BAAD,CA9BlB;AA+BNC,IAAAA,sBAAsB,EAAE,CAAC,qCAAD,CA/BlB;AAgCNC,IAAAA,qBAAqB,EAAE,CAAC,sCAAD,CAhCjB;AAiCNC,IAAAA,oCAAoC,EAAE,CAAC,yBAAD,CAjChC;AAkCNC,IAAAA,mBAAmB,EAAE,CAAC,uCAAD,CAlCf;AAmCNC,IAAAA,uBAAuB,EAAE,CAAC,oBAAD,CAnCnB;AAoCNC,IAAAA,2BAA2B,EAAE,CAAC,yCAAD,CApCvB;AAqCNC,IAAAA,gBAAgB,EAAE,CAAC,0CAAD,CArCZ;AAsCNC,IAAAA,mBAAmB,EAAE,CAAC,wCAAD,CAtCf;AAuCNC,IAAAA,qBAAqB,EAAE,CACnB,qDADmB,CAvCjB;AA0CNC,IAAAA,4BAA4B,EAAE,CAAC,kCAAD,CA1CxB;AA2CNC,IAAAA,8BAA8B,EAAE,CAAC,qCAAD;AA3C1B,GA9KI;AA2NdC,EAAAA,IAAI,EAAE;AACFC,IAAAA,qBAAqB,EAAE,CACnB,wEADmB,CADrB;AAIFC,IAAAA,UAAU,EAAE,CAAC,sCAAD,CAJV;AAKFC,IAAAA,uBAAuB,EAAE,CACrB,6DADqB,EAErB;AAAEC,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFqB,CALvB;AASFC,IAAAA,8BAA8B,EAAE,CAC5B,kFAD4B,EAE5B;AAAEF,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAF4B,CAT9B;AAaFE,IAAAA,kBAAkB,EAAE,CAAC,wCAAD,CAblB;AAcFC,IAAAA,6BAA6B,EAAE,CAC3B,yDAD2B,CAd7B;AAiBFC,IAAAA,mBAAmB,EAAE,CAAC,wCAAD,CAjBnB;AAkBFC,IAAAA,kBAAkB,EAAE,CAAC,6CAAD,CAlBlB;AAmBFC,IAAAA,WAAW,EAAE,CAAC,wCAAD,CAnBX;AAoBFC,IAAAA,gBAAgB,EAAE,CAAC,UAAD,CApBhB;AAqBFC,IAAAA,SAAS,EAAE,CAAC,sBAAD,CArBT;AAsBFC,IAAAA,eAAe,EAAE,CAAC,0CAAD,CAtBf;AAuBFC,IAAAA,kBAAkB,EAAE,CAAC,8BAAD,CAvBlB;AAwBFC,IAAAA,mBAAmB,EAAE,CAAC,wCAAD,CAxBnB;AAyBFC,IAAAA,6BAA6B,EAAE,CAC3B,gDAD2B,CAzB7B;AA4BFC,IAAAA,oCAAoC,EAAE,CAClC,wDADkC,CA5BpC;AA+BFC,IAAAA,mBAAmB,EAAE,CAAC,oCAAD,CA/BnB;AAgCFC,IAAAA,sBAAsB,EAAE,CAAC,sBAAD,CAhCtB;AAiCFC,IAAAA,mBAAmB,EAAE,CAAC,mDAAD,CAjCnB;AAkCFC,IAAAA,0BAA0B,EAAE,CACxB,2DADwB,CAlC1B;AAqCFC,IAAAA,yCAAyC,EAAE,CACvC,wDADuC,CArCzC;AAwCFC,IAAAA,iBAAiB,EAAE,CAAC,wBAAD,CAxCjB;AAyCFC,IAAAA,qCAAqC,EAAE,CAAC,yBAAD,CAzCrC;AA0CFC,IAAAA,SAAS,EAAE,CAAC,gCAAD,CA1CT;AA2CFC,IAAAA,gBAAgB,EAAE,CAAC,wCAAD,CA3ChB;AA4CFC,IAAAA,iCAAiC,EAAE,CAAC,gCAAD,CA5CjC;AA6CFC,IAAAA,qCAAqC,EAAE,CAAC,iCAAD,CA7CrC;AA8CFC,IAAAA,4CAA4C,EAAE,CAC1C,yCAD0C,CA9C5C;AAiDFC,IAAAA,0BAA0B,EAAE,CACxB,2EADwB,CAjD1B;AAoDFC,IAAAA,UAAU,EAAE,CAAC,uCAAD,CApDV;AAqDFC,IAAAA,6BAA6B,EAAE,CAAC,4BAAD,CArD7B;AAsDFC,IAAAA,UAAU,EAAE,CAAC,6CAAD,CAtDV;AAuDFC,IAAAA,mBAAmB,EAAE,CAAC,oDAAD,CAvDnB;AAwDFC,IAAAA,qBAAqB,EAAE,CACnB,uDADmB,CAxDrB;AA2DFC,IAAAA,yBAAyB,EAAE,CAAC,wBAAD;AA3DzB,GA3NQ;AAwRdC,EAAAA,OAAO,EAAE;AACLC,IAAAA,0BAA0B,EAAE,CAAC,0CAAD,CADvB;AAELC,IAAAA,2BAA2B,EAAE,CACzB,gDADyB,CAFxB;AAKLC,IAAAA,2BAA2B,EAAE,CAAC,2CAAD,CALxB;AAMLC,IAAAA,4BAA4B,EAAE,CAC1B,iDAD0B,CANzB;AASLC,IAAAA,0BAA0B,EAAE,CACxB,iDADwB,CATvB;AAYLC,IAAAA,2BAA2B,EAAE,CACzB,uDADyB;AAZxB,GAxRK;AAwSdC,EAAAA,MAAM,EAAE;AACJC,IAAAA,MAAM,EAAE,CAAC,uCAAD,CADJ;AAEJC,IAAAA,WAAW,EAAE,CAAC,yCAAD,CAFT;AAGJC,IAAAA,GAAG,EAAE,CAAC,qDAAD,CAHD;AAIJC,IAAAA,QAAQ,EAAE,CAAC,yDAAD,CAJN;AAKJC,IAAAA,eAAe,EAAE,CACb,iEADa,CALb;AAQJC,IAAAA,UAAU,EAAE,CAAC,oDAAD,CARR;AASJC,IAAAA,YAAY,EAAE,CACV,oEADU,CATV;AAYJC,IAAAA,gBAAgB,EAAE,CAAC,sDAAD,CAZd;AAaJC,IAAAA,cAAc,EAAE,CACZ,oEADY,CAbZ;AAgBJC,IAAAA,oBAAoB,EAAE,CAClB,sDADkB,CAhBlB;AAmBJC,IAAAA,MAAM,EAAE,CAAC,uDAAD;AAnBJ,GAxSM;AA6TdC,EAAAA,YAAY,EAAE;AACVC,IAAAA,cAAc,EAAE,CACZ,oFADY,CADN;AAIVC,IAAAA,QAAQ,EAAE,CACN,+DADM,EAEN,EAFM,EAGN;AAAEC,MAAAA,iBAAiB,EAAE;AAAEC,QAAAA,QAAQ,EAAE;AAAZ;AAArB,KAHM,CAJA;AASVC,IAAAA,WAAW,EAAE,CACT,gEADS,CATH;AAYVC,IAAAA,QAAQ,EAAE,CAAC,2DAAD,CAZA;AAaVC,IAAAA,kBAAkB,EAAE,CAChB,yEADgB,CAbV;AAgBVC,IAAAA,iBAAiB,EAAE,CAAC,gDAAD,CAhBT;AAiBVC,IAAAA,mBAAmB,EAAE,CACjB,yEADiB,EAEjB,EAFiB,EAGjB;AAAEpI,MAAAA,OAAO,EAAE,CAAC,cAAD,EAAiB,oBAAjB;AAAX,KAHiB,CAjBX;AAsBVqI,IAAAA,kBAAkB,EAAE,CAAC,kDAAD,CAtBV;AAuBVC,IAAAA,WAAW,EAAE,CACT,iEADS,CAvBH;AA0BVC,IAAAA,WAAW,EAAE,CAAC,iDAAD;AA1BH,GA7TA;AAyVdC,EAAAA,cAAc,EAAE;AACZC,IAAAA,oBAAoB,EAAE,CAClB,uBADkB,EAElB;AAAEnE,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFkB,CADV;AAKZmE,IAAAA,cAAc,EAAE,CACZ,6BADY,EAEZ;AAAEpE,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFY,CALJ;AASZoE,IAAAA,UAAU,EAAE,CACR,qDADQ,EAER;AAAErE,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFQ;AATA,GAzVF;AAuWdqE,EAAAA,MAAM,EAAE;AAAE1B,IAAAA,GAAG,EAAE,CAAC,aAAD;AAAP,GAvWM;AAwWd2B,EAAAA,eAAe,EAAE;AACbC,IAAAA,kDAAkD,EAAE,CAChD,6EADgD,CADvC;AAIbC,IAAAA,iDAAiD,EAAE,CAC/C,0EAD+C,CAJtC;AAObC,IAAAA,2BAA2B,EAAE,CACzB,oEADyB,CAPhB;AAUbC,IAAAA,qCAAqC,EAAE,CACnC,mDADmC,CAV1B;AAabC,IAAAA,uDAAuD,EAAE,CACrD,iEADqD,CAb5C;AAgBbC,IAAAA,2BAA2B,EAAE,CACzB,oEADyB,CAhBhB;AAmBbC,IAAAA,qCAAqC,EAAE,CACnC,mDADmC,CAnB1B;AAsBbC,IAAAA,sDAAsD,EAAE,CACpD,iEADoD;AAtB3C,GAxWH;AAkYdC,EAAAA,KAAK,EAAE;AACHC,IAAAA,cAAc,EAAE,CAAC,2BAAD,CADb;AAEHvC,IAAAA,MAAM,EAAE,CAAC,aAAD,CAFL;AAGHwC,IAAAA,aAAa,EAAE,CAAC,gCAAD,CAHZ;AAIHC,IAAAA,MAAM,EAAE,CAAC,yBAAD,CAJL;AAKHC,IAAAA,aAAa,EAAE,CAAC,+CAAD,CALZ;AAMHC,IAAAA,IAAI,EAAE,CAAC,6BAAD,CANH;AAOHzC,IAAAA,GAAG,EAAE,CAAC,sBAAD,CAPF;AAQH0C,IAAAA,UAAU,EAAE,CAAC,4CAAD,CART;AASHC,IAAAA,WAAW,EAAE,CAAC,4BAAD,CATV;AAUHC,IAAAA,IAAI,EAAE,CAAC,YAAD,CAVH;AAWHC,IAAAA,YAAY,EAAE,CAAC,+BAAD,CAXX;AAYHC,IAAAA,WAAW,EAAE,CAAC,8BAAD,CAZV;AAaHC,IAAAA,WAAW,EAAE,CAAC,6BAAD,CAbV;AAcHC,IAAAA,SAAS,EAAE,CAAC,4BAAD,CAdR;AAeHC,IAAAA,UAAU,EAAE,CAAC,mBAAD,CAfT;AAgBHC,IAAAA,WAAW,EAAE,CAAC,oBAAD,CAhBV;AAiBHC,IAAAA,IAAI,EAAE,CAAC,2BAAD,CAjBH;AAkBHC,IAAAA,MAAM,EAAE,CAAC,8BAAD,CAlBL;AAmBH5C,IAAAA,MAAM,EAAE,CAAC,wBAAD,CAnBL;AAoBH6C,IAAAA,aAAa,EAAE,CAAC,8CAAD;AApBZ,GAlYO;AAwZdC,EAAAA,GAAG,EAAE;AACDC,IAAAA,UAAU,EAAE,CAAC,sCAAD,CADX;AAEDC,IAAAA,YAAY,EAAE,CAAC,wCAAD,CAFb;AAGDC,IAAAA,SAAS,EAAE,CAAC,qCAAD,CAHV;AAIDC,IAAAA,SAAS,EAAE,CAAC,qCAAD,CAJV;AAKDC,IAAAA,UAAU,EAAE,CAAC,sCAAD,CALX;AAMDC,IAAAA,SAAS,EAAE,CAAC,6CAAD,CANV;AAODC,IAAAA,OAAO,EAAE,CAAC,gDAAD,CAPR;AAQDC,IAAAA,SAAS,EAAE,CAAC,oDAAD,CARV;AASDC,IAAAA,MAAM,EAAE,CAAC,yCAAD,CATP;AAUDC,IAAAA,MAAM,EAAE,CAAC,8CAAD,CAVP;AAWDC,IAAAA,OAAO,EAAE,CAAC,gDAAD,CAXR;AAYDC,IAAAA,gBAAgB,EAAE,CAAC,mDAAD,CAZjB;AAaDC,IAAAA,SAAS,EAAE,CAAC,4CAAD;AAbV,GAxZS;AAuadC,EAAAA,SAAS,EAAE;AACPC,IAAAA,eAAe,EAAE,CAAC,0BAAD,CADV;AAEPC,IAAAA,WAAW,EAAE,CAAC,iCAAD;AAFN,GAvaG;AA2adC,EAAAA,YAAY,EAAE;AACVC,IAAAA,mCAAmC,EAAE,CAAC,8BAAD,CAD3B;AAEVC,IAAAA,qBAAqB,EAAE,CAAC,oCAAD,CAFb;AAGVC,IAAAA,sBAAsB,EAAE,CAAC,8CAAD,CAHd;AAIVC,IAAAA,iCAAiC,EAAE,CAC/B,8BAD+B,EAE/B,EAF+B,EAG/B;AAAE7L,MAAAA,OAAO,EAAE,CAAC,cAAD,EAAiB,qCAAjB;AAAX,KAH+B,CAJzB;AASV8L,IAAAA,sCAAsC,EAAE,CAAC,iCAAD,CAT9B;AAUVC,IAAAA,wBAAwB,EAAE,CAAC,uCAAD,CAVhB;AAWVC,IAAAA,yBAAyB,EAAE,CACvB,iDADuB,CAXjB;AAcVC,IAAAA,oCAAoC,EAAE,CAClC,iCADkC,EAElC,EAFkC,EAGlC;AAAEjM,MAAAA,OAAO,EAAE,CAAC,cAAD,EAAiB,wCAAjB;AAAX,KAHkC,CAd5B;AAmBVkM,IAAAA,mCAAmC,EAAE,CAAC,8BAAD,CAnB3B;AAoBVC,IAAAA,qBAAqB,EAAE,CAAC,oCAAD,CApBb;AAqBVC,IAAAA,sBAAsB,EAAE,CAAC,8CAAD,CArBd;AAsBVC,IAAAA,iCAAiC,EAAE,CAC/B,8BAD+B,EAE/B,EAF+B,EAG/B;AAAErM,MAAAA,OAAO,EAAE,CAAC,cAAD,EAAiB,qCAAjB;AAAX,KAH+B;AAtBzB,GA3aA;AAucdsM,EAAAA,MAAM,EAAE;AACJC,IAAAA,YAAY,EAAE,CACV,4DADU,CADV;AAIJC,IAAAA,SAAS,EAAE,CAAC,yDAAD,CAJP;AAKJC,IAAAA,sBAAsB,EAAE,CAAC,gDAAD,CALpB;AAMJzF,IAAAA,MAAM,EAAE,CAAC,mCAAD,CANJ;AAOJwC,IAAAA,aAAa,EAAE,CACX,2DADW,CAPX;AAUJkD,IAAAA,WAAW,EAAE,CAAC,mCAAD,CAVT;AAWJC,IAAAA,eAAe,EAAE,CAAC,uCAAD,CAXb;AAYJjD,IAAAA,aAAa,EAAE,CACX,2DADW,CAZX;AAeJkD,IAAAA,WAAW,EAAE,CAAC,4CAAD,CAfT;AAgBJC,IAAAA,eAAe,EAAE,CACb,4DADa,CAhBb;AAmBJ3F,IAAAA,GAAG,EAAE,CAAC,iDAAD,CAnBD;AAoBJ0C,IAAAA,UAAU,EAAE,CAAC,wDAAD,CApBR;AAqBJkD,IAAAA,QAAQ,EAAE,CAAC,oDAAD,CArBN;AAsBJC,IAAAA,QAAQ,EAAE,CAAC,yCAAD,CAtBN;AAuBJC,IAAAA,YAAY,EAAE,CAAC,yDAAD,CAvBV;AAwBJlD,IAAAA,IAAI,EAAE,CAAC,aAAD,CAxBF;AAyBJmD,IAAAA,aAAa,EAAE,CAAC,qCAAD,CAzBX;AA0BJlD,IAAAA,YAAY,EAAE,CAAC,0DAAD,CA1BV;AA2BJmD,IAAAA,mBAAmB,EAAE,CAAC,2CAAD,CA3BjB;AA4BJC,IAAAA,UAAU,EAAE,CAAC,wDAAD,CA5BR;AA6BJC,IAAAA,iBAAiB,EAAE,CAAC,yCAAD,CA7Bf;AA8BJC,IAAAA,qBAAqB,EAAE,CACnB,0DADmB,EAEnB;AAAE/I,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,aAAD;AAAZ;AAAb,KAFmB,CA9BnB;AAkCJ+I,IAAAA,wBAAwB,EAAE,CAAC,kBAAD,CAlCtB;AAmCJC,IAAAA,UAAU,EAAE,CAAC,wBAAD,CAnCR;AAoCJC,IAAAA,WAAW,EAAE,CAAC,kCAAD,CApCT;AAqCJC,IAAAA,sBAAsB,EAAE,CACpB,gEADoB,CArCpB;AAwCJC,IAAAA,iBAAiB,EAAE,CAAC,kCAAD,CAxCf;AAyCJC,IAAAA,iBAAiB,EAAE,CACf,wDADe,CAzCf;AA4CJC,IAAAA,cAAc,EAAE,CAAC,sCAAD,CA5CZ;AA6CJC,IAAAA,IAAI,EAAE,CAAC,sDAAD,CA7CF;AA8CJC,IAAAA,eAAe,EAAE,CACb,2DADa,CA9Cb;AAiDJC,IAAAA,eAAe,EAAE,CACb,8DADa,CAjDb;AAoDJC,IAAAA,WAAW,EAAE,CACT,kEADS,CApDT;AAuDJC,IAAAA,SAAS,EAAE,CAAC,wDAAD,CAvDP;AAwDJC,IAAAA,MAAM,EAAE,CAAC,yDAAD,CAxDJ;AAyDJxG,IAAAA,MAAM,EAAE,CAAC,mDAAD,CAzDJ;AA0DJ6C,IAAAA,aAAa,EAAE,CAAC,0DAAD,CA1DX;AA2DJ4D,IAAAA,WAAW,EAAE,CAAC,2CAAD,CA3DT;AA4DJC,IAAAA,eAAe,EAAE,CACb,2DADa;AA5Db,GAvcM;AAugBdC,EAAAA,QAAQ,EAAE;AACNnH,IAAAA,GAAG,EAAE,CAAC,yBAAD,CADC;AAENoH,IAAAA,kBAAkB,EAAE,CAAC,eAAD,CAFd;AAGN3F,IAAAA,UAAU,EAAE,CAAC,mCAAD;AAHN,GAvgBI;AA4gBd4F,EAAAA,QAAQ,EAAE;AACNC,IAAAA,MAAM,EAAE,CAAC,gBAAD,CADF;AAENC,IAAAA,SAAS,EAAE,CACP,oBADO,EAEP;AAAEC,MAAAA,OAAO,EAAE;AAAE,wBAAgB;AAAlB;AAAX,KAFO;AAFL,GA5gBI;AAmhBdC,EAAAA,IAAI,EAAE;AACFzH,IAAAA,GAAG,EAAE,CAAC,WAAD,CADH;AAEF0H,IAAAA,UAAU,EAAE,CAAC,cAAD,CAFV;AAGFC,IAAAA,MAAM,EAAE,CAAC,UAAD,CAHN;AAIFC,IAAAA,IAAI,EAAE,CAAC,OAAD;AAJJ,GAnhBQ;AAyhBdC,EAAAA,UAAU,EAAE;AACRC,IAAAA,YAAY,EAAE,CAAC,qCAAD,CADN;AAERC,IAAAA,iCAAiC,EAAE,CAC/B,gDAD+B,EAE/B;AAAE3K,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAF+B,CAF3B;AAMR2K,IAAAA,mBAAmB,EAAE,CACjB,sDADiB,EAEjB;AAAE5K,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFiB,CANb;AAUR4K,IAAAA,qBAAqB,EAAE,CACnB,mDADmB,EAEnB;AAAE7K,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFmB,CAVf;AAcR6K,IAAAA,8BAA8B,EAAE,CAC5B,6CAD4B,EAE5B;AAAE9K,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAF4B,CAdxB;AAkBR8K,IAAAA,gBAAgB,EAAE,CAAC,0CAAD,CAlBV;AAmBRC,IAAAA,eAAe,EAAE,CAAC,kCAAD,CAnBT;AAoBRC,IAAAA,aAAa,EAAE,CAAC,8CAAD,CApBP;AAqBRC,IAAAA,6BAA6B,EAAE,CAC3B,qCAD2B,EAE3B;AAAElL,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAF2B,CArBvB;AAyBRkL,IAAAA,eAAe,EAAE,CACb,2CADa,EAEb;AAAEnL,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFa,CAzBT;AA6BR+I,IAAAA,wBAAwB,EAAE,CACtB,sBADsB,EAEtB;AAAEhJ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFsB,CA7BlB;AAiCRgJ,IAAAA,UAAU,EAAE,CACR,4BADQ,EAER;AAAEjJ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFQ,CAjCJ;AAqCRmL,IAAAA,eAAe,EAAE,CACb,wDADa,EAEb;AAAEpL,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFa,CArCT;AAyCRoL,IAAAA,gBAAgB,EAAE,CACd,kDADc,EAEd;AAAErL,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFc,CAzCV;AA6CRqL,IAAAA,eAAe,EAAE,CAAC,wDAAD,CA7CT;AA8CRC,IAAAA,gBAAgB,EAAE,CAAC,wCAAD,CA9CV;AA+CRC,IAAAA,yBAAyB,EAAE,CAAC,uBAAD,CA/CnB;AAgDRC,IAAAA,WAAW,EAAE,CAAC,6BAAD,CAhDL;AAiDRC,IAAAA,WAAW,EAAE,CAAC,kCAAD,CAjDL;AAkDRC,IAAAA,8BAA8B,EAAE,CAC5B,+DAD4B,EAE5B;AAAE3L,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAF4B,CAlDxB;AAsDR2L,IAAAA,gBAAgB,EAAE,CACd,qEADc,EAEd;AAAE5L,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,WAAD;AAAZ;AAAb,KAFc,CAtDV;AA0DR4L,IAAAA,YAAY,EAAE,CAAC,oCAAD;AA1DN,GAzhBE;AAqlBdC,EAAAA,IAAI,EAAE;AACFC,IAAAA,SAAS,EAAE,CAAC,mCAAD,CADT;AAEFC,IAAAA,gBAAgB,EAAE,CAAC,gDAAD,CAFhB;AAGFC,IAAAA,gBAAgB,EAAE,CAAC,mCAAD,CAHhB;AAIFC,IAAAA,sBAAsB,EAAE,CAAC,oCAAD,CAJtB;AAKFC,IAAAA,4BAA4B,EAAE,CAAC,2CAAD,CAL5B;AAMFC,IAAAA,kCAAkC,EAAE,CAChC,kDADgC,CANlC;AASFC,IAAAA,gBAAgB,EAAE,CAAC,8BAAD,CAThB;AAUFC,IAAAA,aAAa,EAAE,CAAC,wBAAD,CAVb;AAWFC,IAAAA,aAAa,EAAE,CAAC,oCAAD,CAXb;AAYF3J,IAAAA,GAAG,EAAE,CAAC,iBAAD,CAZH;AAaF4J,IAAAA,iCAAiC,EAAE,CAAC,kCAAD,CAbjC;AAcFC,IAAAA,oBAAoB,EAAE,CAAC,wCAAD,CAdpB;AAeFC,IAAAA,UAAU,EAAE,CAAC,iCAAD,CAfV;AAgBFC,IAAAA,sBAAsB,EAAE,CAAC,wCAAD,CAhBtB;AAiBFnH,IAAAA,IAAI,EAAE,CAAC,oBAAD,CAjBJ;AAkBFoH,IAAAA,oBAAoB,EAAE,CAAC,+BAAD,CAlBpB;AAmBFC,IAAAA,gBAAgB,EAAE,CAAC,wBAAD,CAnBhB;AAoBFC,IAAAA,qBAAqB,EAAE,CAAC,oCAAD,CApBrB;AAqBF9D,IAAAA,wBAAwB,EAAE,CAAC,gBAAD,CArBxB;AAsBFrD,IAAAA,WAAW,EAAE,CAAC,4BAAD,CAtBX;AAuBFoH,IAAAA,mBAAmB,EAAE,CAAC,mDAAD,CAvBnB;AAwBFC,IAAAA,WAAW,EAAE,CAAC,yBAAD,CAxBX;AAyBFC,IAAAA,mCAAmC,EAAE,CAAC,4BAAD,CAzBnC;AA0BFC,IAAAA,wBAAwB,EAAE,CAAC,uCAAD,CA1BxB;AA2BFC,IAAAA,sBAAsB,EAAE,CAAC,6BAAD,CA3BtB;AA4BFC,IAAAA,iBAAiB,EAAE,CAAC,gCAAD,CA5BjB;AA6BFC,IAAAA,YAAY,EAAE,CAAC,uBAAD,CA7BZ;AA8BFC,IAAAA,WAAW,EAAE,CAAC,wCAAD,CA9BX;AA+BFC,IAAAA,YAAY,EAAE,CAAC,uCAAD,CA/BZ;AAgCFC,IAAAA,uBAAuB,EAAE,CAAC,2CAAD,CAhCvB;AAiCFC,IAAAA,yBAAyB,EAAE,CACvB,qDADuB,CAjCzB;AAoCFC,IAAAA,0CAA0C,EAAE,CACxC,8CADwC,CApC1C;AAuCFC,IAAAA,oBAAoB,EAAE,CAAC,wCAAD,CAvCpB;AAwCFC,IAAAA,uCAAuC,EAAE,CACrC,2CADqC,CAxCvC;AA2CFC,IAAAA,WAAW,EAAE,CAAC,sCAAD,CA3CX;AA4CFzK,IAAAA,MAAM,EAAE,CAAC,mBAAD,CA5CN;AA6CF0K,IAAAA,oCAAoC,EAAE,CAClC,oCADkC,CA7CpC;AAgDFC,IAAAA,aAAa,EAAE,CAAC,mCAAD,CAhDb;AAiDFC,IAAAA,yBAAyB,EAAE,CAAC,0CAAD;AAjDzB,GArlBQ;AAwoBdC,EAAAA,QAAQ,EAAE;AACNC,IAAAA,iCAAiC,EAAE,CAC/B,qDAD+B,CAD7B;AAINC,IAAAA,mBAAmB,EAAE,CACjB,2DADiB,CAJf;AAONC,IAAAA,wCAAwC,EAAE,CACtC,mFADsC,CAPpC;AAUNC,IAAAA,0BAA0B,EAAE,CACxB,yFADwB,CAVtB;AAaNC,IAAAA,4CAA4C,EAAE,CAC1C,iEAD0C,EAE1C,EAF0C,EAG1C;AAAE5S,MAAAA,OAAO,EAAE,CAAC,UAAD,EAAa,2CAAb;AAAX,KAH0C,CAbxC;AAkBN6S,IAAAA,2DAA2D,EAAE,CACzD,2DADyD,EAEzD,EAFyD,EAGzD;AACI7S,MAAAA,OAAO,EAAE,CACL,UADK,EAEL,yDAFK;AADb,KAHyD,CAlBvD;AA4BN8S,IAAAA,uDAAuD,EAAE,CACrD,2DADqD,CA5BnD;AA+BNC,IAAAA,yCAAyC,EAAE,CACvC,iEADuC,CA/BrC;AAkCNC,IAAAA,0CAA0C,EAAE,CACxC,uEADwC,CAlCtC;AAqCNC,IAAAA,8BAA8B,EAAE,CAC5B,kDAD4B,CArC1B;AAwCNC,IAAAA,yBAAyB,EAAE,CACvB,wDADuB,CAxCrB;AA2CNC,IAAAA,iBAAiB,EAAE,CACf,8DADe,CA3Cb;AA8CNC,IAAAA,qCAAqC,EAAE,CACnC,gFADmC,CA9CjC;AAiDNC,IAAAA,gCAAgC,EAAE,CAC9B,sFAD8B,CAjD5B;AAoDNC,IAAAA,wBAAwB,EAAE,CACtB,4FADsB,CApDpB;AAuDNC,IAAAA,kCAAkC,EAAE,CAChC,mEADgC,CAvD9B;AA0DNC,IAAAA,oBAAoB,EAAE,CAClB,yEADkB,CA1DhB;AA6DNC,IAAAA,yCAAyC,EAAE,CACvC,yFADuC,CA7DrC;AAgENC,IAAAA,2BAA2B,EAAE,CACzB,+FADyB;AAhEvB,GAxoBI;AA4sBdC,EAAAA,QAAQ,EAAE;AACNC,IAAAA,eAAe,EAAE,CACb,qDADa,EAEb;AAAEtP,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFa,CADX;AAKNsP,IAAAA,UAAU,EAAE,CACR,0CADQ,EAER;AAAEvP,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFQ,CALN;AASNuP,IAAAA,YAAY,EAAE,CACV,qCADU,EAEV;AAAExP,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFU,CATR;AAaNwP,IAAAA,0BAA0B,EAAE,CACxB,qBADwB,EAExB;AAAEzP,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFwB,CAbtB;AAiBNyP,IAAAA,YAAY,EAAE,CACV,2BADU,EAEV;AAAE1P,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFU,CAjBR;AAqBN0P,IAAAA,aAAa,EAAE,CACX,qCADW,EAEX;AAAE3P,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFW,CArBT;AAyBNkF,IAAAA,MAAM,EAAE,CACJ,+BADI,EAEJ;AAAEnF,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFI,CAzBF;AA6BN2P,IAAAA,UAAU,EAAE,CACR,0CADQ,EAER;AAAE5P,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFQ,CA7BN;AAiCN4P,IAAAA,YAAY,EAAE,CACV,sCADU,EAEV;AAAE7P,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFU,CAjCR;AAqCN2C,IAAAA,GAAG,EAAE,CACD,4BADC,EAED;AAAE5C,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFC,CArCC;AAyCN6P,IAAAA,OAAO,EAAE,CACL,uCADK,EAEL;AAAE9P,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFK,CAzCH;AA6CN8P,IAAAA,SAAS,EAAE,CACP,mCADO,EAEP;AAAE/P,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFO,CA7CL;AAiDN+P,IAAAA,oBAAoB,EAAE,CAClB,gEADkB,EAElB;AAAEhQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFkB,CAjDhB;AAqDNgQ,IAAAA,SAAS,EAAE,CACP,yCADO,EAEP;AAAEjQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFO,CArDL;AAyDNiQ,IAAAA,iBAAiB,EAAE,CACf,0CADe,EAEf;AAAElQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFe,CAzDb;AA6DNkQ,IAAAA,WAAW,EAAE,CACT,oCADS,EAET;AAAEnQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFS,CA7DP;AAiENgJ,IAAAA,UAAU,EAAE,CACR,0BADQ,EAER;AAAEjJ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFQ,CAjEN;AAqENiJ,IAAAA,WAAW,EAAE,CACT,oCADS,EAET;AAAElJ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFS,CArEP;AAyEN0F,IAAAA,WAAW,EAAE,CACT,gCADS,EAET;AAAE3F,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFS,CAzEP;AA6ENmQ,IAAAA,QAAQ,EAAE,CACN,8CADM,EAEN;AAAEpQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFM,CA7EJ;AAiFNoQ,IAAAA,UAAU,EAAE,CACR,0CADQ,EAER;AAAErQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFQ,CAjFN;AAqFNqQ,IAAAA,kBAAkB,EAAE,CAChB,wDADgB,EAEhB;AAAEtQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFgB,CArFd;AAyFNmD,IAAAA,MAAM,EAAE,CACJ,8BADI,EAEJ;AAAEpD,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFI,CAzFF;AA6FNsQ,IAAAA,UAAU,EAAE,CACR,yCADQ,EAER;AAAEvQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFQ,CA7FN;AAiGNuQ,IAAAA,YAAY,EAAE,CACV,qCADU,EAEV;AAAExQ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFU;AAjGR,GA5sBI;AAkzBdwQ,EAAAA,KAAK,EAAE;AACHC,IAAAA,aAAa,EAAE,CAAC,qDAAD,CADZ;AAEHhO,IAAAA,MAAM,EAAE,CAAC,kCAAD,CAFL;AAGHiO,IAAAA,2BAA2B,EAAE,CACzB,8EADyB,CAH1B;AAMHC,IAAAA,YAAY,EAAE,CAAC,wDAAD,CANX;AAOHC,IAAAA,mBAAmB,EAAE,CACjB,yDADiB,CAPlB;AAUHC,IAAAA,mBAAmB,EAAE,CACjB,sEADiB,CAVlB;AAaHC,IAAAA,mBAAmB,EAAE,CACjB,0DADiB,CAblB;AAgBHC,IAAAA,aAAa,EAAE,CACX,8EADW,CAhBZ;AAmBHpO,IAAAA,GAAG,EAAE,CAAC,+CAAD,CAnBF;AAoBHqO,IAAAA,SAAS,EAAE,CACP,mEADO,CApBR;AAuBHC,IAAAA,gBAAgB,EAAE,CAAC,uDAAD,CAvBf;AAwBH1L,IAAAA,IAAI,EAAE,CAAC,iCAAD,CAxBH;AAyBH2L,IAAAA,qBAAqB,EAAE,CACnB,4EADmB,CAzBpB;AA4BHzL,IAAAA,WAAW,EAAE,CAAC,uDAAD,CA5BV;AA6BH0L,IAAAA,SAAS,EAAE,CAAC,qDAAD,CA7BR;AA8BHC,IAAAA,sBAAsB,EAAE,CACpB,mEADoB,CA9BrB;AAiCHC,IAAAA,kBAAkB,EAAE,CAChB,wDADgB,CAjCjB;AAoCHC,IAAAA,yBAAyB,EAAE,CAAC,0CAAD,CApCxB;AAqCHC,IAAAA,WAAW,EAAE,CAAC,uDAAD,CArCV;AAsCHC,IAAAA,KAAK,EAAE,CAAC,qDAAD,CAtCJ;AAuCHC,IAAAA,wBAAwB,EAAE,CACtB,sEADsB,CAvCvB;AA0CHC,IAAAA,gBAAgB,EAAE,CACd,oEADc,CA1Cf;AA6CHC,IAAAA,YAAY,EAAE,CACV,2EADU,CA7CX;AAgDHxO,IAAAA,MAAM,EAAE,CAAC,iDAAD,CAhDL;AAiDHyO,IAAAA,YAAY,EAAE,CACV,6DADU,EAEV;AAAE7R,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,QAAD;AAAZ;AAAb,KAFU,CAjDX;AAqDH6R,IAAAA,YAAY,EAAE,CACV,mEADU,CArDX;AAwDHC,IAAAA,mBAAmB,EAAE,CACjB,yDADiB;AAxDlB,GAlzBO;AA82BdC,EAAAA,SAAS,EAAE;AAAEpP,IAAAA,GAAG,EAAE,CAAC,iBAAD;AAAP,GA92BG;AA+2BdqP,EAAAA,SAAS,EAAE;AACPC,IAAAA,sBAAsB,EAAE,CACpB,4DADoB,EAEpB;AAAElS,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFoB,CADjB;AAKPkS,IAAAA,cAAc,EAAE,CACZ,4DADY,EAEZ;AAAEnS,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFY,CALT;AASPmS,IAAAA,qBAAqB,EAAE,CACnB,mEADmB,EAEnB;AAAEpS,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFmB,CAThB;AAaPoS,IAAAA,iCAAiC,EAAE,CAC/B,kEAD+B,EAE/B;AAAErS,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAF+B,CAb5B;AAiBPqS,IAAAA,gBAAgB,EAAE,CACd,4DADc,EAEd;AAAEtS,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFc,CAjBX;AAqBPsS,IAAAA,mCAAmC,EAAE,CACjC,wGADiC,EAEjC;AAAEvS,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFiC,CArB9B;AAyBPuS,IAAAA,4BAA4B,EAAE,CAC1B,8EAD0B,EAE1B;AAAExS,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAF0B,CAzBvB;AA6BPwS,IAAAA,sBAAsB,EAAE,CACpB,4EADoB,EAEpB;AAAEzS,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFoB,CA7BjB;AAiCPyS,IAAAA,cAAc,EAAE,CACZ,4EADY,EAEZ;AAAE1S,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFY,CAjCT;AAqCP0S,IAAAA,qBAAqB,EAAE,CACnB,mFADmB,EAEnB;AAAE3S,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFmB,CArChB;AAyCP2S,IAAAA,2BAA2B,EAAE,CACzB,kFADyB,EAEzB;AAAE5S,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFyB,CAzCtB;AA6CP4S,IAAAA,uBAAuB,EAAE,CACrB,8FADqB,EAErB;AAAE7S,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFqB,CA7ClB;AAiDP6S,IAAAA,8BAA8B,EAAE,CAC5B,wHAD4B,EAE5B;AAAE9S,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAF4B,CAjDzB;AAqDP8S,IAAAA,YAAY,EAAE,CACV,iCADU,EAEV;AAAE/S,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFU,EAGV;AACI+S,MAAAA,UAAU,EAAE;AADhB,KAHU,CArDP;AA4DPC,IAAAA,oBAAoB,EAAE,CAClB,2DADkB,EAElB;AAAEjT,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFkB,CA5Df;AAgEPiT,IAAAA,YAAY,EAAE,CACV,2DADU,EAEV;AAAElT,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFU,CAhEP;AAoEPkT,IAAAA,mBAAmB,EAAE,CACjB,kEADiB,EAEjB;AAAEnT,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFiB,CApEd;AAwEPmT,IAAAA,+BAA+B,EAAE,CAC7B,iEAD6B,EAE7B;AAAEpT,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAF6B,CAxE1B;AA4EPoT,IAAAA,iCAAiC,EAAE,CAC/B,uGAD+B,EAE/B;AAAErT,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAF+B,CA5E5B;AAgFPqT,IAAAA,0BAA0B,EAAE,CACxB,6EADwB,EAExB;AAAEtT,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,eAAD;AAAZ;AAAb,KAFwB;AAhFrB,GA/2BG;AAo8BdsT,EAAAA,KAAK,EAAE;AACHC,IAAAA,gBAAgB,EAAE,CAAC,oDAAD,CADf;AAEHC,IAAAA,wBAAwB,EAAE,CACtB,2EADsB,EAEtB,EAFsB,EAGtB;AAAEC,MAAAA,SAAS,EAAE;AAAb,KAHsB,CAFvB;AAOHpE,IAAAA,eAAe,EAAE,CAAC,oDAAD,CAPd;AAQHqE,IAAAA,sBAAsB,EAAE,CACpB,yFADoB,EAEpB,EAFoB,EAGpB;AAAED,MAAAA,SAAS,EAAE;AAAb,KAHoB,CARrB;AAaHE,IAAAA,yBAAyB,EAAE,CACvB,4EADuB,EAEvB,EAFuB,EAGvB;AAAEF,MAAAA,SAAS,EAAE;AAAb,KAHuB,CAbxB;AAkBHG,IAAAA,yBAAyB,EAAE,CACvB,4EADuB,EAEvB,EAFuB,EAGvB;AAAEH,MAAAA,SAAS,EAAE;AAAb,KAHuB,CAlBxB;AAuBHI,IAAAA,iBAAiB,EAAE,CAAC,oDAAD,CAvBhB;AAwBHC,IAAAA,wBAAwB,EAAE,CACtB,gDADsB,EAEtB;AAAE/T,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,QAAD;AAAZ;AAAb,KAFsB,CAxBvB;AA4BH+T,IAAAA,cAAc,EAAE,CAAC,mDAAD,CA5Bb;AA6BHC,IAAAA,0BAA0B,EAAE,CACxB,8CADwB,CA7BzB;AAgCHC,IAAAA,mBAAmB,EAAE,CACjB,0DADiB,CAhClB;AAmCHC,IAAAA,+BAA+B,EAAE,CAC7B,6EAD6B,EAE7B;AAAEnU,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAF6B,CAnC9B;AAuCHmU,IAAAA,kBAAkB,EAAE,CAAC,2CAAD,CAvCjB;AAwCHC,IAAAA,eAAe,EAAE,CAAC,iCAAD,CAxCd;AAyCHC,IAAAA,gBAAgB,EAAE,CAAC,wCAAD,CAzCf;AA0CHC,IAAAA,sBAAsB,EAAE,CACpB,iEADoB,CA1CrB;AA6CHC,IAAAA,mBAAmB,EAAE,CAAC,uCAAD,CA7ClB;AA8CH/E,IAAAA,0BAA0B,EAAE,CAAC,kBAAD,CA9CzB;AA+CHgF,IAAAA,UAAU,EAAE,CAAC,kCAAD,CA/CT;AAgDHC,IAAAA,WAAW,EAAE,CAAC,wBAAD,CAhDV;AAiDHC,IAAAA,yBAAyB,EAAE,CACvB,2DADuB,CAjDxB;AAoDHC,IAAAA,0BAA0B,EAAE,CAAC,2CAAD,CApDzB;AAqDHC,IAAAA,eAAe,EAAE,CACb,kCADa,EAEb;AAAE7U,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,YAAD;AAAZ;AAAb,KAFa,CArDd;AAyDH6U,IAAAA,aAAa,EAAE,CAAC,qCAAD,CAzDZ;AA0DHC,IAAAA,mBAAmB,EAAE,CACjB,uDADiB,EAEjB;AAAE/U,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,UAAD;AAAZ;AAAb,KAFiB,CA1DlB;AA8DHqM,IAAAA,aAAa,EAAE,CAAC,kCAAD,CA9DZ;AA+DH0I,IAAAA,iBAAiB,EAAE,CAAC,qDAAD,CA/DhB;AAgEH7P,IAAAA,MAAM,EAAE,CAAC,8BAAD,CAhEL;AAiEH8P,IAAAA,wBAAwB,EAAE,CACtB,wEADsB,CAjEvB;AAoEHC,IAAAA,2BAA2B,EAAE,CACzB,0EADyB,CApE1B;AAuEHC,IAAAA,mBAAmB,EAAE,CACjB,8DADiB,CAvElB;AA0EHC,IAAAA,sBAAsB,EAAE,CACpB,2DADoB,CA1ErB;AA6EHC,IAAAA,mBAAmB,EAAE,CAAC,oDAAD,CA7ElB;AA8EHC,IAAAA,+BAA+B,EAAE,CAC7B,+EAD6B,EAE7B;AAAEtV,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAF6B,CA9E9B;AAkFHsV,IAAAA,eAAe,EAAE,CAAC,4CAAD,CAlFd;AAmFHC,IAAAA,gBAAgB,EAAE,CACd,0DADc,CAnFf;AAsFHC,IAAAA,UAAU,EAAE,CAAC,8CAAD,CAtFT;AAuFHC,IAAAA,gBAAgB,EAAE,CACd,0DADc,CAvFf;AA0FHC,IAAAA,eAAe,EAAE,CACb,oCADa,EAEb;AAAE3V,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,YAAD;AAAZ;AAAb,KAFa,CA1Fd;AA8FH2V,IAAAA,iCAAiC,EAAE,CAC/B,yFAD+B,CA9FhC;AAiGHC,IAAAA,aAAa,EAAE,CAAC,oDAAD,CAjGZ;AAkGHC,IAAAA,kBAAkB,EAAE,CAChB,yDADgB,CAlGjB;AAqGHvJ,IAAAA,aAAa,EAAE,CAAC,8CAAD,CArGZ;AAsGHwJ,IAAAA,6BAA6B,EAAE,CAC3B,uDAD2B,EAE3B;AAAE/V,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,QAAD;AAAZ;AAAb,KAF2B,CAtG5B;AA0GH+V,IAAAA,0BAA0B,EAAE,CACxB,mDADwB,EAExB;AAAEhW,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,QAAD;AAAZ;AAAb,KAFwB,CA1GzB;AA8GHgW,IAAAA,eAAe,EAAE,CACb,yCADa,EAEb,EAFa,EAGb;AAAEva,MAAAA,OAAO,EAAE,CAAC,OAAD,EAAU,wBAAV;AAAX,KAHa,CA9Gd;AAmHHwa,IAAAA,sBAAsB,EAAE,CAAC,yCAAD,CAnHrB;AAoHHC,IAAAA,sBAAsB,EAAE,CAAC,yCAAD,CApHrB;AAqHHC,IAAAA,4BAA4B,EAAE,CAC1B,oDAD0B,EAE1B;AAAEpW,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,QAAD;AAAZ;AAAb,KAF0B,CArH3B;AAyHHoW,IAAAA,yBAAyB,EAAE,CACvB,gDADuB,EAEvB;AAAErW,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,QAAD;AAAZ;AAAb,KAFuB,CAzHxB;AA6HH2C,IAAAA,GAAG,EAAE,CAAC,2BAAD,CA7HF;AA8HH0T,IAAAA,qBAAqB,EAAE,CACnB,qEADmB,CA9HpB;AAiIHC,IAAAA,wBAAwB,EAAE,CACtB,uEADsB,CAjIvB;AAoIHC,IAAAA,kBAAkB,EAAE,CAAC,wCAAD,CApIjB;AAqIHC,IAAAA,yBAAyB,EAAE,CACvB,wFADuB,CArIxB;AAwIHC,IAAAA,YAAY,EAAE,CACV,kCADU,EAEV;AAAE1W,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAFU,CAxIX;AA4IH0W,IAAAA,kCAAkC,EAAE,CAChC,0EADgC,CA5IjC;AA+IHC,IAAAA,SAAS,EAAE,CAAC,6CAAD,CA/IR;AAgJHC,IAAAA,mBAAmB,EAAE,CACjB,wDADiB,CAhJlB;AAmJHC,IAAAA,SAAS,EAAE,CAAC,0CAAD,CAnJR;AAoJHC,IAAAA,qBAAqB,EAAE,CAAC,gDAAD,CApJpB;AAqJHC,IAAAA,8BAA8B,EAAE,CAC5B,+DAD4B,CArJ7B;AAwJHC,IAAAA,uBAAuB,EAAE,CAAC,gDAAD,CAxJtB;AAyJHvQ,IAAAA,SAAS,EAAE,CAAC,yCAAD,CAzJR;AA0JHwQ,IAAAA,sBAAsB,EAAE,CAAC,iDAAD,CA1JrB;AA2JHC,IAAAA,gBAAgB,EAAE,CAAC,iDAAD,CA3Jf;AA4JHC,IAAAA,4BAA4B,EAAE,CAC1B,4EAD0B,EAE1B;AAAEpX,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAF0B,CA5J3B;AAgKHoX,IAAAA,0BAA0B,EAAE,CAAC,6CAAD,CAhKzB;AAiKHC,IAAAA,UAAU,EAAE,CAAC,2CAAD,CAjKT;AAkKHC,IAAAA,oBAAoB,EAAE,CAAC,8CAAD,CAlKnB;AAmKHC,IAAAA,YAAY,EAAE,CAAC,yCAAD,CAnKX;AAoKHC,IAAAA,aAAa,EAAE,CAAC,uDAAD,CApKZ;AAqKHC,IAAAA,mBAAmB,EAAE,CACjB,4EADiB,CArKlB;AAwKHC,IAAAA,cAAc,EAAE,CACZ,2DADY,CAxKb;AA2KHC,IAAAA,mBAAmB,EAAE,CAAC,+CAAD,CA3KlB;AA4KHC,IAAAA,gBAAgB,EAAE,CAAC,2CAAD,CA5Kf;AA6KHC,IAAAA,QAAQ,EAAE,CAAC,iCAAD,CA7KP;AA8KHC,IAAAA,aAAa,EAAE,CAAC,mDAAD,CA9KZ;AA+KHC,IAAAA,mBAAmB,EAAE,CAAC,wCAAD,CA/KlB;AAgLHC,IAAAA,qBAAqB,EAAE,CAAC,+CAAD,CAhLpB;AAiLHC,IAAAA,8BAA8B,EAAE,CAC5B,sFAD4B,CAjL7B;AAoLHC,IAAAA,iBAAiB,EAAE,CAAC,4CAAD,CApLhB;AAqLHC,IAAAA,SAAS,EAAE,CAAC,kCAAD,CArLR;AAsLHC,IAAAA,oBAAoB,EAAE,CAAC,wCAAD,CAtLnB;AAuLHC,IAAAA,UAAU,EAAE,CAAC,iDAAD,CAvLT;AAwLHC,IAAAA,eAAe,EAAE,CAAC,sDAAD,CAxLd;AAyLHC,IAAAA,eAAe,EAAE,CAAC,+CAAD,CAzLd;AA0LHC,IAAAA,yBAAyB,EAAE,CACvB,+EADuB,CA1LxB;AA6LHC,IAAAA,mCAAmC,EAAE,CACjC,2EADiC,CA7LlC;AAgMHC,IAAAA,WAAW,EAAE,CAAC,iDAAD,CAhMV;AAiMHC,IAAAA,eAAe,EAAE,CAAC,qDAAD,CAjMd;AAkMHC,IAAAA,mCAAmC,EAAE,CACjC,2EADiC,CAlMlC;AAqMHC,IAAAA,QAAQ,EAAE,CAAC,yCAAD,CArMP;AAsMHpM,IAAAA,UAAU,EAAE,CAAC,2CAAD,CAtMT;AAuMHqM,IAAAA,uBAAuB,EAAE,CACrB,kDADqB,CAvMtB;AA0MHC,IAAAA,YAAY,EAAE,CAAC,oCAAD,CA1MX;AA2MHC,IAAAA,yBAAyB,EAAE,CACvB,oEADuB,EAEvB;AAAEjZ,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAFuB,CA3MxB;AA+MHiQ,IAAAA,iBAAiB,EAAE,CAAC,yCAAD,CA/MhB;AAgNHgJ,IAAAA,qBAAqB,EAAE,CACnB,yDADmB,CAhNpB;AAmNHC,IAAAA,yBAAyB,EAAE,CAAC,oCAAD,CAnNxB;AAoNHC,IAAAA,wBAAwB,EAAE,CACtB,kDADsB,CApNvB;AAuNH1T,IAAAA,WAAW,EAAE,CAAC,mCAAD,CAvNV;AAwNH2T,IAAAA,gBAAgB,EAAE,CAAC,wCAAD,CAxNf;AAyNHC,IAAAA,cAAc,EAAE,CAAC,gCAAD,CAzNb;AA0NHC,IAAAA,sBAAsB,EAAE,CACpB,gEADoB,CA1NrB;AA6NHC,IAAAA,eAAe,EAAE,CAAC,uCAAD,CA7Nd;AA8NHxQ,IAAAA,wBAAwB,EAAE,CAAC,iBAAD,CA9NvB;AA+NHC,IAAAA,UAAU,EAAE,CAAC,uBAAD,CA/NT;AAgOHtD,IAAAA,WAAW,EAAE,CAAC,6BAAD,CAhOV;AAiOHC,IAAAA,SAAS,EAAE,CAAC,iCAAD,CAjOR;AAkOH6T,IAAAA,eAAe,EAAE,CAAC,uCAAD,CAlOd;AAmOHC,IAAAA,mCAAmC,EAAE,CAAC,kCAAD,CAnOlC;AAoOHC,IAAAA,aAAa,EAAE,CAAC,qCAAD,CApOZ;AAqOHC,IAAAA,eAAe,EAAE,CAAC,wCAAD,CArOd;AAsOH/T,IAAAA,UAAU,EAAE,CAAC,mBAAD,CAtOT;AAuOHgU,IAAAA,oCAAoC,EAAE,CAClC,sDADkC,EAElC;AAAE7Z,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAFkC,CAvOnC;AA2OH6Z,IAAAA,iBAAiB,EAAE,CACf,wDADe,CA3OhB;AA8OHC,IAAAA,YAAY,EAAE,CAAC,oCAAD,CA9OX;AA+OHC,IAAAA,QAAQ,EAAE,CAAC,gCAAD,CA/OP;AAgPHC,IAAAA,SAAS,EAAE,CAAC,iCAAD,CAhPR;AAiPH5M,IAAAA,YAAY,EAAE,CAAC,iCAAD,CAjPX;AAkPHoE,IAAAA,KAAK,EAAE,CAAC,mCAAD,CAlPJ;AAmPHnE,IAAAA,WAAW,EAAE,CAAC,kDAAD,CAnPV;AAoPH4M,IAAAA,2BAA2B,EAAE,CACzB,6EADyB,EAEzB,EAFyB,EAGzB;AAAExG,MAAAA,SAAS,EAAE;AAAb,KAHyB,CApP1B;AAyPHpD,IAAAA,kBAAkB,EAAE,CAChB,uDADgB,CAzPjB;AA4PH6J,IAAAA,yBAAyB,EAAE,CACvB,2FADuB,EAEvB,EAFuB,EAGvB;AAAEzG,MAAAA,SAAS,EAAE;AAAb,KAHuB,CA5PxB;AAiQH0G,IAAAA,2BAA2B,EAAE,CACzB,kFADyB,CAjQ1B;AAoQHC,IAAAA,4BAA4B,EAAE,CAC1B,8EAD0B,EAE1B,EAF0B,EAG1B;AAAE3G,MAAAA,SAAS,EAAE;AAAb,KAH0B,CApQ3B;AAyQH4G,IAAAA,4BAA4B,EAAE,CAC1B,8EAD0B,EAE1B,EAF0B,EAG1B;AAAE5G,MAAAA,SAAS,EAAE;AAAb,KAH0B,CAzQ3B;AA8QH6G,IAAAA,YAAY,EAAE,CAAC,qDAAD,CA9QX;AA+QHC,IAAAA,gBAAgB,EAAE,CACd,kCADc,EAEd;AAAExa,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAFc,CA/Qf;AAmRHwa,IAAAA,iBAAiB,EAAE,CAAC,yCAAD,CAnRhB;AAoRHC,IAAAA,wBAAwB,EAAE,CACtB,wEADsB,CApRvB;AAuRHC,IAAAA,wBAAwB,EAAE,CACtB,0EADsB,EAEtB,EAFsB,EAGtB;AAAEjH,MAAAA,SAAS,EAAE;AAAb,KAHsB,CAvRvB;AA4RHkH,IAAAA,sBAAsB,EAAE,CACpB,wFADoB,EAEpB,EAFoB,EAGpB;AAAElH,MAAAA,SAAS,EAAE;AAAb,KAHoB,CA5RrB;AAiSHmH,IAAAA,yBAAyB,EAAE,CACvB,2EADuB,EAEvB,EAFuB,EAGvB;AAAEnH,MAAAA,SAAS,EAAE;AAAb,KAHuB,CAjSxB;AAsSHoH,IAAAA,yBAAyB,EAAE,CACvB,2EADuB,EAEvB,EAFuB,EAGvB;AAAEpH,MAAAA,SAAS,EAAE;AAAb,KAHuB,CAtSxB;AA2SHqH,IAAAA,eAAe,EAAE,CAAC,kDAAD,CA3Sd;AA4SHC,IAAAA,QAAQ,EAAE,CAAC,qCAAD,CA5SP;AA6SH5X,IAAAA,MAAM,EAAE,CAAC,6BAAD,CA7SL;AA8SH6X,IAAAA,sBAAsB,EAAE,CACpB,wDADoB,CA9SrB;AAiTHC,IAAAA,mBAAmB,EAAE,CAAC,mDAAD,CAjTlB;AAkTHC,IAAAA,+BAA+B,EAAE,CAAC,iCAAD,CAlT9B;AAmTHC,IAAAA,gBAAgB,EAAE,CACd,yDADc,CAnTf;AAsTHC,IAAAA,iCAAiC,EAAE,CAC/B,wFAD+B,CAtThC;AAyTHC,IAAAA,aAAa,EAAE,CAAC,mDAAD,CAzTZ;AA0THC,IAAAA,kBAAkB,EAAE,CAChB,wDADgB,CA1TjB;AA6THC,IAAAA,0BAA0B,EAAE,CACxB,iFADwB,EAExB,EAFwB,EAGxB;AAAE9f,MAAAA,OAAO,EAAE,CAAC,OAAD,EAAU,6BAAV;AAAX,KAHwB,CA7TzB;AAkUH+f,IAAAA,2BAA2B,EAAE,CACzB,iFADyB,CAlU1B;AAqUH1N,IAAAA,aAAa,EAAE,CAAC,6CAAD,CArUZ;AAsUH2N,IAAAA,0BAA0B,EAAE,CACxB,oDADwB,CAtUzB;AAyUHC,IAAAA,kBAAkB,EAAE,CAChB,sEADgB,EAEhB;AAAEC,MAAAA,OAAO,EAAE;AAAX,KAFgB;AAzUjB,GAp8BO;AAkxCdC,EAAAA,MAAM,EAAE;AACJC,IAAAA,IAAI,EAAE,CAAC,kBAAD,CADF;AAEJC,IAAAA,OAAO,EAAE,CAAC,qBAAD,EAAwB;AAAE/b,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAAxB,CAFL;AAGJ+b,IAAAA,qBAAqB,EAAE,CAAC,oBAAD,CAHnB;AAIJC,IAAAA,MAAM,EAAE,CAAC,oBAAD,CAJJ;AAKJ1I,IAAAA,KAAK,EAAE,CAAC,0BAAD,CALH;AAMJ2I,IAAAA,MAAM,EAAE,CAAC,oBAAD,EAAuB;AAAElc,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,OAAD;AAAZ;AAAb,KAAvB,CANJ;AAOJkc,IAAAA,KAAK,EAAE,CAAC,mBAAD;AAPH,GAlxCM;AA2xCdC,EAAAA,cAAc,EAAE;AACZ7Y,IAAAA,QAAQ,EAAE,CACN,iEADM,CADE;AAIZM,IAAAA,iBAAiB,EAAE,CAAC,kDAAD,CAJP;AAKZG,IAAAA,WAAW,EAAE,CACT,mEADS;AALD,GA3xCF;AAoyCdqY,EAAAA,KAAK,EAAE;AACHC,IAAAA,iCAAiC,EAAE,CAC/B,0DAD+B,CADhC;AAIHC,IAAAA,kCAAkC,EAAE,CAChC,yDADgC,EAEhC;AAAEvc,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFgC,CAJjC;AAQHuc,IAAAA,+BAA+B,EAAE,CAC7B,wDAD6B,CAR9B;AAWHC,IAAAA,+BAA+B,EAAE,CAC7B,yDAD6B,EAE7B;AAAEzc,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAF6B,CAX9B;AAeHyc,IAAAA,4BAA4B,EAAE,CAC1B,wDAD0B,CAf3B;AAkBHha,IAAAA,MAAM,EAAE,CAAC,wBAAD,CAlBL;AAmBHia,IAAAA,4BAA4B,EAAE,CAC1B,6EAD0B,CAnB3B;AAsBHC,IAAAA,qBAAqB,EAAE,CAAC,gDAAD,CAtBpB;AAuBHC,IAAAA,4BAA4B,EAAE,CAC1B,gGAD0B,CAvB3B;AA0BHC,IAAAA,qBAAqB,EAAE,CACnB,sEADmB,CA1BpB;AA6BHC,IAAAA,WAAW,EAAE,CAAC,sCAAD,CA7BV;AA8BHC,IAAAA,SAAS,EAAE,CAAC,mCAAD,CA9BR;AA+BHC,IAAAA,yBAAyB,EAAE,CACvB,6FADuB,CA/BxB;AAkCHC,IAAAA,kBAAkB,EAAE,CAChB,mEADgB,CAlCjB;AAqCHC,IAAAA,yBAAyB,EAAE,CACvB,0DADuB,CArCxB;AAwCH3X,IAAAA,IAAI,EAAE,CAAC,uBAAD,CAxCH;AAyCH4X,IAAAA,cAAc,EAAE,CAAC,yCAAD,CAzCb;AA0CHC,IAAAA,2BAA2B,EAAE,CACzB,4EADyB,CA1C1B;AA6CHC,IAAAA,oBAAoB,EAAE,CAAC,+CAAD,CA7CnB;AA8CHtU,IAAAA,wBAAwB,EAAE,CAAC,iBAAD,CA9CvB;AA+CHuU,IAAAA,gBAAgB,EAAE,CAAC,2CAAD,CA/Cf;AAgDHC,IAAAA,2BAA2B,EAAE,CACzB,+CADyB,CAhD1B;AAmDHC,IAAAA,iBAAiB,EAAE,CACf,4CADe,EAEf;AAAEzd,MAAAA,SAAS,EAAE;AAAEC,QAAAA,QAAQ,EAAE,CAAC,SAAD;AAAZ;AAAb,KAFe,CAnDhB;AAuDHyd,IAAAA,cAAc,EAAE,CAAC,yCAAD,CAvDb;AAwDHC,IAAAA,4BAA4B,EAAE,CAC1B,6DAD0B,CAxD3B;AA2DHC,IAAAA,kBAAkB,EAAE,CAChB,4DADgB,CA3DjB;AA8DHC,IAAAA,eAAe,EAAE,CACb,2DADa,CA9Dd;AAiEHC,IAAAA,4BAA4B,EAAE,CAC1B,+FAD0B,CAjE3B;AAoEHC,IAAAA,qBAAqB,EAAE,CACnB,qEADmB,CApEpB;AAuEHC,IAAAA,WAAW,EAAE,CAAC,qCAAD;AAvEV,GApyCO;AA62Cd7B,EAAAA,KAAK,EAAE;AACH8B,IAAAA,wBAAwB,EAAE,CAAC,mBAAD,CADvB;AAEHC,IAAAA,KAAK,EAAE,CAAC,6BAAD,CAFJ;AAGHC,IAAAA,YAAY,EAAE,CAAC,6BAAD,CAHX;AAIHC,IAAAA,qBAAqB,EAAE,CAAC,+CAAD,CAJpB;AAKHC,IAAAA,oCAAoC,EAAE,CAAC,gCAAD,CALnC;AAMHC,IAAAA,4BAA4B,EAAE,CAAC,qBAAD,CAN3B;AAOHC,IAAAA,kCAAkC,EAAE,CAAC,iBAAD,CAPjC;AAQHC,IAAAA,2BAA2B,EAAE,CAAC,qBAAD,CAR1B;AASHC,IAAAA,4BAA4B,EAAE,CAAC,oCAAD,CAT3B;AAUHC,IAAAA,kCAAkC,EAAE,CAAC,4BAAD,CAVjC;AAWHC,IAAAA,MAAM,EAAE,CAAC,gCAAD,CAXL;AAYHne,IAAAA,gBAAgB,EAAE,CAAC,WAAD,CAZf;AAaHoe,IAAAA,aAAa,EAAE,CAAC,uBAAD,CAbZ;AAcHC,IAAAA,iBAAiB,EAAE,CAAC,iCAAD,CAdhB;AAeHC,IAAAA,yBAAyB,EAAE,CAAC,iCAAD,CAfxB;AAgBHC,IAAAA,+BAA+B,EAAE,CAAC,yBAAD,CAhB9B;AAiBHvZ,IAAAA,IAAI,EAAE,CAAC,YAAD,CAjBH;AAkBHwZ,IAAAA,0BAA0B,EAAE,CAAC,kBAAD,CAlBzB;AAmBHC,IAAAA,0BAA0B,EAAE,CAAC,kBAAD,CAnBzB;AAoBHC,IAAAA,2BAA2B,EAAE,CAAC,qBAAD,CApB1B;AAqBHC,IAAAA,iCAAiC,EAAE,CAAC,qBAAD,CArBhC;AAsBHC,IAAAA,oBAAoB,EAAE,CAAC,iCAAD,CAtBnB;AAuBHC,IAAAA,oBAAoB,EAAE,CAAC,iCAAD,CAvBnB;AAwBHC,IAAAA,2BAA2B,EAAE,CAAC,oBAAD,CAxB1B;AAyBHC,IAAAA,kBAAkB,EAAE,CAAC,gCAAD,CAzBjB;AA0BHC,IAAAA,gCAAgC,EAAE,CAAC,yBAAD,CA1B/B;AA2BHC,IAAAA,qBAAqB,EAAE,CAAC,4BAAD,CA3BpB;AA4BHC,IAAAA,iCAAiC,EAAE,CAAC,gBAAD,CA5BhC;AA6BHC,IAAAA,yCAAyC,EAAE,CAAC,8BAAD,CA7BxC;AA8BHC,IAAAA,OAAO,EAAE,CAAC,gCAAD,CA9BN;AA+BHC,IAAAA,QAAQ,EAAE,CAAC,mCAAD,CA/BP;AAgCHC,IAAAA,mBAAmB,EAAE,CAAC,aAAD;AAhClB;AA72CO,CAAlB;;ACAO,MAAMC,OAAO,GAAG,mBAAhB;;ACAA,SAASC,kBAAT,CAA4BC,OAA5B,EAAqCC,YAArC,EAAmD;AACtD,QAAMC,UAAU,GAAG,EAAnB;;AACA,OAAK,MAAM,CAACC,KAAD,EAAQC,SAAR,CAAX,IAAiCC,MAAM,CAACC,OAAP,CAAeL,YAAf,CAAjC,EAA+D;AAC3D,SAAK,MAAM,CAACM,UAAD,EAAaC,QAAb,CAAX,IAAqCH,MAAM,CAACC,OAAP,CAAeF,SAAf,CAArC,EAAgE;AAC5D,YAAM,CAACK,KAAD,EAAQC,QAAR,EAAkBC,WAAlB,IAAiCH,QAAvC;AACA,YAAM,CAACI,MAAD,EAASC,GAAT,IAAgBJ,KAAK,CAACK,KAAN,CAAY,GAAZ,CAAtB;AACA,YAAMC,gBAAgB,GAAGV,MAAM,CAACW,MAAP,CAAc;AAAEJ,QAAAA,MAAF;AAAUC,QAAAA;AAAV,OAAd,EAA+BH,QAA/B,CAAzB;;AACA,UAAI,CAACR,UAAU,CAACC,KAAD,CAAf,EAAwB;AACpBD,QAAAA,UAAU,CAACC,KAAD,CAAV,GAAoB,EAApB;AACH;;AACD,YAAMc,YAAY,GAAGf,UAAU,CAACC,KAAD,CAA/B;;AACA,UAAIQ,WAAJ,EAAiB;AACbM,QAAAA,YAAY,CAACV,UAAD,CAAZ,GAA2BW,QAAQ,CAAClB,OAAD,EAAUG,KAAV,EAAiBI,UAAjB,EAA6BQ,gBAA7B,EAA+CJ,WAA/C,CAAnC;AACA;AACH;;AACDM,MAAAA,YAAY,CAACV,UAAD,CAAZ,GAA2BP,OAAO,CAACmB,OAAR,CAAgBT,QAAhB,CAAyBK,gBAAzB,CAA3B;AACH;AACJ;;AACD,SAAOb,UAAP;AACH;;AACD,SAASgB,QAAT,CAAkBlB,OAAlB,EAA2BG,KAA3B,EAAkCI,UAAlC,EAA8CG,QAA9C,EAAwDC,WAAxD,EAAqE;AACjE,QAAMS,mBAAmB,GAAGpB,OAAO,CAACmB,OAAR,CAAgBT,QAAhB,CAAyBA,QAAzB,CAA5B;AACA;;AACA,WAASW,eAAT,CAAyB,GAAGC,IAA5B,EAAkC;AAC9B;AACA,QAAIC,OAAO,GAAGH,mBAAmB,CAACZ,QAApB,CAA6BhP,KAA7B,CAAmC,GAAG8P,IAAtC,CAAd,CAF8B;;AAI9B,QAAIX,WAAW,CAAClN,SAAhB,EAA2B;AACvB8N,MAAAA,OAAO,GAAGlB,MAAM,CAACW,MAAP,CAAc,EAAd,EAAkBO,OAAlB,EAA2B;AACjCC,QAAAA,IAAI,EAAED,OAAO,CAACZ,WAAW,CAAClN,SAAb,CADoB;AAEjC,SAACkN,WAAW,CAAClN,SAAb,GAAyBgO;AAFQ,OAA3B,CAAV;AAIA,aAAOL,mBAAmB,CAACG,OAAD,CAA1B;AACH;;AACD,QAAIZ,WAAW,CAACllB,OAAhB,EAAyB;AACrB,YAAM,CAACimB,QAAD,EAAWC,aAAX,IAA4BhB,WAAW,CAACllB,OAA9C;AACAukB,MAAAA,OAAO,CAAC4B,GAAR,CAAYC,IAAZ,CAAkB,WAAU1B,KAAM,IAAGI,UAAW,kCAAiCmB,QAAS,IAAGC,aAAc,IAA3G;AACH;;AACD,QAAIhB,WAAW,CAAC5N,UAAhB,EAA4B;AACxBiN,MAAAA,OAAO,CAAC4B,GAAR,CAAYC,IAAZ,CAAiBlB,WAAW,CAAC5N,UAA7B;AACH;;AACD,QAAI4N,WAAW,CAACpd,iBAAhB,EAAmC;AAC/B;AACA,YAAMge,OAAO,GAAGH,mBAAmB,CAACZ,QAApB,CAA6BhP,KAA7B,CAAmC,GAAG8P,IAAtC,CAAhB;;AACA,WAAK,MAAM,CAACQ,IAAD,EAAOC,KAAP,CAAX,IAA4B1B,MAAM,CAACC,OAAP,CAAeK,WAAW,CAACpd,iBAA3B,CAA5B,EAA2E;AACvE,YAAIue,IAAI,IAAIP,OAAZ,EAAqB;AACjBvB,UAAAA,OAAO,CAAC4B,GAAR,CAAYC,IAAZ,CAAkB,IAAGC,IAAK,0CAAyC3B,KAAM,IAAGI,UAAW,aAAYwB,KAAM,WAAzG;;AACA,cAAI,EAAEA,KAAK,IAAIR,OAAX,CAAJ,EAAyB;AACrBA,YAAAA,OAAO,CAACQ,KAAD,CAAP,GAAiBR,OAAO,CAACO,IAAD,CAAxB;AACH;;AACD,iBAAOP,OAAO,CAACO,IAAD,CAAd;AACH;AACJ;;AACD,aAAOV,mBAAmB,CAACG,OAAD,CAA1B;AACH,KA/B6B;;;AAiC9B,WAAOH,mBAAmB,CAAC,GAAGE,IAAJ,CAA1B;AACH;;AACD,SAAOjB,MAAM,CAACW,MAAP,CAAcK,eAAd,EAA+BD,mBAA/B,CAAP;AACH;;ACxDM,SAASY,mBAAT,CAA6BhC,OAA7B,EAAsC;AACzC,QAAMiC,GAAG,GAAGlC,kBAAkB,CAACC,OAAD,EAAUkC,SAAV,CAA9B;AACA,SAAO;AACHC,IAAAA,IAAI,EAAEF;AADH,GAAP;AAGH;AACDD,mBAAmB,CAAClC,OAApB,GAA8BA,OAA9B;AACA,AAAO,SAASsC,yBAAT,CAAmCpC,OAAnC,EAA4C;AAC/C,QAAMiC,GAAG,GAAGlC,kBAAkB,CAACC,OAAD,EAAUkC,SAAV,CAA9B;AACA,2CACOD,GADP;AAEIE,IAAAA,IAAI,EAAEF;AAFV;AAIH;AACDG,yBAAyB,CAACtC,OAA1B,GAAoCA,OAApC;;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/endpoints-to-methods.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/endpoints-to-methods.js new file mode 100644 index 00000000..32c2f39a --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/endpoints-to-methods.js @@ -0,0 +1,60 @@ +export function endpointsToMethods(octokit, endpointsMap) { + const newMethods = {}; + for (const [scope, endpoints] of Object.entries(endpointsMap)) { + for (const [methodName, endpoint] of Object.entries(endpoints)) { + const [route, defaults, decorations] = endpoint; + const [method, url] = route.split(/ /); + const endpointDefaults = Object.assign({ method, url }, defaults); + if (!newMethods[scope]) { + newMethods[scope] = {}; + } + const scopeMethods = newMethods[scope]; + if (decorations) { + scopeMethods[methodName] = decorate(octokit, scope, methodName, endpointDefaults, decorations); + continue; + } + scopeMethods[methodName] = octokit.request.defaults(endpointDefaults); + } + } + return newMethods; +} +function decorate(octokit, scope, methodName, defaults, decorations) { + const requestWithDefaults = octokit.request.defaults(defaults); + /* istanbul ignore next */ + function withDecorations(...args) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + let options = requestWithDefaults.endpoint.merge(...args); + // There are currently no other decorations than `.mapToData` + if (decorations.mapToData) { + options = Object.assign({}, options, { + data: options[decorations.mapToData], + [decorations.mapToData]: undefined, + }); + return requestWithDefaults(options); + } + if (decorations.renamed) { + const [newScope, newMethodName] = decorations.renamed; + octokit.log.warn(`octokit.${scope}.${methodName}() has been renamed to octokit.${newScope}.${newMethodName}()`); + } + if (decorations.deprecated) { + octokit.log.warn(decorations.deprecated); + } + if (decorations.renamedParameters) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + const options = requestWithDefaults.endpoint.merge(...args); + for (const [name, alias] of Object.entries(decorations.renamedParameters)) { + if (name in options) { + octokit.log.warn(`"${name}" parameter is deprecated for "octokit.${scope}.${methodName}()". Use "${alias}" instead`); + if (!(alias in options)) { + options[alias] = options[name]; + } + delete options[name]; + } + } + return requestWithDefaults(options); + } + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + return requestWithDefaults(...args); + } + return Object.assign(withDecorations, requestWithDefaults); +} diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/endpoints.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/endpoints.js new file mode 100644 index 00000000..5f781520 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/endpoints.js @@ -0,0 +1,1425 @@ +const Endpoints = { + actions: { + addSelectedRepoToOrgSecret: [ + "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + ], + approveWorkflowRun: [ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve", + ], + cancelWorkflowRun: [ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel", + ], + createOrUpdateEnvironmentSecret: [ + "PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + ], + createOrUpdateOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}"], + createOrUpdateRepoSecret: [ + "PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}", + ], + createRegistrationTokenForOrg: [ + "POST /orgs/{org}/actions/runners/registration-token", + ], + createRegistrationTokenForRepo: [ + "POST /repos/{owner}/{repo}/actions/runners/registration-token", + ], + createRemoveTokenForOrg: ["POST /orgs/{org}/actions/runners/remove-token"], + createRemoveTokenForRepo: [ + "POST /repos/{owner}/{repo}/actions/runners/remove-token", + ], + createWorkflowDispatch: [ + "POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", + ], + deleteArtifact: [ + "DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}", + ], + deleteEnvironmentSecret: [ + "DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + ], + deleteOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}"], + deleteRepoSecret: [ + "DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}", + ], + deleteSelfHostedRunnerFromOrg: [ + "DELETE /orgs/{org}/actions/runners/{runner_id}", + ], + deleteSelfHostedRunnerFromRepo: [ + "DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}", + ], + deleteWorkflowRun: ["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}"], + deleteWorkflowRunLogs: [ + "DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs", + ], + disableSelectedRepositoryGithubActionsOrganization: [ + "DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}", + ], + disableWorkflow: [ + "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", + ], + downloadArtifact: [ + "GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", + ], + downloadJobLogsForWorkflowRun: [ + "GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs", + ], + downloadWorkflowRunLogs: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs", + ], + enableSelectedRepositoryGithubActionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/repositories/{repository_id}", + ], + enableWorkflow: [ + "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", + ], + getAllowedActionsOrganization: [ + "GET /orgs/{org}/actions/permissions/selected-actions", + ], + getAllowedActionsRepository: [ + "GET /repos/{owner}/{repo}/actions/permissions/selected-actions", + ], + getArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"], + getEnvironmentPublicKey: [ + "GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key", + ], + getEnvironmentSecret: [ + "GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + ], + getGithubActionsPermissionsOrganization: [ + "GET /orgs/{org}/actions/permissions", + ], + getGithubActionsPermissionsRepository: [ + "GET /repos/{owner}/{repo}/actions/permissions", + ], + getJobForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"], + getOrgPublicKey: ["GET /orgs/{org}/actions/secrets/public-key"], + getOrgSecret: ["GET /orgs/{org}/actions/secrets/{secret_name}"], + getPendingDeploymentsForRun: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", + ], + getRepoPermissions: [ + "GET /repos/{owner}/{repo}/actions/permissions", + {}, + { renamed: ["actions", "getGithubActionsPermissionsRepository"] }, + ], + getRepoPublicKey: ["GET /repos/{owner}/{repo}/actions/secrets/public-key"], + getRepoSecret: ["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"], + getReviewsForRun: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals", + ], + getSelfHostedRunnerForOrg: ["GET /orgs/{org}/actions/runners/{runner_id}"], + getSelfHostedRunnerForRepo: [ + "GET /repos/{owner}/{repo}/actions/runners/{runner_id}", + ], + getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], + getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], + getWorkflowRunUsage: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing", + ], + getWorkflowUsage: [ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", + ], + listArtifactsForRepo: ["GET /repos/{owner}/{repo}/actions/artifacts"], + listEnvironmentSecrets: [ + "GET /repositories/{repository_id}/environments/{environment_name}/secrets", + ], + listJobsForWorkflowRun: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", + ], + listOrgSecrets: ["GET /orgs/{org}/actions/secrets"], + listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], + listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], + listRunnerApplicationsForOrg: ["GET /orgs/{org}/actions/runners/downloads"], + listRunnerApplicationsForRepo: [ + "GET /repos/{owner}/{repo}/actions/runners/downloads", + ], + listSelectedReposForOrgSecret: [ + "GET /orgs/{org}/actions/secrets/{secret_name}/repositories", + ], + listSelectedRepositoriesEnabledGithubActionsOrganization: [ + "GET /orgs/{org}/actions/permissions/repositories", + ], + listSelfHostedRunnersForOrg: ["GET /orgs/{org}/actions/runners"], + listSelfHostedRunnersForRepo: ["GET /repos/{owner}/{repo}/actions/runners"], + listWorkflowRunArtifacts: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", + ], + listWorkflowRuns: [ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", + ], + listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"], + reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"], + removeSelectedRepoFromOrgSecret: [ + "DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + ], + reviewPendingDeploymentsForRun: [ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", + ], + setAllowedActionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/selected-actions", + ], + setAllowedActionsRepository: [ + "PUT /repos/{owner}/{repo}/actions/permissions/selected-actions", + ], + setGithubActionsPermissionsOrganization: [ + "PUT /orgs/{org}/actions/permissions", + ], + setGithubActionsPermissionsRepository: [ + "PUT /repos/{owner}/{repo}/actions/permissions", + ], + setSelectedReposForOrgSecret: [ + "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories", + ], + setSelectedRepositoriesEnabledGithubActionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/repositories", + ], + }, + activity: { + checkRepoIsStarredByAuthenticatedUser: ["GET /user/starred/{owner}/{repo}"], + deleteRepoSubscription: ["DELETE /repos/{owner}/{repo}/subscription"], + deleteThreadSubscription: [ + "DELETE /notifications/threads/{thread_id}/subscription", + ], + getFeeds: ["GET /feeds"], + getRepoSubscription: ["GET /repos/{owner}/{repo}/subscription"], + getThread: ["GET /notifications/threads/{thread_id}"], + getThreadSubscriptionForAuthenticatedUser: [ + "GET /notifications/threads/{thread_id}/subscription", + ], + listEventsForAuthenticatedUser: ["GET /users/{username}/events"], + listNotificationsForAuthenticatedUser: ["GET /notifications"], + listOrgEventsForAuthenticatedUser: [ + "GET /users/{username}/events/orgs/{org}", + ], + listPublicEvents: ["GET /events"], + listPublicEventsForRepoNetwork: ["GET /networks/{owner}/{repo}/events"], + listPublicEventsForUser: ["GET /users/{username}/events/public"], + listPublicOrgEvents: ["GET /orgs/{org}/events"], + listReceivedEventsForUser: ["GET /users/{username}/received_events"], + listReceivedPublicEventsForUser: [ + "GET /users/{username}/received_events/public", + ], + listRepoEvents: ["GET /repos/{owner}/{repo}/events"], + listRepoNotificationsForAuthenticatedUser: [ + "GET /repos/{owner}/{repo}/notifications", + ], + listReposStarredByAuthenticatedUser: ["GET /user/starred"], + listReposStarredByUser: ["GET /users/{username}/starred"], + listReposWatchedByUser: ["GET /users/{username}/subscriptions"], + listStargazersForRepo: ["GET /repos/{owner}/{repo}/stargazers"], + listWatchedReposForAuthenticatedUser: ["GET /user/subscriptions"], + listWatchersForRepo: ["GET /repos/{owner}/{repo}/subscribers"], + markNotificationsAsRead: ["PUT /notifications"], + markRepoNotificationsAsRead: ["PUT /repos/{owner}/{repo}/notifications"], + markThreadAsRead: ["PATCH /notifications/threads/{thread_id}"], + setRepoSubscription: ["PUT /repos/{owner}/{repo}/subscription"], + setThreadSubscription: [ + "PUT /notifications/threads/{thread_id}/subscription", + ], + starRepoForAuthenticatedUser: ["PUT /user/starred/{owner}/{repo}"], + unstarRepoForAuthenticatedUser: ["DELETE /user/starred/{owner}/{repo}"], + }, + apps: { + addRepoToInstallation: [ + "PUT /user/installations/{installation_id}/repositories/{repository_id}", + ], + checkToken: ["POST /applications/{client_id}/token"], + createContentAttachment: [ + "POST /content_references/{content_reference_id}/attachments", + { mediaType: { previews: ["corsair"] } }, + ], + createContentAttachmentForRepo: [ + "POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + { mediaType: { previews: ["corsair"] } }, + ], + createFromManifest: ["POST /app-manifests/{code}/conversions"], + createInstallationAccessToken: [ + "POST /app/installations/{installation_id}/access_tokens", + ], + deleteAuthorization: ["DELETE /applications/{client_id}/grant"], + deleteInstallation: ["DELETE /app/installations/{installation_id}"], + deleteToken: ["DELETE /applications/{client_id}/token"], + getAuthenticated: ["GET /app"], + getBySlug: ["GET /apps/{app_slug}"], + getInstallation: ["GET /app/installations/{installation_id}"], + getOrgInstallation: ["GET /orgs/{org}/installation"], + getRepoInstallation: ["GET /repos/{owner}/{repo}/installation"], + getSubscriptionPlanForAccount: [ + "GET /marketplace_listing/accounts/{account_id}", + ], + getSubscriptionPlanForAccountStubbed: [ + "GET /marketplace_listing/stubbed/accounts/{account_id}", + ], + getUserInstallation: ["GET /users/{username}/installation"], + getWebhookConfigForApp: ["GET /app/hook/config"], + listAccountsForPlan: ["GET /marketplace_listing/plans/{plan_id}/accounts"], + listAccountsForPlanStubbed: [ + "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts", + ], + listInstallationReposForAuthenticatedUser: [ + "GET /user/installations/{installation_id}/repositories", + ], + listInstallations: ["GET /app/installations"], + listInstallationsForAuthenticatedUser: ["GET /user/installations"], + listPlans: ["GET /marketplace_listing/plans"], + listPlansStubbed: ["GET /marketplace_listing/stubbed/plans"], + listReposAccessibleToInstallation: ["GET /installation/repositories"], + listSubscriptionsForAuthenticatedUser: ["GET /user/marketplace_purchases"], + listSubscriptionsForAuthenticatedUserStubbed: [ + "GET /user/marketplace_purchases/stubbed", + ], + removeRepoFromInstallation: [ + "DELETE /user/installations/{installation_id}/repositories/{repository_id}", + ], + resetToken: ["PATCH /applications/{client_id}/token"], + revokeInstallationAccessToken: ["DELETE /installation/token"], + scopeToken: ["POST /applications/{client_id}/token/scoped"], + suspendInstallation: ["PUT /app/installations/{installation_id}/suspended"], + unsuspendInstallation: [ + "DELETE /app/installations/{installation_id}/suspended", + ], + updateWebhookConfigForApp: ["PATCH /app/hook/config"], + }, + billing: { + getGithubActionsBillingOrg: ["GET /orgs/{org}/settings/billing/actions"], + getGithubActionsBillingUser: [ + "GET /users/{username}/settings/billing/actions", + ], + getGithubPackagesBillingOrg: ["GET /orgs/{org}/settings/billing/packages"], + getGithubPackagesBillingUser: [ + "GET /users/{username}/settings/billing/packages", + ], + getSharedStorageBillingOrg: [ + "GET /orgs/{org}/settings/billing/shared-storage", + ], + getSharedStorageBillingUser: [ + "GET /users/{username}/settings/billing/shared-storage", + ], + }, + checks: { + create: ["POST /repos/{owner}/{repo}/check-runs"], + createSuite: ["POST /repos/{owner}/{repo}/check-suites"], + get: ["GET /repos/{owner}/{repo}/check-runs/{check_run_id}"], + getSuite: ["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}"], + listAnnotations: [ + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + ], + listForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"], + listForSuite: [ + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + ], + listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"], + rerequestSuite: [ + "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", + ], + setSuitesPreferences: [ + "PATCH /repos/{owner}/{repo}/check-suites/preferences", + ], + update: ["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"], + }, + codeScanning: { + deleteAnalysis: [ + "DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}", + ], + getAlert: [ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + {}, + { renamedParameters: { alert_id: "alert_number" } }, + ], + getAnalysis: [ + "GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", + ], + getSarif: ["GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"], + listAlertInstances: [ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", + ], + listAlertsForRepo: ["GET /repos/{owner}/{repo}/code-scanning/alerts"], + listAlertsInstances: [ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", + {}, + { renamed: ["codeScanning", "listAlertInstances"] }, + ], + listRecentAnalyses: ["GET /repos/{owner}/{repo}/code-scanning/analyses"], + updateAlert: [ + "PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + ], + uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"], + }, + codesOfConduct: { + getAllCodesOfConduct: [ + "GET /codes_of_conduct", + { mediaType: { previews: ["scarlet-witch"] } }, + ], + getConductCode: [ + "GET /codes_of_conduct/{key}", + { mediaType: { previews: ["scarlet-witch"] } }, + ], + getForRepo: [ + "GET /repos/{owner}/{repo}/community/code_of_conduct", + { mediaType: { previews: ["scarlet-witch"] } }, + ], + }, + emojis: { get: ["GET /emojis"] }, + enterpriseAdmin: { + disableSelectedOrganizationGithubActionsEnterprise: [ + "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + ], + enableSelectedOrganizationGithubActionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + ], + getAllowedActionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions/selected-actions", + ], + getGithubActionsPermissionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions", + ], + listSelectedOrganizationsEnabledGithubActionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions/organizations", + ], + setAllowedActionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/selected-actions", + ], + setGithubActionsPermissionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions", + ], + setSelectedOrganizationsEnabledGithubActionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/organizations", + ], + }, + gists: { + checkIsStarred: ["GET /gists/{gist_id}/star"], + create: ["POST /gists"], + createComment: ["POST /gists/{gist_id}/comments"], + delete: ["DELETE /gists/{gist_id}"], + deleteComment: ["DELETE /gists/{gist_id}/comments/{comment_id}"], + fork: ["POST /gists/{gist_id}/forks"], + get: ["GET /gists/{gist_id}"], + getComment: ["GET /gists/{gist_id}/comments/{comment_id}"], + getRevision: ["GET /gists/{gist_id}/{sha}"], + list: ["GET /gists"], + listComments: ["GET /gists/{gist_id}/comments"], + listCommits: ["GET /gists/{gist_id}/commits"], + listForUser: ["GET /users/{username}/gists"], + listForks: ["GET /gists/{gist_id}/forks"], + listPublic: ["GET /gists/public"], + listStarred: ["GET /gists/starred"], + star: ["PUT /gists/{gist_id}/star"], + unstar: ["DELETE /gists/{gist_id}/star"], + update: ["PATCH /gists/{gist_id}"], + updateComment: ["PATCH /gists/{gist_id}/comments/{comment_id}"], + }, + git: { + createBlob: ["POST /repos/{owner}/{repo}/git/blobs"], + createCommit: ["POST /repos/{owner}/{repo}/git/commits"], + createRef: ["POST /repos/{owner}/{repo}/git/refs"], + createTag: ["POST /repos/{owner}/{repo}/git/tags"], + createTree: ["POST /repos/{owner}/{repo}/git/trees"], + deleteRef: ["DELETE /repos/{owner}/{repo}/git/refs/{ref}"], + getBlob: ["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"], + getCommit: ["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"], + getRef: ["GET /repos/{owner}/{repo}/git/ref/{ref}"], + getTag: ["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"], + getTree: ["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"], + listMatchingRefs: ["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"], + updateRef: ["PATCH /repos/{owner}/{repo}/git/refs/{ref}"], + }, + gitignore: { + getAllTemplates: ["GET /gitignore/templates"], + getTemplate: ["GET /gitignore/templates/{name}"], + }, + interactions: { + getRestrictionsForAuthenticatedUser: ["GET /user/interaction-limits"], + getRestrictionsForOrg: ["GET /orgs/{org}/interaction-limits"], + getRestrictionsForRepo: ["GET /repos/{owner}/{repo}/interaction-limits"], + getRestrictionsForYourPublicRepos: [ + "GET /user/interaction-limits", + {}, + { renamed: ["interactions", "getRestrictionsForAuthenticatedUser"] }, + ], + removeRestrictionsForAuthenticatedUser: ["DELETE /user/interaction-limits"], + removeRestrictionsForOrg: ["DELETE /orgs/{org}/interaction-limits"], + removeRestrictionsForRepo: [ + "DELETE /repos/{owner}/{repo}/interaction-limits", + ], + removeRestrictionsForYourPublicRepos: [ + "DELETE /user/interaction-limits", + {}, + { renamed: ["interactions", "removeRestrictionsForAuthenticatedUser"] }, + ], + setRestrictionsForAuthenticatedUser: ["PUT /user/interaction-limits"], + setRestrictionsForOrg: ["PUT /orgs/{org}/interaction-limits"], + setRestrictionsForRepo: ["PUT /repos/{owner}/{repo}/interaction-limits"], + setRestrictionsForYourPublicRepos: [ + "PUT /user/interaction-limits", + {}, + { renamed: ["interactions", "setRestrictionsForAuthenticatedUser"] }, + ], + }, + issues: { + addAssignees: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/assignees", + ], + addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"], + checkUserCanBeAssigned: ["GET /repos/{owner}/{repo}/assignees/{assignee}"], + create: ["POST /repos/{owner}/{repo}/issues"], + createComment: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/comments", + ], + createLabel: ["POST /repos/{owner}/{repo}/labels"], + createMilestone: ["POST /repos/{owner}/{repo}/milestones"], + deleteComment: [ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}", + ], + deleteLabel: ["DELETE /repos/{owner}/{repo}/labels/{name}"], + deleteMilestone: [ + "DELETE /repos/{owner}/{repo}/milestones/{milestone_number}", + ], + get: ["GET /repos/{owner}/{repo}/issues/{issue_number}"], + getComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"], + getEvent: ["GET /repos/{owner}/{repo}/issues/events/{event_id}"], + getLabel: ["GET /repos/{owner}/{repo}/labels/{name}"], + getMilestone: ["GET /repos/{owner}/{repo}/milestones/{milestone_number}"], + list: ["GET /issues"], + listAssignees: ["GET /repos/{owner}/{repo}/assignees"], + listComments: ["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"], + listCommentsForRepo: ["GET /repos/{owner}/{repo}/issues/comments"], + listEvents: ["GET /repos/{owner}/{repo}/issues/{issue_number}/events"], + listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"], + listEventsForTimeline: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", + { mediaType: { previews: ["mockingbird"] } }, + ], + listForAuthenticatedUser: ["GET /user/issues"], + listForOrg: ["GET /orgs/{org}/issues"], + listForRepo: ["GET /repos/{owner}/{repo}/issues"], + listLabelsForMilestone: [ + "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels", + ], + listLabelsForRepo: ["GET /repos/{owner}/{repo}/labels"], + listLabelsOnIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/labels", + ], + listMilestones: ["GET /repos/{owner}/{repo}/milestones"], + lock: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"], + removeAllLabels: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels", + ], + removeAssignees: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees", + ], + removeLabel: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", + ], + setLabels: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"], + unlock: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"], + update: ["PATCH /repos/{owner}/{repo}/issues/{issue_number}"], + updateComment: ["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"], + updateLabel: ["PATCH /repos/{owner}/{repo}/labels/{name}"], + updateMilestone: [ + "PATCH /repos/{owner}/{repo}/milestones/{milestone_number}", + ], + }, + licenses: { + get: ["GET /licenses/{license}"], + getAllCommonlyUsed: ["GET /licenses"], + getForRepo: ["GET /repos/{owner}/{repo}/license"], + }, + markdown: { + render: ["POST /markdown"], + renderRaw: [ + "POST /markdown/raw", + { headers: { "content-type": "text/plain; charset=utf-8" } }, + ], + }, + meta: { + get: ["GET /meta"], + getOctocat: ["GET /octocat"], + getZen: ["GET /zen"], + root: ["GET /"], + }, + migrations: { + cancelImport: ["DELETE /repos/{owner}/{repo}/import"], + deleteArchiveForAuthenticatedUser: [ + "DELETE /user/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + deleteArchiveForOrg: [ + "DELETE /orgs/{org}/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + downloadArchiveForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + getArchiveForAuthenticatedUser: [ + "GET /user/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"], + getImportStatus: ["GET /repos/{owner}/{repo}/import"], + getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"], + getStatusForAuthenticatedUser: [ + "GET /user/migrations/{migration_id}", + { mediaType: { previews: ["wyandotte"] } }, + ], + getStatusForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}", + { mediaType: { previews: ["wyandotte"] } }, + ], + listForAuthenticatedUser: [ + "GET /user/migrations", + { mediaType: { previews: ["wyandotte"] } }, + ], + listForOrg: [ + "GET /orgs/{org}/migrations", + { mediaType: { previews: ["wyandotte"] } }, + ], + listReposForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}/repositories", + { mediaType: { previews: ["wyandotte"] } }, + ], + listReposForUser: [ + "GET /user/migrations/{migration_id}/repositories", + { mediaType: { previews: ["wyandotte"] } }, + ], + mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"], + setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"], + startForAuthenticatedUser: ["POST /user/migrations"], + startForOrg: ["POST /orgs/{org}/migrations"], + startImport: ["PUT /repos/{owner}/{repo}/import"], + unlockRepoForAuthenticatedUser: [ + "DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock", + { mediaType: { previews: ["wyandotte"] } }, + ], + unlockRepoForOrg: [ + "DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", + { mediaType: { previews: ["wyandotte"] } }, + ], + updateImport: ["PATCH /repos/{owner}/{repo}/import"], + }, + orgs: { + blockUser: ["PUT /orgs/{org}/blocks/{username}"], + cancelInvitation: ["DELETE /orgs/{org}/invitations/{invitation_id}"], + checkBlockedUser: ["GET /orgs/{org}/blocks/{username}"], + checkMembershipForUser: ["GET /orgs/{org}/members/{username}"], + checkPublicMembershipForUser: ["GET /orgs/{org}/public_members/{username}"], + convertMemberToOutsideCollaborator: [ + "PUT /orgs/{org}/outside_collaborators/{username}", + ], + createInvitation: ["POST /orgs/{org}/invitations"], + createWebhook: ["POST /orgs/{org}/hooks"], + deleteWebhook: ["DELETE /orgs/{org}/hooks/{hook_id}"], + get: ["GET /orgs/{org}"], + getMembershipForAuthenticatedUser: ["GET /user/memberships/orgs/{org}"], + getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], + getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], + getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"], + list: ["GET /organizations"], + listAppInstallations: ["GET /orgs/{org}/installations"], + listBlockedUsers: ["GET /orgs/{org}/blocks"], + listFailedInvitations: ["GET /orgs/{org}/failed_invitations"], + listForAuthenticatedUser: ["GET /user/orgs"], + listForUser: ["GET /users/{username}/orgs"], + listInvitationTeams: ["GET /orgs/{org}/invitations/{invitation_id}/teams"], + listMembers: ["GET /orgs/{org}/members"], + listMembershipsForAuthenticatedUser: ["GET /user/memberships/orgs"], + listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], + listPendingInvitations: ["GET /orgs/{org}/invitations"], + listPublicMembers: ["GET /orgs/{org}/public_members"], + listWebhooks: ["GET /orgs/{org}/hooks"], + pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], + removeMember: ["DELETE /orgs/{org}/members/{username}"], + removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"], + removeOutsideCollaborator: [ + "DELETE /orgs/{org}/outside_collaborators/{username}", + ], + removePublicMembershipForAuthenticatedUser: [ + "DELETE /orgs/{org}/public_members/{username}", + ], + setMembershipForUser: ["PUT /orgs/{org}/memberships/{username}"], + setPublicMembershipForAuthenticatedUser: [ + "PUT /orgs/{org}/public_members/{username}", + ], + unblockUser: ["DELETE /orgs/{org}/blocks/{username}"], + update: ["PATCH /orgs/{org}"], + updateMembershipForAuthenticatedUser: [ + "PATCH /user/memberships/orgs/{org}", + ], + updateWebhook: ["PATCH /orgs/{org}/hooks/{hook_id}"], + updateWebhookConfigForOrg: ["PATCH /orgs/{org}/hooks/{hook_id}/config"], + }, + packages: { + deletePackageForAuthenticatedUser: [ + "DELETE /user/packages/{package_type}/{package_name}", + ], + deletePackageForOrg: [ + "DELETE /orgs/{org}/packages/{package_type}/{package_name}", + ], + deletePackageVersionForAuthenticatedUser: [ + "DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}", + ], + deletePackageVersionForOrg: [ + "DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", + ], + getAllPackageVersionsForAPackageOwnedByAnOrg: [ + "GET /orgs/{org}/packages/{package_type}/{package_name}/versions", + {}, + { renamed: ["packages", "getAllPackageVersionsForPackageOwnedByOrg"] }, + ], + getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser: [ + "GET /user/packages/{package_type}/{package_name}/versions", + {}, + { + renamed: [ + "packages", + "getAllPackageVersionsForPackageOwnedByAuthenticatedUser", + ], + }, + ], + getAllPackageVersionsForPackageOwnedByAuthenticatedUser: [ + "GET /user/packages/{package_type}/{package_name}/versions", + ], + getAllPackageVersionsForPackageOwnedByOrg: [ + "GET /orgs/{org}/packages/{package_type}/{package_name}/versions", + ], + getAllPackageVersionsForPackageOwnedByUser: [ + "GET /users/{username}/packages/{package_type}/{package_name}/versions", + ], + getPackageForAuthenticatedUser: [ + "GET /user/packages/{package_type}/{package_name}", + ], + getPackageForOrganization: [ + "GET /orgs/{org}/packages/{package_type}/{package_name}", + ], + getPackageForUser: [ + "GET /users/{username}/packages/{package_type}/{package_name}", + ], + getPackageVersionForAuthenticatedUser: [ + "GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}", + ], + getPackageVersionForOrganization: [ + "GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", + ], + getPackageVersionForUser: [ + "GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", + ], + restorePackageForAuthenticatedUser: [ + "POST /user/packages/{package_type}/{package_name}/restore{?token}", + ], + restorePackageForOrg: [ + "POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}", + ], + restorePackageVersionForAuthenticatedUser: [ + "POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", + ], + restorePackageVersionForOrg: [ + "POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", + ], + }, + projects: { + addCollaborator: [ + "PUT /projects/{project_id}/collaborators/{username}", + { mediaType: { previews: ["inertia"] } }, + ], + createCard: [ + "POST /projects/columns/{column_id}/cards", + { mediaType: { previews: ["inertia"] } }, + ], + createColumn: [ + "POST /projects/{project_id}/columns", + { mediaType: { previews: ["inertia"] } }, + ], + createForAuthenticatedUser: [ + "POST /user/projects", + { mediaType: { previews: ["inertia"] } }, + ], + createForOrg: [ + "POST /orgs/{org}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + createForRepo: [ + "POST /repos/{owner}/{repo}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + delete: [ + "DELETE /projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + deleteCard: [ + "DELETE /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } }, + ], + deleteColumn: [ + "DELETE /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } }, + ], + get: [ + "GET /projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + getCard: [ + "GET /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } }, + ], + getColumn: [ + "GET /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } }, + ], + getPermissionForUser: [ + "GET /projects/{project_id}/collaborators/{username}/permission", + { mediaType: { previews: ["inertia"] } }, + ], + listCards: [ + "GET /projects/columns/{column_id}/cards", + { mediaType: { previews: ["inertia"] } }, + ], + listCollaborators: [ + "GET /projects/{project_id}/collaborators", + { mediaType: { previews: ["inertia"] } }, + ], + listColumns: [ + "GET /projects/{project_id}/columns", + { mediaType: { previews: ["inertia"] } }, + ], + listForOrg: [ + "GET /orgs/{org}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + listForRepo: [ + "GET /repos/{owner}/{repo}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + listForUser: [ + "GET /users/{username}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + moveCard: [ + "POST /projects/columns/cards/{card_id}/moves", + { mediaType: { previews: ["inertia"] } }, + ], + moveColumn: [ + "POST /projects/columns/{column_id}/moves", + { mediaType: { previews: ["inertia"] } }, + ], + removeCollaborator: [ + "DELETE /projects/{project_id}/collaborators/{username}", + { mediaType: { previews: ["inertia"] } }, + ], + update: [ + "PATCH /projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + updateCard: [ + "PATCH /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } }, + ], + updateColumn: [ + "PATCH /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } }, + ], + }, + pulls: { + checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + create: ["POST /repos/{owner}/{repo}/pulls"], + createReplyForReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", + ], + createReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + createReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments", + ], + deletePendingReview: [ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + ], + deleteReviewComment: [ + "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}", + ], + dismissReview: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", + ], + get: ["GET /repos/{owner}/{repo}/pulls/{pull_number}"], + getReview: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + ], + getReviewComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"], + list: ["GET /repos/{owner}/{repo}/pulls"], + listCommentsForReview: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", + ], + listCommits: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"], + listFiles: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"], + listRequestedReviewers: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + ], + listReviewComments: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments", + ], + listReviewCommentsForRepo: ["GET /repos/{owner}/{repo}/pulls/comments"], + listReviews: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + merge: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + removeRequestedReviewers: [ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + ], + requestReviewers: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + ], + submitReview: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", + ], + update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"], + updateBranch: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch", + { mediaType: { previews: ["lydian"] } }, + ], + updateReview: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + ], + updateReviewComment: [ + "PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}", + ], + }, + rateLimit: { get: ["GET /rate_limit"] }, + reactions: { + createForCommitComment: [ + "POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForIssue: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForIssueComment: [ + "POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForPullRequestReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForRelease: [ + "POST /repos/{owner}/{repo}/releases/{release_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForTeamDiscussionCommentInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForTeamDiscussionInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForCommitComment: [ + "DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForIssue: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForIssueComment: [ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForPullRequestComment: [ + "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForTeamDiscussion: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForTeamDiscussionComment: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteLegacy: [ + "DELETE /reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + { + deprecated: "octokit.rest.reactions.deleteLegacy() is deprecated, see https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy", + }, + ], + listForCommitComment: [ + "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForIssueComment: [ + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForPullRequestReviewComment: [ + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForTeamDiscussionCommentInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForTeamDiscussionInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + }, + repos: { + acceptInvitation: ["PATCH /user/repository_invitations/{invitation_id}"], + addAppAccessRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" }, + ], + addCollaborator: ["PUT /repos/{owner}/{repo}/collaborators/{username}"], + addStatusCheckContexts: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" }, + ], + addTeamAccessRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" }, + ], + addUserAccessRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" }, + ], + checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], + checkVulnerabilityAlerts: [ + "GET /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } }, + ], + compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], + compareCommitsWithBasehead: [ + "GET /repos/{owner}/{repo}/compare/{basehead}", + ], + createCommitComment: [ + "POST /repos/{owner}/{repo}/commits/{commit_sha}/comments", + ], + createCommitSignatureProtection: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } }, + ], + createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"], + createDeployKey: ["POST /repos/{owner}/{repo}/keys"], + createDeployment: ["POST /repos/{owner}/{repo}/deployments"], + createDeploymentStatus: [ + "POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + ], + createDispatchEvent: ["POST /repos/{owner}/{repo}/dispatches"], + createForAuthenticatedUser: ["POST /user/repos"], + createFork: ["POST /repos/{owner}/{repo}/forks"], + createInOrg: ["POST /orgs/{org}/repos"], + createOrUpdateEnvironment: [ + "PUT /repos/{owner}/{repo}/environments/{environment_name}", + ], + createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], + createPagesSite: [ + "POST /repos/{owner}/{repo}/pages", + { mediaType: { previews: ["switcheroo"] } }, + ], + createRelease: ["POST /repos/{owner}/{repo}/releases"], + createUsingTemplate: [ + "POST /repos/{template_owner}/{template_repo}/generate", + { mediaType: { previews: ["baptiste"] } }, + ], + createWebhook: ["POST /repos/{owner}/{repo}/hooks"], + declineInvitation: ["DELETE /user/repository_invitations/{invitation_id}"], + delete: ["DELETE /repos/{owner}/{repo}"], + deleteAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + ], + deleteAdminBranchProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + ], + deleteAnEnvironment: [ + "DELETE /repos/{owner}/{repo}/environments/{environment_name}", + ], + deleteBranchProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection", + ], + deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"], + deleteCommitSignatureProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } }, + ], + deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"], + deleteDeployment: [ + "DELETE /repos/{owner}/{repo}/deployments/{deployment_id}", + ], + deleteFile: ["DELETE /repos/{owner}/{repo}/contents/{path}"], + deleteInvitation: [ + "DELETE /repos/{owner}/{repo}/invitations/{invitation_id}", + ], + deletePagesSite: [ + "DELETE /repos/{owner}/{repo}/pages", + { mediaType: { previews: ["switcheroo"] } }, + ], + deletePullRequestReviewProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + ], + deleteRelease: ["DELETE /repos/{owner}/{repo}/releases/{release_id}"], + deleteReleaseAsset: [ + "DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}", + ], + deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], + disableAutomatedSecurityFixes: [ + "DELETE /repos/{owner}/{repo}/automated-security-fixes", + { mediaType: { previews: ["london"] } }, + ], + disableVulnerabilityAlerts: [ + "DELETE /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } }, + ], + downloadArchive: [ + "GET /repos/{owner}/{repo}/zipball/{ref}", + {}, + { renamed: ["repos", "downloadZipballArchive"] }, + ], + downloadTarballArchive: ["GET /repos/{owner}/{repo}/tarball/{ref}"], + downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"], + enableAutomatedSecurityFixes: [ + "PUT /repos/{owner}/{repo}/automated-security-fixes", + { mediaType: { previews: ["london"] } }, + ], + enableVulnerabilityAlerts: [ + "PUT /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } }, + ], + get: ["GET /repos/{owner}/{repo}"], + getAccessRestrictions: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + ], + getAdminBranchProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + ], + getAllEnvironments: ["GET /repos/{owner}/{repo}/environments"], + getAllStatusCheckContexts: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + ], + getAllTopics: [ + "GET /repos/{owner}/{repo}/topics", + { mediaType: { previews: ["mercy"] } }, + ], + getAppsWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + ], + getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"], + getBranchProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection", + ], + getClones: ["GET /repos/{owner}/{repo}/traffic/clones"], + getCodeFrequencyStats: ["GET /repos/{owner}/{repo}/stats/code_frequency"], + getCollaboratorPermissionLevel: [ + "GET /repos/{owner}/{repo}/collaborators/{username}/permission", + ], + getCombinedStatusForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/status"], + getCommit: ["GET /repos/{owner}/{repo}/commits/{ref}"], + getCommitActivityStats: ["GET /repos/{owner}/{repo}/stats/commit_activity"], + getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"], + getCommitSignatureProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } }, + ], + getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"], + getContent: ["GET /repos/{owner}/{repo}/contents/{path}"], + getContributorsStats: ["GET /repos/{owner}/{repo}/stats/contributors"], + getDeployKey: ["GET /repos/{owner}/{repo}/keys/{key_id}"], + getDeployment: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}"], + getDeploymentStatus: [ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", + ], + getEnvironment: [ + "GET /repos/{owner}/{repo}/environments/{environment_name}", + ], + getLatestPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/latest"], + getLatestRelease: ["GET /repos/{owner}/{repo}/releases/latest"], + getPages: ["GET /repos/{owner}/{repo}/pages"], + getPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/{build_id}"], + getPagesHealthCheck: ["GET /repos/{owner}/{repo}/pages/health"], + getParticipationStats: ["GET /repos/{owner}/{repo}/stats/participation"], + getPullRequestReviewProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + ], + getPunchCardStats: ["GET /repos/{owner}/{repo}/stats/punch_card"], + getReadme: ["GET /repos/{owner}/{repo}/readme"], + getReadmeInDirectory: ["GET /repos/{owner}/{repo}/readme/{dir}"], + getRelease: ["GET /repos/{owner}/{repo}/releases/{release_id}"], + getReleaseAsset: ["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"], + getReleaseByTag: ["GET /repos/{owner}/{repo}/releases/tags/{tag}"], + getStatusChecksProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + ], + getTeamsWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + ], + getTopPaths: ["GET /repos/{owner}/{repo}/traffic/popular/paths"], + getTopReferrers: ["GET /repos/{owner}/{repo}/traffic/popular/referrers"], + getUsersWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + ], + getViews: ["GET /repos/{owner}/{repo}/traffic/views"], + getWebhook: ["GET /repos/{owner}/{repo}/hooks/{hook_id}"], + getWebhookConfigForRepo: [ + "GET /repos/{owner}/{repo}/hooks/{hook_id}/config", + ], + listBranches: ["GET /repos/{owner}/{repo}/branches"], + listBranchesForHeadCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", + { mediaType: { previews: ["groot"] } }, + ], + listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"], + listCommentsForCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments", + ], + listCommitCommentsForRepo: ["GET /repos/{owner}/{repo}/comments"], + listCommitStatusesForRef: [ + "GET /repos/{owner}/{repo}/commits/{ref}/statuses", + ], + listCommits: ["GET /repos/{owner}/{repo}/commits"], + listContributors: ["GET /repos/{owner}/{repo}/contributors"], + listDeployKeys: ["GET /repos/{owner}/{repo}/keys"], + listDeploymentStatuses: [ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + ], + listDeployments: ["GET /repos/{owner}/{repo}/deployments"], + listForAuthenticatedUser: ["GET /user/repos"], + listForOrg: ["GET /orgs/{org}/repos"], + listForUser: ["GET /users/{username}/repos"], + listForks: ["GET /repos/{owner}/{repo}/forks"], + listInvitations: ["GET /repos/{owner}/{repo}/invitations"], + listInvitationsForAuthenticatedUser: ["GET /user/repository_invitations"], + listLanguages: ["GET /repos/{owner}/{repo}/languages"], + listPagesBuilds: ["GET /repos/{owner}/{repo}/pages/builds"], + listPublic: ["GET /repositories"], + listPullRequestsAssociatedWithCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", + { mediaType: { previews: ["groot"] } }, + ], + listReleaseAssets: [ + "GET /repos/{owner}/{repo}/releases/{release_id}/assets", + ], + listReleases: ["GET /repos/{owner}/{repo}/releases"], + listTags: ["GET /repos/{owner}/{repo}/tags"], + listTeams: ["GET /repos/{owner}/{repo}/teams"], + listWebhooks: ["GET /repos/{owner}/{repo}/hooks"], + merge: ["POST /repos/{owner}/{repo}/merges"], + pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"], + removeAppAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" }, + ], + removeCollaborator: [ + "DELETE /repos/{owner}/{repo}/collaborators/{username}", + ], + removeStatusCheckContexts: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" }, + ], + removeStatusCheckProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + ], + removeTeamAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" }, + ], + removeUserAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" }, + ], + renameBranch: ["POST /repos/{owner}/{repo}/branches/{branch}/rename"], + replaceAllTopics: [ + "PUT /repos/{owner}/{repo}/topics", + { mediaType: { previews: ["mercy"] } }, + ], + requestPagesBuild: ["POST /repos/{owner}/{repo}/pages/builds"], + setAdminBranchProtection: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + ], + setAppAccessRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" }, + ], + setStatusCheckContexts: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" }, + ], + setTeamAccessRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" }, + ], + setUserAccessRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" }, + ], + testPushWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"], + transfer: ["POST /repos/{owner}/{repo}/transfer"], + update: ["PATCH /repos/{owner}/{repo}"], + updateBranchProtection: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection", + ], + updateCommitComment: ["PATCH /repos/{owner}/{repo}/comments/{comment_id}"], + updateInformationAboutPagesSite: ["PUT /repos/{owner}/{repo}/pages"], + updateInvitation: [ + "PATCH /repos/{owner}/{repo}/invitations/{invitation_id}", + ], + updatePullRequestReviewProtection: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + ], + updateRelease: ["PATCH /repos/{owner}/{repo}/releases/{release_id}"], + updateReleaseAsset: [ + "PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}", + ], + updateStatusCheckPotection: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + {}, + { renamed: ["repos", "updateStatusCheckProtection"] }, + ], + updateStatusCheckProtection: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + ], + updateWebhook: ["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"], + updateWebhookConfigForRepo: [ + "PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config", + ], + uploadReleaseAsset: [ + "POST /repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", + { baseUrl: "https://uploads.github.com" }, + ], + }, + search: { + code: ["GET /search/code"], + commits: ["GET /search/commits", { mediaType: { previews: ["cloak"] } }], + issuesAndPullRequests: ["GET /search/issues"], + labels: ["GET /search/labels"], + repos: ["GET /search/repositories"], + topics: ["GET /search/topics", { mediaType: { previews: ["mercy"] } }], + users: ["GET /search/users"], + }, + secretScanning: { + getAlert: [ + "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", + ], + listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], + updateAlert: [ + "PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", + ], + }, + teams: { + addOrUpdateMembershipForUserInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/memberships/{username}", + ], + addOrUpdateProjectPermissionsInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + addOrUpdateRepoPermissionsInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + ], + checkPermissionsForProjectInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + checkPermissionsForRepoInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + ], + create: ["POST /orgs/{org}/teams"], + createDiscussionCommentInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + ], + createDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions"], + deleteDiscussionCommentInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + ], + deleteDiscussionInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + ], + deleteInOrg: ["DELETE /orgs/{org}/teams/{team_slug}"], + getByName: ["GET /orgs/{org}/teams/{team_slug}"], + getDiscussionCommentInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + ], + getDiscussionInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + ], + getMembershipForUserInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/memberships/{username}", + ], + list: ["GET /orgs/{org}/teams"], + listChildInOrg: ["GET /orgs/{org}/teams/{team_slug}/teams"], + listDiscussionCommentsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + ], + listDiscussionsInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions"], + listForAuthenticatedUser: ["GET /user/teams"], + listMembersInOrg: ["GET /orgs/{org}/teams/{team_slug}/members"], + listPendingInvitationsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/invitations", + ], + listProjectsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], + removeMembershipForUserInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}", + ], + removeProjectInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}", + ], + removeRepoInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + ], + updateDiscussionCommentInOrg: [ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + ], + updateDiscussionInOrg: [ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + ], + updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"], + }, + users: { + addEmailForAuthenticated: ["POST /user/emails"], + block: ["PUT /user/blocks/{username}"], + checkBlocked: ["GET /user/blocks/{username}"], + checkFollowingForUser: ["GET /users/{username}/following/{target_user}"], + checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"], + createGpgKeyForAuthenticated: ["POST /user/gpg_keys"], + createPublicSshKeyForAuthenticated: ["POST /user/keys"], + deleteEmailForAuthenticated: ["DELETE /user/emails"], + deleteGpgKeyForAuthenticated: ["DELETE /user/gpg_keys/{gpg_key_id}"], + deletePublicSshKeyForAuthenticated: ["DELETE /user/keys/{key_id}"], + follow: ["PUT /user/following/{username}"], + getAuthenticated: ["GET /user"], + getByUsername: ["GET /users/{username}"], + getContextForUser: ["GET /users/{username}/hovercard"], + getGpgKeyForAuthenticated: ["GET /user/gpg_keys/{gpg_key_id}"], + getPublicSshKeyForAuthenticated: ["GET /user/keys/{key_id}"], + list: ["GET /users"], + listBlockedByAuthenticated: ["GET /user/blocks"], + listEmailsForAuthenticated: ["GET /user/emails"], + listFollowedByAuthenticated: ["GET /user/following"], + listFollowersForAuthenticatedUser: ["GET /user/followers"], + listFollowersForUser: ["GET /users/{username}/followers"], + listFollowingForUser: ["GET /users/{username}/following"], + listGpgKeysForAuthenticated: ["GET /user/gpg_keys"], + listGpgKeysForUser: ["GET /users/{username}/gpg_keys"], + listPublicEmailsForAuthenticated: ["GET /user/public_emails"], + listPublicKeysForUser: ["GET /users/{username}/keys"], + listPublicSshKeysForAuthenticated: ["GET /user/keys"], + setPrimaryEmailVisibilityForAuthenticated: ["PATCH /user/email/visibility"], + unblock: ["DELETE /user/blocks/{username}"], + unfollow: ["DELETE /user/following/{username}"], + updateAuthenticated: ["PATCH /user"], + }, +}; +export default Endpoints; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/method-types.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/method-types.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/method-types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/parameters-and-response-types.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/parameters-and-response-types.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/generated/parameters-and-response-types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/index.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/index.js new file mode 100644 index 00000000..53d539da --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/index.js @@ -0,0 +1,18 @@ +import ENDPOINTS from "./generated/endpoints"; +import { VERSION } from "./version"; +import { endpointsToMethods } from "./endpoints-to-methods"; +export function restEndpointMethods(octokit) { + const api = endpointsToMethods(octokit, ENDPOINTS); + return { + rest: api, + }; +} +restEndpointMethods.VERSION = VERSION; +export function legacyRestEndpointMethods(octokit) { + const api = endpointsToMethods(octokit, ENDPOINTS); + return { + ...api, + rest: api, + }; +} +legacyRestEndpointMethods.VERSION = VERSION; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/types.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/types.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/version.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/version.js new file mode 100644 index 00000000..8b3296bf --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "5.3.0"; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/endpoints-to-methods.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/endpoints-to-methods.d.ts new file mode 100644 index 00000000..2a97a4b4 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/endpoints-to-methods.d.ts @@ -0,0 +1,4 @@ +import { Octokit } from "@octokit/core"; +import { EndpointsDefaultsAndDecorations } from "./types"; +import { RestEndpointMethods } from "./generated/method-types"; +export declare function endpointsToMethods(octokit: Octokit, endpointsMap: EndpointsDefaultsAndDecorations): RestEndpointMethods; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/endpoints.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/endpoints.d.ts new file mode 100644 index 00000000..a3c1d92a --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/endpoints.d.ts @@ -0,0 +1,3 @@ +import { EndpointsDefaultsAndDecorations } from "../types"; +declare const Endpoints: EndpointsDefaultsAndDecorations; +export default Endpoints; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types.d.ts new file mode 100644 index 00000000..df4fc017 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types.d.ts @@ -0,0 +1,7933 @@ +import { EndpointInterface, RequestInterface } from "@octokit/types"; +import { RestEndpointMethodTypes } from "./parameters-and-response-types"; +export declare type RestEndpointMethods = { + actions: { + /** + * Adds a repository to 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/actions#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 `secrets` organization permission to use this endpoint. + */ + addSelectedRepoToOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["addSelectedRepoToOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** This endpoint is currently in beta and is subject to change. + * + * 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)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + approveWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["approveWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + cancelWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["cancelWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates or updates an environment secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + createOrUpdateEnvironmentSecret: { + (params?: RestEndpointMethodTypes["actions"]["createOrUpdateEnvironmentSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates or updates an organization secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + createOrUpdateOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["createOrUpdateOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates or updates a repository secret with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. + * + * #### Example encrypting a secret using Node.js + * + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * + * ``` + * const sodium = require('tweetsodium'); + * + * const key = "base64-encoded-public-key"; + * const value = "plain-text-secret"; + * + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); + * + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * + * console.log(encrypted); + * ``` + * + * + * #### Example encrypting a secret using Python + * + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3. + * + * ``` + * from base64 import b64encode + * from nacl import encoding, public + * + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` + * + * #### Example encrypting a secret using C# + * + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` + * + * #### Example encrypting a secret using Ruby + * + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * + * ```ruby + * require "rbnacl" + * require "base64" + * + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) + * + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") + * + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` + */ + createOrUpdateRepoSecret: { + (params?: RestEndpointMethodTypes["actions"]["createOrUpdateRepoSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` + */ + createRegistrationTokenForOrg: { + (params?: RestEndpointMethodTypes["actions"]["createRegistrationTokenForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate + * using an access token with the `repo` scope to use this endpoint. + * + * #### Example using registration token + * + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * + * ``` + * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN + * ``` + */ + createRegistrationTokenForRepo: { + (params?: RestEndpointMethodTypes["actions"]["createRegistrationTokenForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this + * endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + createRemoveTokenForOrg: { + (params?: RestEndpointMethodTypes["actions"]["createRemoveTokenForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * + * #### Example using remove token + * + * To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint. + * + * ``` + * ./config.sh remove --token TOKEN + * ``` + */ + createRemoveTokenForRepo: { + (params?: RestEndpointMethodTypes["actions"]["createRemoveTokenForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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`. + * + * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + */ + createWorkflowDispatch: { + (params?: RestEndpointMethodTypes["actions"]["createWorkflowDispatch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + deleteArtifact: { + (params?: RestEndpointMethodTypes["actions"]["deleteArtifact"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a secret in an environment 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. + */ + deleteEnvironmentSecret: { + (params?: RestEndpointMethodTypes["actions"]["deleteEnvironmentSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + */ + deleteOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["deleteOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + */ + deleteRepoSecret: { + (params?: RestEndpointMethodTypes["actions"]["deleteRepoSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + deleteSelfHostedRunnerFromOrg: { + (params?: RestEndpointMethodTypes["actions"]["deleteSelfHostedRunnerFromOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + * + * You must authenticate using an access token with the `repo` + * scope to use this endpoint. + */ + deleteSelfHostedRunnerFromRepo: { + (params?: RestEndpointMethodTypes["actions"]["deleteSelfHostedRunnerFromRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Delete a specific workflow run. Anyone with write 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:write` permission to use + * this endpoint. + */ + deleteWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["deleteWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + deleteWorkflowRunLogs: { + (params?: RestEndpointMethodTypes["actions"]["deleteWorkflowRunLogs"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes a repository from 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)." + * + * 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. + */ + disableSelectedRepositoryGithubActionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["disableSelectedRepositoryGithubActionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + disableWorkflow: { + (params?: RestEndpointMethodTypes["actions"]["disableWorkflow"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in + * the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to + * the repository can use this endpoint. 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. + */ + downloadArtifact: { + (params?: RestEndpointMethodTypes["actions"]["downloadArtifact"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look + * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can + * use this endpoint. 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. + */ + downloadJobLogsForWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["downloadJobLogsForWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for + * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use + * this endpoint. 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. + */ + downloadWorkflowRunLogs: { + (params?: RestEndpointMethodTypes["actions"]["downloadWorkflowRunLogs"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Adds a repository to 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 must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + * + * 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. + */ + enableSelectedRepositoryGithubActionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["enableSelectedRepositoryGithubActionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + enableWorkflow: { + (params?: RestEndpointMethodTypes["actions"]["enableWorkflow"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the selected actions 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)."" + * + * 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. + */ + getAllowedActionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["getAllowedActionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository 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)." + * + * 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. + */ + getAllowedActionsRepository: { + (params?: RestEndpointMethodTypes["actions"]["getAllowedActionsRepository"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific artifact 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. + */ + getArtifact: { + (params?: RestEndpointMethodTypes["actions"]["getArtifact"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get the public key for an environment, which you need to encrypt environment 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 `secrets` repository permission to use this endpoint. + */ + getEnvironmentPublicKey: { + (params?: RestEndpointMethodTypes["actions"]["getEnvironmentPublicKey"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a single environment 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. + */ + getEnvironmentSecret: { + (params?: RestEndpointMethodTypes["actions"]["getEnvironmentSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + * + * 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. + */ + getGithubActionsPermissionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["getGithubActionsPermissionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. + * + * 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. + */ + getGithubActionsPermissionsRepository: { + (params?: RestEndpointMethodTypes["actions"]["getGithubActionsPermissionsRepository"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific job in 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. + */ + getJobForWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["getJobForWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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 `secrets` organization permission to use this endpoint. + */ + getOrgPublicKey: { + (params?: RestEndpointMethodTypes["actions"]["getOrgPublicKey"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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 `secrets` organization permission to use this endpoint. + */ + getOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["getOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get all deployment environments for a workflow run that are waiting for protection rules to pass. + * + * 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. + */ + getPendingDeploymentsForRun: { + (params?: RestEndpointMethodTypes["actions"]["getPendingDeploymentsForRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. + * + * 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. + * @deprecated octokit.rest.actions.getRepoPermissions() has been renamed to octokit.rest.actions.getGithubActionsPermissionsRepository() (2020-11-10) + */ + getRepoPermissions: { + (params?: RestEndpointMethodTypes["actions"]["getRepoPermissions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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 `secrets` repository permission to use this endpoint. + */ + getRepoPublicKey: { + (params?: RestEndpointMethodTypes["actions"]["getRepoPublicKey"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + */ + getRepoSecret: { + (params?: RestEndpointMethodTypes["actions"]["getRepoSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + */ + getReviewsForRun: { + (params?: RestEndpointMethodTypes["actions"]["getReviewsForRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific self-hosted runner configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + getSelfHostedRunnerForOrg: { + (params?: RestEndpointMethodTypes["actions"]["getSelfHostedRunnerForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific self-hosted runner configured in a repository. + * + * You must authenticate using an access token with the `repo` scope to use this + * endpoint. + */ + getSelfHostedRunnerForRepo: { + (params?: RestEndpointMethodTypes["actions"]["getSelfHostedRunnerForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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. + */ + getWorkflow: { + (params?: RestEndpointMethodTypes["actions"]["getWorkflow"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific 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. + */ + getWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["getWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * 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. + */ + getWorkflowRunUsage: { + (params?: RestEndpointMethodTypes["actions"]["getWorkflowRunUsage"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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. + */ + getWorkflowUsage: { + (params?: RestEndpointMethodTypes["actions"]["getWorkflowUsage"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all artifacts for 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. + */ + listArtifactsForRepo: { + (params?: RestEndpointMethodTypes["actions"]["listArtifactsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all secrets available in an environment 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. + */ + listEnvironmentSecrets: { + (params?: RestEndpointMethodTypes["actions"]["listEnvironmentSecrets"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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). + */ + listJobsForWorkflowRun: { + (params?: RestEndpointMethodTypes["actions"]["listJobsForWorkflowRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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 `secrets` organization permission to use this endpoint. + */ + listOrgSecrets: { + (params?: RestEndpointMethodTypes["actions"]["listOrgSecrets"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + */ + listRepoSecrets: { + (params?: RestEndpointMethodTypes["actions"]["listRepoSecrets"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + */ + listRepoWorkflows: { + (params?: RestEndpointMethodTypes["actions"]["listRepoWorkflows"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + listRunnerApplicationsForOrg: { + (params?: RestEndpointMethodTypes["actions"]["listRunnerApplicationsForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists binaries for the runner application that you can download and run. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + */ + listRunnerApplicationsForRepo: { + (params?: RestEndpointMethodTypes["actions"]["listRunnerApplicationsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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 `secrets` organization permission to use this endpoint. + */ + listSelectedReposForOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["listSelectedReposForOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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)." + * + * 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. + */ + listSelectedRepositoriesEnabledGithubActionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["listSelectedRepositoriesEnabledGithubActionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all self-hosted runners configured in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + */ + listSelfHostedRunnersForOrg: { + (params?: RestEndpointMethodTypes["actions"]["listSelfHostedRunnersForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. + */ + listSelfHostedRunnersForRepo: { + (params?: RestEndpointMethodTypes["actions"]["listSelfHostedRunnersForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists artifacts 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. + */ + listWorkflowRunArtifacts: { + (params?: RestEndpointMethodTypes["actions"]["listWorkflowRunArtifacts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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). + * + * 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. + */ + listWorkflowRuns: { + (params?: RestEndpointMethodTypes["actions"]["listWorkflowRuns"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * + * 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. + */ + listWorkflowRunsForRepo: { + (params?: RestEndpointMethodTypes["actions"]["listWorkflowRunsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + reRunWorkflow: { + (params?: RestEndpointMethodTypes["actions"]["reRunWorkflow"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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/actions#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 `secrets` organization permission to use this endpoint. + */ + removeSelectedRepoFromOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["removeSelectedRepoFromOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Approve or reject pending deployments that are waiting on approval by a required reviewer. + * + * Anyone with read access to the repository contents and deployments can use this endpoint. + */ + reviewPendingDeploymentsForRun: { + (params?: RestEndpointMethodTypes["actions"]["reviewPendingDeploymentsForRun"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the actions 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)." + * + * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + * + * 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. + * + * 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. + */ + setAllowedActionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["setAllowedActionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the actions 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)." + * + * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + * + * 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. + * + * 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. + */ + setAllowedActionsRepository: { + (params?: RestEndpointMethodTypes["actions"]["setAllowedActionsRepository"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. + * + * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. + * + * 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. + */ + setGithubActionsPermissionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["setGithubActionsPermissionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. + * + * 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, then you cannot override them for the repository. + * + * 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. + */ + setGithubActionsPermissionsRepository: { + (params?: RestEndpointMethodTypes["actions"]["setGithubActionsPermissionsRepository"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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/actions#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 `secrets` organization permission to use this endpoint. + */ + setSelectedReposForOrgSecret: { + (params?: RestEndpointMethodTypes["actions"]["setSelectedReposForOrgSecret"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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)." + * + * 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. + */ + setSelectedRepositoriesEnabledGithubActionsOrganization: { + (params?: RestEndpointMethodTypes["actions"]["setSelectedRepositoriesEnabledGithubActionsOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + activity: { + checkRepoIsStarredByAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["checkRepoIsStarredByAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). + */ + deleteRepoSubscription: { + (params?: RestEndpointMethodTypes["activity"]["deleteRepoSubscription"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`. + */ + deleteThreadSubscription: { + (params?: RestEndpointMethodTypes["activity"]["deleteThreadSubscription"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + * + * * **Timeline**: The GitHub global public timeline + * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + * * **Current user public**: The public timeline for the authenticated user + * * **Current user**: The private timeline for the authenticated user + * * **Current user actor**: The private timeline for activity created by the authenticated user + * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. + * + * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + */ + getFeeds: { + (params?: RestEndpointMethodTypes["activity"]["getFeeds"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getRepoSubscription: { + (params?: RestEndpointMethodTypes["activity"]["getRepoSubscription"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getThread: { + (params?: RestEndpointMethodTypes["activity"]["getThread"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). + * + * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + */ + getThreadSubscriptionForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["getThreadSubscriptionForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + */ + listEventsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["listEventsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all notifications for the current user, sorted by most recently updated. + */ + listNotificationsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["listNotificationsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This is the user's organization dashboard. You must be authenticated as the user to view this. + */ + listOrgEventsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["listOrgEventsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + */ + listPublicEvents: { + (params?: RestEndpointMethodTypes["activity"]["listPublicEvents"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listPublicEventsForRepoNetwork: { + (params?: RestEndpointMethodTypes["activity"]["listPublicEventsForRepoNetwork"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listPublicEventsForUser: { + (params?: RestEndpointMethodTypes["activity"]["listPublicEventsForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listPublicOrgEvents: { + (params?: RestEndpointMethodTypes["activity"]["listPublicOrgEvents"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + */ + listReceivedEventsForUser: { + (params?: RestEndpointMethodTypes["activity"]["listReceivedEventsForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listReceivedPublicEventsForUser: { + (params?: RestEndpointMethodTypes["activity"]["listReceivedPublicEventsForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listRepoEvents: { + (params?: RestEndpointMethodTypes["activity"]["listRepoEvents"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all notifications for the current user. + */ + listRepoNotificationsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["listRepoNotificationsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists repositories the authenticated user has starred. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + listReposStarredByAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["listReposStarredByAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists repositories a user has starred. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + listReposStarredByUser: { + (params?: RestEndpointMethodTypes["activity"]["listReposStarredByUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists repositories a user is watching. + */ + listReposWatchedByUser: { + (params?: RestEndpointMethodTypes["activity"]["listReposWatchedByUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the people that have starred the repository. + * + * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + */ + listStargazersForRepo: { + (params?: RestEndpointMethodTypes["activity"]["listStargazersForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists repositories the authenticated user is watching. + */ + listWatchedReposForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["listWatchedReposForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the people watching the specified repository. + */ + listWatchersForRepo: { + (params?: RestEndpointMethodTypes["activity"]["listWatchersForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). 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`. + */ + markNotificationsAsRead: { + (params?: RestEndpointMethodTypes["activity"]["markNotificationsAsRead"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). 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`. + */ + markRepoNotificationsAsRead: { + (params?: RestEndpointMethodTypes["activity"]["markRepoNotificationsAsRead"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + markThreadAsRead: { + (params?: RestEndpointMethodTypes["activity"]["markThreadAsRead"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely. + */ + setRepoSubscription: { + (params?: RestEndpointMethodTypes["activity"]["setRepoSubscription"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. + * + * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. + * + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint. + */ + setThreadSubscription: { + (params?: RestEndpointMethodTypes["activity"]["setThreadSubscription"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + starRepoForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["starRepoForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + unstarRepoForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["activity"]["unstarRepoForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + apps: { + /** + * Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + */ + addRepoToInstallation: { + (params?: RestEndpointMethodTypes["apps"]["addRepoToInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + */ + checkToken: { + (params?: RestEndpointMethodTypes["apps"]["checkToken"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Deprecated:** use `apps.createContentAttachmentForRepo()` (`POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments`) instead. Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. + * + * The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + createContentAttachment: { + (params?: RestEndpointMethodTypes["apps"]["createContentAttachment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. + * + * The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + createContentAttachmentForRepo: { + (params?: RestEndpointMethodTypes["apps"]["createContentAttachmentForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. + */ + createFromManifest: { + (params?: RestEndpointMethodTypes["apps"]["createFromManifest"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + * + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + */ + createInstallationAccessToken: { + (params?: RestEndpointMethodTypes["apps"]["createInstallationAccessToken"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * OAuth application owners can revoke a grant for their OAuth 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. + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + */ + deleteAuthorization: { + (params?: RestEndpointMethodTypes["apps"]["deleteAuthorization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)" endpoint. + * + * 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. + */ + deleteInstallation: { + (params?: RestEndpointMethodTypes["apps"]["deleteInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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 OAuth application's `client_id` and `client_secret` as the username and password. + */ + deleteToken: { + (params?: RestEndpointMethodTypes["apps"]["deleteToken"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)" endpoint. + * + * 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. + */ + getAuthenticated: { + (params?: RestEndpointMethodTypes["apps"]["getAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * + * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + getBySlug: { + (params?: RestEndpointMethodTypes["apps"]["getBySlug"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to. + * + * 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. + */ + getInstallation: { + (params?: RestEndpointMethodTypes["apps"]["getInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables an authenticated GitHub App to find the organization's installation information. + * + * 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. + */ + getOrgInstallation: { + (params?: RestEndpointMethodTypes["apps"]["getOrgInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. + * + * 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. + */ + getRepoInstallation: { + (params?: RestEndpointMethodTypes["apps"]["getRepoInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + getSubscriptionPlanForAccount: { + (params?: RestEndpointMethodTypes["apps"]["getSubscriptionPlanForAccount"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + getSubscriptionPlanForAccountStubbed: { + (params?: RestEndpointMethodTypes["apps"]["getSubscriptionPlanForAccountStubbed"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables an authenticated GitHub App to find the user’s installation information. + * + * 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. + */ + getUserInstallation: { + (params?: RestEndpointMethodTypes["apps"]["getUserInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns 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)." + * + * 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. + */ + getWebhookConfigForApp: { + (params?: RestEndpointMethodTypes["apps"]["getWebhookConfigForApp"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + listAccountsForPlan: { + (params?: RestEndpointMethodTypes["apps"]["listAccountsForPlan"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + listAccountsForPlanStubbed: { + (params?: RestEndpointMethodTypes["apps"]["listAccountsForPlanStubbed"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * + * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. + * + * The access the user has to each repository is included in the hash under the `permissions` key. + */ + listInstallationReposForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["apps"]["listInstallationReposForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + * + * The permissions the installation has are included under the `permissions` key. + */ + listInstallations: { + (params?: RestEndpointMethodTypes["apps"]["listInstallations"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. + * + * You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * + * You can find the permissions for the installation under the `permissions` key. + */ + listInstallationsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["apps"]["listInstallationsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all plans that are part of your GitHub Marketplace listing. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + listPlans: { + (params?: RestEndpointMethodTypes["apps"]["listPlans"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all plans that are part of your GitHub Marketplace listing. + * + * GitHub Apps 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. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + */ + listPlansStubbed: { + (params?: RestEndpointMethodTypes["apps"]["listPlansStubbed"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List repositories that an app installation can access. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + listReposAccessibleToInstallation: { + (params?: RestEndpointMethodTypes["apps"]["listReposAccessibleToInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). + */ + listSubscriptionsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["apps"]["listSubscriptionsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/). + */ + listSubscriptionsForAuthenticatedUserStubbed: { + (params?: RestEndpointMethodTypes["apps"]["listSubscriptionsForAuthenticatedUserStubbed"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Remove a single repository from an installation. The authenticated user must have admin access to the repository. + * + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + */ + removeRepoFromInstallation: { + (params?: RestEndpointMethodTypes["apps"]["removeRepoFromInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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 OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + */ + resetToken: { + (params?: RestEndpointMethodTypes["apps"]["resetToken"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Revokes the installation token you're using to authenticate as an installation and access this endpoint. + * + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)" endpoint. + * + * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + */ + revokeInstallationAccessToken: { + (params?: RestEndpointMethodTypes["apps"]["revokeInstallationAccessToken"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth 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 OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + */ + scopeToken: { + (params?: RestEndpointMethodTypes["apps"]["scopeToken"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + * + * 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. + */ + suspendInstallation: { + (params?: RestEndpointMethodTypes["apps"]["suspendInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes a GitHub App installation suspension. + * + * 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. + */ + unsuspendInstallation: { + (params?: RestEndpointMethodTypes["apps"]["unsuspendInstallation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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)." + * + * 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. + */ + updateWebhookConfigForApp: { + (params?: RestEndpointMethodTypes["apps"]["updateWebhookConfigForApp"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + billing: { + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + getGithubActionsBillingOrg: { + (params?: RestEndpointMethodTypes["billing"]["getGithubActionsBillingOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the summary of the free and paid GitHub Actions minutes used. + * + * 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://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * + * Access tokens must have the `user` scope. + */ + getGithubActionsBillingUser: { + (params?: RestEndpointMethodTypes["billing"]["getGithubActionsBillingUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the free and paid storage usued for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + getGithubPackagesBillingOrg: { + (params?: RestEndpointMethodTypes["billing"]["getGithubPackagesBillingOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the free and paid storage used for GitHub Packages in gigabytes. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `user` scope. + */ + getGithubPackagesBillingUser: { + (params?: RestEndpointMethodTypes["billing"]["getGithubPackagesBillingUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `repo` or `admin:org` scope. + */ + getSharedStorageBillingOrg: { + (params?: RestEndpointMethodTypes["billing"]["getSharedStorageBillingOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages. + * + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * + * Access tokens must have the `user` scope. + */ + getSharedStorageBillingUser: { + (params?: RestEndpointMethodTypes["billing"]["getSharedStorageBillingUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + checks: { + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * + * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + */ + create: { + (params?: RestEndpointMethodTypes["checks"]["create"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + */ + createSuite: { + (params?: RestEndpointMethodTypes["checks"]["createSuite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + get: { + (params?: RestEndpointMethodTypes["checks"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. + */ + getSuite: { + (params?: RestEndpointMethodTypes["checks"]["getSuite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. + */ + listAnnotations: { + (params?: RestEndpointMethodTypes["checks"]["listAnnotations"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + listForRef: { + (params?: RestEndpointMethodTypes["checks"]["listForRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + */ + listForSuite: { + (params?: RestEndpointMethodTypes["checks"]["listForSuite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. + */ + listSuitesForRef: { + (params?: RestEndpointMethodTypes["checks"]["listSuitesForRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * + * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. + */ + rerequestSuite: { + (params?: RestEndpointMethodTypes["checks"]["rerequestSuite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. + */ + setSuitesPreferences: { + (params?: RestEndpointMethodTypes["checks"]["setSuitesPreferences"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + */ + update: { + (params?: RestEndpointMethodTypes["checks"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + codeScanning: { + /** + * Deletes a specified code scanning analysis from a repository. For + * private repositories, you must use an access token with the `repo` scope. For public repositories, + * you must use an access token with `public_repo` and `repo:security_events` scopes. + * GitHub Apps must have the `security_events` write permission to use this endpoint. + * + * You can delete one analysis at a time. + * To delete a series of analyses, start with the most recent analysis and work backwards. + * Conceptually, the process is similar to the undo function in a text editor. + * + * When you list the analyses for a repository, + * one or more will be identified as deletable in the response: + * + * ``` + * "deletable": true + * ``` + * + * An analysis is deletable when it's the most recent in a set of analyses. + * Typically, a repository will have multiple sets of analyses + * for each enabled code scanning tool, + * where a set is determined by a unique combination of analysis values: + * + * * `ref` + * * `tool` + * * `analysis_key` + * * `environment` + * + * If you attempt to delete an analysis that is not the most recent in a set, + * you'll get a 400 response with the message: + * + * ``` + * Analysis specified is not deletable. + * ``` + * + * The response from a successful `DELETE` operation provides you with + * two alternative URLs for deleting the next analysis in the set + * (see the example default response below). + * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis + * in the set. This is a useful option if you want to preserve at least one analysis + * for the specified tool in your repository. + * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. + * When you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url` + * in the 200 response is `null`. + * + * As an example of the deletion process, + * let's imagine that you added a workflow that configured a particular code scanning tool + * to analyze the code in a repository. This tool has added 15 analyses: + * 10 on the default branch, and another 5 on a topic branch. + * You therefore have two separate sets of analyses for this tool. + * You've now decided that you want to remove all of the analyses for the tool. + * To do this you must make 15 separate deletion requests. + * To start, you must find the deletable analysis for one of the sets, + * step through deleting the analyses in that set, + * and then repeat the process for the second set. + * The procedure therefore consists of a nested loop: + * + * **Outer loop**: + * * List the analyses for the repository, filtered by tool. + * * Parse this list to find a deletable analysis. If found: + * + * **Inner loop**: + * * Delete the identified analysis. + * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. + * + * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + */ + deleteAnalysis: { + (params?: RestEndpointMethodTypes["codeScanning"]["deleteAnalysis"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * **Deprecation notice**: + * 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`. + */ + getAlert: { + (params?: RestEndpointMethodTypes["codeScanning"]["getAlert"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specified code scanning analysis for a repository. + * You must use an access token with the `security_events` scope to use this endpoint. + * GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * The default JSON response contains fields that describe the analysis. + * This includes the Git reference and commit SHA to which the analysis relates, + * the datetime of the analysis, the name of the code scanning tool, + * and the number of alerts. + * + * The `rules_count` field in the default response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. + * + * If you use the Accept header `application/sarif+json`, + * the response contains the analysis data that was uploaded. + * This is formatted as + * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + * For an example response, see "[Custom media type for code scanning](#custom-media-type-for-code-scanning)." + * + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + */ + getAnalysis: { + (params?: RestEndpointMethodTypes["codeScanning"]["getAnalysis"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. GitHub Apps must have the `security_events` read permission to use this endpoint. + */ + getSarif: { + (params?: RestEndpointMethodTypes["codeScanning"]["getSarif"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + */ + listAlertInstances: { + (params?: RestEndpointMethodTypes["codeScanning"]["listAlertInstances"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all open code scanning alerts for the default branch (usually `main` + * or `master`). You must use an access token with the `security_events` scope to use + * this endpoint. GitHub Apps must have the `security_events` read permission to use + * this endpoint. + * + * The response includes a `most_recent_instance` object. + * This provides details of the most recent instance of this alert + * for the default branch or for the specified Git reference + * (if you used `ref` in the request). + */ + listAlertsForRepo: { + (params?: RestEndpointMethodTypes["codeScanning"]["listAlertsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. + * @deprecated octokit.rest.codeScanning.listAlertsInstances() has been renamed to octokit.rest.codeScanning.listAlertInstances() (2021-04-30) + */ + listAlertsInstances: { + (params?: RestEndpointMethodTypes["codeScanning"]["listAlertsInstances"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the details of all code scanning analyses for a repository, + * starting with the most recent. + * The response is paginated and you can use the `page` and `per_page` parameters + * to list the analyses you're interested in. + * By default 30 analyses are listed per page. + * + * The `rules_count` field in the response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. + * + * You must use an access token with the `security_events` scope to use this endpoint. + * GitHub Apps must have the `security_events` read permission to use this endpoint. + * + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + */ + listRecentAnalyses: { + (params?: RestEndpointMethodTypes["codeScanning"]["listRecentAnalyses"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + */ + updateAlert: { + (params?: RestEndpointMethodTypes["codeScanning"]["updateAlert"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. GitHub Apps must have the `security_events` write permission to use this endpoint. + * + * There are two places where you can upload code scanning results. + * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + * - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + * + * You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: + * + * ``` + * gzip -c analysis-data.sarif | base64 -w0 + * ``` + * + * SARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries. + * + * The `202 Accepted`, response includes an `id` value. + * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. + * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." + */ + uploadSarif: { + (params?: RestEndpointMethodTypes["codeScanning"]["uploadSarif"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + codesOfConduct: { + getAllCodesOfConduct: { + (params?: RestEndpointMethodTypes["codesOfConduct"]["getAllCodesOfConduct"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getConductCode: { + (params?: RestEndpointMethodTypes["codesOfConduct"]["getConductCode"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the contents of the repository's code of conduct file, if one is detected. + * + * A code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching. + */ + getForRepo: { + (params?: RestEndpointMethodTypes["codesOfConduct"]["getForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + emojis: { + /** + * Lists all the emojis available to use on GitHub. + */ + get: { + (params?: RestEndpointMethodTypes["emojis"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + enterpriseAdmin: { + /** + * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + disableSelectedOrganizationGithubActionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["disableSelectedOrganizationGithubActionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + enableSelectedOrganizationGithubActionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["enableSelectedOrganizationGithubActionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + getAllowedActionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["getAllowedActionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + getGithubActionsPermissionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["getGithubActionsPermissionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + listSelectedOrganizationsEnabledGithubActionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["listSelectedOrganizationsEnabledGithubActionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + setAllowedActionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["setAllowedActionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + setGithubActionsPermissionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["setGithubActionsPermissionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + * + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + */ + setSelectedOrganizationsEnabledGithubActionsEnterprise: { + (params?: RestEndpointMethodTypes["enterpriseAdmin"]["setSelectedOrganizationsEnabledGithubActionsEnterprise"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + gists: { + checkIsStarred: { + (params?: RestEndpointMethodTypes["gists"]["checkIsStarred"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Allows you to add a new gist with one or more files. + * + * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + */ + create: { + (params?: RestEndpointMethodTypes["gists"]["create"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + createComment: { + (params?: RestEndpointMethodTypes["gists"]["createComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + delete: { + (params?: RestEndpointMethodTypes["gists"]["delete"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteComment: { + (params?: RestEndpointMethodTypes["gists"]["deleteComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note**: This was previously `/gists/:gist_id/fork`. + */ + fork: { + (params?: RestEndpointMethodTypes["gists"]["fork"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + get: { + (params?: RestEndpointMethodTypes["gists"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getComment: { + (params?: RestEndpointMethodTypes["gists"]["getComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getRevision: { + (params?: RestEndpointMethodTypes["gists"]["getRevision"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: + */ + list: { + (params?: RestEndpointMethodTypes["gists"]["list"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listComments: { + (params?: RestEndpointMethodTypes["gists"]["listComments"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listCommits: { + (params?: RestEndpointMethodTypes["gists"]["listCommits"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists public gists for the specified user: + */ + listForUser: { + (params?: RestEndpointMethodTypes["gists"]["listForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listForks: { + (params?: RestEndpointMethodTypes["gists"]["listForks"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List public gists sorted by most recently updated to least recently updated. + * + * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + */ + listPublic: { + (params?: RestEndpointMethodTypes["gists"]["listPublic"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the authenticated user's starred gists: + */ + listStarred: { + (params?: RestEndpointMethodTypes["gists"]["listStarred"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + star: { + (params?: RestEndpointMethodTypes["gists"]["star"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + unstar: { + (params?: RestEndpointMethodTypes["gists"]["unstar"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. + */ + update: { + (params?: RestEndpointMethodTypes["gists"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateComment: { + (params?: RestEndpointMethodTypes["gists"]["updateComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + git: { + createBlob: { + (params?: RestEndpointMethodTypes["git"]["createBlob"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + createCommit: { + (params?: RestEndpointMethodTypes["git"]["createCommit"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. + */ + createRef: { + (params?: RestEndpointMethodTypes["git"]["createRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + createTag: { + (params?: RestEndpointMethodTypes["git"]["createTag"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. + * + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." + */ + createTree: { + (params?: RestEndpointMethodTypes["git"]["createTree"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteRef: { + (params?: RestEndpointMethodTypes["git"]["deleteRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The `content` in the response will always be Base64 encoded. + * + * _Note_: This API supports blobs up to 100 megabytes in size. + */ + getBlob: { + (params?: RestEndpointMethodTypes["git"]["getBlob"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + getCommit: { + (params?: RestEndpointMethodTypes["git"]["getCommit"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. + * + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + */ + getRef: { + (params?: RestEndpointMethodTypes["git"]["getRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + getTag: { + (params?: RestEndpointMethodTypes["git"]["getTag"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a single tree using the SHA1 value for that tree. + * + * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. + */ + getTree: { + (params?: RestEndpointMethodTypes["git"]["getTree"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. + * + * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. + * + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * + * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + */ + listMatchingRefs: { + (params?: RestEndpointMethodTypes["git"]["listMatchingRefs"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateRef: { + (params?: RestEndpointMethodTypes["git"]["updateRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + gitignore: { + /** + * List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). + */ + getAllTemplates: { + (params?: RestEndpointMethodTypes["gitignore"]["getAllTemplates"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The API also allows fetching the source of a single template. + * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. + */ + getTemplate: { + (params?: RestEndpointMethodTypes["gitignore"]["getTemplate"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + interactions: { + /** + * Shows which type of GitHub user can interact with your public repositories and when the restriction expires. + */ + getRestrictionsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["interactions"]["getRestrictionsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. + */ + getRestrictionsForOrg: { + (params?: RestEndpointMethodTypes["interactions"]["getRestrictionsForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. + */ + getRestrictionsForRepo: { + (params?: RestEndpointMethodTypes["interactions"]["getRestrictionsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Shows which type of GitHub user can interact with your public repositories and when the restriction expires. + * @deprecated octokit.rest.interactions.getRestrictionsForYourPublicRepos() has been renamed to octokit.rest.interactions.getRestrictionsForAuthenticatedUser() (2021-02-02) + */ + getRestrictionsForYourPublicRepos: { + (params?: RestEndpointMethodTypes["interactions"]["getRestrictionsForYourPublicRepos"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes any interaction restrictions from your public repositories. + */ + removeRestrictionsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["interactions"]["removeRestrictionsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. + */ + removeRestrictionsForOrg: { + (params?: RestEndpointMethodTypes["interactions"]["removeRestrictionsForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. + */ + removeRestrictionsForRepo: { + (params?: RestEndpointMethodTypes["interactions"]["removeRestrictionsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes any interaction restrictions from your public repositories. + * @deprecated octokit.rest.interactions.removeRestrictionsForYourPublicRepos() has been renamed to octokit.rest.interactions.removeRestrictionsForAuthenticatedUser() (2021-02-02) + */ + removeRestrictionsForYourPublicRepos: { + (params?: RestEndpointMethodTypes["interactions"]["removeRestrictionsForYourPublicRepos"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. + */ + setRestrictionsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["interactions"]["setRestrictionsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. + */ + setRestrictionsForOrg: { + (params?: RestEndpointMethodTypes["interactions"]["setRestrictionsForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. + */ + setRestrictionsForRepo: { + (params?: RestEndpointMethodTypes["interactions"]["setRestrictionsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. + * @deprecated octokit.rest.interactions.setRestrictionsForYourPublicRepos() has been renamed to octokit.rest.interactions.setRestrictionsForAuthenticatedUser() (2021-02-02) + */ + setRestrictionsForYourPublicRepos: { + (params?: RestEndpointMethodTypes["interactions"]["setRestrictionsForYourPublicRepos"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + issues: { + /** + * Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. + */ + addAssignees: { + (params?: RestEndpointMethodTypes["issues"]["addAssignees"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + addLabels: { + (params?: RestEndpointMethodTypes["issues"]["addLabels"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Checks if a user has permission to be assigned to an issue in this repository. + * + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + * + * Otherwise a `404` status code is returned. + */ + checkUserCanBeAssigned: { + (params?: RestEndpointMethodTypes["issues"]["checkUserCanBeAssigned"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + create: { + (params?: RestEndpointMethodTypes["issues"]["create"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + createComment: { + (params?: RestEndpointMethodTypes["issues"]["createComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + createLabel: { + (params?: RestEndpointMethodTypes["issues"]["createLabel"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + createMilestone: { + (params?: RestEndpointMethodTypes["issues"]["createMilestone"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteComment: { + (params?: RestEndpointMethodTypes["issues"]["deleteComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteLabel: { + (params?: RestEndpointMethodTypes["issues"]["deleteLabel"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteMilestone: { + (params?: RestEndpointMethodTypes["issues"]["deleteMilestone"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was + * [transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If + * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe + * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + get: { + (params?: RestEndpointMethodTypes["issues"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getComment: { + (params?: RestEndpointMethodTypes["issues"]["getComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getEvent: { + (params?: RestEndpointMethodTypes["issues"]["getEvent"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getLabel: { + (params?: RestEndpointMethodTypes["issues"]["getLabel"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getMilestone: { + (params?: RestEndpointMethodTypes["issues"]["getMilestone"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List issues assigned to the authenticated user across all visible repositories including owned repositories, member + * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + * necessarily assigned to you. + * + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + list: { + (params?: RestEndpointMethodTypes["issues"]["list"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + */ + listAssignees: { + (params?: RestEndpointMethodTypes["issues"]["listAssignees"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Issue Comments are ordered by ascending ID. + */ + listComments: { + (params?: RestEndpointMethodTypes["issues"]["listComments"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * By default, Issue Comments are ordered by ascending ID. + */ + listCommentsForRepo: { + (params?: RestEndpointMethodTypes["issues"]["listCommentsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listEvents: { + (params?: RestEndpointMethodTypes["issues"]["listEvents"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listEventsForRepo: { + (params?: RestEndpointMethodTypes["issues"]["listEventsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listEventsForTimeline: { + (params?: RestEndpointMethodTypes["issues"]["listEventsForTimeline"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List issues across owned and member repositories assigned to the authenticated user. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + listForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["issues"]["listForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List issues in an organization assigned to the authenticated user. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + listForOrg: { + (params?: RestEndpointMethodTypes["issues"]["listForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List issues in a repository. + * + * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * 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 + * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + */ + listForRepo: { + (params?: RestEndpointMethodTypes["issues"]["listForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listLabelsForMilestone: { + (params?: RestEndpointMethodTypes["issues"]["listLabelsForMilestone"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listLabelsForRepo: { + (params?: RestEndpointMethodTypes["issues"]["listLabelsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listLabelsOnIssue: { + (params?: RestEndpointMethodTypes["issues"]["listLabelsOnIssue"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listMilestones: { + (params?: RestEndpointMethodTypes["issues"]["listMilestones"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access can lock an issue or pull request's conversation. + * + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + lock: { + (params?: RestEndpointMethodTypes["issues"]["lock"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + removeAllLabels: { + (params?: RestEndpointMethodTypes["issues"]["removeAllLabels"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes one or more assignees from an issue. + */ + removeAssignees: { + (params?: RestEndpointMethodTypes["issues"]["removeAssignees"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. + */ + removeLabel: { + (params?: RestEndpointMethodTypes["issues"]["removeLabel"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes any previous labels and sets the new labels for an issue. + */ + setLabels: { + (params?: RestEndpointMethodTypes["issues"]["setLabels"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access can unlock an issue's conversation. + */ + unlock: { + (params?: RestEndpointMethodTypes["issues"]["unlock"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Issue owners and users with push access can edit an issue. + */ + update: { + (params?: RestEndpointMethodTypes["issues"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateComment: { + (params?: RestEndpointMethodTypes["issues"]["updateComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateLabel: { + (params?: RestEndpointMethodTypes["issues"]["updateLabel"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateMilestone: { + (params?: RestEndpointMethodTypes["issues"]["updateMilestone"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + licenses: { + get: { + (params?: RestEndpointMethodTypes["licenses"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getAllCommonlyUsed: { + (params?: RestEndpointMethodTypes["licenses"]["getAllCommonlyUsed"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This method returns the contents of the repository's license file, if one is detected. + * + * Similar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. + */ + getForRepo: { + (params?: RestEndpointMethodTypes["licenses"]["getForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + markdown: { + render: { + (params?: RestEndpointMethodTypes["markdown"]["render"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. + */ + renderRaw: { + (params?: RestEndpointMethodTypes["markdown"]["renderRaw"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + meta: { + /** + * Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)." + * + * **Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses. + */ + get: { + (params?: RestEndpointMethodTypes["meta"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get the octocat as ASCII art + */ + getOctocat: { + (params?: RestEndpointMethodTypes["meta"]["getOctocat"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get a random sentence from the Zen of GitHub + */ + getZen: { + (params?: RestEndpointMethodTypes["meta"]["getZen"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get Hypermedia links to resources accessible in GitHub's REST API + */ + root: { + (params?: RestEndpointMethodTypes["meta"]["root"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + migrations: { + /** + * Stop an import for a repository. + */ + cancelImport: { + (params?: RestEndpointMethodTypes["migrations"]["cancelImport"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. + */ + deleteArchiveForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["migrations"]["deleteArchiveForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a previous migration archive. Migration archives are automatically deleted after seven days. + */ + deleteArchiveForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["deleteArchiveForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Fetches the URL to a migration archive. + */ + downloadArchiveForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["downloadArchiveForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: + * + * * attachments + * * bases + * * commit\_comments + * * issue\_comments + * * issue\_events + * * issues + * * milestones + * * organizations + * * projects + * * protected\_branches + * * pull\_request\_reviews + * * pull\_requests + * * releases + * * repositories + * * review\_comments + * * schema + * * users + * + * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. + */ + getArchiveForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["migrations"]["getArchiveForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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 `. + * + * This endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information. + */ + getCommitAuthors: { + (params?: RestEndpointMethodTypes["migrations"]["getCommitAuthors"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * View the progress of an import. + * + * **Import status** + * + * This section includes details about the possible values of the `status` field of the Import Progress response. + * + * An import that does not have errors will progress through these steps: + * + * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. + * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). + * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. + * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". + * * `complete` - the import is complete, and the repository is ready on GitHub. + * + * If there are problems, you will see one of these in the `status` field: + * + * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information. + * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL. + * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. + * + * **The project_choices field** + * + * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. + * + * **Git LFS related fields** + * + * This section includes details about Git LFS related fields that may be present in the Import Progress response. + * + * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. + * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. + * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. + * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. + */ + getImportStatus: { + (params?: RestEndpointMethodTypes["migrations"]["getImportStatus"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List files larger than 100MB found during the import + */ + getLargeFiles: { + (params?: RestEndpointMethodTypes["migrations"]["getLargeFiles"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: + * + * * `pending` - the migration hasn't started yet. + * * `exporting` - the migration is in progress. + * * `exported` - the migration finished successfully. + * * `failed` - the migration failed. + * + * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive). + */ + getStatusForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["migrations"]["getStatusForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Fetches the status of a migration. + * + * The `state` of a migration can be one of the following values: + * + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. + */ + getStatusForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["getStatusForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all migrations a user has started. + */ + listForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["migrations"]["listForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the most recent migrations. + */ + listForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["listForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all the repositories for this organization migration. + */ + listReposForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["listReposForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all the repositories for this user migration. + */ + listReposForUser: { + (params?: RestEndpointMethodTypes["migrations"]["listReposForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. + */ + mapCommitAuthor: { + (params?: RestEndpointMethodTypes["migrations"]["mapCommitAuthor"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/). + */ + setLfsPreference: { + (params?: RestEndpointMethodTypes["migrations"]["setLfsPreference"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Initiates the generation of a user migration archive. + */ + startForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["migrations"]["startForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Initiates the generation of a migration archive. + */ + startForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["startForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Start a source import to a GitHub repository using GitHub Importer. + */ + startImport: { + (params?: RestEndpointMethodTypes["migrations"]["startImport"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#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/reference/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. + */ + unlockRepoForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["migrations"]["unlockRepoForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data. + */ + unlockRepoForOrg: { + (params?: RestEndpointMethodTypes["migrations"]["unlockRepoForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API + * request. If no parameters are provided, the import will be restarted. + */ + updateImport: { + (params?: RestEndpointMethodTypes["migrations"]["updateImport"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + orgs: { + blockUser: { + (params?: RestEndpointMethodTypes["orgs"]["blockUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). + */ + cancelInvitation: { + (params?: RestEndpointMethodTypes["orgs"]["cancelInvitation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + checkBlockedUser: { + (params?: RestEndpointMethodTypes["orgs"]["checkBlockedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Check if a user is, publicly or privately, a member of the organization. + */ + checkMembershipForUser: { + (params?: RestEndpointMethodTypes["orgs"]["checkMembershipForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + checkPublicMembershipForUser: { + (params?: RestEndpointMethodTypes["orgs"]["checkPublicMembershipForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". + */ + convertMemberToOutsideCollaborator: { + (params?: RestEndpointMethodTypes["orgs"]["convertMemberToOutsideCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + createInvitation: { + (params?: RestEndpointMethodTypes["orgs"]["createInvitation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Here's how you can create a hook that posts payloads in JSON format: + */ + createWebhook: { + (params?: RestEndpointMethodTypes["orgs"]["createWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteWebhook: { + (params?: RestEndpointMethodTypes["orgs"]["deleteWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * + * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + */ + get: { + (params?: RestEndpointMethodTypes["orgs"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getMembershipForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["orgs"]["getMembershipForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. + */ + getMembershipForUser: { + (params?: RestEndpointMethodTypes["orgs"]["getMembershipForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization)." + */ + getWebhook: { + (params?: RestEndpointMethodTypes["orgs"]["getWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook)." + * + * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + */ + getWebhookConfigForOrg: { + (params?: RestEndpointMethodTypes["orgs"]["getWebhookConfigForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all organizations, in the order that they were created on GitHub. + * + * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations. + */ + list: { + (params?: RestEndpointMethodTypes["orgs"]["list"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. + */ + listAppInstallations: { + (params?: RestEndpointMethodTypes["orgs"]["listAppInstallations"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the users blocked by an organization. + */ + listBlockedUsers: { + (params?: RestEndpointMethodTypes["orgs"]["listBlockedUsers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + */ + listFailedInvitations: { + (params?: RestEndpointMethodTypes["orgs"]["listFailedInvitations"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List organizations for the authenticated user. + * + * **OAuth scope requirements** + * + * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + */ + listForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["orgs"]["listForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. + * + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead. + */ + listForUser: { + (params?: RestEndpointMethodTypes["orgs"]["listForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. + */ + listInvitationTeams: { + (params?: RestEndpointMethodTypes["orgs"]["listInvitationTeams"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. + */ + listMembers: { + (params?: RestEndpointMethodTypes["orgs"]["listMembers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listMembershipsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["orgs"]["listMembershipsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all users who are outside collaborators of an organization. + */ + listOutsideCollaborators: { + (params?: RestEndpointMethodTypes["orgs"]["listOutsideCollaborators"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + */ + listPendingInvitations: { + (params?: RestEndpointMethodTypes["orgs"]["listPendingInvitations"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Members of an organization can choose to have their membership publicized or not. + */ + listPublicMembers: { + (params?: RestEndpointMethodTypes["orgs"]["listPublicMembers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listWebhooks: { + (params?: RestEndpointMethodTypes["orgs"]["listWebhooks"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + */ + pingWebhook: { + (params?: RestEndpointMethodTypes["orgs"]["pingWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. + */ + removeMember: { + (params?: RestEndpointMethodTypes["orgs"]["removeMember"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * In order to remove a user's membership with an organization, the authenticated user must be an organization owner. + * + * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + */ + removeMembershipForUser: { + (params?: RestEndpointMethodTypes["orgs"]["removeMembershipForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removing a user from this list will remove them from all the organization's repositories. + */ + removeOutsideCollaborator: { + (params?: RestEndpointMethodTypes["orgs"]["removeOutsideCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + removePublicMembershipForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["orgs"]["removePublicMembershipForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Only authenticated organization owners can add a member to the organization or update the member's role. + * + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * + * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. + * + * **Rate limits** + * + * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + */ + setMembershipForUser: { + (params?: RestEndpointMethodTypes["orgs"]["setMembershipForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The user can publicize their own membership. (A user cannot publicize the membership for another user.) + * + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + */ + setPublicMembershipForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["orgs"]["setPublicMembershipForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + unblockUser: { + (params?: RestEndpointMethodTypes["orgs"]["unblockUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * + * Enables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges. + */ + update: { + (params?: RestEndpointMethodTypes["orgs"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateMembershipForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["orgs"]["updateMembershipForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization)." + */ + updateWebhook: { + (params?: RestEndpointMethodTypes["orgs"]["updateWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook)." + * + * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + */ + updateWebhookConfigForOrg: { + (params?: RestEndpointMethodTypes["orgs"]["updateWebhookConfigForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + packages: { + /** + * 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. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + deletePackageForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["packages"]["deletePackageForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. + */ + deletePackageForOrg: { + (params?: RestEndpointMethodTypes["packages"]["deletePackageForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + deletePackageVersionForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["packages"]["deletePackageVersionForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. + */ + deletePackageVersionForOrg: { + (params?: RestEndpointMethodTypes["packages"]["deletePackageVersionForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns all package versions for a package owned by an organization. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + * @deprecated octokit.rest.packages.getAllPackageVersionsForAPackageOwnedByAnOrg() has been renamed to octokit.rest.packages.getAllPackageVersionsForPackageOwnedByOrg() (2021-03-24) + */ + getAllPackageVersionsForAPackageOwnedByAnOrg: { + (params?: RestEndpointMethodTypes["packages"]["getAllPackageVersionsForAPackageOwnedByAnOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns all package versions for a package owned by the authenticated user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + * @deprecated octokit.rest.packages.getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser() has been renamed to octokit.rest.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser() (2021-03-24) + */ + getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser: { + (params?: RestEndpointMethodTypes["packages"]["getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns all package versions for a package owned by the authenticated user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + getAllPackageVersionsForPackageOwnedByAuthenticatedUser: { + (params?: RestEndpointMethodTypes["packages"]["getAllPackageVersionsForPackageOwnedByAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns all package versions for a package owned by an organization. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + getAllPackageVersionsForPackageOwnedByOrg: { + (params?: RestEndpointMethodTypes["packages"]["getAllPackageVersionsForPackageOwnedByOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns all package versions for a public package owned by a specified user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + getAllPackageVersionsForPackageOwnedByUser: { + (params?: RestEndpointMethodTypes["packages"]["getAllPackageVersionsForPackageOwnedByUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific package for a package owned by the authenticated user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + getPackageForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["packages"]["getPackageForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific package in an organization. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + getPackageForOrganization: { + (params?: RestEndpointMethodTypes["packages"]["getPackageForOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific package metadata for a public package owned by a user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + getPackageForUser: { + (params?: RestEndpointMethodTypes["packages"]["getPackageForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific package version for a package owned by the authenticated user. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + getPackageVersionForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["packages"]["getPackageVersionForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific package version in an organization. + * + * You must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + getPackageVersionForOrganization: { + (params?: RestEndpointMethodTypes["packages"]["getPackageVersionForOrganization"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a specific package version for a public package owned by a specified user. + * + * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope. + * If `package_type` is not `container`, your token must also include the `repo` scope. + */ + getPackageVersionForUser: { + (params?: RestEndpointMethodTypes["packages"]["getPackageVersionForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Restores a package owned by the authenticated user. + * + * You can restore a deleted package under the following conditions: + * - The package was deleted within the last 30 days. + * - 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. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scope. If `package_type` is not `container`, your token must also include the `repo` scope. + */ + restorePackageForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["packages"]["restorePackageForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Restores an entire package in an organization. + * + * You can restore a deleted package under the following conditions: + * - The package was deleted within the last 30 days. + * - 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scope. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. + */ + restorePackageForOrg: { + (params?: RestEndpointMethodTypes["packages"]["restorePackageForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Restores a package version owned by the authenticated user. + * + * You can restore a deleted package version under the following conditions: + * - The package was deleted within the last 30 days. + * - 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. + * + * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scope. If `package_type` is not `container`, your token must also include the `repo` scope. + */ + restorePackageVersionForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["packages"]["restorePackageVersionForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Restores a specific package version in an organization. + * + * You can restore a deleted package under the following conditions: + * - The package was deleted within the last 30 days. + * - 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. + * + * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scope. In addition: + * - If `package_type` is not `container`, your token must also include the `repo` scope. + * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. + */ + restorePackageVersionForOrg: { + (params?: RestEndpointMethodTypes["packages"]["restorePackageVersionForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + projects: { + /** + * Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. + */ + addCollaborator: { + (params?: RestEndpointMethodTypes["projects"]["addCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + createCard: { + (params?: RestEndpointMethodTypes["projects"]["createCard"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + createColumn: { + (params?: RestEndpointMethodTypes["projects"]["createColumn"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + createForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["projects"]["createForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + createForOrg: { + (params?: RestEndpointMethodTypes["projects"]["createForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + createForRepo: { + (params?: RestEndpointMethodTypes["projects"]["createForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a project board. Returns a `404 Not Found` status if projects are disabled. + */ + delete: { + (params?: RestEndpointMethodTypes["projects"]["delete"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteCard: { + (params?: RestEndpointMethodTypes["projects"]["deleteCard"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteColumn: { + (params?: RestEndpointMethodTypes["projects"]["deleteColumn"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + get: { + (params?: RestEndpointMethodTypes["projects"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getCard: { + (params?: RestEndpointMethodTypes["projects"]["getCard"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getColumn: { + (params?: RestEndpointMethodTypes["projects"]["getColumn"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. + */ + getPermissionForUser: { + (params?: RestEndpointMethodTypes["projects"]["getPermissionForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listCards: { + (params?: RestEndpointMethodTypes["projects"]["listCards"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. + */ + listCollaborators: { + (params?: RestEndpointMethodTypes["projects"]["listCollaborators"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listColumns: { + (params?: RestEndpointMethodTypes["projects"]["listColumns"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + listForOrg: { + (params?: RestEndpointMethodTypes["projects"]["listForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + listForRepo: { + (params?: RestEndpointMethodTypes["projects"]["listForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listForUser: { + (params?: RestEndpointMethodTypes["projects"]["listForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + moveCard: { + (params?: RestEndpointMethodTypes["projects"]["moveCard"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + moveColumn: { + (params?: RestEndpointMethodTypes["projects"]["moveColumn"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. + */ + removeCollaborator: { + (params?: RestEndpointMethodTypes["projects"]["removeCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + */ + update: { + (params?: RestEndpointMethodTypes["projects"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateCard: { + (params?: RestEndpointMethodTypes["projects"]["updateCard"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateColumn: { + (params?: RestEndpointMethodTypes["projects"]["updateColumn"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + pulls: { + checkIfMerged: { + (params?: RestEndpointMethodTypes["pulls"]["checkIfMerged"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + * + * You can create a new pull request. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + create: { + (params?: RestEndpointMethodTypes["pulls"]["create"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + createReplyForReviewComment: { + (params?: RestEndpointMethodTypes["pulls"]["createReplyForReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * Pull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response. + * + * **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 v3 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. + * + * 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. + */ + createReview: { + (params?: RestEndpointMethodTypes["pulls"]["createReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. + * + * You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices). + * + * **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. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + createReviewComment: { + (params?: RestEndpointMethodTypes["pulls"]["createReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deletePendingReview: { + (params?: RestEndpointMethodTypes["pulls"]["deletePendingReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a review comment. + */ + deleteReviewComment: { + (params?: RestEndpointMethodTypes["pulls"]["deleteReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + */ + dismissReview: { + (params?: RestEndpointMethodTypes["pulls"]["dismissReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists details of a pull request by providing its number. + * + * When you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * + * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. + * + * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: + * + * * If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * + * 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. + */ + get: { + (params?: RestEndpointMethodTypes["pulls"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getReview: { + (params?: RestEndpointMethodTypes["pulls"]["getReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Provides details for a review comment. + */ + getReviewComment: { + (params?: RestEndpointMethodTypes["pulls"]["getReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + list: { + (params?: RestEndpointMethodTypes["pulls"]["list"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List comments for a specific pull request review. + */ + listCommentsForReview: { + (params?: RestEndpointMethodTypes["pulls"]["listCommentsForReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint. + */ + listCommits: { + (params?: RestEndpointMethodTypes["pulls"]["listCommits"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. + */ + listFiles: { + (params?: RestEndpointMethodTypes["pulls"]["listFiles"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listRequestedReviewers: { + (params?: RestEndpointMethodTypes["pulls"]["listRequestedReviewers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all review comments for a pull request. By default, review comments are in ascending order by ID. + */ + listReviewComments: { + (params?: RestEndpointMethodTypes["pulls"]["listReviewComments"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. + */ + listReviewCommentsForRepo: { + (params?: RestEndpointMethodTypes["pulls"]["listReviewCommentsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The list of reviews returns in chronological order. + */ + listReviews: { + (params?: RestEndpointMethodTypes["pulls"]["listReviews"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + merge: { + (params?: RestEndpointMethodTypes["pulls"]["merge"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + removeRequestedReviewers: { + (params?: RestEndpointMethodTypes["pulls"]["removeRequestedReviewers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + */ + requestReviewers: { + (params?: RestEndpointMethodTypes["pulls"]["requestReviewers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + submitReview: { + (params?: RestEndpointMethodTypes["pulls"]["submitReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + */ + update: { + (params?: RestEndpointMethodTypes["pulls"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + */ + updateBranch: { + (params?: RestEndpointMethodTypes["pulls"]["updateBranch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Update the review summary comment with new text. + */ + updateReview: { + (params?: RestEndpointMethodTypes["pulls"]["updateReview"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Enables you to edit a review comment. + */ + updateReviewComment: { + (params?: RestEndpointMethodTypes["pulls"]["updateReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + rateLimit: { + /** + * **Note:** Accessing this endpoint does not count against your REST API rate limit. + * + * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + */ + get: { + (params?: RestEndpointMethodTypes["rateLimit"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + reactions: { + /** + * Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + */ + createForCommitComment: { + (params?: RestEndpointMethodTypes["reactions"]["createForCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue. + */ + createForIssue: { + (params?: RestEndpointMethodTypes["reactions"]["createForIssue"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + */ + createForIssueComment: { + (params?: RestEndpointMethodTypes["reactions"]["createForIssueComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + */ + createForPullRequestReviewComment: { + (params?: RestEndpointMethodTypes["reactions"]["createForPullRequestReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release. + */ + createForRelease: { + (params?: RestEndpointMethodTypes["reactions"]["createForRelease"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + */ + createForTeamDiscussionCommentInOrg: { + (params?: RestEndpointMethodTypes["reactions"]["createForTeamDiscussionCommentInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + */ + createForTeamDiscussionInOrg: { + (params?: RestEndpointMethodTypes["reactions"]["createForTeamDiscussionInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * + * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + */ + deleteForCommitComment: { + (params?: RestEndpointMethodTypes["reactions"]["deleteForCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * + * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + */ + deleteForIssue: { + (params?: RestEndpointMethodTypes["reactions"]["deleteForIssue"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * + * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + */ + deleteForIssueComment: { + (params?: RestEndpointMethodTypes["reactions"]["deleteForIssueComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * + * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + */ + deleteForPullRequestComment: { + (params?: RestEndpointMethodTypes["reactions"]["deleteForPullRequestComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * + * Delete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + deleteForTeamDiscussion: { + (params?: RestEndpointMethodTypes["reactions"]["deleteForTeamDiscussion"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + deleteForTeamDiscussionComment: { + (params?: RestEndpointMethodTypes["reactions"]["deleteForTeamDiscussionComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). + * + * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). + * @deprecated octokit.rest.reactions.deleteLegacy() is deprecated, see https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy + */ + deleteLegacy: { + (params?: RestEndpointMethodTypes["reactions"]["deleteLegacy"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + */ + listForCommitComment: { + (params?: RestEndpointMethodTypes["reactions"]["listForCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the reactions to an [issue](https://docs.github.com/rest/reference/issues). + */ + listForIssue: { + (params?: RestEndpointMethodTypes["reactions"]["listForIssue"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + */ + listForIssueComment: { + (params?: RestEndpointMethodTypes["reactions"]["listForIssueComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + */ + listForPullRequestReviewComment: { + (params?: RestEndpointMethodTypes["reactions"]["listForPullRequestReviewComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + */ + listForTeamDiscussionCommentInOrg: { + (params?: RestEndpointMethodTypes["reactions"]["listForTeamDiscussionCommentInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + */ + listForTeamDiscussionInOrg: { + (params?: RestEndpointMethodTypes["reactions"]["listForTeamDiscussionInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + repos: { + acceptInvitation: { + (params?: RestEndpointMethodTypes["repos"]["acceptInvitation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `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. | + */ + addAppAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["addAppAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * For more information the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations). + * + * **Rate limits** + * + * To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. + */ + addCollaborator: { + (params?: RestEndpointMethodTypes["repos"]["addCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + addStatusCheckContexts: { + (params?: RestEndpointMethodTypes["repos"]["addStatusCheckContexts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified teams push access for this branch. You can also give push access to child teams. + * + * | Type | Description | + * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | + * | `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. | + */ + addTeamAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["addTeamAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Grants the specified people push access for this branch. + * + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + addUserAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["addUserAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + * + * Team members will include the members of child teams. + */ + checkCollaborator: { + (params?: RestEndpointMethodTypes["repos"]["checkCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + */ + checkVulnerabilityAlerts: { + (params?: RestEndpointMethodTypes["repos"]["checkVulnerabilityAlerts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. + * + * The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. 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. + * + * The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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. + * + * **Working with large comparisons** + * + * To process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)." + * + * When calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + compareCommits: { + (params?: RestEndpointMethodTypes["repos"]["compareCommits"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`. + * + * The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. 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. + * + * The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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. + * + * **Working with large comparisons** + * + * To process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)." + * + * When calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + compareCommitsWithBasehead: { + (params?: RestEndpointMethodTypes["repos"]["compareCommitsWithBasehead"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a comment for a commit using its `:commit_sha`. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + createCommitComment: { + (params?: RestEndpointMethodTypes["repos"]["createCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. + */ + createCommitSignatureProtection: { + (params?: RestEndpointMethodTypes["repos"]["createCommitSignatureProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access in a repository can create commit statuses for a given SHA. + * + * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + */ + createCommitStatus: { + (params?: RestEndpointMethodTypes["repos"]["createCommitStatus"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You can create a read-only deploy key. + */ + createDeployKey: { + (params?: RestEndpointMethodTypes["repos"]["createDeployKey"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deployments offer a few configurable parameters with certain defaults. + * + * The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them + * before we merge a pull request. + * + * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have + * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter + * makes it easier to track which environments have requested deployments. The default environment is `production`. + * + * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If + * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, + * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will + * return a failure response. + * + * By default, [commit statuses](https://docs.github.com/rest/reference/repos#statuses) for every submitted context must be in a `success` + * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to + * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do + * not require any contexts or create any commit statuses, the deployment will always succeed. + * + * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text + * field that will be passed on when a deployment event is dispatched. + * + * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might + * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an + * application with debugging enabled. + * + * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. + * + * #### Merged branch response + * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating + * a deployment. This auto-merge happens when: + * * Auto-merge option is enabled in the repository + * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example + * * There are no merge conflicts + * + * If there are no new commits in the base branch, a new request to create a deployment should give a successful + * response. + * + * #### Merge conflict response + * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + * + * #### Failed commit status checks + * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` + * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + */ + createDeployment: { + (params?: RestEndpointMethodTypes["repos"]["createDeployment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with `push` access can create deployment statuses for a given deployment. + * + * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. + */ + createDeploymentStatus: { + (params?: RestEndpointMethodTypes["repos"]["createDeploymentStatus"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." + * + * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. + * + * This endpoint requires write access to the repository by providing either: + * + * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. + * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. + * + * This input example shows how you can use the `client_payload` as a test to debug your workflow. + */ + createDispatchEvent: { + (params?: RestEndpointMethodTypes["repos"]["createDispatchEvent"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a new repository for the authenticated user. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. + * * `repo` scope to create a private repository. + */ + createForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["repos"]["createForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create a fork for the authenticated user. + * + * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com). + */ + createFork: { + (params?: RestEndpointMethodTypes["repos"]["createFork"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a new repository in the specified organization. The authenticated user must be a member of the organization. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. + * * `repo` scope to create a private repository + */ + createInOrg: { + (params?: RestEndpointMethodTypes["repos"]["createInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." + * + * **Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see "[Environments](/actions/reference/environments#deployment-branches)." + * + * **Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)." + * + * You must authenticate using an access token with the repo scope to use this endpoint. + */ + createOrUpdateEnvironment: { + (params?: RestEndpointMethodTypes["repos"]["createOrUpdateEnvironment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a new file or replaces an existing file in a repository. + */ + createOrUpdateFileContents: { + (params?: RestEndpointMethodTypes["repos"]["createOrUpdateFileContents"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." + */ + createPagesSite: { + (params?: RestEndpointMethodTypes["repos"]["createPagesSite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access to the repository can create a release. + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + */ + createRelease: { + (params?: RestEndpointMethodTypes["repos"]["createRelease"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + * + * **OAuth scope requirements** + * + * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * + * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. + * * `repo` scope to create a private repository + */ + createUsingTemplate: { + (params?: RestEndpointMethodTypes["repos"]["createUsingTemplate"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can + * share the same `config` as long as those webhooks do not have any `events` that overlap. + */ + createWebhook: { + (params?: RestEndpointMethodTypes["repos"]["createWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + declineInvitation: { + (params?: RestEndpointMethodTypes["repos"]["declineInvitation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + * + * If an organization owner has configured the organization to prevent members from deleting organization-owned + * repositories, you will get a `403 Forbidden` response. + */ + delete: { + (params?: RestEndpointMethodTypes["repos"]["delete"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Disables the ability to restrict who can push to this branch. + */ + deleteAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["deleteAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + */ + deleteAdminBranchProtection: { + (params?: RestEndpointMethodTypes["repos"]["deleteAdminBranchProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You must authenticate using an access token with the repo scope to use this endpoint. + */ + deleteAnEnvironment: { + (params?: RestEndpointMethodTypes["repos"]["deleteAnEnvironment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + deleteBranchProtection: { + (params?: RestEndpointMethodTypes["repos"]["deleteBranchProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteCommitComment: { + (params?: RestEndpointMethodTypes["repos"]["deleteCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. + */ + deleteCommitSignatureProtection: { + (params?: RestEndpointMethodTypes["repos"]["deleteCommitSignatureProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. + */ + deleteDeployKey: { + (params?: RestEndpointMethodTypes["repos"]["deleteDeployKey"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment. + * + * To set a deployment as inactive, you must: + * + * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. + * * Mark the active deployment as inactive by adding any non-successful deployment status. + * + * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)." + */ + deleteDeployment: { + (params?: RestEndpointMethodTypes["repos"]["deleteDeployment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a file in a repository. + * + * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. + * + * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. + * + * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + */ + deleteFile: { + (params?: RestEndpointMethodTypes["repos"]["deleteFile"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteInvitation: { + (params?: RestEndpointMethodTypes["repos"]["deleteInvitation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deletePagesSite: { + (params?: RestEndpointMethodTypes["repos"]["deletePagesSite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + deletePullRequestReviewProtection: { + (params?: RestEndpointMethodTypes["repos"]["deletePullRequestReviewProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access to the repository can delete a release. + */ + deleteRelease: { + (params?: RestEndpointMethodTypes["repos"]["deleteRelease"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteReleaseAsset: { + (params?: RestEndpointMethodTypes["repos"]["deleteReleaseAsset"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + deleteWebhook: { + (params?: RestEndpointMethodTypes["repos"]["deleteWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/en/articles/configuring-automated-security-fixes)". + */ + disableAutomatedSecurityFixes: { + (params?: RestEndpointMethodTypes["repos"]["disableAutomatedSecurityFixes"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Disables 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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + */ + disableVulnerabilityAlerts: { + (params?: RestEndpointMethodTypes["repos"]["disableVulnerabilityAlerts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually + * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + * the `Location` header to make a second `GET` request. + * **Note**: For private repositories, these links are temporary and expire after five minutes. + * @deprecated octokit.rest.repos.downloadArchive() has been renamed to octokit.rest.repos.downloadZipballArchive() (2020-09-17) + */ + downloadArchive: { + (params?: RestEndpointMethodTypes["repos"]["downloadArchive"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually + * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + * the `Location` header to make a second `GET` request. + * **Note**: For private repositories, these links are temporary and expire after five minutes. + */ + downloadTarballArchive: { + (params?: RestEndpointMethodTypes["repos"]["downloadTarballArchive"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually + * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + * the `Location` header to make a second `GET` request. + * **Note**: For private repositories, these links are temporary and expire after five minutes. + */ + downloadZipballArchive: { + (params?: RestEndpointMethodTypes["repos"]["downloadZipballArchive"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/en/articles/configuring-automated-security-fixes)". + */ + enableAutomatedSecurityFixes: { + (params?: RestEndpointMethodTypes["repos"]["enableAutomatedSecurityFixes"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)". + */ + enableVulnerabilityAlerts: { + (params?: RestEndpointMethodTypes["repos"]["enableVulnerabilityAlerts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file. + * + * 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. + */ + get: { + (params?: RestEndpointMethodTypes["repos"]["get"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists who has access to this protected branch. + * + * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + */ + getAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["getAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + getAdminBranchProtection: { + (params?: RestEndpointMethodTypes["repos"]["getAdminBranchProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get all environments for 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. + */ + getAllEnvironments: { + (params?: RestEndpointMethodTypes["repos"]["getAllEnvironments"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + getAllStatusCheckContexts: { + (params?: RestEndpointMethodTypes["repos"]["getAllStatusCheckContexts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getAllTopics: { + (params?: RestEndpointMethodTypes["repos"]["getAllTopics"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + */ + getAppsWithAccessToProtectedBranch: { + (params?: RestEndpointMethodTypes["repos"]["getAppsWithAccessToProtectedBranch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getBranch: { + (params?: RestEndpointMethodTypes["repos"]["getBranch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + getBranchProtection: { + (params?: RestEndpointMethodTypes["repos"]["getBranchProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + */ + getClones: { + (params?: RestEndpointMethodTypes["repos"]["getClones"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + */ + getCodeFrequencyStats: { + (params?: RestEndpointMethodTypes["repos"]["getCodeFrequencyStats"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. + */ + getCollaboratorPermissionLevel: { + (params?: RestEndpointMethodTypes["repos"]["getCollaboratorPermissionLevel"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. + * + * The most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts. + * + * Additionally, a combined `state` is returned. The `state` is one of: + * + * * **failure** if any of the contexts report as `error` or `failure` + * * **pending** if there are no statuses or a context is `pending` + * * **success** if the latest status for all contexts is `success` + */ + getCombinedStatusForRef: { + (params?: RestEndpointMethodTypes["repos"]["getCombinedStatusForRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. + * + * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * + * 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. Diffs with binary data will have no `patch` property. + * + * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + getCommit: { + (params?: RestEndpointMethodTypes["repos"]["getCommit"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. + */ + getCommitActivityStats: { + (params?: RestEndpointMethodTypes["repos"]["getCommitActivityStats"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getCommitComment: { + (params?: RestEndpointMethodTypes["repos"]["getCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help. + * + * **Note**: You must enable branch protection to require signed commits. + */ + getCommitSignatureProtection: { + (params?: RestEndpointMethodTypes["repos"]["getCommitSignatureProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint will return all community profile metrics, including an + * overall health score, repository description, the presence of documentation, detected + * code of conduct, detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE, + * README, and CONTRIBUTING files. + * + * The `health_percentage` score is defined as a percentage of how many of + * these four documents are present: README, CONTRIBUTING, LICENSE, and + * CODE_OF_CONDUCT. For example, if all four documents are present, then + * the `health_percentage` is `100`. If only one is present, then the + * `health_percentage` is `25`. + * + * `content_reports_enabled` is only returned for organization-owned repositories. + */ + getCommunityProfileMetrics: { + (params?: RestEndpointMethodTypes["repos"]["getCommunityProfileMetrics"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit + * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. + * + * Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for + * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media + * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent + * object format. + * + * **Note**: + * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). + * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees + * API](https://docs.github.com/rest/reference/git#get-a-tree). + * * This API supports files up to 1 megabyte in size. + * + * #### If the content is a directory + * The response will be an array of objects, one object for each item in the directory. + * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value + * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). + * In the next major version of the API, the type will be returned as "submodule". + * + * #### If the content is a symlink + * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the + * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object + * describing the symlink itself. + * + * #### If the content is a submodule + * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific + * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out + * the submodule at that specific commit. + * + * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the + * github.com URLs (`html_url` and `_links["html"]`) will have null values. + */ + getContent: { + (params?: RestEndpointMethodTypes["repos"]["getContent"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: + * + * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits + */ + getContributorsStats: { + (params?: RestEndpointMethodTypes["repos"]["getContributorsStats"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getDeployKey: { + (params?: RestEndpointMethodTypes["repos"]["getDeployKey"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getDeployment: { + (params?: RestEndpointMethodTypes["repos"]["getDeployment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with pull access can view a deployment status for a deployment: + */ + getDeploymentStatus: { + (params?: RestEndpointMethodTypes["repos"]["getDeploymentStatus"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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. + */ + getEnvironment: { + (params?: RestEndpointMethodTypes["repos"]["getEnvironment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getLatestPagesBuild: { + (params?: RestEndpointMethodTypes["repos"]["getLatestPagesBuild"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * View the latest published full release for the repository. + * + * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + */ + getLatestRelease: { + (params?: RestEndpointMethodTypes["repos"]["getLatestRelease"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getPages: { + (params?: RestEndpointMethodTypes["repos"]["getPages"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + getPagesBuild: { + (params?: RestEndpointMethodTypes["repos"]["getPagesBuild"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. + * + * 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. + * + * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint. + */ + getPagesHealthCheck: { + (params?: RestEndpointMethodTypes["repos"]["getPagesHealthCheck"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. + * + * The array order is oldest week (index 0) to most recent week. + */ + getParticipationStats: { + (params?: RestEndpointMethodTypes["repos"]["getParticipationStats"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + getPullRequestReviewProtection: { + (params?: RestEndpointMethodTypes["repos"]["getPullRequestReviewProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Each array contains the day number, hour number, and number of commits: + * + * * `0-6`: Sunday - Saturday + * * `0-23`: Hour of day + * * Number of commits + * + * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + */ + getPunchCardStats: { + (params?: RestEndpointMethodTypes["repos"]["getPunchCardStats"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the preferred README for a repository. + * + * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + */ + getReadme: { + (params?: RestEndpointMethodTypes["repos"]["getReadme"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets the README from a repository directory. + * + * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + */ + getReadmeInDirectory: { + (params?: RestEndpointMethodTypes["repos"]["getReadmeInDirectory"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). + */ + getRelease: { + (params?: RestEndpointMethodTypes["repos"]["getRelease"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + */ + getReleaseAsset: { + (params?: RestEndpointMethodTypes["repos"]["getReleaseAsset"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get a published release with the specified tag. + */ + getReleaseByTag: { + (params?: RestEndpointMethodTypes["repos"]["getReleaseByTag"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + getStatusChecksProtection: { + (params?: RestEndpointMethodTypes["repos"]["getStatusChecksProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the teams who have push access to this branch. The list includes child teams. + */ + getTeamsWithAccessToProtectedBranch: { + (params?: RestEndpointMethodTypes["repos"]["getTeamsWithAccessToProtectedBranch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get the top 10 popular contents over the last 14 days. + */ + getTopPaths: { + (params?: RestEndpointMethodTypes["repos"]["getTopPaths"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get the top 10 referrers over the last 14 days. + */ + getTopReferrers: { + (params?: RestEndpointMethodTypes["repos"]["getTopReferrers"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Lists the people who have push access to this branch. + */ + getUsersWithAccessToProtectedBranch: { + (params?: RestEndpointMethodTypes["repos"]["getUsersWithAccessToProtectedBranch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get the total number of views 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. + */ + getViews: { + (params?: RestEndpointMethodTypes["repos"]["getViews"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository)." + */ + getWebhook: { + (params?: RestEndpointMethodTypes["repos"]["getWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook)." + * + * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + */ + getWebhookConfigForRepo: { + (params?: RestEndpointMethodTypes["repos"]["getWebhookConfigForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listBranches: { + (params?: RestEndpointMethodTypes["repos"]["listBranches"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + */ + listBranchesForHeadCommit: { + (params?: RestEndpointMethodTypes["repos"]["listBranchesForHeadCommit"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + * + * Team members will include the members of child teams. + */ + listCollaborators: { + (params?: RestEndpointMethodTypes["repos"]["listCollaborators"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Use the `:commit_sha` to specify the commit that will have its comments listed. + */ + listCommentsForCommit: { + (params?: RestEndpointMethodTypes["repos"]["listCommentsForCommit"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * + * Comments are ordered by ascending ID. + */ + listCommitCommentsForRepo: { + (params?: RestEndpointMethodTypes["repos"]["listCommitCommentsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. + * + * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + */ + listCommitStatusesForRef: { + (params?: RestEndpointMethodTypes["repos"]["listCommitStatusesForRef"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Signature verification object** + * + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + */ + listCommits: { + (params?: RestEndpointMethodTypes["repos"]["listCommits"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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 v3 caches contributor data to improve performance. + * + * 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. + */ + listContributors: { + (params?: RestEndpointMethodTypes["repos"]["listContributors"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listDeployKeys: { + (params?: RestEndpointMethodTypes["repos"]["listDeployKeys"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with pull access can view deployment statuses for a deployment: + */ + listDeploymentStatuses: { + (params?: RestEndpointMethodTypes["repos"]["listDeploymentStatuses"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Simple filtering of deployments is available via query parameters: + */ + listDeployments: { + (params?: RestEndpointMethodTypes["repos"]["listDeployments"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. + * + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + */ + listForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["repos"]["listForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists repositories for the specified organization. + */ + listForOrg: { + (params?: RestEndpointMethodTypes["repos"]["listForOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. + */ + listForUser: { + (params?: RestEndpointMethodTypes["repos"]["listForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listForks: { + (params?: RestEndpointMethodTypes["repos"]["listForks"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. + */ + listInvitations: { + (params?: RestEndpointMethodTypes["repos"]["listInvitations"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * When authenticating as a user, this endpoint will list all currently open repository invitations for that user. + */ + listInvitationsForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["repos"]["listInvitationsForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. + */ + listLanguages: { + (params?: RestEndpointMethodTypes["repos"]["listLanguages"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listPagesBuilds: { + (params?: RestEndpointMethodTypes["repos"]["listPagesBuilds"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all public repositories in the order that they were created. + * + * Note: + * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories. + */ + listPublic: { + (params?: RestEndpointMethodTypes["repos"]["listPublic"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint. + */ + listPullRequestsAssociatedWithCommit: { + (params?: RestEndpointMethodTypes["repos"]["listPullRequestsAssociatedWithCommit"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listReleaseAssets: { + (params?: RestEndpointMethodTypes["repos"]["listReleaseAssets"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags). + * + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + */ + listReleases: { + (params?: RestEndpointMethodTypes["repos"]["listReleases"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listTags: { + (params?: RestEndpointMethodTypes["repos"]["listTags"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listTeams: { + (params?: RestEndpointMethodTypes["repos"]["listTeams"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + listWebhooks: { + (params?: RestEndpointMethodTypes["repos"]["listWebhooks"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + merge: { + (params?: RestEndpointMethodTypes["repos"]["merge"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + */ + pingWebhook: { + (params?: RestEndpointMethodTypes["repos"]["pingWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `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. | + */ + removeAppAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["removeAppAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + removeCollaborator: { + (params?: RestEndpointMethodTypes["repos"]["removeCollaborator"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + removeStatusCheckContexts: { + (params?: RestEndpointMethodTypes["repos"]["removeStatusCheckContexts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + removeStatusCheckProtection: { + (params?: RestEndpointMethodTypes["repos"]["removeStatusCheckProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of a team to push to this branch. You can also remove push access for child teams. + * + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `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. | + */ + removeTeamAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["removeTeamAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Removes the ability of a user to push to this branch. + * + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + removeUserAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["removeUserAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Renames a branch in a repository. + * + * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + * + * The permissions required to use this endpoint depends on whether you are renaming the default branch. + * + * To rename a non-default branch: + * + * * Users must have push access. + * * GitHub Apps must have the `contents:write` repository permission. + * + * To rename the default branch: + * + * * Users must have admin or owner permissions. + * * GitHub Apps must have the `administration:write` repository permission. + */ + renameBranch: { + (params?: RestEndpointMethodTypes["repos"]["renameBranch"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + replaceAllTopics: { + (params?: RestEndpointMethodTypes["repos"]["replaceAllTopics"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. + * + * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + */ + requestPagesBuild: { + (params?: RestEndpointMethodTypes["repos"]["requestPagesBuild"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + */ + setAdminBranchProtection: { + (params?: RestEndpointMethodTypes["repos"]["setAdminBranchProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * + * | Type | Description | + * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + * | `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. | + */ + setAppAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["setAppAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + */ + setStatusCheckContexts: { + (params?: RestEndpointMethodTypes["repos"]["setStatusCheckContexts"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. + * + * | Type | Description | + * | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | + * | `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. | + */ + setTeamAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["setTeamAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. + * + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + */ + setUserAccessRestrictions: { + (params?: RestEndpointMethodTypes["repos"]["setUserAccessRestrictions"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. + * + * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + */ + testPushWebhook: { + (params?: RestEndpointMethodTypes["repos"]["testPushWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/). + */ + transfer: { + (params?: RestEndpointMethodTypes["repos"]["transfer"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint. + */ + update: { + (params?: RestEndpointMethodTypes["repos"]["update"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Protecting a branch requires admin or owner permissions to the repository. + * + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * + * **Note**: The list of users, apps, and teams in total is limited to 100 items. + */ + updateBranchProtection: { + (params?: RestEndpointMethodTypes["repos"]["updateBranchProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateCommitComment: { + (params?: RestEndpointMethodTypes["repos"]["updateCommitComment"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). + */ + updateInformationAboutPagesSite: { + (params?: RestEndpointMethodTypes["repos"]["updateInformationAboutPagesSite"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + updateInvitation: { + (params?: RestEndpointMethodTypes["repos"]["updateInvitation"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + */ + updatePullRequestReviewProtection: { + (params?: RestEndpointMethodTypes["repos"]["updatePullRequestReviewProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access to the repository can edit a release. + */ + updateRelease: { + (params?: RestEndpointMethodTypes["repos"]["updateRelease"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Users with push access to the repository can edit a release asset. + */ + updateReleaseAsset: { + (params?: RestEndpointMethodTypes["repos"]["updateReleaseAsset"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + * @deprecated octokit.rest.repos.updateStatusCheckPotection() has been renamed to octokit.rest.repos.updateStatusCheckProtection() (2020-09-17) + */ + updateStatusCheckPotection: { + (params?: RestEndpointMethodTypes["repos"]["updateStatusCheckPotection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + */ + updateStatusCheckProtection: { + (params?: RestEndpointMethodTypes["repos"]["updateStatusCheckProtection"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository)." + */ + updateWebhook: { + (params?: RestEndpointMethodTypes["repos"]["updateWebhook"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook)." + * + * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + */ + updateWebhookConfigForRepo: { + (params?: RestEndpointMethodTypes["repos"]["updateWebhookConfigForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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 + * the response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset. + * + * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. + * + * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: + * + * `application/zip` + * + * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, + * you'll still need to pass your authentication to be able to upload an asset. + * + * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. + * + * **Notes:** + * * 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)" + * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact). + * * 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. + */ + uploadReleaseAsset: { + (params?: RestEndpointMethodTypes["repos"]["uploadReleaseAsset"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + search: { + /** + * Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: + * + * `q=addClass+in:file+language:js+repo:jquery/jquery` + * + * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. + * + * #### Considerations for code search + * + * Due to the complexity of searching code, there are a few restrictions on how searches are performed: + * + * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. + * * Only files smaller than 384 KB are searchable. + * * 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 + * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. + */ + code: { + (params?: RestEndpointMethodTypes["search"]["code"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * 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 + * metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: + * + * `q=repo:octocat/Spoon-Knife+css` + */ + commits: { + (params?: RestEndpointMethodTypes["search"]["commits"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted + * search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. + * + * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + * + * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. + * + * **Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + */ + issuesAndPullRequests: { + (params?: RestEndpointMethodTypes["search"]["issuesAndPullRequests"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: + * + * `q=bug+defect+enhancement&repository_id=64778136` + * + * The labels that best match the query appear first in the search results. + */ + labels: { + (params?: RestEndpointMethodTypes["search"]["labels"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: + * + * `q=tetris+language:assembly&sort=stars&order=desc` + * + * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + * + * When you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this: + * + * `q=topic:ruby+topic:rails` + */ + repos: { + (params?: RestEndpointMethodTypes["search"]["repos"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://help.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + * + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: + * + * `q=ruby+is:featured` + * + * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + */ + topics: { + (params?: RestEndpointMethodTypes["search"]["topics"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * + * When searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * + * For example, if you're looking for a list of popular users, you might try this query: + * + * `q=tom+repos:%3E42+followers:%3E1000` + * + * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + */ + users: { + (params?: RestEndpointMethodTypes["search"]["users"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + secretScanning: { + /** + * Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + */ + getAlert: { + (params?: RestEndpointMethodTypes["secretScanning"]["getAlert"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + */ + listAlertsForRepo: { + (params?: RestEndpointMethodTypes["secretScanning"]["listAlertsForRepo"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. + * + * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + */ + updateAlert: { + (params?: RestEndpointMethodTypes["secretScanning"]["updateAlert"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + teams: { + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. + * + * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + */ + addOrUpdateMembershipForUserInOrg: { + (params?: RestEndpointMethodTypes["teams"]["addOrUpdateMembershipForUserInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + addOrUpdateProjectPermissionsInOrg: { + (params?: RestEndpointMethodTypes["teams"]["addOrUpdateProjectPermissionsInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * + * For more information about the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + */ + addOrUpdateRepoPermissionsInOrg: { + (params?: RestEndpointMethodTypes["teams"]["addOrUpdateRepoPermissionsInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + checkPermissionsForProjectInOrg: { + (params?: RestEndpointMethodTypes["teams"]["checkPermissionsForProjectInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. + * + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * + * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + */ + checkPermissionsForRepoInOrg: { + (params?: RestEndpointMethodTypes["teams"]["checkPermissionsForRepoInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." + * + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)". + */ + create: { + (params?: RestEndpointMethodTypes["teams"]["create"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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/). + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + */ + createDiscussionCommentInOrg: { + (params?: RestEndpointMethodTypes["teams"]["createDiscussionCommentInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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/). + * + * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + */ + createDiscussionInOrg: { + (params?: RestEndpointMethodTypes["teams"]["createDiscussionInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Deletes a 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/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + deleteDiscussionCommentInOrg: { + (params?: RestEndpointMethodTypes["teams"]["deleteDiscussionCommentInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Delete a discussion from 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/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + deleteDiscussionInOrg: { + (params?: RestEndpointMethodTypes["teams"]["deleteDiscussionInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To delete a team, the authenticated user must be an organization owner or team maintainer. + * + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + */ + deleteInOrg: { + (params?: RestEndpointMethodTypes["teams"]["deleteInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + */ + getByName: { + (params?: RestEndpointMethodTypes["teams"]["getByName"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + getDiscussionCommentInOrg: { + (params?: RestEndpointMethodTypes["teams"]["getDiscussionCommentInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + getDiscussionInOrg: { + (params?: RestEndpointMethodTypes["teams"]["getDiscussionInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Team members will include the members of child teams. + * + * To get a user's membership with a team, the team must be visible to the authenticated user. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * + * **Note:** + * The response contains the `state` of the membership and the member's `role`. + * + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team). + */ + getMembershipForUserInOrg: { + (params?: RestEndpointMethodTypes["teams"]["getMembershipForUserInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all teams in an organization that are visible to the authenticated user. + */ + list: { + (params?: RestEndpointMethodTypes["teams"]["list"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the child teams of the team specified by `{team_slug}`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + */ + listChildInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listChildInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + */ + listDiscussionCommentsInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listDiscussionCommentsInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + */ + listDiscussionsInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listDiscussionsInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * 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/). + */ + listForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["teams"]["listForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Team members will include the members of child teams. + * + * To list members in a team, the team must be visible to the authenticated user. + */ + listMembersInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listMembersInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + */ + listPendingInvitationsInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listPendingInvitationsInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the organization projects for a team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + */ + listProjectsInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listProjectsInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists a team's repositories visible to the authenticated user. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + */ + listReposInOrg: { + (params?: RestEndpointMethodTypes["teams"]["listReposInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * + * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. + * + * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + */ + removeMembershipForUserInOrg: { + (params?: RestEndpointMethodTypes["teams"]["removeMembershipForUserInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + */ + removeProjectInOrg: { + (params?: RestEndpointMethodTypes["teams"]["removeProjectInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + */ + removeRepoInOrg: { + (params?: RestEndpointMethodTypes["teams"]["removeRepoInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + */ + updateDiscussionCommentInOrg: { + (params?: RestEndpointMethodTypes["teams"]["updateDiscussionCommentInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + */ + updateDiscussionInOrg: { + (params?: RestEndpointMethodTypes["teams"]["updateDiscussionInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + */ + updateInOrg: { + (params?: RestEndpointMethodTypes["teams"]["updateInOrg"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; + users: { + /** + * This endpoint is accessible with the `user` scope. + */ + addEmailForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["addEmailForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + block: { + (params?: RestEndpointMethodTypes["users"]["block"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + checkBlocked: { + (params?: RestEndpointMethodTypes["users"]["checkBlocked"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + checkFollowingForUser: { + (params?: RestEndpointMethodTypes["users"]["checkFollowingForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + checkPersonIsFollowedByAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["checkPersonIsFollowedByAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + createGpgKeyForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["createGpgKeyForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + createPublicSshKeyForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["createPublicSshKeyForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * This endpoint is accessible with the `user` scope. + */ + deleteEmailForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["deleteEmailForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + deleteGpgKeyForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["deleteGpgKeyForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + deletePublicSshKeyForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["deletePublicSshKeyForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * + * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + */ + follow: { + (params?: RestEndpointMethodTypes["users"]["follow"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information. + * + * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + */ + getAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["getAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Provides publicly available information about someone with a GitHub account. + * + * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/reference/users#emails)". + */ + getByUsername: { + (params?: RestEndpointMethodTypes["users"]["getByUsername"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + * + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: + * + * ```shell + * curl -u username:token + * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 + * ``` + */ + getContextForUser: { + (params?: RestEndpointMethodTypes["users"]["getContextForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + getGpgKeyForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["getGpgKeyForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + getPublicSshKeyForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["getPublicSshKeyForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. + * + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users. + */ + list: { + (params?: RestEndpointMethodTypes["users"]["list"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * List the users you've blocked on your personal account. + */ + listBlockedByAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["listBlockedByAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + */ + listEmailsForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["listEmailsForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the people who the authenticated user follows. + */ + listFollowedByAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["listFollowedByAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the people following the authenticated user. + */ + listFollowersForAuthenticatedUser: { + (params?: RestEndpointMethodTypes["users"]["listFollowersForAuthenticatedUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the people following the specified user. + */ + listFollowersForUser: { + (params?: RestEndpointMethodTypes["users"]["listFollowersForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the people who the specified user follows. + */ + listFollowingForUser: { + (params?: RestEndpointMethodTypes["users"]["listFollowingForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + listGpgKeysForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["listGpgKeysForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the GPG keys for a user. This information is accessible by anyone. + */ + listGpgKeysForUser: { + (params?: RestEndpointMethodTypes["users"]["listGpgKeysForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + */ + listPublicEmailsForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["listPublicEmailsForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the _verified_ public SSH keys for a user. This is accessible by anyone. + */ + listPublicKeysForUser: { + (params?: RestEndpointMethodTypes["users"]["listPublicKeysForUser"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + */ + listPublicSshKeysForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["listPublicSshKeysForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Sets the visibility for your primary email addresses. + */ + setPrimaryEmailVisibilityForAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["setPrimaryEmailVisibilityForAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + unblock: { + (params?: RestEndpointMethodTypes["users"]["unblock"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + */ + unfollow: { + (params?: RestEndpointMethodTypes["users"]["unfollow"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + /** + * **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. + */ + updateAuthenticated: { + (params?: RestEndpointMethodTypes["users"]["updateAuthenticated"]["parameters"]): Promise; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ + url: string; + }>; + }; + }; +}; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts new file mode 100644 index 00000000..8ab8c5ac --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/generated/parameters-and-response-types.d.ts @@ -0,0 +1,2653 @@ +import { Endpoints, RequestParameters } from "@octokit/types"; +export declare type RestEndpointMethodTypes = { + actions: { + addSelectedRepoToOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["response"]; + }; + approveWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve"]["response"]; + }; + cancelWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel"]["response"]; + }; + createOrUpdateEnvironmentSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"]["response"]; + }; + createOrUpdateOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}"]["response"]; + }; + createOrUpdateRepoSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["response"]; + }; + createRegistrationTokenForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/actions/runners/registration-token"]["response"]; + }; + createRegistrationTokenForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runners/registration-token"]["response"]; + }; + createRemoveTokenForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/actions/runners/remove-token"]["response"]; + }; + createRemoveTokenForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runners/remove-token"]["response"]; + }; + createWorkflowDispatch: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches"]["response"]; + }; + deleteArtifact: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"]["response"]; + }; + deleteEnvironmentSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"]["response"]; + }; + deleteOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}"]["response"]; + }; + deleteRepoSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["response"]; + }; + deleteSelfHostedRunnerFromOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/actions/runners/{runner_id}"]["response"]; + }; + deleteSelfHostedRunnerFromRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}"]["response"]; + }; + deleteWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}"]["response"]; + }; + deleteWorkflowRunLogs: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs"]["response"]; + }; + disableSelectedRepositoryGithubActionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}"]["response"]; + }; + disableWorkflow: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable"]["response"]; + }; + downloadArtifact: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}"]["response"]; + }; + downloadJobLogsForWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs"]["response"]; + }; + downloadWorkflowRunLogs: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs"]["response"]; + }; + enableSelectedRepositoryGithubActionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/permissions/repositories/{repository_id}"]["response"]; + }; + enableWorkflow: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable"]["response"]; + }; + getAllowedActionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/permissions/selected-actions"]["response"]; + }; + getAllowedActionsRepository: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/permissions/selected-actions"]["response"]; + }; + getArtifact: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"]["response"]; + }; + getEnvironmentPublicKey: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key"]["response"]; + }; + getEnvironmentSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"]["response"]; + }; + getGithubActionsPermissionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/permissions"]["response"]; + }; + getGithubActionsPermissionsRepository: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/permissions"]["response"]; + }; + getJobForWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"]["response"]; + }; + getOrgPublicKey: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/secrets/public-key"]["response"]; + }; + getOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}"]["response"]; + }; + getPendingDeploymentsForRun: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"]["response"]; + }; + getRepoPermissions: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/permissions"]["response"]; + }; + getRepoPublicKey: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets/public-key"]["response"]; + }; + getRepoSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["response"]; + }; + getReviewsForRun: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals"]["response"]; + }; + getSelfHostedRunnerForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/runners/{runner_id}"]["response"]; + }; + getSelfHostedRunnerForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners/{runner_id}"]["response"]; + }; + getWorkflow: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"]["response"]; + }; + getWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}"]["response"]; + }; + getWorkflowRunUsage: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing"]["response"]; + }; + getWorkflowUsage: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing"]["response"]; + }; + listArtifactsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/artifacts"]["response"]; + }; + listEnvironmentSecrets: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets"]["response"]; + }; + listJobsForWorkflowRun: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs"]["response"]; + }; + listOrgSecrets: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/secrets"]["response"]; + }; + listRepoSecrets: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets"]["response"]; + }; + listRepoWorkflows: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"]; + }; + listRunnerApplicationsForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/runners/downloads"]["response"]; + }; + listRunnerApplicationsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners/downloads"]["response"]; + }; + listSelectedReposForOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"]["response"]; + }; + listSelectedRepositoriesEnabledGithubActionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["response"]; + }; + listSelfHostedRunnersForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/actions/runners"]["response"]; + }; + listSelfHostedRunnersForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runners"]["response"]; + }; + listWorkflowRunArtifacts: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts"]["response"]; + }; + listWorkflowRuns: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"]["response"]; + }; + listWorkflowRunsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/actions/runs"]["response"]; + }; + reRunWorkflow: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"]["response"]; + }; + removeSelectedRepoFromOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["response"]; + }; + reviewPendingDeploymentsForRun: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"]["response"]; + }; + setAllowedActionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/permissions/selected-actions"]["response"]; + }; + setAllowedActionsRepository: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/permissions/selected-actions"]["response"]; + }; + setGithubActionsPermissionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/permissions"]["response"]; + }; + setGithubActionsPermissionsRepository: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/actions/permissions"]["response"]; + }; + setSelectedReposForOrgSecret: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories"]["response"]; + }; + setSelectedRepositoriesEnabledGithubActionsOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/actions/permissions/repositories"]["response"]; + }; + }; + activity: { + checkRepoIsStarredByAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/starred/{owner}/{repo}"]["response"]; + }; + deleteRepoSubscription: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/subscription"]["response"]; + }; + deleteThreadSubscription: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /notifications/threads/{thread_id}/subscription"]["response"]; + }; + getFeeds: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /feeds"]["response"]; + }; + getRepoSubscription: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/subscription"]["response"]; + }; + getThread: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /notifications/threads/{thread_id}"]["response"]; + }; + getThreadSubscriptionForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /notifications/threads/{thread_id}/subscription"]["response"]; + }; + listEventsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/events"]["response"]; + }; + listNotificationsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /notifications"]["response"]; + }; + listOrgEventsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/events/orgs/{org}"]["response"]; + }; + listPublicEvents: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /events"]["response"]; + }; + listPublicEventsForRepoNetwork: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /networks/{owner}/{repo}/events"]["response"]; + }; + listPublicEventsForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/events/public"]["response"]; + }; + listPublicOrgEvents: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/events"]["response"]; + }; + listReceivedEventsForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/received_events"]["response"]; + }; + listReceivedPublicEventsForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/received_events/public"]["response"]; + }; + listRepoEvents: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/events"]["response"]; + }; + listRepoNotificationsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/notifications"]["response"]; + }; + listReposStarredByAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/starred"]["response"]; + }; + listReposStarredByUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/starred"]["response"]; + }; + listReposWatchedByUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/subscriptions"]["response"]; + }; + listStargazersForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/stargazers"]["response"]; + }; + listWatchedReposForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/subscriptions"]["response"]; + }; + listWatchersForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/subscribers"]["response"]; + }; + markNotificationsAsRead: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /notifications"]["response"]; + }; + markRepoNotificationsAsRead: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/notifications"]["response"]; + }; + markThreadAsRead: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /notifications/threads/{thread_id}"]["response"]; + }; + setRepoSubscription: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/subscription"]["response"]; + }; + setThreadSubscription: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /notifications/threads/{thread_id}/subscription"]["response"]; + }; + starRepoForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /user/starred/{owner}/{repo}"]["response"]; + }; + unstarRepoForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/starred/{owner}/{repo}"]["response"]; + }; + }; + apps: { + addRepoToInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /user/installations/{installation_id}/repositories/{repository_id}"]["response"]; + }; + checkToken: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /applications/{client_id}/token"]["response"]; + }; + createContentAttachment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /content_references/{content_reference_id}/attachments"]["response"]; + }; + createContentAttachmentForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments"]["response"]; + }; + createFromManifest: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /app-manifests/{code}/conversions"]["response"]; + }; + createInstallationAccessToken: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /app/installations/{installation_id}/access_tokens"]["response"]; + }; + deleteAuthorization: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /applications/{client_id}/grant"]["response"]; + }; + deleteInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /app/installations/{installation_id}"]["response"]; + }; + deleteToken: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /applications/{client_id}/token"]["response"]; + }; + getAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /app"]["response"]; + }; + getBySlug: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /apps/{app_slug}"]["response"]; + }; + getInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /app/installations/{installation_id}"]["response"]; + }; + getOrgInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/installation"]["response"]; + }; + getRepoInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/installation"]["response"]; + }; + getSubscriptionPlanForAccount: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /marketplace_listing/accounts/{account_id}"]["response"]; + }; + getSubscriptionPlanForAccountStubbed: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /marketplace_listing/stubbed/accounts/{account_id}"]["response"]; + }; + getUserInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/installation"]["response"]; + }; + getWebhookConfigForApp: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /app/hook/config"]["response"]; + }; + listAccountsForPlan: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /marketplace_listing/plans/{plan_id}/accounts"]["response"]; + }; + listAccountsForPlanStubbed: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /marketplace_listing/stubbed/plans/{plan_id}/accounts"]["response"]; + }; + listInstallationReposForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/installations/{installation_id}/repositories"]["response"]; + }; + listInstallations: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /app/installations"]["response"]; + }; + listInstallationsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/installations"]["response"]; + }; + listPlans: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /marketplace_listing/plans"]["response"]; + }; + listPlansStubbed: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /marketplace_listing/stubbed/plans"]["response"]; + }; + listReposAccessibleToInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /installation/repositories"]["response"]; + }; + listSubscriptionsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/marketplace_purchases"]["response"]; + }; + listSubscriptionsForAuthenticatedUserStubbed: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/marketplace_purchases/stubbed"]["response"]; + }; + removeRepoFromInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/installations/{installation_id}/repositories/{repository_id}"]["response"]; + }; + resetToken: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /applications/{client_id}/token"]["response"]; + }; + revokeInstallationAccessToken: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /installation/token"]["response"]; + }; + scopeToken: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /applications/{client_id}/token/scoped"]["response"]; + }; + suspendInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /app/installations/{installation_id}/suspended"]["response"]; + }; + unsuspendInstallation: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /app/installations/{installation_id}/suspended"]["response"]; + }; + updateWebhookConfigForApp: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /app/hook/config"]["response"]; + }; + }; + billing: { + getGithubActionsBillingOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/settings/billing/actions"]["response"]; + }; + getGithubActionsBillingUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/settings/billing/actions"]["response"]; + }; + getGithubPackagesBillingOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/settings/billing/packages"]["response"]; + }; + getGithubPackagesBillingUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/settings/billing/packages"]["response"]; + }; + getSharedStorageBillingOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/settings/billing/shared-storage"]["response"]; + }; + getSharedStorageBillingUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/settings/billing/shared-storage"]["response"]; + }; + }; + checks: { + create: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/check-runs"]["response"]; + }; + createSuite: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/check-suites"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}"]["response"]; + }; + getSuite: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}"]["response"]; + }; + listAnnotations: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations"]["response"]; + }; + listForRef: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"]["response"]; + }; + listForSuite: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs"]["response"]; + }; + listSuitesForRef: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"]["response"]; + }; + rerequestSuite: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest"]["response"]; + }; + setSuitesPreferences: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/check-suites/preferences"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"]["response"]; + }; + }; + codeScanning: { + deleteAnalysis: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}"]["response"]; + }; + getAlert: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"]["response"]; + }; + getAnalysis: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}"]["response"]; + }; + getSarif: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"]["response"]; + }; + listAlertInstances: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"]["response"]; + }; + listAlertsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts"]["response"]; + }; + listAlertsInstances: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"]["response"]; + }; + listRecentAnalyses: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/analyses"]["response"]; + }; + updateAlert: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"]["response"]; + }; + uploadSarif: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/code-scanning/sarifs"]["response"]; + }; + }; + codesOfConduct: { + getAllCodesOfConduct: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /codes_of_conduct"]["response"]; + }; + getConductCode: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /codes_of_conduct/{key}"]["response"]; + }; + getForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/community/code_of_conduct"]["response"]; + }; + }; + emojis: { + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /emojis"]["response"]; + }; + }; + enterpriseAdmin: { + disableSelectedOrganizationGithubActionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"]["response"]; + }; + enableSelectedOrganizationGithubActionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"]["response"]; + }; + getAllowedActionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/selected-actions"]["response"]; + }; + getGithubActionsPermissionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /enterprises/{enterprise}/actions/permissions"]["response"]; + }; + listSelectedOrganizationsEnabledGithubActionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["response"]; + }; + setAllowedActionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/selected-actions"]["response"]; + }; + setGithubActionsPermissionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions"]["response"]; + }; + setSelectedOrganizationsEnabledGithubActionsEnterprise: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/organizations"]["response"]; + }; + }; + gists: { + checkIsStarred: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}/star"]["response"]; + }; + create: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /gists"]["response"]; + }; + createComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /gists/{gist_id}/comments"]["response"]; + }; + delete: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /gists/{gist_id}"]["response"]; + }; + deleteComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /gists/{gist_id}/comments/{comment_id}"]["response"]; + }; + fork: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /gists/{gist_id}/forks"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}"]["response"]; + }; + getComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}/comments/{comment_id}"]["response"]; + }; + getRevision: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}/{sha}"]["response"]; + }; + list: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists"]["response"]; + }; + listComments: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}/comments"]["response"]; + }; + listCommits: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}/commits"]["response"]; + }; + listForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/gists"]["response"]; + }; + listForks: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/{gist_id}/forks"]["response"]; + }; + listPublic: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/public"]["response"]; + }; + listStarred: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gists/starred"]["response"]; + }; + star: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /gists/{gist_id}/star"]["response"]; + }; + unstar: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /gists/{gist_id}/star"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /gists/{gist_id}"]["response"]; + }; + updateComment: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /gists/{gist_id}/comments/{comment_id}"]["response"]; + }; + }; + git: { + createBlob: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/git/blobs"]["response"]; + }; + createCommit: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/git/commits"]["response"]; + }; + createRef: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/git/refs"]["response"]; + }; + createTag: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/git/tags"]["response"]; + }; + createTree: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/git/trees"]["response"]; + }; + deleteRef: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/git/refs/{ref}"]["response"]; + }; + getBlob: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"]["response"]; + }; + getCommit: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"]["response"]; + }; + getRef: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/git/ref/{ref}"]["response"]; + }; + getTag: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"]["response"]; + }; + getTree: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"]["response"]; + }; + listMatchingRefs: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"]["response"]; + }; + updateRef: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/git/refs/{ref}"]["response"]; + }; + }; + gitignore: { + getAllTemplates: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gitignore/templates"]["response"]; + }; + getTemplate: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /gitignore/templates/{name}"]["response"]; + }; + }; + interactions: { + getRestrictionsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/interaction-limits"]["response"]; + }; + getRestrictionsForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/interaction-limits"]["response"]; + }; + getRestrictionsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/interaction-limits"]["response"]; + }; + getRestrictionsForYourPublicRepos: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/interaction-limits"]["response"]; + }; + removeRestrictionsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/interaction-limits"]["response"]; + }; + removeRestrictionsForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/interaction-limits"]["response"]; + }; + removeRestrictionsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/interaction-limits"]["response"]; + }; + removeRestrictionsForYourPublicRepos: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/interaction-limits"]["response"]; + }; + setRestrictionsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /user/interaction-limits"]["response"]; + }; + setRestrictionsForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/interaction-limits"]["response"]; + }; + setRestrictionsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/interaction-limits"]["response"]; + }; + setRestrictionsForYourPublicRepos: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /user/interaction-limits"]["response"]; + }; + }; + issues: { + addAssignees: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/assignees"]["response"]; + }; + addLabels: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; + }; + checkUserCanBeAssigned: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/assignees/{assignee}"]["response"]; + }; + create: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/issues"]["response"]; + }; + createComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/comments"]["response"]; + }; + createLabel: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/labels"]["response"]; + }; + createMilestone: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/milestones"]["response"]; + }; + deleteComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}"]["response"]; + }; + deleteLabel: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/labels/{name}"]["response"]; + }; + deleteMilestone: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/milestones/{milestone_number}"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}"]["response"]; + }; + getComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"]["response"]; + }; + getEvent: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/events/{event_id}"]["response"]; + }; + getLabel: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/labels/{name}"]["response"]; + }; + getMilestone: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}"]["response"]; + }; + list: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /issues"]["response"]; + }; + listAssignees: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/assignees"]["response"]; + }; + listComments: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"]["response"]; + }; + listCommentsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments"]["response"]; + }; + listEvents: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/events"]["response"]; + }; + listEventsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/events"]["response"]; + }; + listEventsForTimeline: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/timeline"]["response"]; + }; + listForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/issues"]["response"]; + }; + listForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/issues"]["response"]; + }; + listForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues"]["response"]; + }; + listLabelsForMilestone: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels"]["response"]; + }; + listLabelsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/labels"]["response"]; + }; + listLabelsOnIssue: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; + }; + listMilestones: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/milestones"]["response"]; + }; + lock: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"]["response"]; + }; + removeAllLabels: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; + }; + removeAssignees: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees"]["response"]; + }; + removeLabel: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}"]["response"]; + }; + setLabels: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"]["response"]; + }; + unlock: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/issues/{issue_number}"]["response"]; + }; + updateComment: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"]["response"]; + }; + updateLabel: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/labels/{name}"]["response"]; + }; + updateMilestone: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/milestones/{milestone_number}"]["response"]; + }; + }; + licenses: { + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /licenses/{license}"]["response"]; + }; + getAllCommonlyUsed: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /licenses"]["response"]; + }; + getForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/license"]["response"]; + }; + }; + markdown: { + render: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /markdown"]["response"]; + }; + renderRaw: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /markdown/raw"]["response"]; + }; + }; + meta: { + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /meta"]["response"]; + }; + getOctocat: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /octocat"]["response"]; + }; + getZen: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /zen"]["response"]; + }; + root: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /"]["response"]; + }; + }; + migrations: { + cancelImport: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/import"]["response"]; + }; + deleteArchiveForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/migrations/{migration_id}/archive"]["response"]; + }; + deleteArchiveForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/migrations/{migration_id}/archive"]["response"]; + }; + downloadArchiveForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/migrations/{migration_id}/archive"]["response"]; + }; + getArchiveForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/migrations/{migration_id}/archive"]["response"]; + }; + getCommitAuthors: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/import/authors"]["response"]; + }; + getImportStatus: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/import"]["response"]; + }; + getLargeFiles: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/import/large_files"]["response"]; + }; + getStatusForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/migrations/{migration_id}"]["response"]; + }; + getStatusForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/migrations/{migration_id}"]["response"]; + }; + listForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/migrations"]["response"]; + }; + listForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/migrations"]["response"]; + }; + listReposForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/migrations/{migration_id}/repositories"]["response"]; + }; + listReposForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/migrations/{migration_id}/repositories"]["response"]; + }; + mapCommitAuthor: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"]["response"]; + }; + setLfsPreference: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/import/lfs"]["response"]; + }; + startForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/migrations"]["response"]; + }; + startForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/migrations"]["response"]; + }; + startImport: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/import"]["response"]; + }; + unlockRepoForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock"]["response"]; + }; + unlockRepoForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock"]["response"]; + }; + updateImport: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/import"]["response"]; + }; + }; + orgs: { + blockUser: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/blocks/{username}"]["response"]; + }; + cancelInvitation: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/invitations/{invitation_id}"]["response"]; + }; + checkBlockedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/blocks/{username}"]["response"]; + }; + checkMembershipForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/members/{username}"]["response"]; + }; + checkPublicMembershipForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/public_members/{username}"]["response"]; + }; + convertMemberToOutsideCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/outside_collaborators/{username}"]["response"]; + }; + createInvitation: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/invitations"]["response"]; + }; + createWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/hooks"]["response"]; + }; + deleteWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/hooks/{hook_id}"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}"]["response"]; + }; + getMembershipForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/memberships/orgs/{org}"]["response"]; + }; + getMembershipForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/memberships/{username}"]["response"]; + }; + getWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/hooks/{hook_id}"]["response"]; + }; + getWebhookConfigForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/hooks/{hook_id}/config"]["response"]; + }; + list: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /organizations"]["response"]; + }; + listAppInstallations: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/installations"]["response"]; + }; + listBlockedUsers: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/blocks"]["response"]; + }; + listFailedInvitations: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/failed_invitations"]["response"]; + }; + listForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/orgs"]["response"]; + }; + listForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/orgs"]["response"]; + }; + listInvitationTeams: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/invitations/{invitation_id}/teams"]["response"]; + }; + listMembers: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/members"]["response"]; + }; + listMembershipsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/memberships/orgs"]["response"]; + }; + listOutsideCollaborators: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/outside_collaborators"]["response"]; + }; + listPendingInvitations: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/invitations"]["response"]; + }; + listPublicMembers: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/public_members"]["response"]; + }; + listWebhooks: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/hooks"]["response"]; + }; + pingWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/hooks/{hook_id}/pings"]["response"]; + }; + removeMember: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/members/{username}"]["response"]; + }; + removeMembershipForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/memberships/{username}"]["response"]; + }; + removeOutsideCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/outside_collaborators/{username}"]["response"]; + }; + removePublicMembershipForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/public_members/{username}"]["response"]; + }; + setMembershipForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/memberships/{username}"]["response"]; + }; + setPublicMembershipForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/public_members/{username}"]["response"]; + }; + unblockUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/blocks/{username}"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /orgs/{org}"]["response"]; + }; + updateMembershipForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /user/memberships/orgs/{org}"]["response"]; + }; + updateWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /orgs/{org}/hooks/{hook_id}"]["response"]; + }; + updateWebhookConfigForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /orgs/{org}/hooks/{hook_id}/config"]["response"]; + }; + }; + packages: { + deletePackageForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/packages/{package_type}/{package_name}"]["response"]; + }; + deletePackageForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/packages/{package_type}/{package_name}"]["response"]; + }; + deletePackageVersionForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"]; + }; + deletePackageVersionForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"]; + }; + getAllPackageVersionsForAPackageOwnedByAnOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/packages/{package_type}/{package_name}/versions"]["response"]; + }; + getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/packages/{package_type}/{package_name}/versions"]["response"]; + }; + getAllPackageVersionsForPackageOwnedByAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/packages/{package_type}/{package_name}/versions"]["response"]; + }; + getAllPackageVersionsForPackageOwnedByOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/packages/{package_type}/{package_name}/versions"]["response"]; + }; + getAllPackageVersionsForPackageOwnedByUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/packages/{package_type}/{package_name}/versions"]["response"]; + }; + getPackageForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/packages/{package_type}/{package_name}"]["response"]; + }; + getPackageForOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/packages/{package_type}/{package_name}"]["response"]; + }; + getPackageForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/packages/{package_type}/{package_name}"]["response"]; + }; + getPackageVersionForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"]; + }; + getPackageVersionForOrganization: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"]; + }; + getPackageVersionForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"]["response"]; + }; + restorePackageForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/packages/{package_type}/{package_name}/restore{?token}"]["response"]; + }; + restorePackageForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}"]["response"]; + }; + restorePackageVersionForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["response"]; + }; + restorePackageVersionForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"]["response"]; + }; + }; + projects: { + addCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /projects/{project_id}/collaborators/{username}"]["response"]; + }; + createCard: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /projects/columns/{column_id}/cards"]["response"]; + }; + createColumn: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /projects/{project_id}/columns"]["response"]; + }; + createForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/projects"]["response"]; + }; + createForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/projects"]["response"]; + }; + createForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/projects"]["response"]; + }; + delete: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /projects/{project_id}"]["response"]; + }; + deleteCard: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /projects/columns/cards/{card_id}"]["response"]; + }; + deleteColumn: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /projects/columns/{column_id}"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/{project_id}"]["response"]; + }; + getCard: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/columns/cards/{card_id}"]["response"]; + }; + getColumn: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/columns/{column_id}"]["response"]; + }; + getPermissionForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/{project_id}/collaborators/{username}/permission"]["response"]; + }; + listCards: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/columns/{column_id}/cards"]["response"]; + }; + listCollaborators: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/{project_id}/collaborators"]["response"]; + }; + listColumns: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /projects/{project_id}/columns"]["response"]; + }; + listForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/projects"]["response"]; + }; + listForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/projects"]["response"]; + }; + listForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/projects"]["response"]; + }; + moveCard: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /projects/columns/cards/{card_id}/moves"]["response"]; + }; + moveColumn: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /projects/columns/{column_id}/moves"]["response"]; + }; + removeCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /projects/{project_id}/collaborators/{username}"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /projects/{project_id}"]["response"]; + }; + updateCard: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /projects/columns/cards/{card_id}"]["response"]; + }; + updateColumn: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /projects/columns/{column_id}"]["response"]; + }; + }; + pulls: { + checkIfMerged: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"]["response"]; + }; + create: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls"]["response"]; + }; + createReplyForReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"]["response"]; + }; + createReview: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["response"]; + }; + createReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["response"]; + }; + deletePendingReview: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"]["response"]; + }; + deleteReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}"]["response"]; + }; + dismissReview: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}"]["response"]; + }; + getReview: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"]["response"]; + }; + getReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"]["response"]; + }; + list: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls"]["response"]; + }; + listCommentsForReview: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments"]["response"]; + }; + listCommits: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"]["response"]; + }; + listFiles: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"]["response"]; + }; + listRequestedReviewers: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"]; + }; + listReviewComments: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"]["response"]; + }; + listReviewCommentsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments"]["response"]; + }; + listReviews: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"]["response"]; + }; + merge: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"]["response"]; + }; + removeRequestedReviewers: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"]; + }; + requestReviewers: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers"]["response"]; + }; + submitReview: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"]["response"]; + }; + updateBranch: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch"]["response"]; + }; + updateReview: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}"]["response"]; + }; + updateReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}"]["response"]; + }; + }; + rateLimit: { + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /rate_limit"]["response"]; + }; + }; + reactions: { + createForCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["response"]; + }; + createForIssue: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["response"]; + }; + createForIssueComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["response"]; + }; + createForPullRequestReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["response"]; + }; + createForRelease: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/releases/{release_id}/reactions"]["response"]; + }; + createForTeamDiscussionCommentInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"]; + }; + createForTeamDiscussionInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["response"]; + }; + deleteForCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}"]["response"]; + }; + deleteForIssue: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}"]["response"]; + }; + deleteForIssueComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}"]["response"]; + }; + deleteForPullRequestComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}"]["response"]; + }; + deleteForTeamDiscussion: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}"]["response"]; + }; + deleteForTeamDiscussionComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"]["response"]; + }; + deleteLegacy: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /reactions/{reaction_id}"]["response"]; + }; + listForCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}/reactions"]["response"]; + }; + listForIssue: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"]["response"]; + }; + listForIssueComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions"]["response"]; + }; + listForPullRequestReviewComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions"]["response"]; + }; + listForTeamDiscussionCommentInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"]["response"]; + }; + listForTeamDiscussionInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"]["response"]; + }; + }; + repos: { + acceptInvitation: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /user/repository_invitations/{invitation_id}"]["response"]; + }; + addAppAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; + }; + addCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/collaborators/{username}"]["response"]; + }; + addStatusCheckContexts: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["response"]; + }; + addTeamAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["response"]; + }; + addUserAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; + }; + checkCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/collaborators/{username}"]["response"]; + }; + checkVulnerabilityAlerts: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/vulnerability-alerts"]["response"]; + }; + compareCommits: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/compare/{base}...{head}"]["response"]; + }; + compareCommitsWithBasehead: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/compare/{basehead}"]["response"]; + }; + createCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["response"]; + }; + createCommitSignatureProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"]["response"]; + }; + createCommitStatus: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/statuses/{sha}"]["response"]; + }; + createDeployKey: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/keys"]["response"]; + }; + createDeployment: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/deployments"]["response"]; + }; + createDeploymentStatus: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["response"]; + }; + createDispatchEvent: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/dispatches"]["response"]; + }; + createForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/repos"]["response"]; + }; + createFork: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/forks"]["response"]; + }; + createInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/repos"]["response"]; + }; + createOrUpdateEnvironment: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/environments/{environment_name}"]["response"]; + }; + createOrUpdateFileContents: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/contents/{path}"]["response"]; + }; + createPagesSite: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pages"]["response"]; + }; + createRelease: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/releases"]["response"]; + }; + createUsingTemplate: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{template_owner}/{template_repo}/generate"]["response"]; + }; + createWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/hooks"]["response"]; + }; + declineInvitation: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/repository_invitations/{invitation_id}"]["response"]; + }; + delete: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}"]["response"]; + }; + deleteAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"]["response"]; + }; + deleteAdminBranchProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"]["response"]; + }; + deleteAnEnvironment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/environments/{environment_name}"]["response"]; + }; + deleteBranchProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection"]["response"]; + }; + deleteCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/comments/{comment_id}"]["response"]; + }; + deleteCommitSignatureProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"]["response"]; + }; + deleteDeployKey: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/keys/{key_id}"]["response"]; + }; + deleteDeployment: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/deployments/{deployment_id}"]["response"]; + }; + deleteFile: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/contents/{path}"]["response"]; + }; + deleteInvitation: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/invitations/{invitation_id}"]["response"]; + }; + deletePagesSite: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/pages"]["response"]; + }; + deletePullRequestReviewProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"]["response"]; + }; + deleteRelease: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/releases/{release_id}"]["response"]; + }; + deleteReleaseAsset: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}"]["response"]; + }; + deleteWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"]["response"]; + }; + disableAutomatedSecurityFixes: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/automated-security-fixes"]["response"]; + }; + disableVulnerabilityAlerts: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/vulnerability-alerts"]["response"]; + }; + downloadArchive: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/zipball/{ref}"]["response"]; + }; + downloadTarballArchive: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/tarball/{ref}"]["response"]; + }; + downloadZipballArchive: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/zipball/{ref}"]["response"]; + }; + enableAutomatedSecurityFixes: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/automated-security-fixes"]["response"]; + }; + enableVulnerabilityAlerts: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/vulnerability-alerts"]["response"]; + }; + get: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}"]["response"]; + }; + getAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions"]["response"]; + }; + getAdminBranchProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"]["response"]; + }; + getAllEnvironments: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/environments"]["response"]; + }; + getAllStatusCheckContexts: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["response"]; + }; + getAllTopics: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/topics"]["response"]; + }; + getAppsWithAccessToProtectedBranch: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; + }; + getBranch: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}"]["response"]; + }; + getBranchProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection"]["response"]; + }; + getClones: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/traffic/clones"]["response"]; + }; + getCodeFrequencyStats: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/stats/code_frequency"]["response"]; + }; + getCollaboratorPermissionLevel: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/collaborators/{username}/permission"]["response"]; + }; + getCombinedStatusForRef: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/status"]["response"]; + }; + getCommit: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}"]["response"]; + }; + getCommitActivityStats: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/stats/commit_activity"]["response"]; + }; + getCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/comments/{comment_id}"]["response"]; + }; + getCommitSignatureProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures"]["response"]; + }; + getCommunityProfileMetrics: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/community/profile"]["response"]; + }; + getContent: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/contents/{path}"]["response"]; + }; + getContributorsStats: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/stats/contributors"]["response"]; + }; + getDeployKey: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/keys/{key_id}"]["response"]; + }; + getDeployment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}"]["response"]; + }; + getDeploymentStatus: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}"]["response"]; + }; + getEnvironment: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/environments/{environment_name}"]["response"]; + }; + getLatestPagesBuild: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pages/builds/latest"]["response"]; + }; + getLatestRelease: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/releases/latest"]["response"]; + }; + getPages: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pages"]["response"]; + }; + getPagesBuild: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pages/builds/{build_id}"]["response"]; + }; + getPagesHealthCheck: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pages/health"]["response"]; + }; + getParticipationStats: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/stats/participation"]["response"]; + }; + getPullRequestReviewProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"]["response"]; + }; + getPunchCardStats: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/stats/punch_card"]["response"]; + }; + getReadme: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/readme"]["response"]; + }; + getReadmeInDirectory: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/readme/{dir}"]["response"]; + }; + getRelease: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}"]["response"]; + }; + getReleaseAsset: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"]["response"]; + }; + getReleaseByTag: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/releases/tags/{tag}"]["response"]; + }; + getStatusChecksProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["response"]; + }; + getTeamsWithAccessToProtectedBranch: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["response"]; + }; + getTopPaths: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/traffic/popular/paths"]["response"]; + }; + getTopReferrers: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/traffic/popular/referrers"]["response"]; + }; + getUsersWithAccessToProtectedBranch: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; + }; + getViews: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/traffic/views"]["response"]; + }; + getWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}"]["response"]; + }; + getWebhookConfigForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/config"]["response"]; + }; + listBranches: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/branches"]["response"]; + }; + listBranchesForHeadCommit: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head"]["response"]; + }; + listCollaborators: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/collaborators"]["response"]; + }; + listCommentsForCommit: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/comments"]["response"]; + }; + listCommitCommentsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/comments"]["response"]; + }; + listCommitStatusesForRef: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{ref}/statuses"]["response"]; + }; + listCommits: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits"]["response"]; + }; + listContributors: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/contributors"]["response"]; + }; + listDeployKeys: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/keys"]["response"]; + }; + listDeploymentStatuses: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses"]["response"]; + }; + listDeployments: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/deployments"]["response"]; + }; + listForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/repos"]["response"]; + }; + listForOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/repos"]["response"]; + }; + listForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/repos"]["response"]; + }; + listForks: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/forks"]["response"]; + }; + listInvitations: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/invitations"]["response"]; + }; + listInvitationsForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/repository_invitations"]["response"]; + }; + listLanguages: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/languages"]["response"]; + }; + listPagesBuilds: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/pages/builds"]["response"]; + }; + listPublic: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repositories"]["response"]; + }; + listPullRequestsAssociatedWithCommit: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls"]["response"]; + }; + listReleaseAssets: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/releases/{release_id}/assets"]["response"]; + }; + listReleases: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/releases"]["response"]; + }; + listTags: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/tags"]["response"]; + }; + listTeams: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/teams"]["response"]; + }; + listWebhooks: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/hooks"]["response"]; + }; + merge: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/merges"]["response"]; + }; + pingWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"]["response"]; + }; + removeAppAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; + }; + removeCollaborator: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/collaborators/{username}"]["response"]; + }; + removeStatusCheckContexts: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["response"]; + }; + removeStatusCheckProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["response"]; + }; + removeTeamAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["response"]; + }; + removeUserAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; + }; + renameBranch: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/rename"]["response"]; + }; + replaceAllTopics: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/topics"]["response"]; + }; + requestPagesBuild: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/pages/builds"]["response"]; + }; + setAdminBranchProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins"]["response"]; + }; + setAppAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps"]["response"]; + }; + setStatusCheckContexts: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts"]["response"]; + }; + setTeamAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams"]["response"]; + }; + setUserAccessRestrictions: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; + }; + testPushWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"]["response"]; + }; + transfer: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /repos/{owner}/{repo}/transfer"]["response"]; + }; + update: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}"]["response"]; + }; + updateBranchProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/branches/{branch}/protection"]["response"]; + }; + updateCommitComment: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/comments/{comment_id}"]["response"]; + }; + updateInformationAboutPagesSite: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /repos/{owner}/{repo}/pages"]["response"]; + }; + updateInvitation: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/invitations/{invitation_id}"]["response"]; + }; + updatePullRequestReviewProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews"]["response"]; + }; + updateRelease: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/releases/{release_id}"]["response"]; + }; + updateReleaseAsset: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}"]["response"]; + }; + updateStatusCheckPotection: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["response"]; + }; + updateStatusCheckProtection: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks"]["response"]; + }; + updateWebhook: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"]["response"]; + }; + updateWebhookConfigForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config"]["response"]; + }; + uploadReleaseAsset: { + parameters: RequestParameters & Omit; + response: Endpoints["POST {origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}"]["response"]; + }; + }; + search: { + code: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/code"]["response"]; + }; + commits: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/commits"]["response"]; + }; + issuesAndPullRequests: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/issues"]["response"]; + }; + labels: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/labels"]["response"]; + }; + repos: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/repositories"]["response"]; + }; + topics: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/topics"]["response"]; + }; + users: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /search/users"]["response"]; + }; + }; + secretScanning: { + getAlert: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"]["response"]; + }; + listAlertsForRepo: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts"]["response"]; + }; + updateAlert: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"]["response"]; + }; + }; + teams: { + addOrUpdateMembershipForUserInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/teams/{team_slug}/memberships/{username}"]["response"]; + }; + addOrUpdateProjectPermissionsInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["response"]; + }; + addOrUpdateRepoPermissionsInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["response"]; + }; + checkPermissionsForProjectInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["response"]; + }; + checkPermissionsForRepoInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["response"]; + }; + create: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/teams"]["response"]; + }; + createDiscussionCommentInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["response"]; + }; + createDiscussionInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /orgs/{org}/teams/{team_slug}/discussions"]["response"]; + }; + deleteDiscussionCommentInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"]["response"]; + }; + deleteDiscussionInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"]["response"]; + }; + deleteInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}"]["response"]; + }; + getByName: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}"]["response"]; + }; + getDiscussionCommentInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"]["response"]; + }; + getDiscussionInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"]["response"]; + }; + getMembershipForUserInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/memberships/{username}"]["response"]; + }; + list: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams"]["response"]; + }; + listChildInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/teams"]["response"]; + }; + listDiscussionCommentsInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"]["response"]; + }; + listDiscussionsInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/discussions"]["response"]; + }; + listForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/teams"]["response"]; + }; + listMembersInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/members"]["response"]; + }; + listPendingInvitationsInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/invitations"]["response"]; + }; + listProjectsInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/projects"]["response"]; + }; + listReposInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /orgs/{org}/teams/{team_slug}/repos"]["response"]; + }; + removeMembershipForUserInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}"]["response"]; + }; + removeProjectInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}"]["response"]; + }; + removeRepoInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"]["response"]; + }; + updateDiscussionCommentInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"]["response"]; + }; + updateDiscussionInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"]["response"]; + }; + updateInOrg: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /orgs/{org}/teams/{team_slug}"]["response"]; + }; + }; + users: { + addEmailForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/emails"]["response"]; + }; + block: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /user/blocks/{username}"]["response"]; + }; + checkBlocked: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/blocks/{username}"]["response"]; + }; + checkFollowingForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/following/{target_user}"]["response"]; + }; + checkPersonIsFollowedByAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/following/{username}"]["response"]; + }; + createGpgKeyForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/gpg_keys"]["response"]; + }; + createPublicSshKeyForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["POST /user/keys"]["response"]; + }; + deleteEmailForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/emails"]["response"]; + }; + deleteGpgKeyForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/gpg_keys/{gpg_key_id}"]["response"]; + }; + deletePublicSshKeyForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/keys/{key_id}"]["response"]; + }; + follow: { + parameters: RequestParameters & Omit; + response: Endpoints["PUT /user/following/{username}"]["response"]; + }; + getAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user"]["response"]; + }; + getByUsername: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}"]["response"]; + }; + getContextForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/hovercard"]["response"]; + }; + getGpgKeyForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/gpg_keys/{gpg_key_id}"]["response"]; + }; + getPublicSshKeyForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/keys/{key_id}"]["response"]; + }; + list: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users"]["response"]; + }; + listBlockedByAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/blocks"]["response"]; + }; + listEmailsForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/emails"]["response"]; + }; + listFollowedByAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/following"]["response"]; + }; + listFollowersForAuthenticatedUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/followers"]["response"]; + }; + listFollowersForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/followers"]["response"]; + }; + listFollowingForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/following"]["response"]; + }; + listGpgKeysForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/gpg_keys"]["response"]; + }; + listGpgKeysForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/gpg_keys"]["response"]; + }; + listPublicEmailsForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/public_emails"]["response"]; + }; + listPublicKeysForUser: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /users/{username}/keys"]["response"]; + }; + listPublicSshKeysForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["GET /user/keys"]["response"]; + }; + setPrimaryEmailVisibilityForAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /user/email/visibility"]["response"]; + }; + unblock: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/blocks/{username}"]["response"]; + }; + unfollow: { + parameters: RequestParameters & Omit; + response: Endpoints["DELETE /user/following/{username}"]["response"]; + }; + updateAuthenticated: { + parameters: RequestParameters & Omit; + response: Endpoints["PATCH /user"]["response"]; + }; + }; +}; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/index.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/index.d.ts new file mode 100644 index 00000000..a81f3b07 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/index.d.ts @@ -0,0 +1,11 @@ +import { Octokit } from "@octokit/core"; +export { RestEndpointMethodTypes } from "./generated/parameters-and-response-types"; +import { Api } from "./types"; +export declare function restEndpointMethods(octokit: Octokit): Api; +export declare namespace restEndpointMethods { + var VERSION: string; +} +export declare function legacyRestEndpointMethods(octokit: Octokit): Api["rest"] & Api; +export declare namespace legacyRestEndpointMethods { + var VERSION: string; +} diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/types.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/types.d.ts new file mode 100644 index 00000000..3628f021 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/types.d.ts @@ -0,0 +1,18 @@ +import { Route, RequestParameters } from "@octokit/types"; +import { RestEndpointMethods } from "./generated/method-types"; +export declare type Api = { + rest: RestEndpointMethods; +}; +export declare type EndpointDecorations = { + mapToData?: string; + deprecated?: string; + renamed?: [string, string]; + renamedParameters?: { + [name: string]: string; + }; +}; +export declare type EndpointsDefaultsAndDecorations = { + [scope: string]: { + [methodName: string]: [Route, RequestParameters?, EndpointDecorations?]; + }; +}; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/version.d.ts b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/version.d.ts new file mode 100644 index 00000000..4ebc6534 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "5.3.0"; diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js new file mode 100644 index 00000000..be3d0fc4 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js @@ -0,0 +1,1506 @@ +const Endpoints = { + actions: { + addSelectedRepoToOrgSecret: [ + "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + ], + approveWorkflowRun: [ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve", + ], + cancelWorkflowRun: [ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel", + ], + createOrUpdateEnvironmentSecret: [ + "PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + ], + createOrUpdateOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}"], + createOrUpdateRepoSecret: [ + "PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}", + ], + createRegistrationTokenForOrg: [ + "POST /orgs/{org}/actions/runners/registration-token", + ], + createRegistrationTokenForRepo: [ + "POST /repos/{owner}/{repo}/actions/runners/registration-token", + ], + createRemoveTokenForOrg: ["POST /orgs/{org}/actions/runners/remove-token"], + createRemoveTokenForRepo: [ + "POST /repos/{owner}/{repo}/actions/runners/remove-token", + ], + createWorkflowDispatch: [ + "POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", + ], + deleteArtifact: [ + "DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}", + ], + deleteEnvironmentSecret: [ + "DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + ], + deleteOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}"], + deleteRepoSecret: [ + "DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}", + ], + deleteSelfHostedRunnerFromOrg: [ + "DELETE /orgs/{org}/actions/runners/{runner_id}", + ], + deleteSelfHostedRunnerFromRepo: [ + "DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}", + ], + deleteWorkflowRun: ["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}"], + deleteWorkflowRunLogs: [ + "DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs", + ], + disableSelectedRepositoryGithubActionsOrganization: [ + "DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}", + ], + disableWorkflow: [ + "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", + ], + downloadArtifact: [ + "GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", + ], + downloadJobLogsForWorkflowRun: [ + "GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs", + ], + downloadWorkflowRunLogs: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs", + ], + enableSelectedRepositoryGithubActionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/repositories/{repository_id}", + ], + enableWorkflow: [ + "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", + ], + getAllowedActionsOrganization: [ + "GET /orgs/{org}/actions/permissions/selected-actions", + ], + getAllowedActionsRepository: [ + "GET /repos/{owner}/{repo}/actions/permissions/selected-actions", + ], + getArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"], + getEnvironmentPublicKey: [ + "GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key", + ], + getEnvironmentSecret: [ + "GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + ], + getGithubActionsPermissionsOrganization: [ + "GET /orgs/{org}/actions/permissions", + ], + getGithubActionsPermissionsRepository: [ + "GET /repos/{owner}/{repo}/actions/permissions", + ], + getJobForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"], + getOrgPublicKey: ["GET /orgs/{org}/actions/secrets/public-key"], + getOrgSecret: ["GET /orgs/{org}/actions/secrets/{secret_name}"], + getPendingDeploymentsForRun: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", + ], + getRepoPermissions: [ + "GET /repos/{owner}/{repo}/actions/permissions", + {}, + { renamed: ["actions", "getGithubActionsPermissionsRepository"] }, + ], + getRepoPublicKey: ["GET /repos/{owner}/{repo}/actions/secrets/public-key"], + getRepoSecret: ["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"], + getReviewsForRun: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals", + ], + getSelfHostedRunnerForOrg: ["GET /orgs/{org}/actions/runners/{runner_id}"], + getSelfHostedRunnerForRepo: [ + "GET /repos/{owner}/{repo}/actions/runners/{runner_id}", + ], + getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], + getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], + getWorkflowRunUsage: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing", + ], + getWorkflowUsage: [ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", + ], + listArtifactsForRepo: ["GET /repos/{owner}/{repo}/actions/artifacts"], + listEnvironmentSecrets: [ + "GET /repositories/{repository_id}/environments/{environment_name}/secrets", + ], + listJobsForWorkflowRun: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", + ], + listOrgSecrets: ["GET /orgs/{org}/actions/secrets"], + listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], + listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], + listRunnerApplicationsForOrg: ["GET /orgs/{org}/actions/runners/downloads"], + listRunnerApplicationsForRepo: [ + "GET /repos/{owner}/{repo}/actions/runners/downloads", + ], + listSelectedReposForOrgSecret: [ + "GET /orgs/{org}/actions/secrets/{secret_name}/repositories", + ], + listSelectedRepositoriesEnabledGithubActionsOrganization: [ + "GET /orgs/{org}/actions/permissions/repositories", + ], + listSelfHostedRunnersForOrg: ["GET /orgs/{org}/actions/runners"], + listSelfHostedRunnersForRepo: ["GET /repos/{owner}/{repo}/actions/runners"], + listWorkflowRunArtifacts: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", + ], + listWorkflowRuns: [ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", + ], + listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"], + reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"], + removeSelectedRepoFromOrgSecret: [ + "DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + ], + reviewPendingDeploymentsForRun: [ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", + ], + setAllowedActionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/selected-actions", + ], + setAllowedActionsRepository: [ + "PUT /repos/{owner}/{repo}/actions/permissions/selected-actions", + ], + setGithubActionsPermissionsOrganization: [ + "PUT /orgs/{org}/actions/permissions", + ], + setGithubActionsPermissionsRepository: [ + "PUT /repos/{owner}/{repo}/actions/permissions", + ], + setSelectedReposForOrgSecret: [ + "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories", + ], + setSelectedRepositoriesEnabledGithubActionsOrganization: [ + "PUT /orgs/{org}/actions/permissions/repositories", + ], + }, + activity: { + checkRepoIsStarredByAuthenticatedUser: ["GET /user/starred/{owner}/{repo}"], + deleteRepoSubscription: ["DELETE /repos/{owner}/{repo}/subscription"], + deleteThreadSubscription: [ + "DELETE /notifications/threads/{thread_id}/subscription", + ], + getFeeds: ["GET /feeds"], + getRepoSubscription: ["GET /repos/{owner}/{repo}/subscription"], + getThread: ["GET /notifications/threads/{thread_id}"], + getThreadSubscriptionForAuthenticatedUser: [ + "GET /notifications/threads/{thread_id}/subscription", + ], + listEventsForAuthenticatedUser: ["GET /users/{username}/events"], + listNotificationsForAuthenticatedUser: ["GET /notifications"], + listOrgEventsForAuthenticatedUser: [ + "GET /users/{username}/events/orgs/{org}", + ], + listPublicEvents: ["GET /events"], + listPublicEventsForRepoNetwork: ["GET /networks/{owner}/{repo}/events"], + listPublicEventsForUser: ["GET /users/{username}/events/public"], + listPublicOrgEvents: ["GET /orgs/{org}/events"], + listReceivedEventsForUser: ["GET /users/{username}/received_events"], + listReceivedPublicEventsForUser: [ + "GET /users/{username}/received_events/public", + ], + listRepoEvents: ["GET /repos/{owner}/{repo}/events"], + listRepoNotificationsForAuthenticatedUser: [ + "GET /repos/{owner}/{repo}/notifications", + ], + listReposStarredByAuthenticatedUser: ["GET /user/starred"], + listReposStarredByUser: ["GET /users/{username}/starred"], + listReposWatchedByUser: ["GET /users/{username}/subscriptions"], + listStargazersForRepo: ["GET /repos/{owner}/{repo}/stargazers"], + listWatchedReposForAuthenticatedUser: ["GET /user/subscriptions"], + listWatchersForRepo: ["GET /repos/{owner}/{repo}/subscribers"], + markNotificationsAsRead: ["PUT /notifications"], + markRepoNotificationsAsRead: ["PUT /repos/{owner}/{repo}/notifications"], + markThreadAsRead: ["PATCH /notifications/threads/{thread_id}"], + setRepoSubscription: ["PUT /repos/{owner}/{repo}/subscription"], + setThreadSubscription: [ + "PUT /notifications/threads/{thread_id}/subscription", + ], + starRepoForAuthenticatedUser: ["PUT /user/starred/{owner}/{repo}"], + unstarRepoForAuthenticatedUser: ["DELETE /user/starred/{owner}/{repo}"], + }, + apps: { + addRepoToInstallation: [ + "PUT /user/installations/{installation_id}/repositories/{repository_id}", + ], + checkToken: ["POST /applications/{client_id}/token"], + createContentAttachment: [ + "POST /content_references/{content_reference_id}/attachments", + { mediaType: { previews: ["corsair"] } }, + ], + createContentAttachmentForRepo: [ + "POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", + { mediaType: { previews: ["corsair"] } }, + ], + createFromManifest: ["POST /app-manifests/{code}/conversions"], + createInstallationAccessToken: [ + "POST /app/installations/{installation_id}/access_tokens", + ], + deleteAuthorization: ["DELETE /applications/{client_id}/grant"], + deleteInstallation: ["DELETE /app/installations/{installation_id}"], + deleteToken: ["DELETE /applications/{client_id}/token"], + getAuthenticated: ["GET /app"], + getBySlug: ["GET /apps/{app_slug}"], + getInstallation: ["GET /app/installations/{installation_id}"], + getOrgInstallation: ["GET /orgs/{org}/installation"], + getRepoInstallation: ["GET /repos/{owner}/{repo}/installation"], + getSubscriptionPlanForAccount: [ + "GET /marketplace_listing/accounts/{account_id}", + ], + getSubscriptionPlanForAccountStubbed: [ + "GET /marketplace_listing/stubbed/accounts/{account_id}", + ], + getUserInstallation: ["GET /users/{username}/installation"], + getWebhookConfigForApp: ["GET /app/hook/config"], + listAccountsForPlan: ["GET /marketplace_listing/plans/{plan_id}/accounts"], + listAccountsForPlanStubbed: [ + "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts", + ], + listInstallationReposForAuthenticatedUser: [ + "GET /user/installations/{installation_id}/repositories", + ], + listInstallations: ["GET /app/installations"], + listInstallationsForAuthenticatedUser: ["GET /user/installations"], + listPlans: ["GET /marketplace_listing/plans"], + listPlansStubbed: ["GET /marketplace_listing/stubbed/plans"], + listReposAccessibleToInstallation: ["GET /installation/repositories"], + listSubscriptionsForAuthenticatedUser: ["GET /user/marketplace_purchases"], + listSubscriptionsForAuthenticatedUserStubbed: [ + "GET /user/marketplace_purchases/stubbed", + ], + removeRepoFromInstallation: [ + "DELETE /user/installations/{installation_id}/repositories/{repository_id}", + ], + resetToken: ["PATCH /applications/{client_id}/token"], + revokeInstallationAccessToken: ["DELETE /installation/token"], + scopeToken: ["POST /applications/{client_id}/token/scoped"], + suspendInstallation: ["PUT /app/installations/{installation_id}/suspended"], + unsuspendInstallation: [ + "DELETE /app/installations/{installation_id}/suspended", + ], + updateWebhookConfigForApp: ["PATCH /app/hook/config"], + }, + billing: { + getGithubActionsBillingOrg: ["GET /orgs/{org}/settings/billing/actions"], + getGithubActionsBillingUser: [ + "GET /users/{username}/settings/billing/actions", + ], + getGithubPackagesBillingOrg: ["GET /orgs/{org}/settings/billing/packages"], + getGithubPackagesBillingUser: [ + "GET /users/{username}/settings/billing/packages", + ], + getSharedStorageBillingOrg: [ + "GET /orgs/{org}/settings/billing/shared-storage", + ], + getSharedStorageBillingUser: [ + "GET /users/{username}/settings/billing/shared-storage", + ], + }, + checks: { + create: ["POST /repos/{owner}/{repo}/check-runs"], + createSuite: ["POST /repos/{owner}/{repo}/check-suites"], + get: ["GET /repos/{owner}/{repo}/check-runs/{check_run_id}"], + getSuite: ["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}"], + listAnnotations: [ + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + ], + listForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"], + listForSuite: [ + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + ], + listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"], + rerequestSuite: [ + "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", + ], + setSuitesPreferences: [ + "PATCH /repos/{owner}/{repo}/check-suites/preferences", + ], + update: ["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"], + }, + codeScanning: { + deleteAnalysis: [ + "DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}", + ], + getAlert: [ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + {}, + { renamedParameters: { alert_id: "alert_number" } }, + ], + getAnalysis: [ + "GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", + ], + getSarif: ["GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"], + listAlertInstances: [ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", + ], + listAlertsForRepo: ["GET /repos/{owner}/{repo}/code-scanning/alerts"], + listAlertsInstances: [ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", + {}, + { renamed: ["codeScanning", "listAlertInstances"] }, + ], + listRecentAnalyses: ["GET /repos/{owner}/{repo}/code-scanning/analyses"], + updateAlert: [ + "PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + ], + uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"], + }, + codesOfConduct: { + getAllCodesOfConduct: [ + "GET /codes_of_conduct", + { mediaType: { previews: ["scarlet-witch"] } }, + ], + getConductCode: [ + "GET /codes_of_conduct/{key}", + { mediaType: { previews: ["scarlet-witch"] } }, + ], + getForRepo: [ + "GET /repos/{owner}/{repo}/community/code_of_conduct", + { mediaType: { previews: ["scarlet-witch"] } }, + ], + }, + emojis: { get: ["GET /emojis"] }, + enterpriseAdmin: { + disableSelectedOrganizationGithubActionsEnterprise: [ + "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + ], + enableSelectedOrganizationGithubActionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + ], + getAllowedActionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions/selected-actions", + ], + getGithubActionsPermissionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions", + ], + listSelectedOrganizationsEnabledGithubActionsEnterprise: [ + "GET /enterprises/{enterprise}/actions/permissions/organizations", + ], + setAllowedActionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/selected-actions", + ], + setGithubActionsPermissionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions", + ], + setSelectedOrganizationsEnabledGithubActionsEnterprise: [ + "PUT /enterprises/{enterprise}/actions/permissions/organizations", + ], + }, + gists: { + checkIsStarred: ["GET /gists/{gist_id}/star"], + create: ["POST /gists"], + createComment: ["POST /gists/{gist_id}/comments"], + delete: ["DELETE /gists/{gist_id}"], + deleteComment: ["DELETE /gists/{gist_id}/comments/{comment_id}"], + fork: ["POST /gists/{gist_id}/forks"], + get: ["GET /gists/{gist_id}"], + getComment: ["GET /gists/{gist_id}/comments/{comment_id}"], + getRevision: ["GET /gists/{gist_id}/{sha}"], + list: ["GET /gists"], + listComments: ["GET /gists/{gist_id}/comments"], + listCommits: ["GET /gists/{gist_id}/commits"], + listForUser: ["GET /users/{username}/gists"], + listForks: ["GET /gists/{gist_id}/forks"], + listPublic: ["GET /gists/public"], + listStarred: ["GET /gists/starred"], + star: ["PUT /gists/{gist_id}/star"], + unstar: ["DELETE /gists/{gist_id}/star"], + update: ["PATCH /gists/{gist_id}"], + updateComment: ["PATCH /gists/{gist_id}/comments/{comment_id}"], + }, + git: { + createBlob: ["POST /repos/{owner}/{repo}/git/blobs"], + createCommit: ["POST /repos/{owner}/{repo}/git/commits"], + createRef: ["POST /repos/{owner}/{repo}/git/refs"], + createTag: ["POST /repos/{owner}/{repo}/git/tags"], + createTree: ["POST /repos/{owner}/{repo}/git/trees"], + deleteRef: ["DELETE /repos/{owner}/{repo}/git/refs/{ref}"], + getBlob: ["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"], + getCommit: ["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"], + getRef: ["GET /repos/{owner}/{repo}/git/ref/{ref}"], + getTag: ["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"], + getTree: ["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"], + listMatchingRefs: ["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"], + updateRef: ["PATCH /repos/{owner}/{repo}/git/refs/{ref}"], + }, + gitignore: { + getAllTemplates: ["GET /gitignore/templates"], + getTemplate: ["GET /gitignore/templates/{name}"], + }, + interactions: { + getRestrictionsForAuthenticatedUser: ["GET /user/interaction-limits"], + getRestrictionsForOrg: ["GET /orgs/{org}/interaction-limits"], + getRestrictionsForRepo: ["GET /repos/{owner}/{repo}/interaction-limits"], + getRestrictionsForYourPublicRepos: [ + "GET /user/interaction-limits", + {}, + { renamed: ["interactions", "getRestrictionsForAuthenticatedUser"] }, + ], + removeRestrictionsForAuthenticatedUser: ["DELETE /user/interaction-limits"], + removeRestrictionsForOrg: ["DELETE /orgs/{org}/interaction-limits"], + removeRestrictionsForRepo: [ + "DELETE /repos/{owner}/{repo}/interaction-limits", + ], + removeRestrictionsForYourPublicRepos: [ + "DELETE /user/interaction-limits", + {}, + { renamed: ["interactions", "removeRestrictionsForAuthenticatedUser"] }, + ], + setRestrictionsForAuthenticatedUser: ["PUT /user/interaction-limits"], + setRestrictionsForOrg: ["PUT /orgs/{org}/interaction-limits"], + setRestrictionsForRepo: ["PUT /repos/{owner}/{repo}/interaction-limits"], + setRestrictionsForYourPublicRepos: [ + "PUT /user/interaction-limits", + {}, + { renamed: ["interactions", "setRestrictionsForAuthenticatedUser"] }, + ], + }, + issues: { + addAssignees: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/assignees", + ], + addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"], + checkUserCanBeAssigned: ["GET /repos/{owner}/{repo}/assignees/{assignee}"], + create: ["POST /repos/{owner}/{repo}/issues"], + createComment: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/comments", + ], + createLabel: ["POST /repos/{owner}/{repo}/labels"], + createMilestone: ["POST /repos/{owner}/{repo}/milestones"], + deleteComment: [ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}", + ], + deleteLabel: ["DELETE /repos/{owner}/{repo}/labels/{name}"], + deleteMilestone: [ + "DELETE /repos/{owner}/{repo}/milestones/{milestone_number}", + ], + get: ["GET /repos/{owner}/{repo}/issues/{issue_number}"], + getComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"], + getEvent: ["GET /repos/{owner}/{repo}/issues/events/{event_id}"], + getLabel: ["GET /repos/{owner}/{repo}/labels/{name}"], + getMilestone: ["GET /repos/{owner}/{repo}/milestones/{milestone_number}"], + list: ["GET /issues"], + listAssignees: ["GET /repos/{owner}/{repo}/assignees"], + listComments: ["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"], + listCommentsForRepo: ["GET /repos/{owner}/{repo}/issues/comments"], + listEvents: ["GET /repos/{owner}/{repo}/issues/{issue_number}/events"], + listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"], + listEventsForTimeline: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", + { mediaType: { previews: ["mockingbird"] } }, + ], + listForAuthenticatedUser: ["GET /user/issues"], + listForOrg: ["GET /orgs/{org}/issues"], + listForRepo: ["GET /repos/{owner}/{repo}/issues"], + listLabelsForMilestone: [ + "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels", + ], + listLabelsForRepo: ["GET /repos/{owner}/{repo}/labels"], + listLabelsOnIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/labels", + ], + listMilestones: ["GET /repos/{owner}/{repo}/milestones"], + lock: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"], + removeAllLabels: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels", + ], + removeAssignees: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees", + ], + removeLabel: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", + ], + setLabels: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"], + unlock: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"], + update: ["PATCH /repos/{owner}/{repo}/issues/{issue_number}"], + updateComment: ["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"], + updateLabel: ["PATCH /repos/{owner}/{repo}/labels/{name}"], + updateMilestone: [ + "PATCH /repos/{owner}/{repo}/milestones/{milestone_number}", + ], + }, + licenses: { + get: ["GET /licenses/{license}"], + getAllCommonlyUsed: ["GET /licenses"], + getForRepo: ["GET /repos/{owner}/{repo}/license"], + }, + markdown: { + render: ["POST /markdown"], + renderRaw: [ + "POST /markdown/raw", + { headers: { "content-type": "text/plain; charset=utf-8" } }, + ], + }, + meta: { + get: ["GET /meta"], + getOctocat: ["GET /octocat"], + getZen: ["GET /zen"], + root: ["GET /"], + }, + migrations: { + cancelImport: ["DELETE /repos/{owner}/{repo}/import"], + deleteArchiveForAuthenticatedUser: [ + "DELETE /user/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + deleteArchiveForOrg: [ + "DELETE /orgs/{org}/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + downloadArchiveForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + getArchiveForAuthenticatedUser: [ + "GET /user/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } }, + ], + getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"], + getImportStatus: ["GET /repos/{owner}/{repo}/import"], + getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"], + getStatusForAuthenticatedUser: [ + "GET /user/migrations/{migration_id}", + { mediaType: { previews: ["wyandotte"] } }, + ], + getStatusForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}", + { mediaType: { previews: ["wyandotte"] } }, + ], + listForAuthenticatedUser: [ + "GET /user/migrations", + { mediaType: { previews: ["wyandotte"] } }, + ], + listForOrg: [ + "GET /orgs/{org}/migrations", + { mediaType: { previews: ["wyandotte"] } }, + ], + listReposForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}/repositories", + { mediaType: { previews: ["wyandotte"] } }, + ], + listReposForUser: [ + "GET /user/migrations/{migration_id}/repositories", + { mediaType: { previews: ["wyandotte"] } }, + ], + mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"], + setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"], + startForAuthenticatedUser: ["POST /user/migrations"], + startForOrg: ["POST /orgs/{org}/migrations"], + startImport: ["PUT /repos/{owner}/{repo}/import"], + unlockRepoForAuthenticatedUser: [ + "DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock", + { mediaType: { previews: ["wyandotte"] } }, + ], + unlockRepoForOrg: [ + "DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", + { mediaType: { previews: ["wyandotte"] } }, + ], + updateImport: ["PATCH /repos/{owner}/{repo}/import"], + }, + orgs: { + blockUser: ["PUT /orgs/{org}/blocks/{username}"], + cancelInvitation: ["DELETE /orgs/{org}/invitations/{invitation_id}"], + checkBlockedUser: ["GET /orgs/{org}/blocks/{username}"], + checkMembershipForUser: ["GET /orgs/{org}/members/{username}"], + checkPublicMembershipForUser: ["GET /orgs/{org}/public_members/{username}"], + convertMemberToOutsideCollaborator: [ + "PUT /orgs/{org}/outside_collaborators/{username}", + ], + createInvitation: ["POST /orgs/{org}/invitations"], + createWebhook: ["POST /orgs/{org}/hooks"], + deleteWebhook: ["DELETE /orgs/{org}/hooks/{hook_id}"], + get: ["GET /orgs/{org}"], + getMembershipForAuthenticatedUser: ["GET /user/memberships/orgs/{org}"], + getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], + getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], + getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"], + list: ["GET /organizations"], + listAppInstallations: ["GET /orgs/{org}/installations"], + listBlockedUsers: ["GET /orgs/{org}/blocks"], + listFailedInvitations: ["GET /orgs/{org}/failed_invitations"], + listForAuthenticatedUser: ["GET /user/orgs"], + listForUser: ["GET /users/{username}/orgs"], + listInvitationTeams: ["GET /orgs/{org}/invitations/{invitation_id}/teams"], + listMembers: ["GET /orgs/{org}/members"], + listMembershipsForAuthenticatedUser: ["GET /user/memberships/orgs"], + listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], + listPendingInvitations: ["GET /orgs/{org}/invitations"], + listPublicMembers: ["GET /orgs/{org}/public_members"], + listWebhooks: ["GET /orgs/{org}/hooks"], + pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], + removeMember: ["DELETE /orgs/{org}/members/{username}"], + removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"], + removeOutsideCollaborator: [ + "DELETE /orgs/{org}/outside_collaborators/{username}", + ], + removePublicMembershipForAuthenticatedUser: [ + "DELETE /orgs/{org}/public_members/{username}", + ], + setMembershipForUser: ["PUT /orgs/{org}/memberships/{username}"], + setPublicMembershipForAuthenticatedUser: [ + "PUT /orgs/{org}/public_members/{username}", + ], + unblockUser: ["DELETE /orgs/{org}/blocks/{username}"], + update: ["PATCH /orgs/{org}"], + updateMembershipForAuthenticatedUser: [ + "PATCH /user/memberships/orgs/{org}", + ], + updateWebhook: ["PATCH /orgs/{org}/hooks/{hook_id}"], + updateWebhookConfigForOrg: ["PATCH /orgs/{org}/hooks/{hook_id}/config"], + }, + packages: { + deletePackageForAuthenticatedUser: [ + "DELETE /user/packages/{package_type}/{package_name}", + ], + deletePackageForOrg: [ + "DELETE /orgs/{org}/packages/{package_type}/{package_name}", + ], + deletePackageVersionForAuthenticatedUser: [ + "DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}", + ], + deletePackageVersionForOrg: [ + "DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", + ], + getAllPackageVersionsForAPackageOwnedByAnOrg: [ + "GET /orgs/{org}/packages/{package_type}/{package_name}/versions", + {}, + { renamed: ["packages", "getAllPackageVersionsForPackageOwnedByOrg"] }, + ], + getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser: [ + "GET /user/packages/{package_type}/{package_name}/versions", + {}, + { + renamed: [ + "packages", + "getAllPackageVersionsForPackageOwnedByAuthenticatedUser", + ], + }, + ], + getAllPackageVersionsForPackageOwnedByAuthenticatedUser: [ + "GET /user/packages/{package_type}/{package_name}/versions", + ], + getAllPackageVersionsForPackageOwnedByOrg: [ + "GET /orgs/{org}/packages/{package_type}/{package_name}/versions", + ], + getAllPackageVersionsForPackageOwnedByUser: [ + "GET /users/{username}/packages/{package_type}/{package_name}/versions", + ], + getPackageForAuthenticatedUser: [ + "GET /user/packages/{package_type}/{package_name}", + ], + getPackageForOrganization: [ + "GET /orgs/{org}/packages/{package_type}/{package_name}", + ], + getPackageForUser: [ + "GET /users/{username}/packages/{package_type}/{package_name}", + ], + getPackageVersionForAuthenticatedUser: [ + "GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}", + ], + getPackageVersionForOrganization: [ + "GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", + ], + getPackageVersionForUser: [ + "GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", + ], + restorePackageForAuthenticatedUser: [ + "POST /user/packages/{package_type}/{package_name}/restore{?token}", + ], + restorePackageForOrg: [ + "POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}", + ], + restorePackageVersionForAuthenticatedUser: [ + "POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", + ], + restorePackageVersionForOrg: [ + "POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", + ], + }, + projects: { + addCollaborator: [ + "PUT /projects/{project_id}/collaborators/{username}", + { mediaType: { previews: ["inertia"] } }, + ], + createCard: [ + "POST /projects/columns/{column_id}/cards", + { mediaType: { previews: ["inertia"] } }, + ], + createColumn: [ + "POST /projects/{project_id}/columns", + { mediaType: { previews: ["inertia"] } }, + ], + createForAuthenticatedUser: [ + "POST /user/projects", + { mediaType: { previews: ["inertia"] } }, + ], + createForOrg: [ + "POST /orgs/{org}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + createForRepo: [ + "POST /repos/{owner}/{repo}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + delete: [ + "DELETE /projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + deleteCard: [ + "DELETE /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } }, + ], + deleteColumn: [ + "DELETE /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } }, + ], + get: [ + "GET /projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + getCard: [ + "GET /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } }, + ], + getColumn: [ + "GET /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } }, + ], + getPermissionForUser: [ + "GET /projects/{project_id}/collaborators/{username}/permission", + { mediaType: { previews: ["inertia"] } }, + ], + listCards: [ + "GET /projects/columns/{column_id}/cards", + { mediaType: { previews: ["inertia"] } }, + ], + listCollaborators: [ + "GET /projects/{project_id}/collaborators", + { mediaType: { previews: ["inertia"] } }, + ], + listColumns: [ + "GET /projects/{project_id}/columns", + { mediaType: { previews: ["inertia"] } }, + ], + listForOrg: [ + "GET /orgs/{org}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + listForRepo: [ + "GET /repos/{owner}/{repo}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + listForUser: [ + "GET /users/{username}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + moveCard: [ + "POST /projects/columns/cards/{card_id}/moves", + { mediaType: { previews: ["inertia"] } }, + ], + moveColumn: [ + "POST /projects/columns/{column_id}/moves", + { mediaType: { previews: ["inertia"] } }, + ], + removeCollaborator: [ + "DELETE /projects/{project_id}/collaborators/{username}", + { mediaType: { previews: ["inertia"] } }, + ], + update: [ + "PATCH /projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + updateCard: [ + "PATCH /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } }, + ], + updateColumn: [ + "PATCH /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } }, + ], + }, + pulls: { + checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + create: ["POST /repos/{owner}/{repo}/pulls"], + createReplyForReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", + ], + createReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + createReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments", + ], + deletePendingReview: [ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + ], + deleteReviewComment: [ + "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}", + ], + dismissReview: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", + ], + get: ["GET /repos/{owner}/{repo}/pulls/{pull_number}"], + getReview: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + ], + getReviewComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"], + list: ["GET /repos/{owner}/{repo}/pulls"], + listCommentsForReview: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", + ], + listCommits: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"], + listFiles: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"], + listRequestedReviewers: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + ], + listReviewComments: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments", + ], + listReviewCommentsForRepo: ["GET /repos/{owner}/{repo}/pulls/comments"], + listReviews: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + merge: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + removeRequestedReviewers: [ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + ], + requestReviewers: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + ], + submitReview: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", + ], + update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"], + updateBranch: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch", + { mediaType: { previews: ["lydian"] } }, + ], + updateReview: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + ], + updateReviewComment: [ + "PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}", + ], + }, + rateLimit: { get: ["GET /rate_limit"] }, + reactions: { + createForCommitComment: [ + "POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForIssue: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForIssueComment: [ + "POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForPullRequestReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForRelease: [ + "POST /repos/{owner}/{repo}/releases/{release_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForTeamDiscussionCommentInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + createForTeamDiscussionInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForCommitComment: [ + "DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForIssue: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForIssueComment: [ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForPullRequestComment: [ + "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForTeamDiscussion: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteForTeamDiscussionComment: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + deleteLegacy: [ + "DELETE /reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } }, + { + deprecated: "octokit.rest.reactions.deleteLegacy() is deprecated, see https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy", + }, + ], + listForCommitComment: [ + "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForIssueComment: [ + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForPullRequestReviewComment: [ + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForTeamDiscussionCommentInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + listForTeamDiscussionInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } }, + ], + }, + repos: { + acceptInvitation: ["PATCH /user/repository_invitations/{invitation_id}"], + addAppAccessRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" }, + ], + addCollaborator: ["PUT /repos/{owner}/{repo}/collaborators/{username}"], + addStatusCheckContexts: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" }, + ], + addTeamAccessRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" }, + ], + addUserAccessRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" }, + ], + checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], + checkVulnerabilityAlerts: [ + "GET /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } }, + ], + compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], + compareCommitsWithBasehead: [ + "GET /repos/{owner}/{repo}/compare/{basehead}", + ], + createCommitComment: [ + "POST /repos/{owner}/{repo}/commits/{commit_sha}/comments", + ], + createCommitSignatureProtection: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } }, + ], + createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"], + createDeployKey: ["POST /repos/{owner}/{repo}/keys"], + createDeployment: ["POST /repos/{owner}/{repo}/deployments"], + createDeploymentStatus: [ + "POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + ], + createDispatchEvent: ["POST /repos/{owner}/{repo}/dispatches"], + createForAuthenticatedUser: ["POST /user/repos"], + createFork: ["POST /repos/{owner}/{repo}/forks"], + createInOrg: ["POST /orgs/{org}/repos"], + createOrUpdateEnvironment: [ + "PUT /repos/{owner}/{repo}/environments/{environment_name}", + ], + createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], + createPagesSite: [ + "POST /repos/{owner}/{repo}/pages", + { mediaType: { previews: ["switcheroo"] } }, + ], + createRelease: ["POST /repos/{owner}/{repo}/releases"], + createUsingTemplate: [ + "POST /repos/{template_owner}/{template_repo}/generate", + { mediaType: { previews: ["baptiste"] } }, + ], + createWebhook: ["POST /repos/{owner}/{repo}/hooks"], + declineInvitation: ["DELETE /user/repository_invitations/{invitation_id}"], + delete: ["DELETE /repos/{owner}/{repo}"], + deleteAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + ], + deleteAdminBranchProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + ], + deleteAnEnvironment: [ + "DELETE /repos/{owner}/{repo}/environments/{environment_name}", + ], + deleteBranchProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection", + ], + deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"], + deleteCommitSignatureProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } }, + ], + deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"], + deleteDeployment: [ + "DELETE /repos/{owner}/{repo}/deployments/{deployment_id}", + ], + deleteFile: ["DELETE /repos/{owner}/{repo}/contents/{path}"], + deleteInvitation: [ + "DELETE /repos/{owner}/{repo}/invitations/{invitation_id}", + ], + deletePagesSite: [ + "DELETE /repos/{owner}/{repo}/pages", + { mediaType: { previews: ["switcheroo"] } }, + ], + deletePullRequestReviewProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + ], + deleteRelease: ["DELETE /repos/{owner}/{repo}/releases/{release_id}"], + deleteReleaseAsset: [ + "DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}", + ], + deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], + disableAutomatedSecurityFixes: [ + "DELETE /repos/{owner}/{repo}/automated-security-fixes", + { mediaType: { previews: ["london"] } }, + ], + disableVulnerabilityAlerts: [ + "DELETE /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } }, + ], + downloadArchive: [ + "GET /repos/{owner}/{repo}/zipball/{ref}", + {}, + { renamed: ["repos", "downloadZipballArchive"] }, + ], + downloadTarballArchive: ["GET /repos/{owner}/{repo}/tarball/{ref}"], + downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"], + enableAutomatedSecurityFixes: [ + "PUT /repos/{owner}/{repo}/automated-security-fixes", + { mediaType: { previews: ["london"] } }, + ], + enableVulnerabilityAlerts: [ + "PUT /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } }, + ], + get: ["GET /repos/{owner}/{repo}"], + getAccessRestrictions: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + ], + getAdminBranchProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + ], + getAllEnvironments: ["GET /repos/{owner}/{repo}/environments"], + getAllStatusCheckContexts: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + ], + getAllTopics: [ + "GET /repos/{owner}/{repo}/topics", + { mediaType: { previews: ["mercy"] } }, + ], + getAppsWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + ], + getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"], + getBranchProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection", + ], + getClones: ["GET /repos/{owner}/{repo}/traffic/clones"], + getCodeFrequencyStats: ["GET /repos/{owner}/{repo}/stats/code_frequency"], + getCollaboratorPermissionLevel: [ + "GET /repos/{owner}/{repo}/collaborators/{username}/permission", + ], + getCombinedStatusForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/status"], + getCommit: ["GET /repos/{owner}/{repo}/commits/{ref}"], + getCommitActivityStats: ["GET /repos/{owner}/{repo}/stats/commit_activity"], + getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"], + getCommitSignatureProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } }, + ], + getCommunityProfileMetrics: ["GET /repos/{owner}/{repo}/community/profile"], + getContent: ["GET /repos/{owner}/{repo}/contents/{path}"], + getContributorsStats: ["GET /repos/{owner}/{repo}/stats/contributors"], + getDeployKey: ["GET /repos/{owner}/{repo}/keys/{key_id}"], + getDeployment: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}"], + getDeploymentStatus: [ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", + ], + getEnvironment: [ + "GET /repos/{owner}/{repo}/environments/{environment_name}", + ], + getLatestPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/latest"], + getLatestRelease: ["GET /repos/{owner}/{repo}/releases/latest"], + getPages: ["GET /repos/{owner}/{repo}/pages"], + getPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/{build_id}"], + getPagesHealthCheck: ["GET /repos/{owner}/{repo}/pages/health"], + getParticipationStats: ["GET /repos/{owner}/{repo}/stats/participation"], + getPullRequestReviewProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + ], + getPunchCardStats: ["GET /repos/{owner}/{repo}/stats/punch_card"], + getReadme: ["GET /repos/{owner}/{repo}/readme"], + getReadmeInDirectory: ["GET /repos/{owner}/{repo}/readme/{dir}"], + getRelease: ["GET /repos/{owner}/{repo}/releases/{release_id}"], + getReleaseAsset: ["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"], + getReleaseByTag: ["GET /repos/{owner}/{repo}/releases/tags/{tag}"], + getStatusChecksProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + ], + getTeamsWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + ], + getTopPaths: ["GET /repos/{owner}/{repo}/traffic/popular/paths"], + getTopReferrers: ["GET /repos/{owner}/{repo}/traffic/popular/referrers"], + getUsersWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + ], + getViews: ["GET /repos/{owner}/{repo}/traffic/views"], + getWebhook: ["GET /repos/{owner}/{repo}/hooks/{hook_id}"], + getWebhookConfigForRepo: [ + "GET /repos/{owner}/{repo}/hooks/{hook_id}/config", + ], + listBranches: ["GET /repos/{owner}/{repo}/branches"], + listBranchesForHeadCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", + { mediaType: { previews: ["groot"] } }, + ], + listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"], + listCommentsForCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments", + ], + listCommitCommentsForRepo: ["GET /repos/{owner}/{repo}/comments"], + listCommitStatusesForRef: [ + "GET /repos/{owner}/{repo}/commits/{ref}/statuses", + ], + listCommits: ["GET /repos/{owner}/{repo}/commits"], + listContributors: ["GET /repos/{owner}/{repo}/contributors"], + listDeployKeys: ["GET /repos/{owner}/{repo}/keys"], + listDeploymentStatuses: [ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + ], + listDeployments: ["GET /repos/{owner}/{repo}/deployments"], + listForAuthenticatedUser: ["GET /user/repos"], + listForOrg: ["GET /orgs/{org}/repos"], + listForUser: ["GET /users/{username}/repos"], + listForks: ["GET /repos/{owner}/{repo}/forks"], + listInvitations: ["GET /repos/{owner}/{repo}/invitations"], + listInvitationsForAuthenticatedUser: ["GET /user/repository_invitations"], + listLanguages: ["GET /repos/{owner}/{repo}/languages"], + listPagesBuilds: ["GET /repos/{owner}/{repo}/pages/builds"], + listPublic: ["GET /repositories"], + listPullRequestsAssociatedWithCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", + { mediaType: { previews: ["groot"] } }, + ], + listReleaseAssets: [ + "GET /repos/{owner}/{repo}/releases/{release_id}/assets", + ], + listReleases: ["GET /repos/{owner}/{repo}/releases"], + listTags: ["GET /repos/{owner}/{repo}/tags"], + listTeams: ["GET /repos/{owner}/{repo}/teams"], + listWebhooks: ["GET /repos/{owner}/{repo}/hooks"], + merge: ["POST /repos/{owner}/{repo}/merges"], + pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"], + removeAppAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" }, + ], + removeCollaborator: [ + "DELETE /repos/{owner}/{repo}/collaborators/{username}", + ], + removeStatusCheckContexts: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" }, + ], + removeStatusCheckProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + ], + removeTeamAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" }, + ], + removeUserAccessRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" }, + ], + renameBranch: ["POST /repos/{owner}/{repo}/branches/{branch}/rename"], + replaceAllTopics: [ + "PUT /repos/{owner}/{repo}/topics", + { mediaType: { previews: ["mercy"] } }, + ], + requestPagesBuild: ["POST /repos/{owner}/{repo}/pages/builds"], + setAdminBranchProtection: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + ], + setAppAccessRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" }, + ], + setStatusCheckContexts: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" }, + ], + setTeamAccessRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" }, + ], + setUserAccessRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" }, + ], + testPushWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"], + transfer: ["POST /repos/{owner}/{repo}/transfer"], + update: ["PATCH /repos/{owner}/{repo}"], + updateBranchProtection: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection", + ], + updateCommitComment: ["PATCH /repos/{owner}/{repo}/comments/{comment_id}"], + updateInformationAboutPagesSite: ["PUT /repos/{owner}/{repo}/pages"], + updateInvitation: [ + "PATCH /repos/{owner}/{repo}/invitations/{invitation_id}", + ], + updatePullRequestReviewProtection: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + ], + updateRelease: ["PATCH /repos/{owner}/{repo}/releases/{release_id}"], + updateReleaseAsset: [ + "PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}", + ], + updateStatusCheckPotection: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + {}, + { renamed: ["repos", "updateStatusCheckProtection"] }, + ], + updateStatusCheckProtection: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + ], + updateWebhook: ["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"], + updateWebhookConfigForRepo: [ + "PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config", + ], + uploadReleaseAsset: [ + "POST /repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", + { baseUrl: "https://uploads.github.com" }, + ], + }, + search: { + code: ["GET /search/code"], + commits: ["GET /search/commits", { mediaType: { previews: ["cloak"] } }], + issuesAndPullRequests: ["GET /search/issues"], + labels: ["GET /search/labels"], + repos: ["GET /search/repositories"], + topics: ["GET /search/topics", { mediaType: { previews: ["mercy"] } }], + users: ["GET /search/users"], + }, + secretScanning: { + getAlert: [ + "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", + ], + listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], + updateAlert: [ + "PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", + ], + }, + teams: { + addOrUpdateMembershipForUserInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/memberships/{username}", + ], + addOrUpdateProjectPermissionsInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + addOrUpdateRepoPermissionsInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + ], + checkPermissionsForProjectInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", + { mediaType: { previews: ["inertia"] } }, + ], + checkPermissionsForRepoInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + ], + create: ["POST /orgs/{org}/teams"], + createDiscussionCommentInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + ], + createDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions"], + deleteDiscussionCommentInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + ], + deleteDiscussionInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + ], + deleteInOrg: ["DELETE /orgs/{org}/teams/{team_slug}"], + getByName: ["GET /orgs/{org}/teams/{team_slug}"], + getDiscussionCommentInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + ], + getDiscussionInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + ], + getMembershipForUserInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/memberships/{username}", + ], + list: ["GET /orgs/{org}/teams"], + listChildInOrg: ["GET /orgs/{org}/teams/{team_slug}/teams"], + listDiscussionCommentsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + ], + listDiscussionsInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions"], + listForAuthenticatedUser: ["GET /user/teams"], + listMembersInOrg: ["GET /orgs/{org}/teams/{team_slug}/members"], + listPendingInvitationsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/invitations", + ], + listProjectsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/projects", + { mediaType: { previews: ["inertia"] } }, + ], + listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], + removeMembershipForUserInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}", + ], + removeProjectInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}", + ], + removeRepoInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + ], + updateDiscussionCommentInOrg: [ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + ], + updateDiscussionInOrg: [ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + ], + updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"], + }, + users: { + addEmailForAuthenticated: ["POST /user/emails"], + block: ["PUT /user/blocks/{username}"], + checkBlocked: ["GET /user/blocks/{username}"], + checkFollowingForUser: ["GET /users/{username}/following/{target_user}"], + checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"], + createGpgKeyForAuthenticated: ["POST /user/gpg_keys"], + createPublicSshKeyForAuthenticated: ["POST /user/keys"], + deleteEmailForAuthenticated: ["DELETE /user/emails"], + deleteGpgKeyForAuthenticated: ["DELETE /user/gpg_keys/{gpg_key_id}"], + deletePublicSshKeyForAuthenticated: ["DELETE /user/keys/{key_id}"], + follow: ["PUT /user/following/{username}"], + getAuthenticated: ["GET /user"], + getByUsername: ["GET /users/{username}"], + getContextForUser: ["GET /users/{username}/hovercard"], + getGpgKeyForAuthenticated: ["GET /user/gpg_keys/{gpg_key_id}"], + getPublicSshKeyForAuthenticated: ["GET /user/keys/{key_id}"], + list: ["GET /users"], + listBlockedByAuthenticated: ["GET /user/blocks"], + listEmailsForAuthenticated: ["GET /user/emails"], + listFollowedByAuthenticated: ["GET /user/following"], + listFollowersForAuthenticatedUser: ["GET /user/followers"], + listFollowersForUser: ["GET /users/{username}/followers"], + listFollowingForUser: ["GET /users/{username}/following"], + listGpgKeysForAuthenticated: ["GET /user/gpg_keys"], + listGpgKeysForUser: ["GET /users/{username}/gpg_keys"], + listPublicEmailsForAuthenticated: ["GET /user/public_emails"], + listPublicKeysForUser: ["GET /users/{username}/keys"], + listPublicSshKeysForAuthenticated: ["GET /user/keys"], + setPrimaryEmailVisibilityForAuthenticated: ["PATCH /user/email/visibility"], + unblock: ["DELETE /user/blocks/{username}"], + unfollow: ["DELETE /user/following/{username}"], + updateAuthenticated: ["PATCH /user"], + }, +}; + +const VERSION = "5.3.0"; + +function endpointsToMethods(octokit, endpointsMap) { + const newMethods = {}; + for (const [scope, endpoints] of Object.entries(endpointsMap)) { + for (const [methodName, endpoint] of Object.entries(endpoints)) { + const [route, defaults, decorations] = endpoint; + const [method, url] = route.split(/ /); + const endpointDefaults = Object.assign({ method, url }, defaults); + if (!newMethods[scope]) { + newMethods[scope] = {}; + } + const scopeMethods = newMethods[scope]; + if (decorations) { + scopeMethods[methodName] = decorate(octokit, scope, methodName, endpointDefaults, decorations); + continue; + } + scopeMethods[methodName] = octokit.request.defaults(endpointDefaults); + } + } + return newMethods; +} +function decorate(octokit, scope, methodName, defaults, decorations) { + const requestWithDefaults = octokit.request.defaults(defaults); + /* istanbul ignore next */ + function withDecorations(...args) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + let options = requestWithDefaults.endpoint.merge(...args); + // There are currently no other decorations than `.mapToData` + if (decorations.mapToData) { + options = Object.assign({}, options, { + data: options[decorations.mapToData], + [decorations.mapToData]: undefined, + }); + return requestWithDefaults(options); + } + if (decorations.renamed) { + const [newScope, newMethodName] = decorations.renamed; + octokit.log.warn(`octokit.${scope}.${methodName}() has been renamed to octokit.${newScope}.${newMethodName}()`); + } + if (decorations.deprecated) { + octokit.log.warn(decorations.deprecated); + } + if (decorations.renamedParameters) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + const options = requestWithDefaults.endpoint.merge(...args); + for (const [name, alias] of Object.entries(decorations.renamedParameters)) { + if (name in options) { + octokit.log.warn(`"${name}" parameter is deprecated for "octokit.${scope}.${methodName}()". Use "${alias}" instead`); + if (!(alias in options)) { + options[alias] = options[name]; + } + delete options[name]; + } + } + return requestWithDefaults(options); + } + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + return requestWithDefaults(...args); + } + return Object.assign(withDecorations, requestWithDefaults); +} + +function restEndpointMethods(octokit) { + const api = endpointsToMethods(octokit, Endpoints); + return { + rest: api, + }; +} +restEndpointMethods.VERSION = VERSION; +function legacyRestEndpointMethods(octokit) { + const api = endpointsToMethods(octokit, Endpoints); + return { + ...api, + rest: api, + }; +} +legacyRestEndpointMethods.VERSION = VERSION; + +export { legacyRestEndpointMethods, restEndpointMethods }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js.map b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js.map new file mode 100644 index 00000000..74e8b036 --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/generated/endpoints.js","../dist-src/version.js","../dist-src/endpoints-to-methods.js","../dist-src/index.js"],"sourcesContent":["const Endpoints = {\n actions: {\n addSelectedRepoToOrgSecret: [\n \"PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}\",\n ],\n approveWorkflowRun: [\n \"POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve\",\n ],\n cancelWorkflowRun: [\n \"POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel\",\n ],\n createOrUpdateEnvironmentSecret: [\n \"PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}\",\n ],\n createOrUpdateOrgSecret: [\"PUT /orgs/{org}/actions/secrets/{secret_name}\"],\n createOrUpdateRepoSecret: [\n \"PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}\",\n ],\n createRegistrationTokenForOrg: [\n \"POST /orgs/{org}/actions/runners/registration-token\",\n ],\n createRegistrationTokenForRepo: [\n \"POST /repos/{owner}/{repo}/actions/runners/registration-token\",\n ],\n createRemoveTokenForOrg: [\"POST /orgs/{org}/actions/runners/remove-token\"],\n createRemoveTokenForRepo: [\n \"POST /repos/{owner}/{repo}/actions/runners/remove-token\",\n ],\n createWorkflowDispatch: [\n \"POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches\",\n ],\n deleteArtifact: [\n \"DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}\",\n ],\n deleteEnvironmentSecret: [\n \"DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}\",\n ],\n deleteOrgSecret: [\"DELETE /orgs/{org}/actions/secrets/{secret_name}\"],\n deleteRepoSecret: [\n \"DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}\",\n ],\n deleteSelfHostedRunnerFromOrg: [\n \"DELETE /orgs/{org}/actions/runners/{runner_id}\",\n ],\n deleteSelfHostedRunnerFromRepo: [\n \"DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}\",\n ],\n deleteWorkflowRun: [\"DELETE /repos/{owner}/{repo}/actions/runs/{run_id}\"],\n deleteWorkflowRunLogs: [\n \"DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs\",\n ],\n disableSelectedRepositoryGithubActionsOrganization: [\n \"DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}\",\n ],\n disableWorkflow: [\n \"PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable\",\n ],\n downloadArtifact: [\n \"GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}\",\n ],\n downloadJobLogsForWorkflowRun: [\n \"GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs\",\n ],\n downloadWorkflowRunLogs: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs\",\n ],\n enableSelectedRepositoryGithubActionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions/repositories/{repository_id}\",\n ],\n enableWorkflow: [\n \"PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable\",\n ],\n getAllowedActionsOrganization: [\n \"GET /orgs/{org}/actions/permissions/selected-actions\",\n ],\n getAllowedActionsRepository: [\n \"GET /repos/{owner}/{repo}/actions/permissions/selected-actions\",\n ],\n getArtifact: [\"GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}\"],\n getEnvironmentPublicKey: [\n \"GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key\",\n ],\n getEnvironmentSecret: [\n \"GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}\",\n ],\n getGithubActionsPermissionsOrganization: [\n \"GET /orgs/{org}/actions/permissions\",\n ],\n getGithubActionsPermissionsRepository: [\n \"GET /repos/{owner}/{repo}/actions/permissions\",\n ],\n getJobForWorkflowRun: [\"GET /repos/{owner}/{repo}/actions/jobs/{job_id}\"],\n getOrgPublicKey: [\"GET /orgs/{org}/actions/secrets/public-key\"],\n getOrgSecret: [\"GET /orgs/{org}/actions/secrets/{secret_name}\"],\n getPendingDeploymentsForRun: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments\",\n ],\n getRepoPermissions: [\n \"GET /repos/{owner}/{repo}/actions/permissions\",\n {},\n { renamed: [\"actions\", \"getGithubActionsPermissionsRepository\"] },\n ],\n getRepoPublicKey: [\"GET /repos/{owner}/{repo}/actions/secrets/public-key\"],\n getRepoSecret: [\"GET /repos/{owner}/{repo}/actions/secrets/{secret_name}\"],\n getReviewsForRun: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals\",\n ],\n getSelfHostedRunnerForOrg: [\"GET /orgs/{org}/actions/runners/{runner_id}\"],\n getSelfHostedRunnerForRepo: [\n \"GET /repos/{owner}/{repo}/actions/runners/{runner_id}\",\n ],\n getWorkflow: [\"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}\"],\n getWorkflowRun: [\"GET /repos/{owner}/{repo}/actions/runs/{run_id}\"],\n getWorkflowRunUsage: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing\",\n ],\n getWorkflowUsage: [\n \"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing\",\n ],\n listArtifactsForRepo: [\"GET /repos/{owner}/{repo}/actions/artifacts\"],\n listEnvironmentSecrets: [\n \"GET /repositories/{repository_id}/environments/{environment_name}/secrets\",\n ],\n listJobsForWorkflowRun: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs\",\n ],\n listOrgSecrets: [\"GET /orgs/{org}/actions/secrets\"],\n listRepoSecrets: [\"GET /repos/{owner}/{repo}/actions/secrets\"],\n listRepoWorkflows: [\"GET /repos/{owner}/{repo}/actions/workflows\"],\n listRunnerApplicationsForOrg: [\"GET /orgs/{org}/actions/runners/downloads\"],\n listRunnerApplicationsForRepo: [\n \"GET /repos/{owner}/{repo}/actions/runners/downloads\",\n ],\n listSelectedReposForOrgSecret: [\n \"GET /orgs/{org}/actions/secrets/{secret_name}/repositories\",\n ],\n listSelectedRepositoriesEnabledGithubActionsOrganization: [\n \"GET /orgs/{org}/actions/permissions/repositories\",\n ],\n listSelfHostedRunnersForOrg: [\"GET /orgs/{org}/actions/runners\"],\n listSelfHostedRunnersForRepo: [\"GET /repos/{owner}/{repo}/actions/runners\"],\n listWorkflowRunArtifacts: [\n \"GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts\",\n ],\n listWorkflowRuns: [\n \"GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs\",\n ],\n listWorkflowRunsForRepo: [\"GET /repos/{owner}/{repo}/actions/runs\"],\n reRunWorkflow: [\"POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun\"],\n removeSelectedRepoFromOrgSecret: [\n \"DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}\",\n ],\n reviewPendingDeploymentsForRun: [\n \"POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments\",\n ],\n setAllowedActionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions/selected-actions\",\n ],\n setAllowedActionsRepository: [\n \"PUT /repos/{owner}/{repo}/actions/permissions/selected-actions\",\n ],\n setGithubActionsPermissionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions\",\n ],\n setGithubActionsPermissionsRepository: [\n \"PUT /repos/{owner}/{repo}/actions/permissions\",\n ],\n setSelectedReposForOrgSecret: [\n \"PUT /orgs/{org}/actions/secrets/{secret_name}/repositories\",\n ],\n setSelectedRepositoriesEnabledGithubActionsOrganization: [\n \"PUT /orgs/{org}/actions/permissions/repositories\",\n ],\n },\n activity: {\n checkRepoIsStarredByAuthenticatedUser: [\"GET /user/starred/{owner}/{repo}\"],\n deleteRepoSubscription: [\"DELETE /repos/{owner}/{repo}/subscription\"],\n deleteThreadSubscription: [\n \"DELETE /notifications/threads/{thread_id}/subscription\",\n ],\n getFeeds: [\"GET /feeds\"],\n getRepoSubscription: [\"GET /repos/{owner}/{repo}/subscription\"],\n getThread: [\"GET /notifications/threads/{thread_id}\"],\n getThreadSubscriptionForAuthenticatedUser: [\n \"GET /notifications/threads/{thread_id}/subscription\",\n ],\n listEventsForAuthenticatedUser: [\"GET /users/{username}/events\"],\n listNotificationsForAuthenticatedUser: [\"GET /notifications\"],\n listOrgEventsForAuthenticatedUser: [\n \"GET /users/{username}/events/orgs/{org}\",\n ],\n listPublicEvents: [\"GET /events\"],\n listPublicEventsForRepoNetwork: [\"GET /networks/{owner}/{repo}/events\"],\n listPublicEventsForUser: [\"GET /users/{username}/events/public\"],\n listPublicOrgEvents: [\"GET /orgs/{org}/events\"],\n listReceivedEventsForUser: [\"GET /users/{username}/received_events\"],\n listReceivedPublicEventsForUser: [\n \"GET /users/{username}/received_events/public\",\n ],\n listRepoEvents: [\"GET /repos/{owner}/{repo}/events\"],\n listRepoNotificationsForAuthenticatedUser: [\n \"GET /repos/{owner}/{repo}/notifications\",\n ],\n listReposStarredByAuthenticatedUser: [\"GET /user/starred\"],\n listReposStarredByUser: [\"GET /users/{username}/starred\"],\n listReposWatchedByUser: [\"GET /users/{username}/subscriptions\"],\n listStargazersForRepo: [\"GET /repos/{owner}/{repo}/stargazers\"],\n listWatchedReposForAuthenticatedUser: [\"GET /user/subscriptions\"],\n listWatchersForRepo: [\"GET /repos/{owner}/{repo}/subscribers\"],\n markNotificationsAsRead: [\"PUT /notifications\"],\n markRepoNotificationsAsRead: [\"PUT /repos/{owner}/{repo}/notifications\"],\n markThreadAsRead: [\"PATCH /notifications/threads/{thread_id}\"],\n setRepoSubscription: [\"PUT /repos/{owner}/{repo}/subscription\"],\n setThreadSubscription: [\n \"PUT /notifications/threads/{thread_id}/subscription\",\n ],\n starRepoForAuthenticatedUser: [\"PUT /user/starred/{owner}/{repo}\"],\n unstarRepoForAuthenticatedUser: [\"DELETE /user/starred/{owner}/{repo}\"],\n },\n apps: {\n addRepoToInstallation: [\n \"PUT /user/installations/{installation_id}/repositories/{repository_id}\",\n ],\n checkToken: [\"POST /applications/{client_id}/token\"],\n createContentAttachment: [\n \"POST /content_references/{content_reference_id}/attachments\",\n { mediaType: { previews: [\"corsair\"] } },\n ],\n createContentAttachmentForRepo: [\n \"POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments\",\n { mediaType: { previews: [\"corsair\"] } },\n ],\n createFromManifest: [\"POST /app-manifests/{code}/conversions\"],\n createInstallationAccessToken: [\n \"POST /app/installations/{installation_id}/access_tokens\",\n ],\n deleteAuthorization: [\"DELETE /applications/{client_id}/grant\"],\n deleteInstallation: [\"DELETE /app/installations/{installation_id}\"],\n deleteToken: [\"DELETE /applications/{client_id}/token\"],\n getAuthenticated: [\"GET /app\"],\n getBySlug: [\"GET /apps/{app_slug}\"],\n getInstallation: [\"GET /app/installations/{installation_id}\"],\n getOrgInstallation: [\"GET /orgs/{org}/installation\"],\n getRepoInstallation: [\"GET /repos/{owner}/{repo}/installation\"],\n getSubscriptionPlanForAccount: [\n \"GET /marketplace_listing/accounts/{account_id}\",\n ],\n getSubscriptionPlanForAccountStubbed: [\n \"GET /marketplace_listing/stubbed/accounts/{account_id}\",\n ],\n getUserInstallation: [\"GET /users/{username}/installation\"],\n getWebhookConfigForApp: [\"GET /app/hook/config\"],\n listAccountsForPlan: [\"GET /marketplace_listing/plans/{plan_id}/accounts\"],\n listAccountsForPlanStubbed: [\n \"GET /marketplace_listing/stubbed/plans/{plan_id}/accounts\",\n ],\n listInstallationReposForAuthenticatedUser: [\n \"GET /user/installations/{installation_id}/repositories\",\n ],\n listInstallations: [\"GET /app/installations\"],\n listInstallationsForAuthenticatedUser: [\"GET /user/installations\"],\n listPlans: [\"GET /marketplace_listing/plans\"],\n listPlansStubbed: [\"GET /marketplace_listing/stubbed/plans\"],\n listReposAccessibleToInstallation: [\"GET /installation/repositories\"],\n listSubscriptionsForAuthenticatedUser: [\"GET /user/marketplace_purchases\"],\n listSubscriptionsForAuthenticatedUserStubbed: [\n \"GET /user/marketplace_purchases/stubbed\",\n ],\n removeRepoFromInstallation: [\n \"DELETE /user/installations/{installation_id}/repositories/{repository_id}\",\n ],\n resetToken: [\"PATCH /applications/{client_id}/token\"],\n revokeInstallationAccessToken: [\"DELETE /installation/token\"],\n scopeToken: [\"POST /applications/{client_id}/token/scoped\"],\n suspendInstallation: [\"PUT /app/installations/{installation_id}/suspended\"],\n unsuspendInstallation: [\n \"DELETE /app/installations/{installation_id}/suspended\",\n ],\n updateWebhookConfigForApp: [\"PATCH /app/hook/config\"],\n },\n billing: {\n getGithubActionsBillingOrg: [\"GET /orgs/{org}/settings/billing/actions\"],\n getGithubActionsBillingUser: [\n \"GET /users/{username}/settings/billing/actions\",\n ],\n getGithubPackagesBillingOrg: [\"GET /orgs/{org}/settings/billing/packages\"],\n getGithubPackagesBillingUser: [\n \"GET /users/{username}/settings/billing/packages\",\n ],\n getSharedStorageBillingOrg: [\n \"GET /orgs/{org}/settings/billing/shared-storage\",\n ],\n getSharedStorageBillingUser: [\n \"GET /users/{username}/settings/billing/shared-storage\",\n ],\n },\n checks: {\n create: [\"POST /repos/{owner}/{repo}/check-runs\"],\n createSuite: [\"POST /repos/{owner}/{repo}/check-suites\"],\n get: [\"GET /repos/{owner}/{repo}/check-runs/{check_run_id}\"],\n getSuite: [\"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}\"],\n listAnnotations: [\n \"GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations\",\n ],\n listForRef: [\"GET /repos/{owner}/{repo}/commits/{ref}/check-runs\"],\n listForSuite: [\n \"GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs\",\n ],\n listSuitesForRef: [\"GET /repos/{owner}/{repo}/commits/{ref}/check-suites\"],\n rerequestSuite: [\n \"POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest\",\n ],\n setSuitesPreferences: [\n \"PATCH /repos/{owner}/{repo}/check-suites/preferences\",\n ],\n update: [\"PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}\"],\n },\n codeScanning: {\n deleteAnalysis: [\n \"DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}\",\n ],\n getAlert: [\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}\",\n {},\n { renamedParameters: { alert_id: \"alert_number\" } },\n ],\n getAnalysis: [\n \"GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}\",\n ],\n getSarif: [\"GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}\"],\n listAlertInstances: [\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances\",\n ],\n listAlertsForRepo: [\"GET /repos/{owner}/{repo}/code-scanning/alerts\"],\n listAlertsInstances: [\n \"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances\",\n {},\n { renamed: [\"codeScanning\", \"listAlertInstances\"] },\n ],\n listRecentAnalyses: [\"GET /repos/{owner}/{repo}/code-scanning/analyses\"],\n updateAlert: [\n \"PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}\",\n ],\n uploadSarif: [\"POST /repos/{owner}/{repo}/code-scanning/sarifs\"],\n },\n codesOfConduct: {\n getAllCodesOfConduct: [\n \"GET /codes_of_conduct\",\n { mediaType: { previews: [\"scarlet-witch\"] } },\n ],\n getConductCode: [\n \"GET /codes_of_conduct/{key}\",\n { mediaType: { previews: [\"scarlet-witch\"] } },\n ],\n getForRepo: [\n \"GET /repos/{owner}/{repo}/community/code_of_conduct\",\n { mediaType: { previews: [\"scarlet-witch\"] } },\n ],\n },\n emojis: { get: [\"GET /emojis\"] },\n enterpriseAdmin: {\n disableSelectedOrganizationGithubActionsEnterprise: [\n \"DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}\",\n ],\n enableSelectedOrganizationGithubActionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}\",\n ],\n getAllowedActionsEnterprise: [\n \"GET /enterprises/{enterprise}/actions/permissions/selected-actions\",\n ],\n getGithubActionsPermissionsEnterprise: [\n \"GET /enterprises/{enterprise}/actions/permissions\",\n ],\n listSelectedOrganizationsEnabledGithubActionsEnterprise: [\n \"GET /enterprises/{enterprise}/actions/permissions/organizations\",\n ],\n setAllowedActionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions/selected-actions\",\n ],\n setGithubActionsPermissionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions\",\n ],\n setSelectedOrganizationsEnabledGithubActionsEnterprise: [\n \"PUT /enterprises/{enterprise}/actions/permissions/organizations\",\n ],\n },\n gists: {\n checkIsStarred: [\"GET /gists/{gist_id}/star\"],\n create: [\"POST /gists\"],\n createComment: [\"POST /gists/{gist_id}/comments\"],\n delete: [\"DELETE /gists/{gist_id}\"],\n deleteComment: [\"DELETE /gists/{gist_id}/comments/{comment_id}\"],\n fork: [\"POST /gists/{gist_id}/forks\"],\n get: [\"GET /gists/{gist_id}\"],\n getComment: [\"GET /gists/{gist_id}/comments/{comment_id}\"],\n getRevision: [\"GET /gists/{gist_id}/{sha}\"],\n list: [\"GET /gists\"],\n listComments: [\"GET /gists/{gist_id}/comments\"],\n listCommits: [\"GET /gists/{gist_id}/commits\"],\n listForUser: [\"GET /users/{username}/gists\"],\n listForks: [\"GET /gists/{gist_id}/forks\"],\n listPublic: [\"GET /gists/public\"],\n listStarred: [\"GET /gists/starred\"],\n star: [\"PUT /gists/{gist_id}/star\"],\n unstar: [\"DELETE /gists/{gist_id}/star\"],\n update: [\"PATCH /gists/{gist_id}\"],\n updateComment: [\"PATCH /gists/{gist_id}/comments/{comment_id}\"],\n },\n git: {\n createBlob: [\"POST /repos/{owner}/{repo}/git/blobs\"],\n createCommit: [\"POST /repos/{owner}/{repo}/git/commits\"],\n createRef: [\"POST /repos/{owner}/{repo}/git/refs\"],\n createTag: [\"POST /repos/{owner}/{repo}/git/tags\"],\n createTree: [\"POST /repos/{owner}/{repo}/git/trees\"],\n deleteRef: [\"DELETE /repos/{owner}/{repo}/git/refs/{ref}\"],\n getBlob: [\"GET /repos/{owner}/{repo}/git/blobs/{file_sha}\"],\n getCommit: [\"GET /repos/{owner}/{repo}/git/commits/{commit_sha}\"],\n getRef: [\"GET /repos/{owner}/{repo}/git/ref/{ref}\"],\n getTag: [\"GET /repos/{owner}/{repo}/git/tags/{tag_sha}\"],\n getTree: [\"GET /repos/{owner}/{repo}/git/trees/{tree_sha}\"],\n listMatchingRefs: [\"GET /repos/{owner}/{repo}/git/matching-refs/{ref}\"],\n updateRef: [\"PATCH /repos/{owner}/{repo}/git/refs/{ref}\"],\n },\n gitignore: {\n getAllTemplates: [\"GET /gitignore/templates\"],\n getTemplate: [\"GET /gitignore/templates/{name}\"],\n },\n interactions: {\n getRestrictionsForAuthenticatedUser: [\"GET /user/interaction-limits\"],\n getRestrictionsForOrg: [\"GET /orgs/{org}/interaction-limits\"],\n getRestrictionsForRepo: [\"GET /repos/{owner}/{repo}/interaction-limits\"],\n getRestrictionsForYourPublicRepos: [\n \"GET /user/interaction-limits\",\n {},\n { renamed: [\"interactions\", \"getRestrictionsForAuthenticatedUser\"] },\n ],\n removeRestrictionsForAuthenticatedUser: [\"DELETE /user/interaction-limits\"],\n removeRestrictionsForOrg: [\"DELETE /orgs/{org}/interaction-limits\"],\n removeRestrictionsForRepo: [\n \"DELETE /repos/{owner}/{repo}/interaction-limits\",\n ],\n removeRestrictionsForYourPublicRepos: [\n \"DELETE /user/interaction-limits\",\n {},\n { renamed: [\"interactions\", \"removeRestrictionsForAuthenticatedUser\"] },\n ],\n setRestrictionsForAuthenticatedUser: [\"PUT /user/interaction-limits\"],\n setRestrictionsForOrg: [\"PUT /orgs/{org}/interaction-limits\"],\n setRestrictionsForRepo: [\"PUT /repos/{owner}/{repo}/interaction-limits\"],\n setRestrictionsForYourPublicRepos: [\n \"PUT /user/interaction-limits\",\n {},\n { renamed: [\"interactions\", \"setRestrictionsForAuthenticatedUser\"] },\n ],\n },\n issues: {\n addAssignees: [\n \"POST /repos/{owner}/{repo}/issues/{issue_number}/assignees\",\n ],\n addLabels: [\"POST /repos/{owner}/{repo}/issues/{issue_number}/labels\"],\n checkUserCanBeAssigned: [\"GET /repos/{owner}/{repo}/assignees/{assignee}\"],\n create: [\"POST /repos/{owner}/{repo}/issues\"],\n createComment: [\n \"POST /repos/{owner}/{repo}/issues/{issue_number}/comments\",\n ],\n createLabel: [\"POST /repos/{owner}/{repo}/labels\"],\n createMilestone: [\"POST /repos/{owner}/{repo}/milestones\"],\n deleteComment: [\n \"DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}\",\n ],\n deleteLabel: [\"DELETE /repos/{owner}/{repo}/labels/{name}\"],\n deleteMilestone: [\n \"DELETE /repos/{owner}/{repo}/milestones/{milestone_number}\",\n ],\n get: [\"GET /repos/{owner}/{repo}/issues/{issue_number}\"],\n getComment: [\"GET /repos/{owner}/{repo}/issues/comments/{comment_id}\"],\n getEvent: [\"GET /repos/{owner}/{repo}/issues/events/{event_id}\"],\n getLabel: [\"GET /repos/{owner}/{repo}/labels/{name}\"],\n getMilestone: [\"GET /repos/{owner}/{repo}/milestones/{milestone_number}\"],\n list: [\"GET /issues\"],\n listAssignees: [\"GET /repos/{owner}/{repo}/assignees\"],\n listComments: [\"GET /repos/{owner}/{repo}/issues/{issue_number}/comments\"],\n listCommentsForRepo: [\"GET /repos/{owner}/{repo}/issues/comments\"],\n listEvents: [\"GET /repos/{owner}/{repo}/issues/{issue_number}/events\"],\n listEventsForRepo: [\"GET /repos/{owner}/{repo}/issues/events\"],\n listEventsForTimeline: [\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/timeline\",\n { mediaType: { previews: [\"mockingbird\"] } },\n ],\n listForAuthenticatedUser: [\"GET /user/issues\"],\n listForOrg: [\"GET /orgs/{org}/issues\"],\n listForRepo: [\"GET /repos/{owner}/{repo}/issues\"],\n listLabelsForMilestone: [\n \"GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels\",\n ],\n listLabelsForRepo: [\"GET /repos/{owner}/{repo}/labels\"],\n listLabelsOnIssue: [\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/labels\",\n ],\n listMilestones: [\"GET /repos/{owner}/{repo}/milestones\"],\n lock: [\"PUT /repos/{owner}/{repo}/issues/{issue_number}/lock\"],\n removeAllLabels: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels\",\n ],\n removeAssignees: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees\",\n ],\n removeLabel: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}\",\n ],\n setLabels: [\"PUT /repos/{owner}/{repo}/issues/{issue_number}/labels\"],\n unlock: [\"DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock\"],\n update: [\"PATCH /repos/{owner}/{repo}/issues/{issue_number}\"],\n updateComment: [\"PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}\"],\n updateLabel: [\"PATCH /repos/{owner}/{repo}/labels/{name}\"],\n updateMilestone: [\n \"PATCH /repos/{owner}/{repo}/milestones/{milestone_number}\",\n ],\n },\n licenses: {\n get: [\"GET /licenses/{license}\"],\n getAllCommonlyUsed: [\"GET /licenses\"],\n getForRepo: [\"GET /repos/{owner}/{repo}/license\"],\n },\n markdown: {\n render: [\"POST /markdown\"],\n renderRaw: [\n \"POST /markdown/raw\",\n { headers: { \"content-type\": \"text/plain; charset=utf-8\" } },\n ],\n },\n meta: {\n get: [\"GET /meta\"],\n getOctocat: [\"GET /octocat\"],\n getZen: [\"GET /zen\"],\n root: [\"GET /\"],\n },\n migrations: {\n cancelImport: [\"DELETE /repos/{owner}/{repo}/import\"],\n deleteArchiveForAuthenticatedUser: [\n \"DELETE /user/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n deleteArchiveForOrg: [\n \"DELETE /orgs/{org}/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n downloadArchiveForOrg: [\n \"GET /orgs/{org}/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n getArchiveForAuthenticatedUser: [\n \"GET /user/migrations/{migration_id}/archive\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n getCommitAuthors: [\"GET /repos/{owner}/{repo}/import/authors\"],\n getImportStatus: [\"GET /repos/{owner}/{repo}/import\"],\n getLargeFiles: [\"GET /repos/{owner}/{repo}/import/large_files\"],\n getStatusForAuthenticatedUser: [\n \"GET /user/migrations/{migration_id}\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n getStatusForOrg: [\n \"GET /orgs/{org}/migrations/{migration_id}\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listForAuthenticatedUser: [\n \"GET /user/migrations\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listForOrg: [\n \"GET /orgs/{org}/migrations\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listReposForOrg: [\n \"GET /orgs/{org}/migrations/{migration_id}/repositories\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n listReposForUser: [\n \"GET /user/migrations/{migration_id}/repositories\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n mapCommitAuthor: [\"PATCH /repos/{owner}/{repo}/import/authors/{author_id}\"],\n setLfsPreference: [\"PATCH /repos/{owner}/{repo}/import/lfs\"],\n startForAuthenticatedUser: [\"POST /user/migrations\"],\n startForOrg: [\"POST /orgs/{org}/migrations\"],\n startImport: [\"PUT /repos/{owner}/{repo}/import\"],\n unlockRepoForAuthenticatedUser: [\n \"DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n unlockRepoForOrg: [\n \"DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock\",\n { mediaType: { previews: [\"wyandotte\"] } },\n ],\n updateImport: [\"PATCH /repos/{owner}/{repo}/import\"],\n },\n orgs: {\n blockUser: [\"PUT /orgs/{org}/blocks/{username}\"],\n cancelInvitation: [\"DELETE /orgs/{org}/invitations/{invitation_id}\"],\n checkBlockedUser: [\"GET /orgs/{org}/blocks/{username}\"],\n checkMembershipForUser: [\"GET /orgs/{org}/members/{username}\"],\n checkPublicMembershipForUser: [\"GET /orgs/{org}/public_members/{username}\"],\n convertMemberToOutsideCollaborator: [\n \"PUT /orgs/{org}/outside_collaborators/{username}\",\n ],\n createInvitation: [\"POST /orgs/{org}/invitations\"],\n createWebhook: [\"POST /orgs/{org}/hooks\"],\n deleteWebhook: [\"DELETE /orgs/{org}/hooks/{hook_id}\"],\n get: [\"GET /orgs/{org}\"],\n getMembershipForAuthenticatedUser: [\"GET /user/memberships/orgs/{org}\"],\n getMembershipForUser: [\"GET /orgs/{org}/memberships/{username}\"],\n getWebhook: [\"GET /orgs/{org}/hooks/{hook_id}\"],\n getWebhookConfigForOrg: [\"GET /orgs/{org}/hooks/{hook_id}/config\"],\n list: [\"GET /organizations\"],\n listAppInstallations: [\"GET /orgs/{org}/installations\"],\n listBlockedUsers: [\"GET /orgs/{org}/blocks\"],\n listFailedInvitations: [\"GET /orgs/{org}/failed_invitations\"],\n listForAuthenticatedUser: [\"GET /user/orgs\"],\n listForUser: [\"GET /users/{username}/orgs\"],\n listInvitationTeams: [\"GET /orgs/{org}/invitations/{invitation_id}/teams\"],\n listMembers: [\"GET /orgs/{org}/members\"],\n listMembershipsForAuthenticatedUser: [\"GET /user/memberships/orgs\"],\n listOutsideCollaborators: [\"GET /orgs/{org}/outside_collaborators\"],\n listPendingInvitations: [\"GET /orgs/{org}/invitations\"],\n listPublicMembers: [\"GET /orgs/{org}/public_members\"],\n listWebhooks: [\"GET /orgs/{org}/hooks\"],\n pingWebhook: [\"POST /orgs/{org}/hooks/{hook_id}/pings\"],\n removeMember: [\"DELETE /orgs/{org}/members/{username}\"],\n removeMembershipForUser: [\"DELETE /orgs/{org}/memberships/{username}\"],\n removeOutsideCollaborator: [\n \"DELETE /orgs/{org}/outside_collaborators/{username}\",\n ],\n removePublicMembershipForAuthenticatedUser: [\n \"DELETE /orgs/{org}/public_members/{username}\",\n ],\n setMembershipForUser: [\"PUT /orgs/{org}/memberships/{username}\"],\n setPublicMembershipForAuthenticatedUser: [\n \"PUT /orgs/{org}/public_members/{username}\",\n ],\n unblockUser: [\"DELETE /orgs/{org}/blocks/{username}\"],\n update: [\"PATCH /orgs/{org}\"],\n updateMembershipForAuthenticatedUser: [\n \"PATCH /user/memberships/orgs/{org}\",\n ],\n updateWebhook: [\"PATCH /orgs/{org}/hooks/{hook_id}\"],\n updateWebhookConfigForOrg: [\"PATCH /orgs/{org}/hooks/{hook_id}/config\"],\n },\n packages: {\n deletePackageForAuthenticatedUser: [\n \"DELETE /user/packages/{package_type}/{package_name}\",\n ],\n deletePackageForOrg: [\n \"DELETE /orgs/{org}/packages/{package_type}/{package_name}\",\n ],\n deletePackageVersionForAuthenticatedUser: [\n \"DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}\",\n ],\n deletePackageVersionForOrg: [\n \"DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}\",\n ],\n getAllPackageVersionsForAPackageOwnedByAnOrg: [\n \"GET /orgs/{org}/packages/{package_type}/{package_name}/versions\",\n {},\n { renamed: [\"packages\", \"getAllPackageVersionsForPackageOwnedByOrg\"] },\n ],\n getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser: [\n \"GET /user/packages/{package_type}/{package_name}/versions\",\n {},\n {\n renamed: [\n \"packages\",\n \"getAllPackageVersionsForPackageOwnedByAuthenticatedUser\",\n ],\n },\n ],\n getAllPackageVersionsForPackageOwnedByAuthenticatedUser: [\n \"GET /user/packages/{package_type}/{package_name}/versions\",\n ],\n getAllPackageVersionsForPackageOwnedByOrg: [\n \"GET /orgs/{org}/packages/{package_type}/{package_name}/versions\",\n ],\n getAllPackageVersionsForPackageOwnedByUser: [\n \"GET /users/{username}/packages/{package_type}/{package_name}/versions\",\n ],\n getPackageForAuthenticatedUser: [\n \"GET /user/packages/{package_type}/{package_name}\",\n ],\n getPackageForOrganization: [\n \"GET /orgs/{org}/packages/{package_type}/{package_name}\",\n ],\n getPackageForUser: [\n \"GET /users/{username}/packages/{package_type}/{package_name}\",\n ],\n getPackageVersionForAuthenticatedUser: [\n \"GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}\",\n ],\n getPackageVersionForOrganization: [\n \"GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}\",\n ],\n getPackageVersionForUser: [\n \"GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}\",\n ],\n restorePackageForAuthenticatedUser: [\n \"POST /user/packages/{package_type}/{package_name}/restore{?token}\",\n ],\n restorePackageForOrg: [\n \"POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}\",\n ],\n restorePackageVersionForAuthenticatedUser: [\n \"POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore\",\n ],\n restorePackageVersionForOrg: [\n \"POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore\",\n ],\n },\n projects: {\n addCollaborator: [\n \"PUT /projects/{project_id}/collaborators/{username}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createCard: [\n \"POST /projects/columns/{column_id}/cards\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createColumn: [\n \"POST /projects/{project_id}/columns\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createForAuthenticatedUser: [\n \"POST /user/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createForOrg: [\n \"POST /orgs/{org}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n createForRepo: [\n \"POST /repos/{owner}/{repo}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n delete: [\n \"DELETE /projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n deleteCard: [\n \"DELETE /projects/columns/cards/{card_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n deleteColumn: [\n \"DELETE /projects/columns/{column_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n get: [\n \"GET /projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n getCard: [\n \"GET /projects/columns/cards/{card_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n getColumn: [\n \"GET /projects/columns/{column_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n getPermissionForUser: [\n \"GET /projects/{project_id}/collaborators/{username}/permission\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listCards: [\n \"GET /projects/columns/{column_id}/cards\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listCollaborators: [\n \"GET /projects/{project_id}/collaborators\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listColumns: [\n \"GET /projects/{project_id}/columns\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listForOrg: [\n \"GET /orgs/{org}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listForRepo: [\n \"GET /repos/{owner}/{repo}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listForUser: [\n \"GET /users/{username}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n moveCard: [\n \"POST /projects/columns/cards/{card_id}/moves\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n moveColumn: [\n \"POST /projects/columns/{column_id}/moves\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n removeCollaborator: [\n \"DELETE /projects/{project_id}/collaborators/{username}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n update: [\n \"PATCH /projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n updateCard: [\n \"PATCH /projects/columns/cards/{card_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n updateColumn: [\n \"PATCH /projects/columns/{column_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n },\n pulls: {\n checkIfMerged: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/merge\"],\n create: [\"POST /repos/{owner}/{repo}/pulls\"],\n createReplyForReviewComment: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies\",\n ],\n createReview: [\"POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews\"],\n createReviewComment: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/comments\",\n ],\n deletePendingReview: [\n \"DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}\",\n ],\n deleteReviewComment: [\n \"DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}\",\n ],\n dismissReview: [\n \"PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals\",\n ],\n get: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}\"],\n getReview: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}\",\n ],\n getReviewComment: [\"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}\"],\n list: [\"GET /repos/{owner}/{repo}/pulls\"],\n listCommentsForReview: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments\",\n ],\n listCommits: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/commits\"],\n listFiles: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/files\"],\n listRequestedReviewers: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n ],\n listReviewComments: [\n \"GET /repos/{owner}/{repo}/pulls/{pull_number}/comments\",\n ],\n listReviewCommentsForRepo: [\"GET /repos/{owner}/{repo}/pulls/comments\"],\n listReviews: [\"GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews\"],\n merge: [\"PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge\"],\n removeRequestedReviewers: [\n \"DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n ],\n requestReviewers: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers\",\n ],\n submitReview: [\n \"POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events\",\n ],\n update: [\"PATCH /repos/{owner}/{repo}/pulls/{pull_number}\"],\n updateBranch: [\n \"PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch\",\n { mediaType: { previews: [\"lydian\"] } },\n ],\n updateReview: [\n \"PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}\",\n ],\n updateReviewComment: [\n \"PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}\",\n ],\n },\n rateLimit: { get: [\"GET /rate_limit\"] },\n reactions: {\n createForCommitComment: [\n \"POST /repos/{owner}/{repo}/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForIssue: [\n \"POST /repos/{owner}/{repo}/issues/{issue_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForIssueComment: [\n \"POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForPullRequestReviewComment: [\n \"POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForRelease: [\n \"POST /repos/{owner}/{repo}/releases/{release_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForTeamDiscussionCommentInOrg: [\n \"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n createForTeamDiscussionInOrg: [\n \"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForCommitComment: [\n \"DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForIssue: [\n \"DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForIssueComment: [\n \"DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForPullRequestComment: [\n \"DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForTeamDiscussion: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteForTeamDiscussionComment: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n deleteLegacy: [\n \"DELETE /reactions/{reaction_id}\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n {\n deprecated: \"octokit.rest.reactions.deleteLegacy() is deprecated, see https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy\",\n },\n ],\n listForCommitComment: [\n \"GET /repos/{owner}/{repo}/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForIssue: [\n \"GET /repos/{owner}/{repo}/issues/{issue_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForIssueComment: [\n \"GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForPullRequestReviewComment: [\n \"GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForTeamDiscussionCommentInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n listForTeamDiscussionInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions\",\n { mediaType: { previews: [\"squirrel-girl\"] } },\n ],\n },\n repos: {\n acceptInvitation: [\"PATCH /user/repository_invitations/{invitation_id}\"],\n addAppAccessRestrictions: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n {},\n { mapToData: \"apps\" },\n ],\n addCollaborator: [\"PUT /repos/{owner}/{repo}/collaborators/{username}\"],\n addStatusCheckContexts: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n {},\n { mapToData: \"contexts\" },\n ],\n addTeamAccessRestrictions: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n {},\n { mapToData: \"teams\" },\n ],\n addUserAccessRestrictions: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n {},\n { mapToData: \"users\" },\n ],\n checkCollaborator: [\"GET /repos/{owner}/{repo}/collaborators/{username}\"],\n checkVulnerabilityAlerts: [\n \"GET /repos/{owner}/{repo}/vulnerability-alerts\",\n { mediaType: { previews: [\"dorian\"] } },\n ],\n compareCommits: [\"GET /repos/{owner}/{repo}/compare/{base}...{head}\"],\n compareCommitsWithBasehead: [\n \"GET /repos/{owner}/{repo}/compare/{basehead}\",\n ],\n createCommitComment: [\n \"POST /repos/{owner}/{repo}/commits/{commit_sha}/comments\",\n ],\n createCommitSignatureProtection: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures\",\n { mediaType: { previews: [\"zzzax\"] } },\n ],\n createCommitStatus: [\"POST /repos/{owner}/{repo}/statuses/{sha}\"],\n createDeployKey: [\"POST /repos/{owner}/{repo}/keys\"],\n createDeployment: [\"POST /repos/{owner}/{repo}/deployments\"],\n createDeploymentStatus: [\n \"POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses\",\n ],\n createDispatchEvent: [\"POST /repos/{owner}/{repo}/dispatches\"],\n createForAuthenticatedUser: [\"POST /user/repos\"],\n createFork: [\"POST /repos/{owner}/{repo}/forks\"],\n createInOrg: [\"POST /orgs/{org}/repos\"],\n createOrUpdateEnvironment: [\n \"PUT /repos/{owner}/{repo}/environments/{environment_name}\",\n ],\n createOrUpdateFileContents: [\"PUT /repos/{owner}/{repo}/contents/{path}\"],\n createPagesSite: [\n \"POST /repos/{owner}/{repo}/pages\",\n { mediaType: { previews: [\"switcheroo\"] } },\n ],\n createRelease: [\"POST /repos/{owner}/{repo}/releases\"],\n createUsingTemplate: [\n \"POST /repos/{template_owner}/{template_repo}/generate\",\n { mediaType: { previews: [\"baptiste\"] } },\n ],\n createWebhook: [\"POST /repos/{owner}/{repo}/hooks\"],\n declineInvitation: [\"DELETE /user/repository_invitations/{invitation_id}\"],\n delete: [\"DELETE /repos/{owner}/{repo}\"],\n deleteAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions\",\n ],\n deleteAdminBranchProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins\",\n ],\n deleteAnEnvironment: [\n \"DELETE /repos/{owner}/{repo}/environments/{environment_name}\",\n ],\n deleteBranchProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection\",\n ],\n deleteCommitComment: [\"DELETE /repos/{owner}/{repo}/comments/{comment_id}\"],\n deleteCommitSignatureProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures\",\n { mediaType: { previews: [\"zzzax\"] } },\n ],\n deleteDeployKey: [\"DELETE /repos/{owner}/{repo}/keys/{key_id}\"],\n deleteDeployment: [\n \"DELETE /repos/{owner}/{repo}/deployments/{deployment_id}\",\n ],\n deleteFile: [\"DELETE /repos/{owner}/{repo}/contents/{path}\"],\n deleteInvitation: [\n \"DELETE /repos/{owner}/{repo}/invitations/{invitation_id}\",\n ],\n deletePagesSite: [\n \"DELETE /repos/{owner}/{repo}/pages\",\n { mediaType: { previews: [\"switcheroo\"] } },\n ],\n deletePullRequestReviewProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews\",\n ],\n deleteRelease: [\"DELETE /repos/{owner}/{repo}/releases/{release_id}\"],\n deleteReleaseAsset: [\n \"DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}\",\n ],\n deleteWebhook: [\"DELETE /repos/{owner}/{repo}/hooks/{hook_id}\"],\n disableAutomatedSecurityFixes: [\n \"DELETE /repos/{owner}/{repo}/automated-security-fixes\",\n { mediaType: { previews: [\"london\"] } },\n ],\n disableVulnerabilityAlerts: [\n \"DELETE /repos/{owner}/{repo}/vulnerability-alerts\",\n { mediaType: { previews: [\"dorian\"] } },\n ],\n downloadArchive: [\n \"GET /repos/{owner}/{repo}/zipball/{ref}\",\n {},\n { renamed: [\"repos\", \"downloadZipballArchive\"] },\n ],\n downloadTarballArchive: [\"GET /repos/{owner}/{repo}/tarball/{ref}\"],\n downloadZipballArchive: [\"GET /repos/{owner}/{repo}/zipball/{ref}\"],\n enableAutomatedSecurityFixes: [\n \"PUT /repos/{owner}/{repo}/automated-security-fixes\",\n { mediaType: { previews: [\"london\"] } },\n ],\n enableVulnerabilityAlerts: [\n \"PUT /repos/{owner}/{repo}/vulnerability-alerts\",\n { mediaType: { previews: [\"dorian\"] } },\n ],\n get: [\"GET /repos/{owner}/{repo}\"],\n getAccessRestrictions: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions\",\n ],\n getAdminBranchProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins\",\n ],\n getAllEnvironments: [\"GET /repos/{owner}/{repo}/environments\"],\n getAllStatusCheckContexts: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n ],\n getAllTopics: [\n \"GET /repos/{owner}/{repo}/topics\",\n { mediaType: { previews: [\"mercy\"] } },\n ],\n getAppsWithAccessToProtectedBranch: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n ],\n getBranch: [\"GET /repos/{owner}/{repo}/branches/{branch}\"],\n getBranchProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection\",\n ],\n getClones: [\"GET /repos/{owner}/{repo}/traffic/clones\"],\n getCodeFrequencyStats: [\"GET /repos/{owner}/{repo}/stats/code_frequency\"],\n getCollaboratorPermissionLevel: [\n \"GET /repos/{owner}/{repo}/collaborators/{username}/permission\",\n ],\n getCombinedStatusForRef: [\"GET /repos/{owner}/{repo}/commits/{ref}/status\"],\n getCommit: [\"GET /repos/{owner}/{repo}/commits/{ref}\"],\n getCommitActivityStats: [\"GET /repos/{owner}/{repo}/stats/commit_activity\"],\n getCommitComment: [\"GET /repos/{owner}/{repo}/comments/{comment_id}\"],\n getCommitSignatureProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures\",\n { mediaType: { previews: [\"zzzax\"] } },\n ],\n getCommunityProfileMetrics: [\"GET /repos/{owner}/{repo}/community/profile\"],\n getContent: [\"GET /repos/{owner}/{repo}/contents/{path}\"],\n getContributorsStats: [\"GET /repos/{owner}/{repo}/stats/contributors\"],\n getDeployKey: [\"GET /repos/{owner}/{repo}/keys/{key_id}\"],\n getDeployment: [\"GET /repos/{owner}/{repo}/deployments/{deployment_id}\"],\n getDeploymentStatus: [\n \"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}\",\n ],\n getEnvironment: [\n \"GET /repos/{owner}/{repo}/environments/{environment_name}\",\n ],\n getLatestPagesBuild: [\"GET /repos/{owner}/{repo}/pages/builds/latest\"],\n getLatestRelease: [\"GET /repos/{owner}/{repo}/releases/latest\"],\n getPages: [\"GET /repos/{owner}/{repo}/pages\"],\n getPagesBuild: [\"GET /repos/{owner}/{repo}/pages/builds/{build_id}\"],\n getPagesHealthCheck: [\"GET /repos/{owner}/{repo}/pages/health\"],\n getParticipationStats: [\"GET /repos/{owner}/{repo}/stats/participation\"],\n getPullRequestReviewProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews\",\n ],\n getPunchCardStats: [\"GET /repos/{owner}/{repo}/stats/punch_card\"],\n getReadme: [\"GET /repos/{owner}/{repo}/readme\"],\n getReadmeInDirectory: [\"GET /repos/{owner}/{repo}/readme/{dir}\"],\n getRelease: [\"GET /repos/{owner}/{repo}/releases/{release_id}\"],\n getReleaseAsset: [\"GET /repos/{owner}/{repo}/releases/assets/{asset_id}\"],\n getReleaseByTag: [\"GET /repos/{owner}/{repo}/releases/tags/{tag}\"],\n getStatusChecksProtection: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n ],\n getTeamsWithAccessToProtectedBranch: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n ],\n getTopPaths: [\"GET /repos/{owner}/{repo}/traffic/popular/paths\"],\n getTopReferrers: [\"GET /repos/{owner}/{repo}/traffic/popular/referrers\"],\n getUsersWithAccessToProtectedBranch: [\n \"GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n ],\n getViews: [\"GET /repos/{owner}/{repo}/traffic/views\"],\n getWebhook: [\"GET /repos/{owner}/{repo}/hooks/{hook_id}\"],\n getWebhookConfigForRepo: [\n \"GET /repos/{owner}/{repo}/hooks/{hook_id}/config\",\n ],\n listBranches: [\"GET /repos/{owner}/{repo}/branches\"],\n listBranchesForHeadCommit: [\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head\",\n { mediaType: { previews: [\"groot\"] } },\n ],\n listCollaborators: [\"GET /repos/{owner}/{repo}/collaborators\"],\n listCommentsForCommit: [\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/comments\",\n ],\n listCommitCommentsForRepo: [\"GET /repos/{owner}/{repo}/comments\"],\n listCommitStatusesForRef: [\n \"GET /repos/{owner}/{repo}/commits/{ref}/statuses\",\n ],\n listCommits: [\"GET /repos/{owner}/{repo}/commits\"],\n listContributors: [\"GET /repos/{owner}/{repo}/contributors\"],\n listDeployKeys: [\"GET /repos/{owner}/{repo}/keys\"],\n listDeploymentStatuses: [\n \"GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses\",\n ],\n listDeployments: [\"GET /repos/{owner}/{repo}/deployments\"],\n listForAuthenticatedUser: [\"GET /user/repos\"],\n listForOrg: [\"GET /orgs/{org}/repos\"],\n listForUser: [\"GET /users/{username}/repos\"],\n listForks: [\"GET /repos/{owner}/{repo}/forks\"],\n listInvitations: [\"GET /repos/{owner}/{repo}/invitations\"],\n listInvitationsForAuthenticatedUser: [\"GET /user/repository_invitations\"],\n listLanguages: [\"GET /repos/{owner}/{repo}/languages\"],\n listPagesBuilds: [\"GET /repos/{owner}/{repo}/pages/builds\"],\n listPublic: [\"GET /repositories\"],\n listPullRequestsAssociatedWithCommit: [\n \"GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls\",\n { mediaType: { previews: [\"groot\"] } },\n ],\n listReleaseAssets: [\n \"GET /repos/{owner}/{repo}/releases/{release_id}/assets\",\n ],\n listReleases: [\"GET /repos/{owner}/{repo}/releases\"],\n listTags: [\"GET /repos/{owner}/{repo}/tags\"],\n listTeams: [\"GET /repos/{owner}/{repo}/teams\"],\n listWebhooks: [\"GET /repos/{owner}/{repo}/hooks\"],\n merge: [\"POST /repos/{owner}/{repo}/merges\"],\n pingWebhook: [\"POST /repos/{owner}/{repo}/hooks/{hook_id}/pings\"],\n removeAppAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n {},\n { mapToData: \"apps\" },\n ],\n removeCollaborator: [\n \"DELETE /repos/{owner}/{repo}/collaborators/{username}\",\n ],\n removeStatusCheckContexts: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n {},\n { mapToData: \"contexts\" },\n ],\n removeStatusCheckProtection: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n ],\n removeTeamAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n {},\n { mapToData: \"teams\" },\n ],\n removeUserAccessRestrictions: [\n \"DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n {},\n { mapToData: \"users\" },\n ],\n renameBranch: [\"POST /repos/{owner}/{repo}/branches/{branch}/rename\"],\n replaceAllTopics: [\n \"PUT /repos/{owner}/{repo}/topics\",\n { mediaType: { previews: [\"mercy\"] } },\n ],\n requestPagesBuild: [\"POST /repos/{owner}/{repo}/pages/builds\"],\n setAdminBranchProtection: [\n \"POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins\",\n ],\n setAppAccessRestrictions: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps\",\n {},\n { mapToData: \"apps\" },\n ],\n setStatusCheckContexts: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts\",\n {},\n { mapToData: \"contexts\" },\n ],\n setTeamAccessRestrictions: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams\",\n {},\n { mapToData: \"teams\" },\n ],\n setUserAccessRestrictions: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users\",\n {},\n { mapToData: \"users\" },\n ],\n testPushWebhook: [\"POST /repos/{owner}/{repo}/hooks/{hook_id}/tests\"],\n transfer: [\"POST /repos/{owner}/{repo}/transfer\"],\n update: [\"PATCH /repos/{owner}/{repo}\"],\n updateBranchProtection: [\n \"PUT /repos/{owner}/{repo}/branches/{branch}/protection\",\n ],\n updateCommitComment: [\"PATCH /repos/{owner}/{repo}/comments/{comment_id}\"],\n updateInformationAboutPagesSite: [\"PUT /repos/{owner}/{repo}/pages\"],\n updateInvitation: [\n \"PATCH /repos/{owner}/{repo}/invitations/{invitation_id}\",\n ],\n updatePullRequestReviewProtection: [\n \"PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews\",\n ],\n updateRelease: [\"PATCH /repos/{owner}/{repo}/releases/{release_id}\"],\n updateReleaseAsset: [\n \"PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}\",\n ],\n updateStatusCheckPotection: [\n \"PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n {},\n { renamed: [\"repos\", \"updateStatusCheckProtection\"] },\n ],\n updateStatusCheckProtection: [\n \"PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks\",\n ],\n updateWebhook: [\"PATCH /repos/{owner}/{repo}/hooks/{hook_id}\"],\n updateWebhookConfigForRepo: [\n \"PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config\",\n ],\n uploadReleaseAsset: [\n \"POST /repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}\",\n { baseUrl: \"https://uploads.github.com\" },\n ],\n },\n search: {\n code: [\"GET /search/code\"],\n commits: [\"GET /search/commits\", { mediaType: { previews: [\"cloak\"] } }],\n issuesAndPullRequests: [\"GET /search/issues\"],\n labels: [\"GET /search/labels\"],\n repos: [\"GET /search/repositories\"],\n topics: [\"GET /search/topics\", { mediaType: { previews: [\"mercy\"] } }],\n users: [\"GET /search/users\"],\n },\n secretScanning: {\n getAlert: [\n \"GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}\",\n ],\n listAlertsForRepo: [\"GET /repos/{owner}/{repo}/secret-scanning/alerts\"],\n updateAlert: [\n \"PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}\",\n ],\n },\n teams: {\n addOrUpdateMembershipForUserInOrg: [\n \"PUT /orgs/{org}/teams/{team_slug}/memberships/{username}\",\n ],\n addOrUpdateProjectPermissionsInOrg: [\n \"PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n addOrUpdateRepoPermissionsInOrg: [\n \"PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}\",\n ],\n checkPermissionsForProjectInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/projects/{project_id}\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n checkPermissionsForRepoInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}\",\n ],\n create: [\"POST /orgs/{org}/teams\"],\n createDiscussionCommentInOrg: [\n \"POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments\",\n ],\n createDiscussionInOrg: [\"POST /orgs/{org}/teams/{team_slug}/discussions\"],\n deleteDiscussionCommentInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}\",\n ],\n deleteDiscussionInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}\",\n ],\n deleteInOrg: [\"DELETE /orgs/{org}/teams/{team_slug}\"],\n getByName: [\"GET /orgs/{org}/teams/{team_slug}\"],\n getDiscussionCommentInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}\",\n ],\n getDiscussionInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}\",\n ],\n getMembershipForUserInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/memberships/{username}\",\n ],\n list: [\"GET /orgs/{org}/teams\"],\n listChildInOrg: [\"GET /orgs/{org}/teams/{team_slug}/teams\"],\n listDiscussionCommentsInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments\",\n ],\n listDiscussionsInOrg: [\"GET /orgs/{org}/teams/{team_slug}/discussions\"],\n listForAuthenticatedUser: [\"GET /user/teams\"],\n listMembersInOrg: [\"GET /orgs/{org}/teams/{team_slug}/members\"],\n listPendingInvitationsInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/invitations\",\n ],\n listProjectsInOrg: [\n \"GET /orgs/{org}/teams/{team_slug}/projects\",\n { mediaType: { previews: [\"inertia\"] } },\n ],\n listReposInOrg: [\"GET /orgs/{org}/teams/{team_slug}/repos\"],\n removeMembershipForUserInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}\",\n ],\n removeProjectInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}\",\n ],\n removeRepoInOrg: [\n \"DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}\",\n ],\n updateDiscussionCommentInOrg: [\n \"PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}\",\n ],\n updateDiscussionInOrg: [\n \"PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}\",\n ],\n updateInOrg: [\"PATCH /orgs/{org}/teams/{team_slug}\"],\n },\n users: {\n addEmailForAuthenticated: [\"POST /user/emails\"],\n block: [\"PUT /user/blocks/{username}\"],\n checkBlocked: [\"GET /user/blocks/{username}\"],\n checkFollowingForUser: [\"GET /users/{username}/following/{target_user}\"],\n checkPersonIsFollowedByAuthenticated: [\"GET /user/following/{username}\"],\n createGpgKeyForAuthenticated: [\"POST /user/gpg_keys\"],\n createPublicSshKeyForAuthenticated: [\"POST /user/keys\"],\n deleteEmailForAuthenticated: [\"DELETE /user/emails\"],\n deleteGpgKeyForAuthenticated: [\"DELETE /user/gpg_keys/{gpg_key_id}\"],\n deletePublicSshKeyForAuthenticated: [\"DELETE /user/keys/{key_id}\"],\n follow: [\"PUT /user/following/{username}\"],\n getAuthenticated: [\"GET /user\"],\n getByUsername: [\"GET /users/{username}\"],\n getContextForUser: [\"GET /users/{username}/hovercard\"],\n getGpgKeyForAuthenticated: [\"GET /user/gpg_keys/{gpg_key_id}\"],\n getPublicSshKeyForAuthenticated: [\"GET /user/keys/{key_id}\"],\n list: [\"GET /users\"],\n listBlockedByAuthenticated: [\"GET /user/blocks\"],\n listEmailsForAuthenticated: [\"GET /user/emails\"],\n listFollowedByAuthenticated: [\"GET /user/following\"],\n listFollowersForAuthenticatedUser: [\"GET /user/followers\"],\n listFollowersForUser: [\"GET /users/{username}/followers\"],\n listFollowingForUser: [\"GET /users/{username}/following\"],\n listGpgKeysForAuthenticated: [\"GET /user/gpg_keys\"],\n listGpgKeysForUser: [\"GET /users/{username}/gpg_keys\"],\n listPublicEmailsForAuthenticated: [\"GET /user/public_emails\"],\n listPublicKeysForUser: [\"GET /users/{username}/keys\"],\n listPublicSshKeysForAuthenticated: [\"GET /user/keys\"],\n setPrimaryEmailVisibilityForAuthenticated: [\"PATCH /user/email/visibility\"],\n unblock: [\"DELETE /user/blocks/{username}\"],\n unfollow: [\"DELETE /user/following/{username}\"],\n updateAuthenticated: [\"PATCH /user\"],\n },\n};\nexport default Endpoints;\n","export const VERSION = \"5.3.0\";\n","export function endpointsToMethods(octokit, endpointsMap) {\n const newMethods = {};\n for (const [scope, endpoints] of Object.entries(endpointsMap)) {\n for (const [methodName, endpoint] of Object.entries(endpoints)) {\n const [route, defaults, decorations] = endpoint;\n const [method, url] = route.split(/ /);\n const endpointDefaults = Object.assign({ method, url }, defaults);\n if (!newMethods[scope]) {\n newMethods[scope] = {};\n }\n const scopeMethods = newMethods[scope];\n if (decorations) {\n scopeMethods[methodName] = decorate(octokit, scope, methodName, endpointDefaults, decorations);\n continue;\n }\n scopeMethods[methodName] = octokit.request.defaults(endpointDefaults);\n }\n }\n return newMethods;\n}\nfunction decorate(octokit, scope, methodName, defaults, decorations) {\n const requestWithDefaults = octokit.request.defaults(defaults);\n /* istanbul ignore next */\n function withDecorations(...args) {\n // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488\n let options = requestWithDefaults.endpoint.merge(...args);\n // There are currently no other decorations than `.mapToData`\n if (decorations.mapToData) {\n options = Object.assign({}, options, {\n data: options[decorations.mapToData],\n [decorations.mapToData]: undefined,\n });\n return requestWithDefaults(options);\n }\n if (decorations.renamed) {\n const [newScope, newMethodName] = decorations.renamed;\n octokit.log.warn(`octokit.${scope}.${methodName}() has been renamed to octokit.${newScope}.${newMethodName}()`);\n }\n if (decorations.deprecated) {\n octokit.log.warn(decorations.deprecated);\n }\n if (decorations.renamedParameters) {\n // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488\n const options = requestWithDefaults.endpoint.merge(...args);\n for (const [name, alias] of Object.entries(decorations.renamedParameters)) {\n if (name in options) {\n octokit.log.warn(`\"${name}\" parameter is deprecated for \"octokit.${scope}.${methodName}()\". Use \"${alias}\" instead`);\n if (!(alias in options)) {\n options[alias] = options[name];\n }\n delete options[name];\n }\n }\n return requestWithDefaults(options);\n }\n // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488\n return requestWithDefaults(...args);\n }\n return Object.assign(withDecorations, requestWithDefaults);\n}\n","import ENDPOINTS from \"./generated/endpoints\";\nimport { VERSION } from \"./version\";\nimport { endpointsToMethods } from \"./endpoints-to-methods\";\nexport function restEndpointMethods(octokit) {\n const api = endpointsToMethods(octokit, ENDPOINTS);\n return {\n rest: api,\n };\n}\nrestEndpointMethods.VERSION = VERSION;\nexport function legacyRestEndpointMethods(octokit) {\n const api = endpointsToMethods(octokit, ENDPOINTS);\n return {\n ...api,\n rest: api,\n };\n}\nlegacyRestEndpointMethods.VERSION = VERSION;\n"],"names":["ENDPOINTS"],"mappings":"AAAA,MAAM,SAAS,GAAG;AAClB,IAAI,OAAO,EAAE;AACb,QAAQ,0BAA0B,EAAE;AACpC,YAAY,4EAA4E;AACxF,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,iBAAiB,EAAE;AAC3B,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,+BAA+B,EAAE;AACzC,YAAY,yFAAyF;AACrG,SAAS;AACT,QAAQ,uBAAuB,EAAE,CAAC,+CAA+C,CAAC;AAClF,QAAQ,wBAAwB,EAAE;AAClC,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,6BAA6B,EAAE;AACvC,YAAY,qDAAqD;AACjE,SAAS;AACT,QAAQ,8BAA8B,EAAE;AACxC,YAAY,+DAA+D;AAC3E,SAAS;AACT,QAAQ,uBAAuB,EAAE,CAAC,+CAA+C,CAAC;AAClF,QAAQ,wBAAwB,EAAE;AAClC,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,sBAAsB,EAAE;AAChC,YAAY,uEAAuE;AACnF,SAAS;AACT,QAAQ,cAAc,EAAE;AACxB,YAAY,8DAA8D;AAC1E,SAAS;AACT,QAAQ,uBAAuB,EAAE;AACjC,YAAY,4FAA4F;AACxG,SAAS;AACT,QAAQ,eAAe,EAAE,CAAC,kDAAkD,CAAC;AAC7E,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,4DAA4D;AACxE,SAAS;AACT,QAAQ,6BAA6B,EAAE;AACvC,YAAY,gDAAgD;AAC5D,SAAS;AACT,QAAQ,8BAA8B,EAAE;AACxC,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,oDAAoD,CAAC;AACjF,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,kDAAkD,EAAE;AAC5D,YAAY,qEAAqE;AACjF,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,mEAAmE;AAC/E,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,4EAA4E;AACxF,SAAS;AACT,QAAQ,6BAA6B,EAAE;AACvC,YAAY,sDAAsD;AAClE,SAAS;AACT,QAAQ,uBAAuB,EAAE;AACjC,YAAY,sDAAsD;AAClE,SAAS;AACT,QAAQ,iDAAiD,EAAE;AAC3D,YAAY,kEAAkE;AAC9E,SAAS;AACT,QAAQ,cAAc,EAAE;AACxB,YAAY,kEAAkE;AAC9E,SAAS;AACT,QAAQ,6BAA6B,EAAE;AACvC,YAAY,sDAAsD;AAClE,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,gEAAgE;AAC5E,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,2DAA2D,CAAC;AAClF,QAAQ,uBAAuB,EAAE;AACjC,YAAY,sFAAsF;AAClG,SAAS;AACT,QAAQ,oBAAoB,EAAE;AAC9B,YAAY,yFAAyF;AACrG,SAAS;AACT,QAAQ,uCAAuC,EAAE;AACjD,YAAY,qCAAqC;AACjD,SAAS;AACT,QAAQ,qCAAqC,EAAE;AAC/C,YAAY,+CAA+C;AAC3D,SAAS;AACT,QAAQ,oBAAoB,EAAE,CAAC,iDAAiD,CAAC;AACjF,QAAQ,eAAe,EAAE,CAAC,4CAA4C,CAAC;AACvE,QAAQ,YAAY,EAAE,CAAC,+CAA+C,CAAC;AACvE,QAAQ,2BAA2B,EAAE;AACrC,YAAY,qEAAqE;AACjF,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,+CAA+C;AAC3D,YAAY,EAAE;AACd,YAAY,EAAE,OAAO,EAAE,CAAC,SAAS,EAAE,uCAAuC,CAAC,EAAE;AAC7E,SAAS;AACT,QAAQ,gBAAgB,EAAE,CAAC,sDAAsD,CAAC;AAClF,QAAQ,aAAa,EAAE,CAAC,yDAAyD,CAAC;AAClF,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,yBAAyB,EAAE,CAAC,6CAA6C,CAAC;AAClF,QAAQ,0BAA0B,EAAE;AACpC,YAAY,uDAAuD;AACnE,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,2DAA2D,CAAC;AAClF,QAAQ,cAAc,EAAE,CAAC,iDAAiD,CAAC;AAC3E,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,kEAAkE;AAC9E,SAAS;AACT,QAAQ,oBAAoB,EAAE,CAAC,6CAA6C,CAAC;AAC7E,QAAQ,sBAAsB,EAAE;AAChC,YAAY,2EAA2E;AACvF,SAAS;AACT,QAAQ,sBAAsB,EAAE;AAChC,YAAY,sDAAsD;AAClE,SAAS;AACT,QAAQ,cAAc,EAAE,CAAC,iCAAiC,CAAC;AAC3D,QAAQ,eAAe,EAAE,CAAC,2CAA2C,CAAC;AACtE,QAAQ,iBAAiB,EAAE,CAAC,6CAA6C,CAAC;AAC1E,QAAQ,4BAA4B,EAAE,CAAC,2CAA2C,CAAC;AACnF,QAAQ,6BAA6B,EAAE;AACvC,YAAY,qDAAqD;AACjE,SAAS;AACT,QAAQ,6BAA6B,EAAE;AACvC,YAAY,4DAA4D;AACxE,SAAS;AACT,QAAQ,wDAAwD,EAAE;AAClE,YAAY,kDAAkD;AAC9D,SAAS;AACT,QAAQ,2BAA2B,EAAE,CAAC,iCAAiC,CAAC;AACxE,QAAQ,4BAA4B,EAAE,CAAC,2CAA2C,CAAC;AACnF,QAAQ,wBAAwB,EAAE;AAClC,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,gEAAgE;AAC5E,SAAS;AACT,QAAQ,uBAAuB,EAAE,CAAC,wCAAwC,CAAC;AAC3E,QAAQ,aAAa,EAAE,CAAC,wDAAwD,CAAC;AACjF,QAAQ,+BAA+B,EAAE;AACzC,YAAY,+EAA+E;AAC3F,SAAS;AACT,QAAQ,8BAA8B,EAAE;AACxC,YAAY,sEAAsE;AAClF,SAAS;AACT,QAAQ,6BAA6B,EAAE;AACvC,YAAY,sDAAsD;AAClE,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,gEAAgE;AAC5E,SAAS;AACT,QAAQ,uCAAuC,EAAE;AACjD,YAAY,qCAAqC;AACjD,SAAS;AACT,QAAQ,qCAAqC,EAAE;AAC/C,YAAY,+CAA+C;AAC3D,SAAS;AACT,QAAQ,4BAA4B,EAAE;AACtC,YAAY,4DAA4D;AACxE,SAAS;AACT,QAAQ,uDAAuD,EAAE;AACjE,YAAY,kDAAkD;AAC9D,SAAS;AACT,KAAK;AACL,IAAI,QAAQ,EAAE;AACd,QAAQ,qCAAqC,EAAE,CAAC,kCAAkC,CAAC;AACnF,QAAQ,sBAAsB,EAAE,CAAC,2CAA2C,CAAC;AAC7E,QAAQ,wBAAwB,EAAE;AAClC,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,QAAQ,EAAE,CAAC,YAAY,CAAC;AAChC,QAAQ,mBAAmB,EAAE,CAAC,wCAAwC,CAAC;AACvE,QAAQ,SAAS,EAAE,CAAC,wCAAwC,CAAC;AAC7D,QAAQ,yCAAyC,EAAE;AACnD,YAAY,qDAAqD;AACjE,SAAS;AACT,QAAQ,8BAA8B,EAAE,CAAC,8BAA8B,CAAC;AACxE,QAAQ,qCAAqC,EAAE,CAAC,oBAAoB,CAAC;AACrE,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,yCAAyC;AACrD,SAAS;AACT,QAAQ,gBAAgB,EAAE,CAAC,aAAa,CAAC;AACzC,QAAQ,8BAA8B,EAAE,CAAC,qCAAqC,CAAC;AAC/E,QAAQ,uBAAuB,EAAE,CAAC,qCAAqC,CAAC;AACxE,QAAQ,mBAAmB,EAAE,CAAC,wBAAwB,CAAC;AACvD,QAAQ,yBAAyB,EAAE,CAAC,uCAAuC,CAAC;AAC5E,QAAQ,+BAA+B,EAAE;AACzC,YAAY,8CAA8C;AAC1D,SAAS;AACT,QAAQ,cAAc,EAAE,CAAC,kCAAkC,CAAC;AAC5D,QAAQ,yCAAyC,EAAE;AACnD,YAAY,yCAAyC;AACrD,SAAS;AACT,QAAQ,mCAAmC,EAAE,CAAC,mBAAmB,CAAC;AAClE,QAAQ,sBAAsB,EAAE,CAAC,+BAA+B,CAAC;AACjE,QAAQ,sBAAsB,EAAE,CAAC,qCAAqC,CAAC;AACvE,QAAQ,qBAAqB,EAAE,CAAC,sCAAsC,CAAC;AACvE,QAAQ,oCAAoC,EAAE,CAAC,yBAAyB,CAAC;AACzE,QAAQ,mBAAmB,EAAE,CAAC,uCAAuC,CAAC;AACtE,QAAQ,uBAAuB,EAAE,CAAC,oBAAoB,CAAC;AACvD,QAAQ,2BAA2B,EAAE,CAAC,yCAAyC,CAAC;AAChF,QAAQ,gBAAgB,EAAE,CAAC,0CAA0C,CAAC;AACtE,QAAQ,mBAAmB,EAAE,CAAC,wCAAwC,CAAC;AACvE,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,qDAAqD;AACjE,SAAS;AACT,QAAQ,4BAA4B,EAAE,CAAC,kCAAkC,CAAC;AAC1E,QAAQ,8BAA8B,EAAE,CAAC,qCAAqC,CAAC;AAC/E,KAAK;AACL,IAAI,IAAI,EAAE;AACV,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,wEAAwE;AACpF,SAAS;AACT,QAAQ,UAAU,EAAE,CAAC,sCAAsC,CAAC;AAC5D,QAAQ,uBAAuB,EAAE;AACjC,YAAY,6DAA6D;AACzE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,8BAA8B,EAAE;AACxC,YAAY,kFAAkF;AAC9F,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,kBAAkB,EAAE,CAAC,wCAAwC,CAAC;AACtE,QAAQ,6BAA6B,EAAE;AACvC,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,mBAAmB,EAAE,CAAC,wCAAwC,CAAC;AACvE,QAAQ,kBAAkB,EAAE,CAAC,6CAA6C,CAAC;AAC3E,QAAQ,WAAW,EAAE,CAAC,wCAAwC,CAAC;AAC/D,QAAQ,gBAAgB,EAAE,CAAC,UAAU,CAAC;AACtC,QAAQ,SAAS,EAAE,CAAC,sBAAsB,CAAC;AAC3C,QAAQ,eAAe,EAAE,CAAC,0CAA0C,CAAC;AACrE,QAAQ,kBAAkB,EAAE,CAAC,8BAA8B,CAAC;AAC5D,QAAQ,mBAAmB,EAAE,CAAC,wCAAwC,CAAC;AACvE,QAAQ,6BAA6B,EAAE;AACvC,YAAY,gDAAgD;AAC5D,SAAS;AACT,QAAQ,oCAAoC,EAAE;AAC9C,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,mBAAmB,EAAE,CAAC,oCAAoC,CAAC;AACnE,QAAQ,sBAAsB,EAAE,CAAC,sBAAsB,CAAC;AACxD,QAAQ,mBAAmB,EAAE,CAAC,mDAAmD,CAAC;AAClF,QAAQ,0BAA0B,EAAE;AACpC,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,yCAAyC,EAAE;AACnD,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,wBAAwB,CAAC;AACrD,QAAQ,qCAAqC,EAAE,CAAC,yBAAyB,CAAC;AAC1E,QAAQ,SAAS,EAAE,CAAC,gCAAgC,CAAC;AACrD,QAAQ,gBAAgB,EAAE,CAAC,wCAAwC,CAAC;AACpE,QAAQ,iCAAiC,EAAE,CAAC,gCAAgC,CAAC;AAC7E,QAAQ,qCAAqC,EAAE,CAAC,iCAAiC,CAAC;AAClF,QAAQ,4CAA4C,EAAE;AACtD,YAAY,yCAAyC;AACrD,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,2EAA2E;AACvF,SAAS;AACT,QAAQ,UAAU,EAAE,CAAC,uCAAuC,CAAC;AAC7D,QAAQ,6BAA6B,EAAE,CAAC,4BAA4B,CAAC;AACrE,QAAQ,UAAU,EAAE,CAAC,6CAA6C,CAAC;AACnE,QAAQ,mBAAmB,EAAE,CAAC,oDAAoD,CAAC;AACnF,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,uDAAuD;AACnE,SAAS;AACT,QAAQ,yBAAyB,EAAE,CAAC,wBAAwB,CAAC;AAC7D,KAAK;AACL,IAAI,OAAO,EAAE;AACb,QAAQ,0BAA0B,EAAE,CAAC,0CAA0C,CAAC;AAChF,QAAQ,2BAA2B,EAAE;AACrC,YAAY,gDAAgD;AAC5D,SAAS;AACT,QAAQ,2BAA2B,EAAE,CAAC,2CAA2C,CAAC;AAClF,QAAQ,4BAA4B,EAAE;AACtC,YAAY,iDAAiD;AAC7D,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,iDAAiD;AAC7D,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,uDAAuD;AACnE,SAAS;AACT,KAAK;AACL,IAAI,MAAM,EAAE;AACZ,QAAQ,MAAM,EAAE,CAAC,uCAAuC,CAAC;AACzD,QAAQ,WAAW,EAAE,CAAC,yCAAyC,CAAC;AAChE,QAAQ,GAAG,EAAE,CAAC,qDAAqD,CAAC;AACpE,QAAQ,QAAQ,EAAE,CAAC,yDAAyD,CAAC;AAC7E,QAAQ,eAAe,EAAE;AACzB,YAAY,iEAAiE;AAC7E,SAAS;AACT,QAAQ,UAAU,EAAE,CAAC,oDAAoD,CAAC;AAC1E,QAAQ,YAAY,EAAE;AACtB,YAAY,oEAAoE;AAChF,SAAS;AACT,QAAQ,gBAAgB,EAAE,CAAC,sDAAsD,CAAC;AAClF,QAAQ,cAAc,EAAE;AACxB,YAAY,oEAAoE;AAChF,SAAS;AACT,QAAQ,oBAAoB,EAAE;AAC9B,YAAY,sDAAsD;AAClE,SAAS;AACT,QAAQ,MAAM,EAAE,CAAC,uDAAuD,CAAC;AACzE,KAAK;AACL,IAAI,YAAY,EAAE;AAClB,QAAQ,cAAc,EAAE;AACxB,YAAY,oFAAoF;AAChG,SAAS;AACT,QAAQ,QAAQ,EAAE;AAClB,YAAY,+DAA+D;AAC3E,YAAY,EAAE;AACd,YAAY,EAAE,iBAAiB,EAAE,EAAE,QAAQ,EAAE,cAAc,EAAE,EAAE;AAC/D,SAAS;AACT,QAAQ,WAAW,EAAE;AACrB,YAAY,gEAAgE;AAC5E,SAAS;AACT,QAAQ,QAAQ,EAAE,CAAC,2DAA2D,CAAC;AAC/E,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,yEAAyE;AACrF,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,gDAAgD,CAAC;AAC7E,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,yEAAyE;AACrF,YAAY,EAAE;AACd,YAAY,EAAE,OAAO,EAAE,CAAC,cAAc,EAAE,oBAAoB,CAAC,EAAE;AAC/D,SAAS;AACT,QAAQ,kBAAkB,EAAE,CAAC,kDAAkD,CAAC;AAChF,QAAQ,WAAW,EAAE;AACrB,YAAY,iEAAiE;AAC7E,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,iDAAiD,CAAC;AACxE,KAAK;AACL,IAAI,cAAc,EAAE;AACpB,QAAQ,oBAAoB,EAAE;AAC9B,YAAY,uBAAuB;AACnC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,cAAc,EAAE;AACxB,YAAY,6BAA6B;AACzC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,qDAAqD;AACjE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,KAAK;AACL,IAAI,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,EAAE;AACpC,IAAI,eAAe,EAAE;AACrB,QAAQ,kDAAkD,EAAE;AAC5D,YAAY,6EAA6E;AACzF,SAAS;AACT,QAAQ,iDAAiD,EAAE;AAC3D,YAAY,0EAA0E;AACtF,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,oEAAoE;AAChF,SAAS;AACT,QAAQ,qCAAqC,EAAE;AAC/C,YAAY,mDAAmD;AAC/D,SAAS;AACT,QAAQ,uDAAuD,EAAE;AACjE,YAAY,iEAAiE;AAC7E,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,oEAAoE;AAChF,SAAS;AACT,QAAQ,qCAAqC,EAAE;AAC/C,YAAY,mDAAmD;AAC/D,SAAS;AACT,QAAQ,sDAAsD,EAAE;AAChE,YAAY,iEAAiE;AAC7E,SAAS;AACT,KAAK;AACL,IAAI,KAAK,EAAE;AACX,QAAQ,cAAc,EAAE,CAAC,2BAA2B,CAAC;AACrD,QAAQ,MAAM,EAAE,CAAC,aAAa,CAAC;AAC/B,QAAQ,aAAa,EAAE,CAAC,gCAAgC,CAAC;AACzD,QAAQ,MAAM,EAAE,CAAC,yBAAyB,CAAC;AAC3C,QAAQ,aAAa,EAAE,CAAC,+CAA+C,CAAC;AACxE,QAAQ,IAAI,EAAE,CAAC,6BAA6B,CAAC;AAC7C,QAAQ,GAAG,EAAE,CAAC,sBAAsB,CAAC;AACrC,QAAQ,UAAU,EAAE,CAAC,4CAA4C,CAAC;AAClE,QAAQ,WAAW,EAAE,CAAC,4BAA4B,CAAC;AACnD,QAAQ,IAAI,EAAE,CAAC,YAAY,CAAC;AAC5B,QAAQ,YAAY,EAAE,CAAC,+BAA+B,CAAC;AACvD,QAAQ,WAAW,EAAE,CAAC,8BAA8B,CAAC;AACrD,QAAQ,WAAW,EAAE,CAAC,6BAA6B,CAAC;AACpD,QAAQ,SAAS,EAAE,CAAC,4BAA4B,CAAC;AACjD,QAAQ,UAAU,EAAE,CAAC,mBAAmB,CAAC;AACzC,QAAQ,WAAW,EAAE,CAAC,oBAAoB,CAAC;AAC3C,QAAQ,IAAI,EAAE,CAAC,2BAA2B,CAAC;AAC3C,QAAQ,MAAM,EAAE,CAAC,8BAA8B,CAAC;AAChD,QAAQ,MAAM,EAAE,CAAC,wBAAwB,CAAC;AAC1C,QAAQ,aAAa,EAAE,CAAC,8CAA8C,CAAC;AACvE,KAAK;AACL,IAAI,GAAG,EAAE;AACT,QAAQ,UAAU,EAAE,CAAC,sCAAsC,CAAC;AAC5D,QAAQ,YAAY,EAAE,CAAC,wCAAwC,CAAC;AAChE,QAAQ,SAAS,EAAE,CAAC,qCAAqC,CAAC;AAC1D,QAAQ,SAAS,EAAE,CAAC,qCAAqC,CAAC;AAC1D,QAAQ,UAAU,EAAE,CAAC,sCAAsC,CAAC;AAC5D,QAAQ,SAAS,EAAE,CAAC,6CAA6C,CAAC;AAClE,QAAQ,OAAO,EAAE,CAAC,gDAAgD,CAAC;AACnE,QAAQ,SAAS,EAAE,CAAC,oDAAoD,CAAC;AACzE,QAAQ,MAAM,EAAE,CAAC,yCAAyC,CAAC;AAC3D,QAAQ,MAAM,EAAE,CAAC,8CAA8C,CAAC;AAChE,QAAQ,OAAO,EAAE,CAAC,gDAAgD,CAAC;AACnE,QAAQ,gBAAgB,EAAE,CAAC,mDAAmD,CAAC;AAC/E,QAAQ,SAAS,EAAE,CAAC,4CAA4C,CAAC;AACjE,KAAK;AACL,IAAI,SAAS,EAAE;AACf,QAAQ,eAAe,EAAE,CAAC,0BAA0B,CAAC;AACrD,QAAQ,WAAW,EAAE,CAAC,iCAAiC,CAAC;AACxD,KAAK;AACL,IAAI,YAAY,EAAE;AAClB,QAAQ,mCAAmC,EAAE,CAAC,8BAA8B,CAAC;AAC7E,QAAQ,qBAAqB,EAAE,CAAC,oCAAoC,CAAC;AACrE,QAAQ,sBAAsB,EAAE,CAAC,8CAA8C,CAAC;AAChF,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,8BAA8B;AAC1C,YAAY,EAAE;AACd,YAAY,EAAE,OAAO,EAAE,CAAC,cAAc,EAAE,qCAAqC,CAAC,EAAE;AAChF,SAAS;AACT,QAAQ,sCAAsC,EAAE,CAAC,iCAAiC,CAAC;AACnF,QAAQ,wBAAwB,EAAE,CAAC,uCAAuC,CAAC;AAC3E,QAAQ,yBAAyB,EAAE;AACnC,YAAY,iDAAiD;AAC7D,SAAS;AACT,QAAQ,oCAAoC,EAAE;AAC9C,YAAY,iCAAiC;AAC7C,YAAY,EAAE;AACd,YAAY,EAAE,OAAO,EAAE,CAAC,cAAc,EAAE,wCAAwC,CAAC,EAAE;AACnF,SAAS;AACT,QAAQ,mCAAmC,EAAE,CAAC,8BAA8B,CAAC;AAC7E,QAAQ,qBAAqB,EAAE,CAAC,oCAAoC,CAAC;AACrE,QAAQ,sBAAsB,EAAE,CAAC,8CAA8C,CAAC;AAChF,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,8BAA8B;AAC1C,YAAY,EAAE;AACd,YAAY,EAAE,OAAO,EAAE,CAAC,cAAc,EAAE,qCAAqC,CAAC,EAAE;AAChF,SAAS;AACT,KAAK;AACL,IAAI,MAAM,EAAE;AACZ,QAAQ,YAAY,EAAE;AACtB,YAAY,4DAA4D;AACxE,SAAS;AACT,QAAQ,SAAS,EAAE,CAAC,yDAAyD,CAAC;AAC9E,QAAQ,sBAAsB,EAAE,CAAC,gDAAgD,CAAC;AAClF,QAAQ,MAAM,EAAE,CAAC,mCAAmC,CAAC;AACrD,QAAQ,aAAa,EAAE;AACvB,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,mCAAmC,CAAC;AAC1D,QAAQ,eAAe,EAAE,CAAC,uCAAuC,CAAC;AAClE,QAAQ,aAAa,EAAE;AACvB,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,4CAA4C,CAAC;AACnE,QAAQ,eAAe,EAAE;AACzB,YAAY,4DAA4D;AACxE,SAAS;AACT,QAAQ,GAAG,EAAE,CAAC,iDAAiD,CAAC;AAChE,QAAQ,UAAU,EAAE,CAAC,wDAAwD,CAAC;AAC9E,QAAQ,QAAQ,EAAE,CAAC,oDAAoD,CAAC;AACxE,QAAQ,QAAQ,EAAE,CAAC,yCAAyC,CAAC;AAC7D,QAAQ,YAAY,EAAE,CAAC,yDAAyD,CAAC;AACjF,QAAQ,IAAI,EAAE,CAAC,aAAa,CAAC;AAC7B,QAAQ,aAAa,EAAE,CAAC,qCAAqC,CAAC;AAC9D,QAAQ,YAAY,EAAE,CAAC,0DAA0D,CAAC;AAClF,QAAQ,mBAAmB,EAAE,CAAC,2CAA2C,CAAC;AAC1E,QAAQ,UAAU,EAAE,CAAC,wDAAwD,CAAC;AAC9E,QAAQ,iBAAiB,EAAE,CAAC,yCAAyC,CAAC;AACtE,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,0DAA0D;AACtE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC,EAAE,EAAE;AACxD,SAAS;AACT,QAAQ,wBAAwB,EAAE,CAAC,kBAAkB,CAAC;AACtD,QAAQ,UAAU,EAAE,CAAC,wBAAwB,CAAC;AAC9C,QAAQ,WAAW,EAAE,CAAC,kCAAkC,CAAC;AACzD,QAAQ,sBAAsB,EAAE;AAChC,YAAY,gEAAgE;AAC5E,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,kCAAkC,CAAC;AAC/D,QAAQ,iBAAiB,EAAE;AAC3B,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,cAAc,EAAE,CAAC,sCAAsC,CAAC;AAChE,QAAQ,IAAI,EAAE,CAAC,sDAAsD,CAAC;AACtE,QAAQ,eAAe,EAAE;AACzB,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,8DAA8D;AAC1E,SAAS;AACT,QAAQ,WAAW,EAAE;AACrB,YAAY,kEAAkE;AAC9E,SAAS;AACT,QAAQ,SAAS,EAAE,CAAC,wDAAwD,CAAC;AAC7E,QAAQ,MAAM,EAAE,CAAC,yDAAyD,CAAC;AAC3E,QAAQ,MAAM,EAAE,CAAC,mDAAmD,CAAC;AACrE,QAAQ,aAAa,EAAE,CAAC,0DAA0D,CAAC;AACnF,QAAQ,WAAW,EAAE,CAAC,2CAA2C,CAAC;AAClE,QAAQ,eAAe,EAAE;AACzB,YAAY,2DAA2D;AACvE,SAAS;AACT,KAAK;AACL,IAAI,QAAQ,EAAE;AACd,QAAQ,GAAG,EAAE,CAAC,yBAAyB,CAAC;AACxC,QAAQ,kBAAkB,EAAE,CAAC,eAAe,CAAC;AAC7C,QAAQ,UAAU,EAAE,CAAC,mCAAmC,CAAC;AACzD,KAAK;AACL,IAAI,QAAQ,EAAE;AACd,QAAQ,MAAM,EAAE,CAAC,gBAAgB,CAAC;AAClC,QAAQ,SAAS,EAAE;AACnB,YAAY,oBAAoB;AAChC,YAAY,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,2BAA2B,EAAE,EAAE;AACxE,SAAS;AACT,KAAK;AACL,IAAI,IAAI,EAAE;AACV,QAAQ,GAAG,EAAE,CAAC,WAAW,CAAC;AAC1B,QAAQ,UAAU,EAAE,CAAC,cAAc,CAAC;AACpC,QAAQ,MAAM,EAAE,CAAC,UAAU,CAAC;AAC5B,QAAQ,IAAI,EAAE,CAAC,OAAO,CAAC;AACvB,KAAK;AACL,IAAI,UAAU,EAAE;AAChB,QAAQ,YAAY,EAAE,CAAC,qCAAqC,CAAC;AAC7D,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,gDAAgD;AAC5D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,sDAAsD;AAClE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,mDAAmD;AAC/D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,8BAA8B,EAAE;AACxC,YAAY,6CAA6C;AACzD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,gBAAgB,EAAE,CAAC,0CAA0C,CAAC;AACtE,QAAQ,eAAe,EAAE,CAAC,kCAAkC,CAAC;AAC7D,QAAQ,aAAa,EAAE,CAAC,8CAA8C,CAAC;AACvE,QAAQ,6BAA6B,EAAE;AACvC,YAAY,qCAAqC;AACjD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,2CAA2C;AACvD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,wBAAwB,EAAE;AAClC,YAAY,sBAAsB;AAClC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,4BAA4B;AACxC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,wDAAwD;AACpE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,kDAAkD;AAC9D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,eAAe,EAAE,CAAC,wDAAwD,CAAC;AACnF,QAAQ,gBAAgB,EAAE,CAAC,wCAAwC,CAAC;AACpE,QAAQ,yBAAyB,EAAE,CAAC,uBAAuB,CAAC;AAC5D,QAAQ,WAAW,EAAE,CAAC,6BAA6B,CAAC;AACpD,QAAQ,WAAW,EAAE,CAAC,kCAAkC,CAAC;AACzD,QAAQ,8BAA8B,EAAE;AACxC,YAAY,+DAA+D;AAC3E,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,qEAAqE;AACjF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,WAAW,CAAC,EAAE,EAAE;AACtD,SAAS;AACT,QAAQ,YAAY,EAAE,CAAC,oCAAoC,CAAC;AAC5D,KAAK;AACL,IAAI,IAAI,EAAE;AACV,QAAQ,SAAS,EAAE,CAAC,mCAAmC,CAAC;AACxD,QAAQ,gBAAgB,EAAE,CAAC,gDAAgD,CAAC;AAC5E,QAAQ,gBAAgB,EAAE,CAAC,mCAAmC,CAAC;AAC/D,QAAQ,sBAAsB,EAAE,CAAC,oCAAoC,CAAC;AACtE,QAAQ,4BAA4B,EAAE,CAAC,2CAA2C,CAAC;AACnF,QAAQ,kCAAkC,EAAE;AAC5C,YAAY,kDAAkD;AAC9D,SAAS;AACT,QAAQ,gBAAgB,EAAE,CAAC,8BAA8B,CAAC;AAC1D,QAAQ,aAAa,EAAE,CAAC,wBAAwB,CAAC;AACjD,QAAQ,aAAa,EAAE,CAAC,oCAAoC,CAAC;AAC7D,QAAQ,GAAG,EAAE,CAAC,iBAAiB,CAAC;AAChC,QAAQ,iCAAiC,EAAE,CAAC,kCAAkC,CAAC;AAC/E,QAAQ,oBAAoB,EAAE,CAAC,wCAAwC,CAAC;AACxE,QAAQ,UAAU,EAAE,CAAC,iCAAiC,CAAC;AACvD,QAAQ,sBAAsB,EAAE,CAAC,wCAAwC,CAAC;AAC1E,QAAQ,IAAI,EAAE,CAAC,oBAAoB,CAAC;AACpC,QAAQ,oBAAoB,EAAE,CAAC,+BAA+B,CAAC;AAC/D,QAAQ,gBAAgB,EAAE,CAAC,wBAAwB,CAAC;AACpD,QAAQ,qBAAqB,EAAE,CAAC,oCAAoC,CAAC;AACrE,QAAQ,wBAAwB,EAAE,CAAC,gBAAgB,CAAC;AACpD,QAAQ,WAAW,EAAE,CAAC,4BAA4B,CAAC;AACnD,QAAQ,mBAAmB,EAAE,CAAC,mDAAmD,CAAC;AAClF,QAAQ,WAAW,EAAE,CAAC,yBAAyB,CAAC;AAChD,QAAQ,mCAAmC,EAAE,CAAC,4BAA4B,CAAC;AAC3E,QAAQ,wBAAwB,EAAE,CAAC,uCAAuC,CAAC;AAC3E,QAAQ,sBAAsB,EAAE,CAAC,6BAA6B,CAAC;AAC/D,QAAQ,iBAAiB,EAAE,CAAC,gCAAgC,CAAC;AAC7D,QAAQ,YAAY,EAAE,CAAC,uBAAuB,CAAC;AAC/C,QAAQ,WAAW,EAAE,CAAC,wCAAwC,CAAC;AAC/D,QAAQ,YAAY,EAAE,CAAC,uCAAuC,CAAC;AAC/D,QAAQ,uBAAuB,EAAE,CAAC,2CAA2C,CAAC;AAC9E,QAAQ,yBAAyB,EAAE;AACnC,YAAY,qDAAqD;AACjE,SAAS;AACT,QAAQ,0CAA0C,EAAE;AACpD,YAAY,8CAA8C;AAC1D,SAAS;AACT,QAAQ,oBAAoB,EAAE,CAAC,wCAAwC,CAAC;AACxE,QAAQ,uCAAuC,EAAE;AACjD,YAAY,2CAA2C;AACvD,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,sCAAsC,CAAC;AAC7D,QAAQ,MAAM,EAAE,CAAC,mBAAmB,CAAC;AACrC,QAAQ,oCAAoC,EAAE;AAC9C,YAAY,oCAAoC;AAChD,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,mCAAmC,CAAC;AAC5D,QAAQ,yBAAyB,EAAE,CAAC,0CAA0C,CAAC;AAC/E,KAAK;AACL,IAAI,QAAQ,EAAE;AACd,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,qDAAqD;AACjE,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,wCAAwC,EAAE;AAClD,YAAY,mFAAmF;AAC/F,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,yFAAyF;AACrG,SAAS;AACT,QAAQ,4CAA4C,EAAE;AACtD,YAAY,iEAAiE;AAC7E,YAAY,EAAE;AACd,YAAY,EAAE,OAAO,EAAE,CAAC,UAAU,EAAE,2CAA2C,CAAC,EAAE;AAClF,SAAS;AACT,QAAQ,2DAA2D,EAAE;AACrE,YAAY,2DAA2D;AACvE,YAAY,EAAE;AACd,YAAY;AACZ,gBAAgB,OAAO,EAAE;AACzB,oBAAoB,UAAU;AAC9B,oBAAoB,yDAAyD;AAC7E,iBAAiB;AACjB,aAAa;AACb,SAAS;AACT,QAAQ,uDAAuD,EAAE;AACjE,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,yCAAyC,EAAE;AACnD,YAAY,iEAAiE;AAC7E,SAAS;AACT,QAAQ,0CAA0C,EAAE;AACpD,YAAY,uEAAuE;AACnF,SAAS;AACT,QAAQ,8BAA8B,EAAE;AACxC,YAAY,kDAAkD;AAC9D,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,iBAAiB,EAAE;AAC3B,YAAY,8DAA8D;AAC1E,SAAS;AACT,QAAQ,qCAAqC,EAAE;AAC/C,YAAY,gFAAgF;AAC5F,SAAS;AACT,QAAQ,gCAAgC,EAAE;AAC1C,YAAY,sFAAsF;AAClG,SAAS;AACT,QAAQ,wBAAwB,EAAE;AAClC,YAAY,4FAA4F;AACxG,SAAS;AACT,QAAQ,kCAAkC,EAAE;AAC5C,YAAY,mEAAmE;AAC/E,SAAS;AACT,QAAQ,oBAAoB,EAAE;AAC9B,YAAY,yEAAyE;AACrF,SAAS;AACT,QAAQ,yCAAyC,EAAE;AACnD,YAAY,yFAAyF;AACrG,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,+FAA+F;AAC3G,SAAS;AACT,KAAK;AACL,IAAI,QAAQ,EAAE;AACd,QAAQ,eAAe,EAAE;AACzB,YAAY,qDAAqD;AACjE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,0CAA0C;AACtD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,qCAAqC;AACjD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,qBAAqB;AACjC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,2BAA2B;AACvC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,aAAa,EAAE;AACvB,YAAY,qCAAqC;AACjD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,MAAM,EAAE;AAChB,YAAY,+BAA+B;AAC3C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,0CAA0C;AACtD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,sCAAsC;AAClD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,GAAG,EAAE;AACb,YAAY,4BAA4B;AACxC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,OAAO,EAAE;AACjB,YAAY,uCAAuC;AACnD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,SAAS,EAAE;AACnB,YAAY,mCAAmC;AAC/C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,oBAAoB,EAAE;AAC9B,YAAY,gEAAgE;AAC5E,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,SAAS,EAAE;AACnB,YAAY,yCAAyC;AACrD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,iBAAiB,EAAE;AAC3B,YAAY,0CAA0C;AACtD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,WAAW,EAAE;AACrB,YAAY,oCAAoC;AAChD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,0BAA0B;AACtC,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,WAAW,EAAE;AACrB,YAAY,oCAAoC;AAChD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,WAAW,EAAE;AACrB,YAAY,gCAAgC;AAC5C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,QAAQ,EAAE;AAClB,YAAY,8CAA8C;AAC1D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,0CAA0C;AACtD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,wDAAwD;AACpE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,MAAM,EAAE;AAChB,YAAY,8BAA8B;AAC1C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,UAAU,EAAE;AACpB,YAAY,yCAAyC;AACrD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,qCAAqC;AACjD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,KAAK;AACL,IAAI,KAAK,EAAE;AACX,QAAQ,aAAa,EAAE,CAAC,qDAAqD,CAAC;AAC9E,QAAQ,MAAM,EAAE,CAAC,kCAAkC,CAAC;AACpD,QAAQ,2BAA2B,EAAE;AACrC,YAAY,8EAA8E;AAC1F,SAAS;AACT,QAAQ,YAAY,EAAE,CAAC,wDAAwD,CAAC;AAChF,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,sEAAsE;AAClF,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,aAAa,EAAE;AACvB,YAAY,8EAA8E;AAC1F,SAAS;AACT,QAAQ,GAAG,EAAE,CAAC,+CAA+C,CAAC;AAC9D,QAAQ,SAAS,EAAE;AACnB,YAAY,mEAAmE;AAC/E,SAAS;AACT,QAAQ,gBAAgB,EAAE,CAAC,uDAAuD,CAAC;AACnF,QAAQ,IAAI,EAAE,CAAC,iCAAiC,CAAC;AACjD,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,4EAA4E;AACxF,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,uDAAuD,CAAC;AAC9E,QAAQ,SAAS,EAAE,CAAC,qDAAqD,CAAC;AAC1E,QAAQ,sBAAsB,EAAE;AAChC,YAAY,mEAAmE;AAC/E,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,yBAAyB,EAAE,CAAC,0CAA0C,CAAC;AAC/E,QAAQ,WAAW,EAAE,CAAC,uDAAuD,CAAC;AAC9E,QAAQ,KAAK,EAAE,CAAC,qDAAqD,CAAC;AACtE,QAAQ,wBAAwB,EAAE;AAClC,YAAY,sEAAsE;AAClF,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,oEAAoE;AAChF,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,2EAA2E;AACvF,SAAS;AACT,QAAQ,MAAM,EAAE,CAAC,iDAAiD,CAAC;AACnE,QAAQ,YAAY,EAAE;AACtB,YAAY,6DAA6D;AACzE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;AACnD,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,mEAAmE;AAC/E,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,yDAAyD;AACrE,SAAS;AACT,KAAK;AACL,IAAI,SAAS,EAAE,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EAAE;AAC3C,IAAI,SAAS,EAAE;AACf,QAAQ,sBAAsB,EAAE;AAChC,YAAY,4DAA4D;AACxE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,cAAc,EAAE;AACxB,YAAY,4DAA4D;AACxE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,mEAAmE;AAC/E,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,kEAAkE;AAC9E,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,4DAA4D;AACxE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,mCAAmC,EAAE;AAC7C,YAAY,wGAAwG;AACpH,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,4BAA4B,EAAE;AACtC,YAAY,8EAA8E;AAC1F,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,sBAAsB,EAAE;AAChC,YAAY,4EAA4E;AACxF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,cAAc,EAAE;AACxB,YAAY,4EAA4E;AACxF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,mFAAmF;AAC/F,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,kFAAkF;AAC9F,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,uBAAuB,EAAE;AACjC,YAAY,8FAA8F;AAC1G,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,8BAA8B,EAAE;AACxC,YAAY,wHAAwH;AACpI,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,iCAAiC;AAC7C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,YAAY;AACZ,gBAAgB,UAAU,EAAE,qIAAqI;AACjK,aAAa;AACb,SAAS;AACT,QAAQ,oBAAoB,EAAE;AAC9B,YAAY,2DAA2D;AACvE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,2DAA2D;AACvE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,kEAAkE;AAC9E,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,+BAA+B,EAAE;AACzC,YAAY,iEAAiE;AAC7E,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,uGAAuG;AACnH,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,6EAA6E;AACzF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,EAAE;AAC1D,SAAS;AACT,KAAK;AACL,IAAI,KAAK,EAAE;AACX,QAAQ,gBAAgB,EAAE,CAAC,oDAAoD,CAAC;AAChF,QAAQ,wBAAwB,EAAE;AAClC,YAAY,2EAA2E;AACvF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE;AACjC,SAAS;AACT,QAAQ,eAAe,EAAE,CAAC,oDAAoD,CAAC;AAC/E,QAAQ,sBAAsB,EAAE;AAChC,YAAY,yFAAyF;AACrG,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE;AACrC,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,4EAA4E;AACxF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE;AAClC,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,4EAA4E;AACxF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE;AAClC,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,oDAAoD,CAAC;AACjF,QAAQ,wBAAwB,EAAE;AAClC,YAAY,gDAAgD;AAC5D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;AACnD,SAAS;AACT,QAAQ,cAAc,EAAE,CAAC,mDAAmD,CAAC;AAC7E,QAAQ,0BAA0B,EAAE;AACpC,YAAY,8CAA8C;AAC1D,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,+BAA+B,EAAE;AACzC,YAAY,6EAA6E;AACzF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,kBAAkB,EAAE,CAAC,2CAA2C,CAAC;AACzE,QAAQ,eAAe,EAAE,CAAC,iCAAiC,CAAC;AAC5D,QAAQ,gBAAgB,EAAE,CAAC,wCAAwC,CAAC;AACpE,QAAQ,sBAAsB,EAAE;AAChC,YAAY,iEAAiE;AAC7E,SAAS;AACT,QAAQ,mBAAmB,EAAE,CAAC,uCAAuC,CAAC;AACtE,QAAQ,0BAA0B,EAAE,CAAC,kBAAkB,CAAC;AACxD,QAAQ,UAAU,EAAE,CAAC,kCAAkC,CAAC;AACxD,QAAQ,WAAW,EAAE,CAAC,wBAAwB,CAAC;AAC/C,QAAQ,yBAAyB,EAAE;AACnC,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,0BAA0B,EAAE,CAAC,2CAA2C,CAAC;AACjF,QAAQ,eAAe,EAAE;AACzB,YAAY,kCAAkC;AAC9C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE;AACvD,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,qCAAqC,CAAC;AAC9D,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,uDAAuD;AACnE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE;AACrD,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,kCAAkC,CAAC;AAC3D,QAAQ,iBAAiB,EAAE,CAAC,qDAAqD,CAAC;AAClF,QAAQ,MAAM,EAAE,CAAC,8BAA8B,CAAC;AAChD,QAAQ,wBAAwB,EAAE;AAClC,YAAY,wEAAwE;AACpF,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,0EAA0E;AACtF,SAAS;AACT,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,8DAA8D;AAC1E,SAAS;AACT,QAAQ,sBAAsB,EAAE;AAChC,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,mBAAmB,EAAE,CAAC,oDAAoD,CAAC;AACnF,QAAQ,+BAA+B,EAAE;AACzC,YAAY,+EAA+E;AAC3F,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,eAAe,EAAE,CAAC,4CAA4C,CAAC;AACvE,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,UAAU,EAAE,CAAC,8CAA8C,CAAC;AACpE,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,oCAAoC;AAChD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE;AACvD,SAAS;AACT,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,yFAAyF;AACrG,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,oDAAoD,CAAC;AAC7E,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,8CAA8C,CAAC;AACvE,QAAQ,6BAA6B,EAAE;AACvC,YAAY,uDAAuD;AACnE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;AACnD,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,mDAAmD;AAC/D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;AACnD,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,yCAAyC;AACrD,YAAY,EAAE;AACd,YAAY,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,wBAAwB,CAAC,EAAE;AAC5D,SAAS;AACT,QAAQ,sBAAsB,EAAE,CAAC,yCAAyC,CAAC;AAC3E,QAAQ,sBAAsB,EAAE,CAAC,yCAAyC,CAAC;AAC3E,QAAQ,4BAA4B,EAAE;AACtC,YAAY,oDAAoD;AAChE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;AACnD,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,gDAAgD;AAC5D,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;AACnD,SAAS;AACT,QAAQ,GAAG,EAAE,CAAC,2BAA2B,CAAC;AAC1C,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,qEAAqE;AACjF,SAAS;AACT,QAAQ,wBAAwB,EAAE;AAClC,YAAY,uEAAuE;AACnF,SAAS;AACT,QAAQ,kBAAkB,EAAE,CAAC,wCAAwC,CAAC;AACtE,QAAQ,yBAAyB,EAAE;AACnC,YAAY,wFAAwF;AACpG,SAAS;AACT,QAAQ,YAAY,EAAE;AACtB,YAAY,kCAAkC;AAC9C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,kCAAkC,EAAE;AAC5C,YAAY,0EAA0E;AACtF,SAAS;AACT,QAAQ,SAAS,EAAE,CAAC,6CAA6C,CAAC;AAClE,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,SAAS,EAAE,CAAC,0CAA0C,CAAC;AAC/D,QAAQ,qBAAqB,EAAE,CAAC,gDAAgD,CAAC;AACjF,QAAQ,8BAA8B,EAAE;AACxC,YAAY,+DAA+D;AAC3E,SAAS;AACT,QAAQ,uBAAuB,EAAE,CAAC,gDAAgD,CAAC;AACnF,QAAQ,SAAS,EAAE,CAAC,yCAAyC,CAAC;AAC9D,QAAQ,sBAAsB,EAAE,CAAC,iDAAiD,CAAC;AACnF,QAAQ,gBAAgB,EAAE,CAAC,iDAAiD,CAAC;AAC7E,QAAQ,4BAA4B,EAAE;AACtC,YAAY,4EAA4E;AACxF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,0BAA0B,EAAE,CAAC,6CAA6C,CAAC;AACnF,QAAQ,UAAU,EAAE,CAAC,2CAA2C,CAAC;AACjE,QAAQ,oBAAoB,EAAE,CAAC,8CAA8C,CAAC;AAC9E,QAAQ,YAAY,EAAE,CAAC,yCAAyC,CAAC;AACjE,QAAQ,aAAa,EAAE,CAAC,uDAAuD,CAAC;AAChF,QAAQ,mBAAmB,EAAE;AAC7B,YAAY,4EAA4E;AACxF,SAAS;AACT,QAAQ,cAAc,EAAE;AACxB,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,mBAAmB,EAAE,CAAC,+CAA+C,CAAC;AAC9E,QAAQ,gBAAgB,EAAE,CAAC,2CAA2C,CAAC;AACvE,QAAQ,QAAQ,EAAE,CAAC,iCAAiC,CAAC;AACrD,QAAQ,aAAa,EAAE,CAAC,mDAAmD,CAAC;AAC5E,QAAQ,mBAAmB,EAAE,CAAC,wCAAwC,CAAC;AACvE,QAAQ,qBAAqB,EAAE,CAAC,+CAA+C,CAAC;AAChF,QAAQ,8BAA8B,EAAE;AACxC,YAAY,sFAAsF;AAClG,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,4CAA4C,CAAC;AACzE,QAAQ,SAAS,EAAE,CAAC,kCAAkC,CAAC;AACvD,QAAQ,oBAAoB,EAAE,CAAC,wCAAwC,CAAC;AACxE,QAAQ,UAAU,EAAE,CAAC,iDAAiD,CAAC;AACvE,QAAQ,eAAe,EAAE,CAAC,sDAAsD,CAAC;AACjF,QAAQ,eAAe,EAAE,CAAC,+CAA+C,CAAC;AAC1E,QAAQ,yBAAyB,EAAE;AACnC,YAAY,+EAA+E;AAC3F,SAAS;AACT,QAAQ,mCAAmC,EAAE;AAC7C,YAAY,2EAA2E;AACvF,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,iDAAiD,CAAC;AACxE,QAAQ,eAAe,EAAE,CAAC,qDAAqD,CAAC;AAChF,QAAQ,mCAAmC,EAAE;AAC7C,YAAY,2EAA2E;AACvF,SAAS;AACT,QAAQ,QAAQ,EAAE,CAAC,yCAAyC,CAAC;AAC7D,QAAQ,UAAU,EAAE,CAAC,2CAA2C,CAAC;AACjE,QAAQ,uBAAuB,EAAE;AACjC,YAAY,kDAAkD;AAC9D,SAAS;AACT,QAAQ,YAAY,EAAE,CAAC,oCAAoC,CAAC;AAC5D,QAAQ,yBAAyB,EAAE;AACnC,YAAY,oEAAoE;AAChF,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,yCAAyC,CAAC;AACtE,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,yBAAyB,EAAE,CAAC,oCAAoC,CAAC;AACzE,QAAQ,wBAAwB,EAAE;AAClC,YAAY,kDAAkD;AAC9D,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,mCAAmC,CAAC;AAC1D,QAAQ,gBAAgB,EAAE,CAAC,wCAAwC,CAAC;AACpE,QAAQ,cAAc,EAAE,CAAC,gCAAgC,CAAC;AAC1D,QAAQ,sBAAsB,EAAE;AAChC,YAAY,gEAAgE;AAC5E,SAAS;AACT,QAAQ,eAAe,EAAE,CAAC,uCAAuC,CAAC;AAClE,QAAQ,wBAAwB,EAAE,CAAC,iBAAiB,CAAC;AACrD,QAAQ,UAAU,EAAE,CAAC,uBAAuB,CAAC;AAC7C,QAAQ,WAAW,EAAE,CAAC,6BAA6B,CAAC;AACpD,QAAQ,SAAS,EAAE,CAAC,iCAAiC,CAAC;AACtD,QAAQ,eAAe,EAAE,CAAC,uCAAuC,CAAC;AAClE,QAAQ,mCAAmC,EAAE,CAAC,kCAAkC,CAAC;AACjF,QAAQ,aAAa,EAAE,CAAC,qCAAqC,CAAC;AAC9D,QAAQ,eAAe,EAAE,CAAC,wCAAwC,CAAC;AACnE,QAAQ,UAAU,EAAE,CAAC,mBAAmB,CAAC;AACzC,QAAQ,oCAAoC,EAAE;AAC9C,YAAY,sDAAsD;AAClE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,iBAAiB,EAAE;AAC3B,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,YAAY,EAAE,CAAC,oCAAoC,CAAC;AAC5D,QAAQ,QAAQ,EAAE,CAAC,gCAAgC,CAAC;AACpD,QAAQ,SAAS,EAAE,CAAC,iCAAiC,CAAC;AACtD,QAAQ,YAAY,EAAE,CAAC,iCAAiC,CAAC;AACzD,QAAQ,KAAK,EAAE,CAAC,mCAAmC,CAAC;AACpD,QAAQ,WAAW,EAAE,CAAC,kDAAkD,CAAC;AACzE,QAAQ,2BAA2B,EAAE;AACrC,YAAY,6EAA6E;AACzF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE;AACjC,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,uDAAuD;AACnE,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,2FAA2F;AACvG,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE;AACrC,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,kFAAkF;AAC9F,SAAS;AACT,QAAQ,4BAA4B,EAAE;AACtC,YAAY,8EAA8E;AAC1F,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE;AAClC,SAAS;AACT,QAAQ,4BAA4B,EAAE;AACtC,YAAY,8EAA8E;AAC1F,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE;AAClC,SAAS;AACT,QAAQ,YAAY,EAAE,CAAC,qDAAqD,CAAC;AAC7E,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,kCAAkC;AAC9C,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE;AAClD,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,yCAAyC,CAAC;AACtE,QAAQ,wBAAwB,EAAE;AAClC,YAAY,wEAAwE;AACpF,SAAS;AACT,QAAQ,wBAAwB,EAAE;AAClC,YAAY,0EAA0E;AACtF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE;AACjC,SAAS;AACT,QAAQ,sBAAsB,EAAE;AAChC,YAAY,wFAAwF;AACpG,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE;AACrC,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,2EAA2E;AACvF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE;AAClC,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,2EAA2E;AACvF,YAAY,EAAE;AACd,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE;AAClC,SAAS;AACT,QAAQ,eAAe,EAAE,CAAC,kDAAkD,CAAC;AAC7E,QAAQ,QAAQ,EAAE,CAAC,qCAAqC,CAAC;AACzD,QAAQ,MAAM,EAAE,CAAC,6BAA6B,CAAC;AAC/C,QAAQ,sBAAsB,EAAE;AAChC,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,mBAAmB,EAAE,CAAC,mDAAmD,CAAC;AAClF,QAAQ,+BAA+B,EAAE,CAAC,iCAAiC,CAAC;AAC5E,QAAQ,gBAAgB,EAAE;AAC1B,YAAY,yDAAyD;AACrE,SAAS;AACT,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,wFAAwF;AACpG,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,mDAAmD,CAAC;AAC5E,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,0BAA0B,EAAE;AACpC,YAAY,iFAAiF;AAC7F,YAAY,EAAE;AACd,YAAY,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,6BAA6B,CAAC,EAAE;AACjE,SAAS;AACT,QAAQ,2BAA2B,EAAE;AACrC,YAAY,iFAAiF;AAC7F,SAAS;AACT,QAAQ,aAAa,EAAE,CAAC,6CAA6C,CAAC;AACtE,QAAQ,0BAA0B,EAAE;AACpC,YAAY,oDAAoD;AAChE,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,sEAAsE;AAClF,YAAY,EAAE,OAAO,EAAE,4BAA4B,EAAE;AACrD,SAAS;AACT,KAAK;AACL,IAAI,MAAM,EAAE;AACZ,QAAQ,IAAI,EAAE,CAAC,kBAAkB,CAAC;AAClC,QAAQ,OAAO,EAAE,CAAC,qBAAqB,EAAE,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;AAChF,QAAQ,qBAAqB,EAAE,CAAC,oBAAoB,CAAC;AACrD,QAAQ,MAAM,EAAE,CAAC,oBAAoB,CAAC;AACtC,QAAQ,KAAK,EAAE,CAAC,0BAA0B,CAAC;AAC3C,QAAQ,MAAM,EAAE,CAAC,oBAAoB,EAAE,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;AAC9E,QAAQ,KAAK,EAAE,CAAC,mBAAmB,CAAC;AACpC,KAAK;AACL,IAAI,cAAc,EAAE;AACpB,QAAQ,QAAQ,EAAE;AAClB,YAAY,iEAAiE;AAC7E,SAAS;AACT,QAAQ,iBAAiB,EAAE,CAAC,kDAAkD,CAAC;AAC/E,QAAQ,WAAW,EAAE;AACrB,YAAY,mEAAmE;AAC/E,SAAS;AACT,KAAK;AACL,IAAI,KAAK,EAAE;AACX,QAAQ,iCAAiC,EAAE;AAC3C,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,kCAAkC,EAAE;AAC5C,YAAY,yDAAyD;AACrE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,+BAA+B,EAAE;AACzC,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,+BAA+B,EAAE;AACzC,YAAY,yDAAyD;AACrE,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,4BAA4B,EAAE;AACtC,YAAY,wDAAwD;AACpE,SAAS;AACT,QAAQ,MAAM,EAAE,CAAC,wBAAwB,CAAC;AAC1C,QAAQ,4BAA4B,EAAE;AACtC,YAAY,6EAA6E;AACzF,SAAS;AACT,QAAQ,qBAAqB,EAAE,CAAC,gDAAgD,CAAC;AACjF,QAAQ,4BAA4B,EAAE;AACtC,YAAY,gGAAgG;AAC5G,SAAS;AACT,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,sEAAsE;AAClF,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,sCAAsC,CAAC;AAC7D,QAAQ,SAAS,EAAE,CAAC,mCAAmC,CAAC;AACxD,QAAQ,yBAAyB,EAAE;AACnC,YAAY,6FAA6F;AACzG,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,mEAAmE;AAC/E,SAAS;AACT,QAAQ,yBAAyB,EAAE;AACnC,YAAY,0DAA0D;AACtE,SAAS;AACT,QAAQ,IAAI,EAAE,CAAC,uBAAuB,CAAC;AACvC,QAAQ,cAAc,EAAE,CAAC,yCAAyC,CAAC;AACnE,QAAQ,2BAA2B,EAAE;AACrC,YAAY,4EAA4E;AACxF,SAAS;AACT,QAAQ,oBAAoB,EAAE,CAAC,+CAA+C,CAAC;AAC/E,QAAQ,wBAAwB,EAAE,CAAC,iBAAiB,CAAC;AACrD,QAAQ,gBAAgB,EAAE,CAAC,2CAA2C,CAAC;AACvE,QAAQ,2BAA2B,EAAE;AACrC,YAAY,+CAA+C;AAC3D,SAAS;AACT,QAAQ,iBAAiB,EAAE;AAC3B,YAAY,4CAA4C;AACxD,YAAY,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE;AACpD,SAAS;AACT,QAAQ,cAAc,EAAE,CAAC,yCAAyC,CAAC;AACnE,QAAQ,4BAA4B,EAAE;AACtC,YAAY,6DAA6D;AACzE,SAAS;AACT,QAAQ,kBAAkB,EAAE;AAC5B,YAAY,4DAA4D;AACxE,SAAS;AACT,QAAQ,eAAe,EAAE;AACzB,YAAY,2DAA2D;AACvE,SAAS;AACT,QAAQ,4BAA4B,EAAE;AACtC,YAAY,+FAA+F;AAC3G,SAAS;AACT,QAAQ,qBAAqB,EAAE;AAC/B,YAAY,qEAAqE;AACjF,SAAS;AACT,QAAQ,WAAW,EAAE,CAAC,qCAAqC,CAAC;AAC5D,KAAK;AACL,IAAI,KAAK,EAAE;AACX,QAAQ,wBAAwB,EAAE,CAAC,mBAAmB,CAAC;AACvD,QAAQ,KAAK,EAAE,CAAC,6BAA6B,CAAC;AAC9C,QAAQ,YAAY,EAAE,CAAC,6BAA6B,CAAC;AACrD,QAAQ,qBAAqB,EAAE,CAAC,+CAA+C,CAAC;AAChF,QAAQ,oCAAoC,EAAE,CAAC,gCAAgC,CAAC;AAChF,QAAQ,4BAA4B,EAAE,CAAC,qBAAqB,CAAC;AAC7D,QAAQ,kCAAkC,EAAE,CAAC,iBAAiB,CAAC;AAC/D,QAAQ,2BAA2B,EAAE,CAAC,qBAAqB,CAAC;AAC5D,QAAQ,4BAA4B,EAAE,CAAC,oCAAoC,CAAC;AAC5E,QAAQ,kCAAkC,EAAE,CAAC,4BAA4B,CAAC;AAC1E,QAAQ,MAAM,EAAE,CAAC,gCAAgC,CAAC;AAClD,QAAQ,gBAAgB,EAAE,CAAC,WAAW,CAAC;AACvC,QAAQ,aAAa,EAAE,CAAC,uBAAuB,CAAC;AAChD,QAAQ,iBAAiB,EAAE,CAAC,iCAAiC,CAAC;AAC9D,QAAQ,yBAAyB,EAAE,CAAC,iCAAiC,CAAC;AACtE,QAAQ,+BAA+B,EAAE,CAAC,yBAAyB,CAAC;AACpE,QAAQ,IAAI,EAAE,CAAC,YAAY,CAAC;AAC5B,QAAQ,0BAA0B,EAAE,CAAC,kBAAkB,CAAC;AACxD,QAAQ,0BAA0B,EAAE,CAAC,kBAAkB,CAAC;AACxD,QAAQ,2BAA2B,EAAE,CAAC,qBAAqB,CAAC;AAC5D,QAAQ,iCAAiC,EAAE,CAAC,qBAAqB,CAAC;AAClE,QAAQ,oBAAoB,EAAE,CAAC,iCAAiC,CAAC;AACjE,QAAQ,oBAAoB,EAAE,CAAC,iCAAiC,CAAC;AACjE,QAAQ,2BAA2B,EAAE,CAAC,oBAAoB,CAAC;AAC3D,QAAQ,kBAAkB,EAAE,CAAC,gCAAgC,CAAC;AAC9D,QAAQ,gCAAgC,EAAE,CAAC,yBAAyB,CAAC;AACrE,QAAQ,qBAAqB,EAAE,CAAC,4BAA4B,CAAC;AAC7D,QAAQ,iCAAiC,EAAE,CAAC,gBAAgB,CAAC;AAC7D,QAAQ,yCAAyC,EAAE,CAAC,8BAA8B,CAAC;AACnF,QAAQ,OAAO,EAAE,CAAC,gCAAgC,CAAC;AACnD,QAAQ,QAAQ,EAAE,CAAC,mCAAmC,CAAC;AACvD,QAAQ,mBAAmB,EAAE,CAAC,aAAa,CAAC;AAC5C,KAAK;AACL,CAAC;;AC/4CM,MAAM,OAAO,GAAG,mBAAmB,CAAC;;ACApC,SAAS,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE;AAC1D,IAAI,MAAM,UAAU,GAAG,EAAE,CAAC;AAC1B,IAAI,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;AACnE,QAAQ,KAAK,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;AACxE,YAAY,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAC;AAC5D,YAAY,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACnD,YAAY,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC;AAC9E,YAAY,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;AACpC,gBAAgB,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;AACvC,aAAa;AACb,YAAY,MAAM,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;AACnD,YAAY,IAAI,WAAW,EAAE;AAC7B,gBAAgB,YAAY,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,WAAW,CAAC,CAAC;AAC/G,gBAAgB,SAAS;AACzB,aAAa;AACb,YAAY,YAAY,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;AAClF,SAAS;AACT,KAAK;AACL,IAAI,OAAO,UAAU,CAAC;AACtB,CAAC;AACD,SAAS,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE;AACrE,IAAI,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACnE;AACA,IAAI,SAAS,eAAe,CAAC,GAAG,IAAI,EAAE;AACtC;AACA,QAAQ,IAAI,OAAO,GAAG,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;AAClE;AACA,QAAQ,IAAI,WAAW,CAAC,SAAS,EAAE;AACnC,YAAY,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE;AACjD,gBAAgB,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC;AACpD,gBAAgB,CAAC,WAAW,CAAC,SAAS,GAAG,SAAS;AAClD,aAAa,CAAC,CAAC;AACf,YAAY,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC;AAChD,SAAS;AACT,QAAQ,IAAI,WAAW,CAAC,OAAO,EAAE;AACjC,YAAY,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC;AAClE,YAAY,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,+BAA+B,EAAE,QAAQ,CAAC,CAAC,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;AAC5H,SAAS;AACT,QAAQ,IAAI,WAAW,CAAC,UAAU,EAAE;AACpC,YAAY,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AACrD,SAAS;AACT,QAAQ,IAAI,WAAW,CAAC,iBAAiB,EAAE;AAC3C;AACA,YAAY,MAAM,OAAO,GAAG,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;AACxE,YAAY,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,iBAAiB,CAAC,EAAE;AACvF,gBAAgB,IAAI,IAAI,IAAI,OAAO,EAAE;AACrC,oBAAoB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;AACzI,oBAAoB,IAAI,EAAE,KAAK,IAAI,OAAO,CAAC,EAAE;AAC7C,wBAAwB,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AACvD,qBAAqB;AACrB,oBAAoB,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;AACzC,iBAAiB;AACjB,aAAa;AACb,YAAY,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC;AAChD,SAAS;AACT;AACA,QAAQ,OAAO,mBAAmB,CAAC,GAAG,IAAI,CAAC,CAAC;AAC5C,KAAK;AACL,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;AAC/D,CAAC;;ACxDM,SAAS,mBAAmB,CAAC,OAAO,EAAE;AAC7C,IAAI,MAAM,GAAG,GAAG,kBAAkB,CAAC,OAAO,EAAEA,SAAS,CAAC,CAAC;AACvD,IAAI,OAAO;AACX,QAAQ,IAAI,EAAE,GAAG;AACjB,KAAK,CAAC;AACN,CAAC;AACD,mBAAmB,CAAC,OAAO,GAAG,OAAO,CAAC;AACtC,AAAO,SAAS,yBAAyB,CAAC,OAAO,EAAE;AACnD,IAAI,MAAM,GAAG,GAAG,kBAAkB,CAAC,OAAO,EAAEA,SAAS,CAAC,CAAC;AACvD,IAAI,OAAO;AACX,QAAQ,GAAG,GAAG;AACd,QAAQ,IAAI,EAAE,GAAG;AACjB,KAAK,CAAC;AACN,CAAC;AACD,yBAAyB,CAAC,OAAO,GAAG,OAAO,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/plugin-rest-endpoint-methods/package.json b/node_modules/@octokit/plugin-rest-endpoint-methods/package.json new file mode 100644 index 00000000..5e4e233c --- /dev/null +++ b/node_modules/@octokit/plugin-rest-endpoint-methods/package.json @@ -0,0 +1,60 @@ +{ + "name": "@octokit/plugin-rest-endpoint-methods", + "description": "Octokit plugin adding one method for all of api.github.com REST API endpoints", + "version": "5.3.0", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "github", + "api", + "sdk", + "toolkit" + ], + "repository": "github:octokit/plugin-rest-endpoint-methods.js", + "dependencies": { + "@octokit/types": "^6.16.0", + "deprecation": "^2.3.1" + }, + "peerDependencies": { + "@octokit/core": ">=3" + }, + "devDependencies": { + "@gimenete/type-writer": "^0.1.5", + "@octokit/core": "^3.0.0", + "@octokit/graphql": "^4.3.1", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/fetch-mock": "^7.3.1", + "@types/jest": "^26.0.0", + "@types/node": "^14.0.4", + "fetch-mock": "^9.0.0", + "fs-extra": "^10.0.0", + "jest": "^26.1.0", + "lodash.camelcase": "^4.3.0", + "lodash.set": "^4.3.2", + "lodash.upperfirst": "^4.3.1", + "mustache": "^4.0.0", + "npm-run-all": "^4.1.5", + "prettier": "^2.0.1", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "sort-keys": "^4.2.0", + "string-to-jsdoc-comment": "^1.0.0", + "ts-jest": "^26.1.3", + "typescript": "^4.0.2" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/request-error/LICENSE b/node_modules/@octokit/request-error/LICENSE new file mode 100644 index 00000000..ef2c18ee --- /dev/null +++ b/node_modules/@octokit/request-error/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/@octokit/request-error/README.md b/node_modules/@octokit/request-error/README.md new file mode 100644 index 00000000..c939cdae --- /dev/null +++ b/node_modules/@octokit/request-error/README.md @@ -0,0 +1,67 @@ +# http-error.js + +> Error class for Octokit request errors + +[![@latest](https://img.shields.io/npm/v/@octokit/request-error.svg)](https://www.npmjs.com/package/@octokit/request-error) +[![Build Status](https://github.com/octokit/request-error.js/workflows/Test/badge.svg)](https://github.com/octokit/request-error.js/actions?query=workflow%3ATest) + +## Usage + + + + + + +
+Browsers + +Load @octokit/request-error directly from cdn.skypack.dev + +```html + +``` + +
+Node + + +Install with npm install @octokit/request-error + +```js +const { RequestError } = require("@octokit/request-error"); +// or: import { RequestError } from "@octokit/request-error"; +``` + +
+ +```js +const error = new RequestError("Oops", 500, { + headers: { + "x-github-request-id": "1:2:3:4", + }, // response headers + request: { + method: "POST", + url: "https://api.github.com/foo", + body: { + bar: "baz", + }, + headers: { + authorization: "token secret123", + }, + }, +}); + +error.message; // Oops +error.status; // 500 +error.headers; // { 'x-github-request-id': '1:2:3:4' } +error.request.method; // POST +error.request.url; // https://api.github.com/foo +error.request.body; // { bar: 'baz' } +error.request.headers; // { authorization: 'token [REDACTED]' } +``` + +## LICENSE + +[MIT](LICENSE) diff --git a/node_modules/@octokit/request-error/dist-node/index.js b/node_modules/@octokit/request-error/dist-node/index.js new file mode 100644 index 00000000..95b9c579 --- /dev/null +++ b/node_modules/@octokit/request-error/dist-node/index.js @@ -0,0 +1,55 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } + +var deprecation = require('deprecation'); +var once = _interopDefault(require('once')); + +const logOnce = once(deprecation => console.warn(deprecation)); +/** + * Error with extra properties to help with debugging + */ + +class RequestError extends Error { + constructor(message, statusCode, options) { + super(message); // Maintains proper stack trace (only available on V8) + + /* istanbul ignore next */ + + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + + this.name = "HttpError"; + this.status = statusCode; + Object.defineProperty(this, "code", { + get() { + logOnce(new deprecation.Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); + return statusCode; + } + + }); + this.headers = options.headers || {}; // redact request credentials without mutating original request options + + const requestCopy = Object.assign({}, options.request); + + if (options.request.headers.authorization) { + requestCopy.headers = Object.assign({}, options.request.headers, { + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]") + }); + } + + requestCopy.url = requestCopy.url // client_id & client_secret can be passed as URL query parameters to increase rate limit + // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications + .replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]") // OAuth tokens can be passed as URL query parameters, although it is not recommended + // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header + .replace(/\baccess_token=\w+/g, "access_token=[REDACTED]"); + this.request = requestCopy; + } + +} + +exports.RequestError = RequestError; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/request-error/dist-node/index.js.map b/node_modules/@octokit/request-error/dist-node/index.js.map new file mode 100644 index 00000000..f5d527e8 --- /dev/null +++ b/node_modules/@octokit/request-error/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n },\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\"),\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":["logOnce","once","deprecation","console","warn","RequestError","Error","constructor","message","statusCode","options","captureStackTrace","name","status","Object","defineProperty","get","Deprecation","headers","requestCopy","assign","request","authorization","replace","url"],"mappings":";;;;;;;;;AAEA,MAAMA,OAAO,GAAGC,IAAI,CAAEC,WAAD,IAAiBC,OAAO,CAACC,IAAR,CAAaF,WAAb,CAAlB,CAApB;AACA;AACA;AACA;;AACO,MAAMG,YAAN,SAA2BC,KAA3B,CAAiC;AACpCC,EAAAA,WAAW,CAACC,OAAD,EAAUC,UAAV,EAAsBC,OAAtB,EAA+B;AACtC,UAAMF,OAAN,EADsC;;AAGtC;;AACA,QAAIF,KAAK,CAACK,iBAAV,EAA6B;AACzBL,MAAAA,KAAK,CAACK,iBAAN,CAAwB,IAAxB,EAA8B,KAAKJ,WAAnC;AACH;;AACD,SAAKK,IAAL,GAAY,WAAZ;AACA,SAAKC,MAAL,GAAcJ,UAAd;AACAK,IAAAA,MAAM,CAACC,cAAP,CAAsB,IAAtB,EAA4B,MAA5B,EAAoC;AAChCC,MAAAA,GAAG,GAAG;AACFhB,QAAAA,OAAO,CAAC,IAAIiB,uBAAJ,CAAgB,0EAAhB,CAAD,CAAP;AACA,eAAOR,UAAP;AACH;;AAJ+B,KAApC;AAMA,SAAKS,OAAL,GAAeR,OAAO,CAACQ,OAAR,IAAmB,EAAlC,CAfsC;;AAiBtC,UAAMC,WAAW,GAAGL,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAA1B,CAApB;;AACA,QAAIX,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAA5B,EAA2C;AACvCH,MAAAA,WAAW,CAACD,OAAZ,GAAsBJ,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAAR,CAAgBH,OAAlC,EAA2C;AAC7DI,QAAAA,aAAa,EAAEZ,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAAxB,CAAsCC,OAAtC,CAA8C,MAA9C,EAAsD,aAAtD;AAD8C,OAA3C,CAAtB;AAGH;;AACDJ,IAAAA,WAAW,CAACK,GAAZ,GAAkBL,WAAW,CAACK,GAAZ;AAEd;AAFc,KAGbD,OAHa,CAGL,sBAHK,EAGmB,0BAHnB;AAKd;AALc,KAMbA,OANa,CAML,qBANK,EAMkB,yBANlB,CAAlB;AAOA,SAAKF,OAAL,GAAeF,WAAf;AACH;;AAhCmC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request-error/dist-src/index.js b/node_modules/@octokit/request-error/dist-src/index.js new file mode 100644 index 00000000..c880b450 --- /dev/null +++ b/node_modules/@octokit/request-error/dist-src/index.js @@ -0,0 +1,40 @@ +import { Deprecation } from "deprecation"; +import once from "once"; +const logOnce = once((deprecation) => console.warn(deprecation)); +/** + * Error with extra properties to help with debugging + */ +export class RequestError extends Error { + constructor(message, statusCode, options) { + super(message); + // Maintains proper stack trace (only available on V8) + /* istanbul ignore next */ + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + this.name = "HttpError"; + this.status = statusCode; + Object.defineProperty(this, "code", { + get() { + logOnce(new Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); + return statusCode; + }, + }); + this.headers = options.headers || {}; + // redact request credentials without mutating original request options + const requestCopy = Object.assign({}, options.request); + if (options.request.headers.authorization) { + requestCopy.headers = Object.assign({}, options.request.headers, { + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]"), + }); + } + requestCopy.url = requestCopy.url + // client_id & client_secret can be passed as URL query parameters to increase rate limit + // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications + .replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]") + // OAuth tokens can be passed as URL query parameters, although it is not recommended + // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header + .replace(/\baccess_token=\w+/g, "access_token=[REDACTED]"); + this.request = requestCopy; + } +} diff --git a/node_modules/@octokit/request-error/dist-src/types.js b/node_modules/@octokit/request-error/dist-src/types.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/request-error/dist-src/types.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/request-error/dist-types/index.d.ts b/node_modules/@octokit/request-error/dist-types/index.d.ts new file mode 100644 index 00000000..baa8a0eb --- /dev/null +++ b/node_modules/@octokit/request-error/dist-types/index.d.ts @@ -0,0 +1,27 @@ +import { RequestOptions, ResponseHeaders } from "@octokit/types"; +import { RequestErrorOptions } from "./types"; +/** + * Error with extra properties to help with debugging + */ +export declare class RequestError extends Error { + name: "HttpError"; + /** + * http status code + */ + status: number; + /** + * http status code + * + * @deprecated `error.code` is deprecated in favor of `error.status` + */ + code: number; + /** + * error response headers + */ + headers: ResponseHeaders; + /** + * Request options that lead to the error. + */ + request: RequestOptions; + constructor(message: string, statusCode: number, options: RequestErrorOptions); +} diff --git a/node_modules/@octokit/request-error/dist-types/types.d.ts b/node_modules/@octokit/request-error/dist-types/types.d.ts new file mode 100644 index 00000000..865d2139 --- /dev/null +++ b/node_modules/@octokit/request-error/dist-types/types.d.ts @@ -0,0 +1,5 @@ +import { RequestOptions, ResponseHeaders } from "@octokit/types"; +export declare type RequestErrorOptions = { + headers?: ResponseHeaders; + request: RequestOptions; +}; diff --git a/node_modules/@octokit/request-error/dist-web/index.js b/node_modules/@octokit/request-error/dist-web/index.js new file mode 100644 index 00000000..feec58ef --- /dev/null +++ b/node_modules/@octokit/request-error/dist-web/index.js @@ -0,0 +1,44 @@ +import { Deprecation } from 'deprecation'; +import once from 'once'; + +const logOnce = once((deprecation) => console.warn(deprecation)); +/** + * Error with extra properties to help with debugging + */ +class RequestError extends Error { + constructor(message, statusCode, options) { + super(message); + // Maintains proper stack trace (only available on V8) + /* istanbul ignore next */ + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + this.name = "HttpError"; + this.status = statusCode; + Object.defineProperty(this, "code", { + get() { + logOnce(new Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); + return statusCode; + }, + }); + this.headers = options.headers || {}; + // redact request credentials without mutating original request options + const requestCopy = Object.assign({}, options.request); + if (options.request.headers.authorization) { + requestCopy.headers = Object.assign({}, options.request.headers, { + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]"), + }); + } + requestCopy.url = requestCopy.url + // client_id & client_secret can be passed as URL query parameters to increase rate limit + // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications + .replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]") + // OAuth tokens can be passed as URL query parameters, although it is not recommended + // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header + .replace(/\baccess_token=\w+/g, "access_token=[REDACTED]"); + this.request = requestCopy; + } +} + +export { RequestError }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/request-error/dist-web/index.js.map b/node_modules/@octokit/request-error/dist-web/index.js.map new file mode 100644 index 00000000..130740d7 --- /dev/null +++ b/node_modules/@octokit/request-error/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n },\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\"),\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":[],"mappings":";;;AAEA,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;AACjE;AACA;AACA;AACO,MAAM,YAAY,SAAS,KAAK,CAAC;AACxC,IAAI,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE;AAC9C,QAAQ,KAAK,CAAC,OAAO,CAAC,CAAC;AACvB;AACA;AACA,QAAQ,IAAI,KAAK,CAAC,iBAAiB,EAAE;AACrC,YAAY,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;AAC5D,SAAS;AACT,QAAQ,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;AAChC,QAAQ,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;AACjC,QAAQ,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE;AAC5C,YAAY,GAAG,GAAG;AAClB,gBAAgB,OAAO,CAAC,IAAI,WAAW,CAAC,0EAA0E,CAAC,CAAC,CAAC;AACrH,gBAAgB,OAAO,UAAU,CAAC;AAClC,aAAa;AACb,SAAS,CAAC,CAAC;AACX,QAAQ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;AAC7C;AACA,QAAQ,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AAC/D,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE;AACnD,YAAY,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE;AAC7E,gBAAgB,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC;AACnG,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,WAAW,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG;AACzC;AACA;AACA,aAAa,OAAO,CAAC,sBAAsB,EAAE,0BAA0B,CAAC;AACxE;AACA;AACA,aAAa,OAAO,CAAC,qBAAqB,EAAE,yBAAyB,CAAC,CAAC;AACvE,QAAQ,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC;AACnC,KAAK;AACL;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request-error/package.json b/node_modules/@octokit/request-error/package.json new file mode 100644 index 00000000..4c41600e --- /dev/null +++ b/node_modules/@octokit/request-error/package.json @@ -0,0 +1,54 @@ +{ + "name": "@octokit/request-error", + "description": "Error class for Octokit request errors", + "version": "2.0.5", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "octokit", + "github", + "api", + "error" + ], + "homepage": "https://github.com/octokit/request-error.js#readme", + "bugs": { + "url": "https://github.com/octokit/request-error.js/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/octokit/request-error.js.git" + }, + "dependencies": { + "@octokit/types": "^6.0.3", + "deprecation": "^2.0.0", + "once": "^1.4.0" + }, + "devDependencies": { + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-bundle-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/jest": "^26.0.0", + "@types/node": "^14.0.4", + "@types/once": "^1.4.0", + "jest": "^26.0.0", + "pika-plugin-unpkg-field": "^1.1.0", + "prettier": "^2.0.1", + "semantic-release": "^17.0.0", + "ts-jest": "^26.0.0", + "typescript": "^4.0.0" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/request/LICENSE b/node_modules/@octokit/request/LICENSE new file mode 100644 index 00000000..af5366d0 --- /dev/null +++ b/node_modules/@octokit/request/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2018 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/@octokit/request/README.md b/node_modules/@octokit/request/README.md new file mode 100644 index 00000000..514eb6e2 --- /dev/null +++ b/node_modules/@octokit/request/README.md @@ -0,0 +1,541 @@ +# request.js + +> Send parameterized requests to GitHub’s APIs with sensible defaults in browsers and Node + +[![@latest](https://img.shields.io/npm/v/@octokit/request.svg)](https://www.npmjs.com/package/@octokit/request) +[![Build Status](https://github.com/octokit/request.js/workflows/Test/badge.svg)](https://github.com/octokit/request.js/actions?query=workflow%3ATest+branch%3Amaster) + +`@octokit/request` is a request library for browsers & node that makes it easier +to interact with [GitHub’s REST API](https://developer.github.com/v3/) and +[GitHub’s GraphQL API](https://developer.github.com/v4/guides/forming-calls/#the-graphql-endpoint). + +It uses [`@octokit/endpoint`](https://github.com/octokit/endpoint.js) to parse +the passed options and sends the request using [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) +([node-fetch](https://github.com/bitinn/node-fetch) in Node). + + + + + +- [Features](#features) +- [Usage](#usage) + - [REST API example](#rest-api-example) + - [GraphQL example](#graphql-example) + - [Alternative: pass `method` & `url` as part of options](#alternative-pass-method--url-as-part-of-options) +- [Authentication](#authentication) +- [request()](#request) +- [`request.defaults()`](#requestdefaults) +- [`request.endpoint`](#requestendpoint) +- [Special cases](#special-cases) + - [The `data` parameter – set request body directly](#the-data-parameter-%E2%80%93-set-request-body-directly) + - [Set parameters for both the URL/query and the request body](#set-parameters-for-both-the-urlquery-and-the-request-body) +- [LICENSE](#license) + + + +## Features + +🤩 1:1 mapping of REST API endpoint documentation, e.g. [Add labels to an issue](https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue) becomes + +```js +request("POST /repos/{owner}/{repo}/issues/{number}/labels", { + mediaType: { + previews: ["symmetra"], + }, + owner: "octokit", + repo: "request.js", + number: 1, + labels: ["🐛 bug"], +}); +``` + +👶 [Small bundle size](https://bundlephobia.com/result?p=@octokit/request@5.0.3) (\<4kb minified + gzipped) + +😎 [Authenticate](#authentication) with any of [GitHubs Authentication Strategies](https://github.com/octokit/auth.js). + +👍 Sensible defaults + +- `baseUrl`: `https://api.github.com` +- `headers.accept`: `application/vnd.github.v3+json` +- `headers.agent`: `octokit-request.js/ `, e.g. `octokit-request.js/1.2.3 Node.js/10.15.0 (macOS Mojave; x64)` + +👌 Simple to test: mock requests by passing a custom fetch method. + +🧐 Simple to debug: Sets `error.request` to request options causing the error (with redacted credentials). + +## Usage + + + + + + +
+Browsers + +Load @octokit/request directly from cdn.skypack.dev + +```html + +``` + +
+Node + + +Install with npm install @octokit/request + +```js +const { request } = require("@octokit/request"); +// or: import { request } from "@octokit/request"; +``` + +
+ +### REST API example + +```js +// Following GitHub docs formatting: +// https://developer.github.com/v3/repos/#list-organization-repositories +const result = await request("GET /orgs/{org}/repos", { + headers: { + authorization: "token 0000000000000000000000000000000000000001", + }, + org: "octokit", + type: "private", +}); + +console.log(`${result.data.length} repos found.`); +``` + +### GraphQL example + +For GraphQL request we recommend using [`@octokit/graphql`](https://github.com/octokit/graphql.js#readme) + +```js +const result = await request("POST /graphql", { + headers: { + authorization: "token 0000000000000000000000000000000000000001", + }, + query: `query ($login: String!) { + organization(login: $login) { + repositories(privacy: PRIVATE) { + totalCount + } + } + }`, + variables: { + login: "octokit", + }, +}); +``` + +### Alternative: pass `method` & `url` as part of options + +Alternatively, pass in a method and a url + +```js +const result = await request({ + method: "GET", + url: "/orgs/{org}/repos", + headers: { + authorization: "token 0000000000000000000000000000000000000001", + }, + org: "octokit", + type: "private", +}); +``` + +## Authentication + +The simplest way to authenticate a request is to set the `Authorization` header directly, e.g. to a [personal access token](https://github.com/settings/tokens/). + +```js +const requestWithAuth = request.defaults({ + headers: { + authorization: "token 0000000000000000000000000000000000000001", + }, +}); +const result = await requestWithAuth("GET /user"); +``` + +For more complex authentication strategies such as GitHub Apps or Basic, we recommend the according authentication library exported by [`@octokit/auth`](https://github.com/octokit/auth.js). + +```js +const { createAppAuth } = require("@octokit/auth-app"); +const auth = createAppAuth({ + appId: process.env.APP_ID, + privateKey: process.env.PRIVATE_KEY, + installationId: 123, +}); +const requestWithAuth = request.defaults({ + request: { + hook: auth.hook, + }, + mediaType: { + previews: ["machine-man"], + }, +}); + +const { data: app } = await requestWithAuth("GET /app"); +const { data: app } = await requestWithAuth( + "POST /repos/{owner}/{repo}/issues", + { + owner: "octocat", + repo: "hello-world", + title: "Hello from the engine room", + } +); +``` + +## request() + +`request(route, options)` or `request(options)`. + +**Options** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ name + + type + + description +
+ route + + String + + If route is set it has to be a string consisting of the request method and URL, e.g. GET /orgs/{org} +
+ options.baseUrl + + String + + Required. Any supported http verb, case insensitive. Defaults to https://api.github.com. +
+ options.headers + + Object + + Custom headers. Passed headers are merged with defaults:
+ headers['user-agent'] defaults to octokit-rest.js/1.2.3 (where 1.2.3 is the released version).
+ headers['accept'] defaults to application/vnd.github.v3+json.
Use options.mediaType.{format,previews} to request API previews and custom media types. +
+ options.mediaType.format + + String + + Media type param, such as `raw`, `html`, or `full`. See Media Types. +
+ options.mediaType.previews + + Array of strings + + Name of previews, such as `mercy`, `symmetra`, or `scarlet-witch`. See API Previews. +
+ options.method + + String + + Required. Any supported http verb, case insensitive. Defaults to Get. +
+ options.url + + String + + Required. A path or full URL which may contain :variable or {variable} placeholders, + e.g. /orgs/{org}/repos. The url is parsed using url-template. +
+ options.data + + Any + + Set request body directly instead of setting it to JSON based on additional parameters. See "The `data` parameter" below. +
+ options.request.agent + + http(s).Agent instance + + Node only. Useful for custom proxy, certificate, or dns lookup. +
+ options.request.fetch + + Function + + Custom replacement for built-in fetch method. Useful for testing or request hooks. +
+ options.request.hook + + Function + + Function with the signature hook(request, endpointOptions), where endpointOptions are the parsed options as returned by endpoint.merge(), and request is request(). This option works great in conjuction with before-after-hook. +
+ options.request.signal + + new AbortController().signal + + Use an AbortController instance to cancel a request. In node you can only cancel streamed requests. +
+ options.request.timeout + + Number + + Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). options.request.signal is recommended instead. +
+ +All other options except `options.request.*` will be passed depending on the `method` and `url` options. + +1. If the option key is a placeholder in the `url`, it will be used as replacement. For example, if the passed options are `{url: '/orgs/{org}/repos', org: 'foo'}` the returned `options.url` is `https://api.github.com/orgs/foo/repos` +2. If the `method` is `GET` or `HEAD`, the option is passed as query parameter +3. Otherwise the parameter is passed in the request body as JSON key. + +**Result** + +`request` returns a promise and resolves with 4 keys + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ key + + type + + description +
statusIntegerResponse status status
urlStringURL of response. If a request results in redirects, this is the final URL. You can send a HEAD request to retrieve it without loading the full response body.
headersObjectAll response headers
dataAnyThe response body as returned from server. If the response is JSON then it will be parsed into an object
+ +If an error occurs, the `error` instance has additional properties to help with debugging + +- `error.status` The http response status code +- `error.headers` The http response headers as an object +- `error.request` The request options such as `method`, `url` and `data` + +## `request.defaults()` + +Override or set default options. Example: + +```js +const myrequest = require("@octokit/request").defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", + headers: { + "user-agent": "myApp/1.2.3", + authorization: `token 0000000000000000000000000000000000000001`, + }, + org: "my-project", + per_page: 100, +}); + +myrequest(`GET /orgs/{org}/repos`); +``` + +You can call `.defaults()` again on the returned method, the defaults will cascade. + +```js +const myProjectRequest = request.defaults({ + baseUrl: "https://github-enterprise.acme-inc.com/api/v3", + headers: { + "user-agent": "myApp/1.2.3", + }, + org: "my-project", +}); +const myProjectRequestWithAuth = myProjectRequest.defaults({ + headers: { + authorization: `token 0000000000000000000000000000000000000001`, + }, +}); +``` + +`myProjectRequest` now defaults the `baseUrl`, `headers['user-agent']`, +`org` and `headers['authorization']` on top of `headers['accept']` that is set +by the global default. + +## `request.endpoint` + +See https://github.com/octokit/endpoint.js. Example + +```js +const options = request.endpoint("GET /orgs/{org}/repos", { + org: "my-project", + type: "private", +}); + +// { +// method: 'GET', +// url: 'https://api.github.com/orgs/my-project/repos?type=private', +// headers: { +// accept: 'application/vnd.github.v3+json', +// authorization: 'token 0000000000000000000000000000000000000001', +// 'user-agent': 'octokit/endpoint.js v1.2.3' +// } +// } +``` + +All of the [`@octokit/endpoint`](https://github.com/octokit/endpoint.js) API can be used: + +- [`octokitRequest.endpoint()`](#endpoint) +- [`octokitRequest.endpoint.defaults()`](#endpointdefaults) +- [`octokitRequest.endpoint.merge()`](#endpointdefaults) +- [`octokitRequest.endpoint.parse()`](#endpointmerge) + +## Special cases + + + +### The `data` parameter – set request body directly + +Some endpoints such as [Render a Markdown document in raw mode](https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode) don’t have parameters that are sent as request body keys, instead the request body needs to be set directly. In these cases, set the `data` parameter. + +```js +const response = await request("POST /markdown/raw", { + data: "Hello world github/linguist#1 **cool**, and #1!", + headers: { + accept: "text/html;charset=utf-8", + "content-type": "text/plain", + }, +}); + +// Request is sent as +// +// { +// method: 'post', +// url: 'https://api.github.com/markdown/raw', +// headers: { +// accept: 'text/html;charset=utf-8', +// 'content-type': 'text/plain', +// 'user-agent': userAgent +// }, +// body: 'Hello world github/linguist#1 **cool**, and #1!' +// } +// +// not as +// +// { +// ... +// body: '{"data": "Hello world github/linguist#1 **cool**, and #1!"}' +// } +``` + +### Set parameters for both the URL/query and the request body + +There are API endpoints that accept both query parameters as well as a body. In that case you need to add the query parameters as templates to `options.url`, as defined in the [RFC 6570 URI Template specification](https://tools.ietf.org/html/rfc6570). + +Example + +```js +request( + "POST https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", + { + name: "example.zip", + label: "short description", + headers: { + "content-type": "text/plain", + "content-length": 14, + authorization: `token 0000000000000000000000000000000000000001`, + }, + data: "Hello, world!", + } +); +``` + +## LICENSE + +[MIT](LICENSE) diff --git a/node_modules/@octokit/request/dist-node/index.js b/node_modules/@octokit/request/dist-node/index.js new file mode 100644 index 00000000..e175f9eb --- /dev/null +++ b/node_modules/@octokit/request/dist-node/index.js @@ -0,0 +1,150 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } + +var endpoint = require('@octokit/endpoint'); +var universalUserAgent = require('universal-user-agent'); +var isPlainObject = require('is-plain-object'); +var nodeFetch = _interopDefault(require('node-fetch')); +var requestError = require('@octokit/request-error'); + +const VERSION = "5.4.15"; + +function getBufferResponse(response) { + return response.arrayBuffer(); +} + +function fetchWrapper(requestOptions) { + if (isPlainObject.isPlainObject(requestOptions.body) || Array.isArray(requestOptions.body)) { + requestOptions.body = JSON.stringify(requestOptions.body); + } + + let headers = {}; + let status; + let url; + const fetch = requestOptions.request && requestOptions.request.fetch || nodeFetch; + return fetch(requestOptions.url, Object.assign({ + method: requestOptions.method, + body: requestOptions.body, + headers: requestOptions.headers, + redirect: requestOptions.redirect + }, // `requestOptions.request.agent` type is incompatible + // see https://github.com/octokit/types.ts/pull/264 + requestOptions.request)).then(response => { + url = response.url; + status = response.status; + + for (const keyAndValue of response.headers) { + headers[keyAndValue[0]] = keyAndValue[1]; + } + + if (status === 204 || status === 205) { + return; + } // GitHub API returns 200 for HEAD requests + + + if (requestOptions.method === "HEAD") { + if (status < 400) { + return; + } + + throw new requestError.RequestError(response.statusText, status, { + headers, + request: requestOptions + }); + } + + if (status === 304) { + throw new requestError.RequestError("Not modified", status, { + headers, + request: requestOptions + }); + } + + if (status >= 400) { + return response.text().then(message => { + const error = new requestError.RequestError(message, status, { + headers, + request: requestOptions + }); + + try { + let responseBody = JSON.parse(error.message); + Object.assign(error, responseBody); + let errors = responseBody.errors; // Assumption `errors` would always be in Array format + + error.message = error.message + ": " + errors.map(JSON.stringify).join(", "); + } catch (e) {// ignore, see octokit/rest.js#684 + } + + throw error; + }); + } + + const contentType = response.headers.get("content-type"); + + if (/application\/json/.test(contentType)) { + return response.json(); + } + + if (!contentType || /^text\/|charset=utf-8$/.test(contentType)) { + return response.text(); + } + + return getBufferResponse(response); + }).then(data => { + return { + status, + url, + headers, + data + }; + }).catch(error => { + if (error instanceof requestError.RequestError) { + throw error; + } + + throw new requestError.RequestError(error.message, 500, { + headers, + request: requestOptions + }); + }); +} + +function withDefaults(oldEndpoint, newDefaults) { + const endpoint = oldEndpoint.defaults(newDefaults); + + const newApi = function (route, parameters) { + const endpointOptions = endpoint.merge(route, parameters); + + if (!endpointOptions.request || !endpointOptions.request.hook) { + return fetchWrapper(endpoint.parse(endpointOptions)); + } + + const request = (route, parameters) => { + return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters))); + }; + + Object.assign(request, { + endpoint, + defaults: withDefaults.bind(null, endpoint) + }); + return endpointOptions.request.hook(request, endpointOptions); + }; + + return Object.assign(newApi, { + endpoint, + defaults: withDefaults.bind(null, endpoint) + }); +} + +const request = withDefaults(endpoint.endpoint, { + headers: { + "user-agent": `octokit-request.js/${VERSION} ${universalUserAgent.getUserAgent()}` + } +}); + +exports.request = request; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/request/dist-node/index.js.map b/node_modules/@octokit/request/dist-node/index.js.map new file mode 100644 index 00000000..e1c22d5d --- /dev/null +++ b/node_modules/@octokit/request/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/get-buffer-response.js","../dist-src/fetch-wrapper.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.4.15\";\n","export default function getBufferResponse(response) {\n return response.arrayBuffer();\n}\n","import { isPlainObject } from \"is-plain-object\";\nimport nodeFetch from \"node-fetch\";\nimport { RequestError } from \"@octokit/request-error\";\nimport getBuffer from \"./get-buffer-response\";\nexport default function fetchWrapper(requestOptions) {\n if (isPlainObject(requestOptions.body) ||\n Array.isArray(requestOptions.body)) {\n requestOptions.body = JSON.stringify(requestOptions.body);\n }\n let headers = {};\n let status;\n let url;\n const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch;\n return fetch(requestOptions.url, Object.assign({\n method: requestOptions.method,\n body: requestOptions.body,\n headers: requestOptions.headers,\n redirect: requestOptions.redirect,\n }, \n // `requestOptions.request.agent` type is incompatible\n // see https://github.com/octokit/types.ts/pull/264\n requestOptions.request))\n .then((response) => {\n url = response.url;\n status = response.status;\n for (const keyAndValue of response.headers) {\n headers[keyAndValue[0]] = keyAndValue[1];\n }\n if (status === 204 || status === 205) {\n return;\n }\n // GitHub API returns 200 for HEAD requests\n if (requestOptions.method === \"HEAD\") {\n if (status < 400) {\n return;\n }\n throw new RequestError(response.statusText, status, {\n headers,\n request: requestOptions,\n });\n }\n if (status === 304) {\n throw new RequestError(\"Not modified\", status, {\n headers,\n request: requestOptions,\n });\n }\n if (status >= 400) {\n return response\n .text()\n .then((message) => {\n const error = new RequestError(message, status, {\n headers,\n request: requestOptions,\n });\n try {\n let responseBody = JSON.parse(error.message);\n Object.assign(error, responseBody);\n let errors = responseBody.errors;\n // Assumption `errors` would always be in Array format\n error.message =\n error.message + \": \" + errors.map(JSON.stringify).join(\", \");\n }\n catch (e) {\n // ignore, see octokit/rest.js#684\n }\n throw error;\n });\n }\n const contentType = response.headers.get(\"content-type\");\n if (/application\\/json/.test(contentType)) {\n return response.json();\n }\n if (!contentType || /^text\\/|charset=utf-8$/.test(contentType)) {\n return response.text();\n }\n return getBuffer(response);\n })\n .then((data) => {\n return {\n status,\n url,\n headers,\n data,\n };\n })\n .catch((error) => {\n if (error instanceof RequestError) {\n throw error;\n }\n throw new RequestError(error.message, 500, {\n headers,\n request: requestOptions,\n });\n });\n}\n","import fetchWrapper from \"./fetch-wrapper\";\nexport default function withDefaults(oldEndpoint, newDefaults) {\n const endpoint = oldEndpoint.defaults(newDefaults);\n const newApi = function (route, parameters) {\n const endpointOptions = endpoint.merge(route, parameters);\n if (!endpointOptions.request || !endpointOptions.request.hook) {\n return fetchWrapper(endpoint.parse(endpointOptions));\n }\n const request = (route, parameters) => {\n return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters)));\n };\n Object.assign(request, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint),\n });\n return endpointOptions.request.hook(request, endpointOptions);\n };\n return Object.assign(newApi, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint),\n });\n}\n","import { endpoint } from \"@octokit/endpoint\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport withDefaults from \"./with-defaults\";\nexport const request = withDefaults(endpoint, {\n headers: {\n \"user-agent\": `octokit-request.js/${VERSION} ${getUserAgent()}`,\n },\n});\n"],"names":["VERSION","getBufferResponse","response","arrayBuffer","fetchWrapper","requestOptions","isPlainObject","body","Array","isArray","JSON","stringify","headers","status","url","fetch","request","nodeFetch","Object","assign","method","redirect","then","keyAndValue","RequestError","statusText","text","message","error","responseBody","parse","errors","map","join","e","contentType","get","test","json","getBuffer","data","catch","withDefaults","oldEndpoint","newDefaults","endpoint","defaults","newApi","route","parameters","endpointOptions","merge","hook","bind","getUserAgent"],"mappings":";;;;;;;;;;;;AAAO,MAAMA,OAAO,GAAG,mBAAhB;;ACAQ,SAASC,iBAAT,CAA2BC,QAA3B,EAAqC;AAChD,SAAOA,QAAQ,CAACC,WAAT,EAAP;AACH;;ACEc,SAASC,YAAT,CAAsBC,cAAtB,EAAsC;AACjD,MAAIC,2BAAa,CAACD,cAAc,CAACE,IAAhB,CAAb,IACAC,KAAK,CAACC,OAAN,CAAcJ,cAAc,CAACE,IAA7B,CADJ,EACwC;AACpCF,IAAAA,cAAc,CAACE,IAAf,GAAsBG,IAAI,CAACC,SAAL,CAAeN,cAAc,CAACE,IAA9B,CAAtB;AACH;;AACD,MAAIK,OAAO,GAAG,EAAd;AACA,MAAIC,MAAJ;AACA,MAAIC,GAAJ;AACA,QAAMC,KAAK,GAAIV,cAAc,CAACW,OAAf,IAA0BX,cAAc,CAACW,OAAf,CAAuBD,KAAlD,IAA4DE,SAA1E;AACA,SAAOF,KAAK,CAACV,cAAc,CAACS,GAAhB,EAAqBI,MAAM,CAACC,MAAP,CAAc;AAC3CC,IAAAA,MAAM,EAAEf,cAAc,CAACe,MADoB;AAE3Cb,IAAAA,IAAI,EAAEF,cAAc,CAACE,IAFsB;AAG3CK,IAAAA,OAAO,EAAEP,cAAc,CAACO,OAHmB;AAI3CS,IAAAA,QAAQ,EAAEhB,cAAc,CAACgB;AAJkB,GAAd;AAOjC;AACAhB,EAAAA,cAAc,CAACW,OARkB,CAArB,CAAL,CASFM,IATE,CASIpB,QAAD,IAAc;AACpBY,IAAAA,GAAG,GAAGZ,QAAQ,CAACY,GAAf;AACAD,IAAAA,MAAM,GAAGX,QAAQ,CAACW,MAAlB;;AACA,SAAK,MAAMU,WAAX,IAA0BrB,QAAQ,CAACU,OAAnC,EAA4C;AACxCA,MAAAA,OAAO,CAACW,WAAW,CAAC,CAAD,CAAZ,CAAP,GAA0BA,WAAW,CAAC,CAAD,CAArC;AACH;;AACD,QAAIV,MAAM,KAAK,GAAX,IAAkBA,MAAM,KAAK,GAAjC,EAAsC;AAClC;AACH,KARmB;;;AAUpB,QAAIR,cAAc,CAACe,MAAf,KAA0B,MAA9B,EAAsC;AAClC,UAAIP,MAAM,GAAG,GAAb,EAAkB;AACd;AACH;;AACD,YAAM,IAAIW,yBAAJ,CAAiBtB,QAAQ,CAACuB,UAA1B,EAAsCZ,MAAtC,EAA8C;AAChDD,QAAAA,OADgD;AAEhDI,QAAAA,OAAO,EAAEX;AAFuC,OAA9C,CAAN;AAIH;;AACD,QAAIQ,MAAM,KAAK,GAAf,EAAoB;AAChB,YAAM,IAAIW,yBAAJ,CAAiB,cAAjB,EAAiCX,MAAjC,EAAyC;AAC3CD,QAAAA,OAD2C;AAE3CI,QAAAA,OAAO,EAAEX;AAFkC,OAAzC,CAAN;AAIH;;AACD,QAAIQ,MAAM,IAAI,GAAd,EAAmB;AACf,aAAOX,QAAQ,CACVwB,IADE,GAEFJ,IAFE,CAEIK,OAAD,IAAa;AACnB,cAAMC,KAAK,GAAG,IAAIJ,yBAAJ,CAAiBG,OAAjB,EAA0Bd,MAA1B,EAAkC;AAC5CD,UAAAA,OAD4C;AAE5CI,UAAAA,OAAO,EAAEX;AAFmC,SAAlC,CAAd;;AAIA,YAAI;AACA,cAAIwB,YAAY,GAAGnB,IAAI,CAACoB,KAAL,CAAWF,KAAK,CAACD,OAAjB,CAAnB;AACAT,UAAAA,MAAM,CAACC,MAAP,CAAcS,KAAd,EAAqBC,YAArB;AACA,cAAIE,MAAM,GAAGF,YAAY,CAACE,MAA1B,CAHA;;AAKAH,UAAAA,KAAK,CAACD,OAAN,GACIC,KAAK,CAACD,OAAN,GAAgB,IAAhB,GAAuBI,MAAM,CAACC,GAAP,CAAWtB,IAAI,CAACC,SAAhB,EAA2BsB,IAA3B,CAAgC,IAAhC,CAD3B;AAEH,SAPD,CAQA,OAAOC,CAAP,EAAU;AAET;;AACD,cAAMN,KAAN;AACH,OAnBM,CAAP;AAoBH;;AACD,UAAMO,WAAW,GAAGjC,QAAQ,CAACU,OAAT,CAAiBwB,GAAjB,CAAqB,cAArB,CAApB;;AACA,QAAI,oBAAoBC,IAApB,CAAyBF,WAAzB,CAAJ,EAA2C;AACvC,aAAOjC,QAAQ,CAACoC,IAAT,EAAP;AACH;;AACD,QAAI,CAACH,WAAD,IAAgB,yBAAyBE,IAAzB,CAA8BF,WAA9B,CAApB,EAAgE;AAC5D,aAAOjC,QAAQ,CAACwB,IAAT,EAAP;AACH;;AACD,WAAOa,iBAAS,CAACrC,QAAD,CAAhB;AACH,GAhEM,EAiEFoB,IAjEE,CAiEIkB,IAAD,IAAU;AAChB,WAAO;AACH3B,MAAAA,MADG;AAEHC,MAAAA,GAFG;AAGHF,MAAAA,OAHG;AAIH4B,MAAAA;AAJG,KAAP;AAMH,GAxEM,EAyEFC,KAzEE,CAyEKb,KAAD,IAAW;AAClB,QAAIA,KAAK,YAAYJ,yBAArB,EAAmC;AAC/B,YAAMI,KAAN;AACH;;AACD,UAAM,IAAIJ,yBAAJ,CAAiBI,KAAK,CAACD,OAAvB,EAAgC,GAAhC,EAAqC;AACvCf,MAAAA,OADuC;AAEvCI,MAAAA,OAAO,EAAEX;AAF8B,KAArC,CAAN;AAIH,GAjFM,CAAP;AAkFH;;AC9Fc,SAASqC,YAAT,CAAsBC,WAAtB,EAAmCC,WAAnC,EAAgD;AAC3D,QAAMC,QAAQ,GAAGF,WAAW,CAACG,QAAZ,CAAqBF,WAArB,CAAjB;;AACA,QAAMG,MAAM,GAAG,UAAUC,KAAV,EAAiBC,UAAjB,EAA6B;AACxC,UAAMC,eAAe,GAAGL,QAAQ,CAACM,KAAT,CAAeH,KAAf,EAAsBC,UAAtB,CAAxB;;AACA,QAAI,CAACC,eAAe,CAAClC,OAAjB,IAA4B,CAACkC,eAAe,CAAClC,OAAhB,CAAwBoC,IAAzD,EAA+D;AAC3D,aAAOhD,YAAY,CAACyC,QAAQ,CAACf,KAAT,CAAeoB,eAAf,CAAD,CAAnB;AACH;;AACD,UAAMlC,OAAO,GAAG,CAACgC,KAAD,EAAQC,UAAR,KAAuB;AACnC,aAAO7C,YAAY,CAACyC,QAAQ,CAACf,KAAT,CAAee,QAAQ,CAACM,KAAT,CAAeH,KAAf,EAAsBC,UAAtB,CAAf,CAAD,CAAnB;AACH,KAFD;;AAGA/B,IAAAA,MAAM,CAACC,MAAP,CAAcH,OAAd,EAAuB;AACnB6B,MAAAA,QADmB;AAEnBC,MAAAA,QAAQ,EAAEJ,YAAY,CAACW,IAAb,CAAkB,IAAlB,EAAwBR,QAAxB;AAFS,KAAvB;AAIA,WAAOK,eAAe,CAAClC,OAAhB,CAAwBoC,IAAxB,CAA6BpC,OAA7B,EAAsCkC,eAAtC,CAAP;AACH,GAbD;;AAcA,SAAOhC,MAAM,CAACC,MAAP,CAAc4B,MAAd,EAAsB;AACzBF,IAAAA,QADyB;AAEzBC,IAAAA,QAAQ,EAAEJ,YAAY,CAACW,IAAb,CAAkB,IAAlB,EAAwBR,QAAxB;AAFe,GAAtB,CAAP;AAIH;;MCjBY7B,OAAO,GAAG0B,YAAY,CAACG,iBAAD,EAAW;AAC1CjC,EAAAA,OAAO,EAAE;AACL,kBAAe,sBAAqBZ,OAAQ,IAAGsD,+BAAY,EAAG;AADzD;AADiC,CAAX,CAA5B;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/dist-src/fetch-wrapper.js b/node_modules/@octokit/request/dist-src/fetch-wrapper.js new file mode 100644 index 00000000..0746ce6e --- /dev/null +++ b/node_modules/@octokit/request/dist-src/fetch-wrapper.js @@ -0,0 +1,96 @@ +import { isPlainObject } from "is-plain-object"; +import nodeFetch from "node-fetch"; +import { RequestError } from "@octokit/request-error"; +import getBuffer from "./get-buffer-response"; +export default function fetchWrapper(requestOptions) { + if (isPlainObject(requestOptions.body) || + Array.isArray(requestOptions.body)) { + requestOptions.body = JSON.stringify(requestOptions.body); + } + let headers = {}; + let status; + let url; + const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch; + return fetch(requestOptions.url, Object.assign({ + method: requestOptions.method, + body: requestOptions.body, + headers: requestOptions.headers, + redirect: requestOptions.redirect, + }, + // `requestOptions.request.agent` type is incompatible + // see https://github.com/octokit/types.ts/pull/264 + requestOptions.request)) + .then((response) => { + url = response.url; + status = response.status; + for (const keyAndValue of response.headers) { + headers[keyAndValue[0]] = keyAndValue[1]; + } + if (status === 204 || status === 205) { + return; + } + // GitHub API returns 200 for HEAD requests + if (requestOptions.method === "HEAD") { + if (status < 400) { + return; + } + throw new RequestError(response.statusText, status, { + headers, + request: requestOptions, + }); + } + if (status === 304) { + throw new RequestError("Not modified", status, { + headers, + request: requestOptions, + }); + } + if (status >= 400) { + return response + .text() + .then((message) => { + const error = new RequestError(message, status, { + headers, + request: requestOptions, + }); + try { + let responseBody = JSON.parse(error.message); + Object.assign(error, responseBody); + let errors = responseBody.errors; + // Assumption `errors` would always be in Array format + error.message = + error.message + ": " + errors.map(JSON.stringify).join(", "); + } + catch (e) { + // ignore, see octokit/rest.js#684 + } + throw error; + }); + } + const contentType = response.headers.get("content-type"); + if (/application\/json/.test(contentType)) { + return response.json(); + } + if (!contentType || /^text\/|charset=utf-8$/.test(contentType)) { + return response.text(); + } + return getBuffer(response); + }) + .then((data) => { + return { + status, + url, + headers, + data, + }; + }) + .catch((error) => { + if (error instanceof RequestError) { + throw error; + } + throw new RequestError(error.message, 500, { + headers, + request: requestOptions, + }); + }); +} diff --git a/node_modules/@octokit/request/dist-src/get-buffer-response.js b/node_modules/@octokit/request/dist-src/get-buffer-response.js new file mode 100644 index 00000000..845a3947 --- /dev/null +++ b/node_modules/@octokit/request/dist-src/get-buffer-response.js @@ -0,0 +1,3 @@ +export default function getBufferResponse(response) { + return response.arrayBuffer(); +} diff --git a/node_modules/@octokit/request/dist-src/index.js b/node_modules/@octokit/request/dist-src/index.js new file mode 100644 index 00000000..2460e992 --- /dev/null +++ b/node_modules/@octokit/request/dist-src/index.js @@ -0,0 +1,9 @@ +import { endpoint } from "@octokit/endpoint"; +import { getUserAgent } from "universal-user-agent"; +import { VERSION } from "./version"; +import withDefaults from "./with-defaults"; +export const request = withDefaults(endpoint, { + headers: { + "user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}`, + }, +}); diff --git a/node_modules/@octokit/request/dist-src/version.js b/node_modules/@octokit/request/dist-src/version.js new file mode 100644 index 00000000..4e94e69d --- /dev/null +++ b/node_modules/@octokit/request/dist-src/version.js @@ -0,0 +1 @@ +export const VERSION = "5.4.15"; diff --git a/node_modules/@octokit/request/dist-src/with-defaults.js b/node_modules/@octokit/request/dist-src/with-defaults.js new file mode 100644 index 00000000..e2064294 --- /dev/null +++ b/node_modules/@octokit/request/dist-src/with-defaults.js @@ -0,0 +1,22 @@ +import fetchWrapper from "./fetch-wrapper"; +export default function withDefaults(oldEndpoint, newDefaults) { + const endpoint = oldEndpoint.defaults(newDefaults); + const newApi = function (route, parameters) { + const endpointOptions = endpoint.merge(route, parameters); + if (!endpointOptions.request || !endpointOptions.request.hook) { + return fetchWrapper(endpoint.parse(endpointOptions)); + } + const request = (route, parameters) => { + return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters))); + }; + Object.assign(request, { + endpoint, + defaults: withDefaults.bind(null, endpoint), + }); + return endpointOptions.request.hook(request, endpointOptions); + }; + return Object.assign(newApi, { + endpoint, + defaults: withDefaults.bind(null, endpoint), + }); +} diff --git a/node_modules/@octokit/request/dist-types/fetch-wrapper.d.ts b/node_modules/@octokit/request/dist-types/fetch-wrapper.d.ts new file mode 100644 index 00000000..4901c79e --- /dev/null +++ b/node_modules/@octokit/request/dist-types/fetch-wrapper.d.ts @@ -0,0 +1,11 @@ +import { EndpointInterface } from "@octokit/types"; +export default function fetchWrapper(requestOptions: ReturnType & { + redirect?: "error" | "follow" | "manual"; +}): Promise<{ + status: number; + url: string; + headers: { + [header: string]: string; + }; + data: any; +}>; diff --git a/node_modules/@octokit/request/dist-types/get-buffer-response.d.ts b/node_modules/@octokit/request/dist-types/get-buffer-response.d.ts new file mode 100644 index 00000000..915b7057 --- /dev/null +++ b/node_modules/@octokit/request/dist-types/get-buffer-response.d.ts @@ -0,0 +1,2 @@ +import { Response } from "node-fetch"; +export default function getBufferResponse(response: Response): Promise; diff --git a/node_modules/@octokit/request/dist-types/index.d.ts b/node_modules/@octokit/request/dist-types/index.d.ts new file mode 100644 index 00000000..1030809f --- /dev/null +++ b/node_modules/@octokit/request/dist-types/index.d.ts @@ -0,0 +1 @@ +export declare const request: import("@octokit/types").RequestInterface; diff --git a/node_modules/@octokit/request/dist-types/version.d.ts b/node_modules/@octokit/request/dist-types/version.d.ts new file mode 100644 index 00000000..2ec648da --- /dev/null +++ b/node_modules/@octokit/request/dist-types/version.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "5.4.15"; diff --git a/node_modules/@octokit/request/dist-types/with-defaults.d.ts b/node_modules/@octokit/request/dist-types/with-defaults.d.ts new file mode 100644 index 00000000..00804693 --- /dev/null +++ b/node_modules/@octokit/request/dist-types/with-defaults.d.ts @@ -0,0 +1,2 @@ +import { EndpointInterface, RequestInterface, RequestParameters } from "@octokit/types"; +export default function withDefaults(oldEndpoint: EndpointInterface, newDefaults: RequestParameters): RequestInterface; diff --git a/node_modules/@octokit/request/dist-web/index.js b/node_modules/@octokit/request/dist-web/index.js new file mode 100644 index 00000000..45c6e97c --- /dev/null +++ b/node_modules/@octokit/request/dist-web/index.js @@ -0,0 +1,135 @@ +import { endpoint } from '@octokit/endpoint'; +import { getUserAgent } from 'universal-user-agent'; +import { isPlainObject } from 'is-plain-object'; +import nodeFetch from 'node-fetch'; +import { RequestError } from '@octokit/request-error'; + +const VERSION = "5.4.15"; + +function getBufferResponse(response) { + return response.arrayBuffer(); +} + +function fetchWrapper(requestOptions) { + if (isPlainObject(requestOptions.body) || + Array.isArray(requestOptions.body)) { + requestOptions.body = JSON.stringify(requestOptions.body); + } + let headers = {}; + let status; + let url; + const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch; + return fetch(requestOptions.url, Object.assign({ + method: requestOptions.method, + body: requestOptions.body, + headers: requestOptions.headers, + redirect: requestOptions.redirect, + }, + // `requestOptions.request.agent` type is incompatible + // see https://github.com/octokit/types.ts/pull/264 + requestOptions.request)) + .then((response) => { + url = response.url; + status = response.status; + for (const keyAndValue of response.headers) { + headers[keyAndValue[0]] = keyAndValue[1]; + } + if (status === 204 || status === 205) { + return; + } + // GitHub API returns 200 for HEAD requests + if (requestOptions.method === "HEAD") { + if (status < 400) { + return; + } + throw new RequestError(response.statusText, status, { + headers, + request: requestOptions, + }); + } + if (status === 304) { + throw new RequestError("Not modified", status, { + headers, + request: requestOptions, + }); + } + if (status >= 400) { + return response + .text() + .then((message) => { + const error = new RequestError(message, status, { + headers, + request: requestOptions, + }); + try { + let responseBody = JSON.parse(error.message); + Object.assign(error, responseBody); + let errors = responseBody.errors; + // Assumption `errors` would always be in Array format + error.message = + error.message + ": " + errors.map(JSON.stringify).join(", "); + } + catch (e) { + // ignore, see octokit/rest.js#684 + } + throw error; + }); + } + const contentType = response.headers.get("content-type"); + if (/application\/json/.test(contentType)) { + return response.json(); + } + if (!contentType || /^text\/|charset=utf-8$/.test(contentType)) { + return response.text(); + } + return getBufferResponse(response); + }) + .then((data) => { + return { + status, + url, + headers, + data, + }; + }) + .catch((error) => { + if (error instanceof RequestError) { + throw error; + } + throw new RequestError(error.message, 500, { + headers, + request: requestOptions, + }); + }); +} + +function withDefaults(oldEndpoint, newDefaults) { + const endpoint = oldEndpoint.defaults(newDefaults); + const newApi = function (route, parameters) { + const endpointOptions = endpoint.merge(route, parameters); + if (!endpointOptions.request || !endpointOptions.request.hook) { + return fetchWrapper(endpoint.parse(endpointOptions)); + } + const request = (route, parameters) => { + return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters))); + }; + Object.assign(request, { + endpoint, + defaults: withDefaults.bind(null, endpoint), + }); + return endpointOptions.request.hook(request, endpointOptions); + }; + return Object.assign(newApi, { + endpoint, + defaults: withDefaults.bind(null, endpoint), + }); +} + +const request = withDefaults(endpoint, { + headers: { + "user-agent": `octokit-request.js/${VERSION} ${getUserAgent()}`, + }, +}); + +export { request }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/request/dist-web/index.js.map b/node_modules/@octokit/request/dist-web/index.js.map new file mode 100644 index 00000000..d3d24bb9 --- /dev/null +++ b/node_modules/@octokit/request/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/version.js","../dist-src/get-buffer-response.js","../dist-src/fetch-wrapper.js","../dist-src/with-defaults.js","../dist-src/index.js"],"sourcesContent":["export const VERSION = \"5.4.15\";\n","export default function getBufferResponse(response) {\n return response.arrayBuffer();\n}\n","import { isPlainObject } from \"is-plain-object\";\nimport nodeFetch from \"node-fetch\";\nimport { RequestError } from \"@octokit/request-error\";\nimport getBuffer from \"./get-buffer-response\";\nexport default function fetchWrapper(requestOptions) {\n if (isPlainObject(requestOptions.body) ||\n Array.isArray(requestOptions.body)) {\n requestOptions.body = JSON.stringify(requestOptions.body);\n }\n let headers = {};\n let status;\n let url;\n const fetch = (requestOptions.request && requestOptions.request.fetch) || nodeFetch;\n return fetch(requestOptions.url, Object.assign({\n method: requestOptions.method,\n body: requestOptions.body,\n headers: requestOptions.headers,\n redirect: requestOptions.redirect,\n }, \n // `requestOptions.request.agent` type is incompatible\n // see https://github.com/octokit/types.ts/pull/264\n requestOptions.request))\n .then((response) => {\n url = response.url;\n status = response.status;\n for (const keyAndValue of response.headers) {\n headers[keyAndValue[0]] = keyAndValue[1];\n }\n if (status === 204 || status === 205) {\n return;\n }\n // GitHub API returns 200 for HEAD requests\n if (requestOptions.method === \"HEAD\") {\n if (status < 400) {\n return;\n }\n throw new RequestError(response.statusText, status, {\n headers,\n request: requestOptions,\n });\n }\n if (status === 304) {\n throw new RequestError(\"Not modified\", status, {\n headers,\n request: requestOptions,\n });\n }\n if (status >= 400) {\n return response\n .text()\n .then((message) => {\n const error = new RequestError(message, status, {\n headers,\n request: requestOptions,\n });\n try {\n let responseBody = JSON.parse(error.message);\n Object.assign(error, responseBody);\n let errors = responseBody.errors;\n // Assumption `errors` would always be in Array format\n error.message =\n error.message + \": \" + errors.map(JSON.stringify).join(\", \");\n }\n catch (e) {\n // ignore, see octokit/rest.js#684\n }\n throw error;\n });\n }\n const contentType = response.headers.get(\"content-type\");\n if (/application\\/json/.test(contentType)) {\n return response.json();\n }\n if (!contentType || /^text\\/|charset=utf-8$/.test(contentType)) {\n return response.text();\n }\n return getBuffer(response);\n })\n .then((data) => {\n return {\n status,\n url,\n headers,\n data,\n };\n })\n .catch((error) => {\n if (error instanceof RequestError) {\n throw error;\n }\n throw new RequestError(error.message, 500, {\n headers,\n request: requestOptions,\n });\n });\n}\n","import fetchWrapper from \"./fetch-wrapper\";\nexport default function withDefaults(oldEndpoint, newDefaults) {\n const endpoint = oldEndpoint.defaults(newDefaults);\n const newApi = function (route, parameters) {\n const endpointOptions = endpoint.merge(route, parameters);\n if (!endpointOptions.request || !endpointOptions.request.hook) {\n return fetchWrapper(endpoint.parse(endpointOptions));\n }\n const request = (route, parameters) => {\n return fetchWrapper(endpoint.parse(endpoint.merge(route, parameters)));\n };\n Object.assign(request, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint),\n });\n return endpointOptions.request.hook(request, endpointOptions);\n };\n return Object.assign(newApi, {\n endpoint,\n defaults: withDefaults.bind(null, endpoint),\n });\n}\n","import { endpoint } from \"@octokit/endpoint\";\nimport { getUserAgent } from \"universal-user-agent\";\nimport { VERSION } from \"./version\";\nimport withDefaults from \"./with-defaults\";\nexport const request = withDefaults(endpoint, {\n headers: {\n \"user-agent\": `octokit-request.js/${VERSION} ${getUserAgent()}`,\n },\n});\n"],"names":["getBuffer"],"mappings":";;;;;;AAAO,MAAM,OAAO,GAAG,mBAAmB;;ACA3B,SAAS,iBAAiB,CAAC,QAAQ,EAAE;AACpD,IAAI,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;AAClC,CAAC;;ACEc,SAAS,YAAY,CAAC,cAAc,EAAE;AACrD,IAAI,IAAI,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC;AAC1C,QAAQ,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;AAC5C,QAAQ,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AAClE,KAAK;AACL,IAAI,IAAI,OAAO,GAAG,EAAE,CAAC;AACrB,IAAI,IAAI,MAAM,CAAC;AACf,IAAI,IAAI,GAAG,CAAC;AACZ,IAAI,MAAM,KAAK,GAAG,CAAC,cAAc,CAAC,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC;AACxF,IAAI,OAAO,KAAK,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC;AACnD,QAAQ,MAAM,EAAE,cAAc,CAAC,MAAM;AACrC,QAAQ,IAAI,EAAE,cAAc,CAAC,IAAI;AACjC,QAAQ,OAAO,EAAE,cAAc,CAAC,OAAO;AACvC,QAAQ,QAAQ,EAAE,cAAc,CAAC,QAAQ;AACzC,KAAK;AACL;AACA;AACA,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;AAC5B,SAAS,IAAI,CAAC,CAAC,QAAQ,KAAK;AAC5B,QAAQ,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;AAC3B,QAAQ,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;AACjC,QAAQ,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,OAAO,EAAE;AACpD,YAAY,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AACrD,SAAS;AACT,QAAQ,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE;AAC9C,YAAY,OAAO;AACnB,SAAS;AACT;AACA,QAAQ,IAAI,cAAc,CAAC,MAAM,KAAK,MAAM,EAAE;AAC9C,YAAY,IAAI,MAAM,GAAG,GAAG,EAAE;AAC9B,gBAAgB,OAAO;AACvB,aAAa;AACb,YAAY,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE;AAChE,gBAAgB,OAAO;AACvB,gBAAgB,OAAO,EAAE,cAAc;AACvC,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,IAAI,MAAM,KAAK,GAAG,EAAE;AAC5B,YAAY,MAAM,IAAI,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE;AAC3D,gBAAgB,OAAO;AACvB,gBAAgB,OAAO,EAAE,cAAc;AACvC,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,IAAI,MAAM,IAAI,GAAG,EAAE;AAC3B,YAAY,OAAO,QAAQ;AAC3B,iBAAiB,IAAI,EAAE;AACvB,iBAAiB,IAAI,CAAC,CAAC,OAAO,KAAK;AACnC,gBAAgB,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE;AAChE,oBAAoB,OAAO;AAC3B,oBAAoB,OAAO,EAAE,cAAc;AAC3C,iBAAiB,CAAC,CAAC;AACnB,gBAAgB,IAAI;AACpB,oBAAoB,IAAI,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACjE,oBAAoB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;AACvD,oBAAoB,IAAI,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;AACrD;AACA,oBAAoB,KAAK,CAAC,OAAO;AACjC,wBAAwB,KAAK,CAAC,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACrF,iBAAiB;AACjB,gBAAgB,OAAO,CAAC,EAAE;AAC1B;AACA,iBAAiB;AACjB,gBAAgB,MAAM,KAAK,CAAC;AAC5B,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;AACjE,QAAQ,IAAI,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AACnD,YAAY,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACnC,SAAS;AACT,QAAQ,IAAI,CAAC,WAAW,IAAI,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AACxE,YAAY,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACnC,SAAS;AACT,QAAQ,OAAOA,iBAAS,CAAC,QAAQ,CAAC,CAAC;AACnC,KAAK,CAAC;AACN,SAAS,IAAI,CAAC,CAAC,IAAI,KAAK;AACxB,QAAQ,OAAO;AACf,YAAY,MAAM;AAClB,YAAY,GAAG;AACf,YAAY,OAAO;AACnB,YAAY,IAAI;AAChB,SAAS,CAAC;AACV,KAAK,CAAC;AACN,SAAS,KAAK,CAAC,CAAC,KAAK,KAAK;AAC1B,QAAQ,IAAI,KAAK,YAAY,YAAY,EAAE;AAC3C,YAAY,MAAM,KAAK,CAAC;AACxB,SAAS;AACT,QAAQ,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE;AACnD,YAAY,OAAO;AACnB,YAAY,OAAO,EAAE,cAAc;AACnC,SAAS,CAAC,CAAC;AACX,KAAK,CAAC,CAAC;AACP,CAAC;;AC9Fc,SAAS,YAAY,CAAC,WAAW,EAAE,WAAW,EAAE;AAC/D,IAAI,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AACvD,IAAI,MAAM,MAAM,GAAG,UAAU,KAAK,EAAE,UAAU,EAAE;AAChD,QAAQ,MAAM,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AAClE,QAAQ,IAAI,CAAC,eAAe,CAAC,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE;AACvE,YAAY,OAAO,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;AACjE,SAAS;AACT,QAAQ,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK;AAC/C,YAAY,OAAO,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;AACnF,SAAS,CAAC;AACV,QAAQ,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;AAC/B,YAAY,QAAQ;AACpB,YAAY,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACvD,SAAS,CAAC,CAAC;AACX,QAAQ,OAAO,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AACtE,KAAK,CAAC;AACN,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;AACjC,QAAQ,QAAQ;AAChB,QAAQ,QAAQ,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;AACnD,KAAK,CAAC,CAAC;AACP,CAAC;;ACjBW,MAAC,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE;AAC9C,IAAI,OAAO,EAAE;AACb,QAAQ,YAAY,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AACvE,KAAK;AACL,CAAC,CAAC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/LICENSE b/node_modules/@octokit/request/node_modules/@octokit/request-error/LICENSE new file mode 100644 index 00000000..ef2c18ee --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/README.md b/node_modules/@octokit/request/node_modules/@octokit/request-error/README.md new file mode 100644 index 00000000..315064ce --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/README.md @@ -0,0 +1,67 @@ +# http-error.js + +> Error class for Octokit request errors + +[![@latest](https://img.shields.io/npm/v/@octokit/request-error.svg)](https://www.npmjs.com/package/@octokit/request-error) +[![Build Status](https://github.com/octokit/request-error.js/workflows/Test/badge.svg)](https://github.com/octokit/request-error.js/actions?query=workflow%3ATest) + +## Usage + + + + + + +
+Browsers + +Load @octokit/request-error directly from cdn.pika.dev + +```html + +``` + +
+Node + + +Install with npm install @octokit/request-error + +```js +const { RequestError } = require("@octokit/request-error"); +// or: import { RequestError } from "@octokit/request-error"; +``` + +
+ +```js +const error = new RequestError("Oops", 500, { + headers: { + "x-github-request-id": "1:2:3:4", + }, // response headers + request: { + method: "POST", + url: "https://api.github.com/foo", + body: { + bar: "baz", + }, + headers: { + authorization: "token secret123", + }, + }, +}); + +error.message; // Oops +error.status; // 500 +error.headers; // { 'x-github-request-id': '1:2:3:4' } +error.request.method; // POST +error.request.url; // https://api.github.com/foo +error.request.body; // { bar: 'baz' } +error.request.headers; // { authorization: 'token [REDACTED]' } +``` + +## LICENSE + +[MIT](LICENSE) diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-node/index.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-node/index.js new file mode 100644 index 00000000..95b9c579 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-node/index.js @@ -0,0 +1,55 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } + +var deprecation = require('deprecation'); +var once = _interopDefault(require('once')); + +const logOnce = once(deprecation => console.warn(deprecation)); +/** + * Error with extra properties to help with debugging + */ + +class RequestError extends Error { + constructor(message, statusCode, options) { + super(message); // Maintains proper stack trace (only available on V8) + + /* istanbul ignore next */ + + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + + this.name = "HttpError"; + this.status = statusCode; + Object.defineProperty(this, "code", { + get() { + logOnce(new deprecation.Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); + return statusCode; + } + + }); + this.headers = options.headers || {}; // redact request credentials without mutating original request options + + const requestCopy = Object.assign({}, options.request); + + if (options.request.headers.authorization) { + requestCopy.headers = Object.assign({}, options.request.headers, { + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]") + }); + } + + requestCopy.url = requestCopy.url // client_id & client_secret can be passed as URL query parameters to increase rate limit + // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications + .replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]") // OAuth tokens can be passed as URL query parameters, although it is not recommended + // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header + .replace(/\baccess_token=\w+/g, "access_token=[REDACTED]"); + this.request = requestCopy; + } + +} + +exports.RequestError = RequestError; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-node/index.js.map b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-node/index.js.map new file mode 100644 index 00000000..25620064 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n },\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\"),\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":["logOnce","once","deprecation","console","warn","RequestError","Error","constructor","message","statusCode","options","captureStackTrace","name","status","Object","defineProperty","get","Deprecation","headers","requestCopy","assign","request","authorization","replace","url"],"mappings":";;;;;;;;;AAEA,MAAMA,OAAO,GAAGC,IAAI,CAAEC,WAAD,IAAiBC,OAAO,CAACC,IAAR,CAAaF,WAAb,CAAlB,CAApB;AACA;;;;AAGO,MAAMG,YAAN,SAA2BC,KAA3B,CAAiC;AACpCC,EAAAA,WAAW,CAACC,OAAD,EAAUC,UAAV,EAAsBC,OAAtB,EAA+B;AACtC,UAAMF,OAAN,EADsC;;AAGtC;;AACA,QAAIF,KAAK,CAACK,iBAAV,EAA6B;AACzBL,MAAAA,KAAK,CAACK,iBAAN,CAAwB,IAAxB,EAA8B,KAAKJ,WAAnC;AACH;;AACD,SAAKK,IAAL,GAAY,WAAZ;AACA,SAAKC,MAAL,GAAcJ,UAAd;AACAK,IAAAA,MAAM,CAACC,cAAP,CAAsB,IAAtB,EAA4B,MAA5B,EAAoC;AAChCC,MAAAA,GAAG,GAAG;AACFhB,QAAAA,OAAO,CAAC,IAAIiB,uBAAJ,CAAgB,0EAAhB,CAAD,CAAP;AACA,eAAOR,UAAP;AACH;;AAJ+B,KAApC;AAMA,SAAKS,OAAL,GAAeR,OAAO,CAACQ,OAAR,IAAmB,EAAlC,CAfsC;;AAiBtC,UAAMC,WAAW,GAAGL,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAA1B,CAApB;;AACA,QAAIX,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAA5B,EAA2C;AACvCH,MAAAA,WAAW,CAACD,OAAZ,GAAsBJ,MAAM,CAACM,MAAP,CAAc,EAAd,EAAkBV,OAAO,CAACW,OAAR,CAAgBH,OAAlC,EAA2C;AAC7DI,QAAAA,aAAa,EAAEZ,OAAO,CAACW,OAAR,CAAgBH,OAAhB,CAAwBI,aAAxB,CAAsCC,OAAtC,CAA8C,MAA9C,EAAsD,aAAtD;AAD8C,OAA3C,CAAtB;AAGH;;AACDJ,IAAAA,WAAW,CAACK,GAAZ,GAAkBL,WAAW,CAACK,GAAZ;AAEd;AAFc,KAGbD,OAHa,CAGL,sBAHK,EAGmB,0BAHnB;AAKd;AALc,KAMbA,OANa,CAML,qBANK,EAMkB,yBANlB,CAAlB;AAOA,SAAKF,OAAL,GAAeF,WAAf;AACH;;AAhCmC;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-src/index.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-src/index.js new file mode 100644 index 00000000..c880b450 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-src/index.js @@ -0,0 +1,40 @@ +import { Deprecation } from "deprecation"; +import once from "once"; +const logOnce = once((deprecation) => console.warn(deprecation)); +/** + * Error with extra properties to help with debugging + */ +export class RequestError extends Error { + constructor(message, statusCode, options) { + super(message); + // Maintains proper stack trace (only available on V8) + /* istanbul ignore next */ + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + this.name = "HttpError"; + this.status = statusCode; + Object.defineProperty(this, "code", { + get() { + logOnce(new Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); + return statusCode; + }, + }); + this.headers = options.headers || {}; + // redact request credentials without mutating original request options + const requestCopy = Object.assign({}, options.request); + if (options.request.headers.authorization) { + requestCopy.headers = Object.assign({}, options.request.headers, { + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]"), + }); + } + requestCopy.url = requestCopy.url + // client_id & client_secret can be passed as URL query parameters to increase rate limit + // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications + .replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]") + // OAuth tokens can be passed as URL query parameters, although it is not recommended + // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header + .replace(/\baccess_token=\w+/g, "access_token=[REDACTED]"); + this.request = requestCopy; + } +} diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-src/types.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-src/types.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-types/index.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-types/index.d.ts new file mode 100644 index 00000000..baa8a0eb --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-types/index.d.ts @@ -0,0 +1,27 @@ +import { RequestOptions, ResponseHeaders } from "@octokit/types"; +import { RequestErrorOptions } from "./types"; +/** + * Error with extra properties to help with debugging + */ +export declare class RequestError extends Error { + name: "HttpError"; + /** + * http status code + */ + status: number; + /** + * http status code + * + * @deprecated `error.code` is deprecated in favor of `error.status` + */ + code: number; + /** + * error response headers + */ + headers: ResponseHeaders; + /** + * Request options that lead to the error. + */ + request: RequestOptions; + constructor(message: string, statusCode: number, options: RequestErrorOptions); +} diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-types/types.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-types/types.d.ts new file mode 100644 index 00000000..865d2139 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-types/types.d.ts @@ -0,0 +1,5 @@ +import { RequestOptions, ResponseHeaders } from "@octokit/types"; +export declare type RequestErrorOptions = { + headers?: ResponseHeaders; + request: RequestOptions; +}; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-web/index.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-web/index.js new file mode 100644 index 00000000..feec58ef --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-web/index.js @@ -0,0 +1,44 @@ +import { Deprecation } from 'deprecation'; +import once from 'once'; + +const logOnce = once((deprecation) => console.warn(deprecation)); +/** + * Error with extra properties to help with debugging + */ +class RequestError extends Error { + constructor(message, statusCode, options) { + super(message); + // Maintains proper stack trace (only available on V8) + /* istanbul ignore next */ + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + this.name = "HttpError"; + this.status = statusCode; + Object.defineProperty(this, "code", { + get() { + logOnce(new Deprecation("[@octokit/request-error] `error.code` is deprecated, use `error.status`.")); + return statusCode; + }, + }); + this.headers = options.headers || {}; + // redact request credentials without mutating original request options + const requestCopy = Object.assign({}, options.request); + if (options.request.headers.authorization) { + requestCopy.headers = Object.assign({}, options.request.headers, { + authorization: options.request.headers.authorization.replace(/ .*$/, " [REDACTED]"), + }); + } + requestCopy.url = requestCopy.url + // client_id & client_secret can be passed as URL query parameters to increase rate limit + // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications + .replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]") + // OAuth tokens can be passed as URL query parameters, although it is not recommended + // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header + .replace(/\baccess_token=\w+/g, "access_token=[REDACTED]"); + this.request = requestCopy; + } +} + +export { RequestError }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-web/index.js.map b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-web/index.js.map new file mode 100644 index 00000000..130740d7 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/index.js"],"sourcesContent":["import { Deprecation } from \"deprecation\";\nimport once from \"once\";\nconst logOnce = once((deprecation) => console.warn(deprecation));\n/**\n * Error with extra properties to help with debugging\n */\nexport class RequestError extends Error {\n constructor(message, statusCode, options) {\n super(message);\n // Maintains proper stack trace (only available on V8)\n /* istanbul ignore next */\n if (Error.captureStackTrace) {\n Error.captureStackTrace(this, this.constructor);\n }\n this.name = \"HttpError\";\n this.status = statusCode;\n Object.defineProperty(this, \"code\", {\n get() {\n logOnce(new Deprecation(\"[@octokit/request-error] `error.code` is deprecated, use `error.status`.\"));\n return statusCode;\n },\n });\n this.headers = options.headers || {};\n // redact request credentials without mutating original request options\n const requestCopy = Object.assign({}, options.request);\n if (options.request.headers.authorization) {\n requestCopy.headers = Object.assign({}, options.request.headers, {\n authorization: options.request.headers.authorization.replace(/ .*$/, \" [REDACTED]\"),\n });\n }\n requestCopy.url = requestCopy.url\n // client_id & client_secret can be passed as URL query parameters to increase rate limit\n // see https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications\n .replace(/\\bclient_secret=\\w+/g, \"client_secret=[REDACTED]\")\n // OAuth tokens can be passed as URL query parameters, although it is not recommended\n // see https://developer.github.com/v3/#oauth2-token-sent-in-a-header\n .replace(/\\baccess_token=\\w+/g, \"access_token=[REDACTED]\");\n this.request = requestCopy;\n }\n}\n"],"names":[],"mappings":";;;AAEA,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;AACjE;AACA;AACA;AACO,MAAM,YAAY,SAAS,KAAK,CAAC;AACxC,IAAI,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE;AAC9C,QAAQ,KAAK,CAAC,OAAO,CAAC,CAAC;AACvB;AACA;AACA,QAAQ,IAAI,KAAK,CAAC,iBAAiB,EAAE;AACrC,YAAY,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;AAC5D,SAAS;AACT,QAAQ,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;AAChC,QAAQ,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;AACjC,QAAQ,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE;AAC5C,YAAY,GAAG,GAAG;AAClB,gBAAgB,OAAO,CAAC,IAAI,WAAW,CAAC,0EAA0E,CAAC,CAAC,CAAC;AACrH,gBAAgB,OAAO,UAAU,CAAC;AAClC,aAAa;AACb,SAAS,CAAC,CAAC;AACX,QAAQ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;AAC7C;AACA,QAAQ,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AAC/D,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE;AACnD,YAAY,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE;AAC7E,gBAAgB,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC;AACnG,aAAa,CAAC,CAAC;AACf,SAAS;AACT,QAAQ,WAAW,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG;AACzC;AACA;AACA,aAAa,OAAO,CAAC,sBAAsB,EAAE,0BAA0B,CAAC;AACxE;AACA;AACA,aAAa,OAAO,CAAC,qBAAqB,EAAE,yBAAyB,CAAC,CAAC;AACvE,QAAQ,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC;AACnC,KAAK;AACL;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/LICENSE b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/LICENSE new file mode 100644 index 00000000..57bee5f1 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/LICENSE @@ -0,0 +1,7 @@ +MIT License Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/README.md b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/README.md new file mode 100644 index 00000000..74079207 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/README.md @@ -0,0 +1,64 @@ +# types.ts + +> Shared TypeScript definitions for Octokit projects + +[![@latest](https://img.shields.io/npm/v/@octokit/types.svg)](https://www.npmjs.com/package/@octokit/types) +[![Build Status](https://github.com/octokit/types.ts/workflows/Test/badge.svg)](https://github.com/octokit/types.ts/actions?workflow=Test) + + + +- [Usage](#usage) +- [Examples](#examples) + - [Get parameter and response data types for a REST API endpoint](#get-parameter-and-response-data-types-for-a-rest-api-endpoint) + - [Get response types from endpoint methods](#get-response-types-from-endpoint-methods) +- [Contributing](#contributing) +- [License](#license) + + + +## Usage + +See all exported types at https://octokit.github.io/types.ts + +## Examples + +### Get parameter and response data types for a REST API endpoint + +```ts +import { Endpoints } from "./src"; + +type listUserReposParameters = Endpoints["GET /repos/:owner/:repo"]["parameters"]; +type listUserReposResponse = Endpoints["GET /repos/:owner/:repo"]["response"]; + +async function listRepos( + options: listUserReposParameters +): listUserReposResponse["data"] { + // ... +} +``` + +### Get response types from endpoint methods + +```ts +import { + GetResponseTypeFromEndpointMethod, + GetResponseDataTypeFromEndpointMethod, +} from "@octokit/types"; +import { Octokit } from "@octokit/rest"; + +const octokit = new Octokit(); +type CreateLabelResponseType = GetResponseTypeFromEndpointMethod< + typeof octokit.issues.createLabel +>; +type CreateLabelResponseDataType = GetResponseDataTypeFromEndpointMethod< + typeof octokit.issues.createLabel +>; +``` + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-node/index.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-node/index.js new file mode 100644 index 00000000..bc41e1a7 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-node/index.js @@ -0,0 +1,8 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +const VERSION = "4.1.6"; + +exports.VERSION = VERSION; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-node/index.js.map b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-node/index.js.map new file mode 100644 index 00000000..2d148d3b --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/VERSION.js"],"sourcesContent":["export const VERSION = \"0.0.0-development\";\n"],"names":["VERSION"],"mappings":";;;;MAAaA,OAAO,GAAG;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/AuthInterface.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/AuthInterface.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/EndpointDefaults.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/EndpointDefaults.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/EndpointInterface.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/EndpointInterface.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/EndpointOptions.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/EndpointOptions.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/Fetch.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/Fetch.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/OctokitResponse.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/OctokitResponse.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestHeaders.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestHeaders.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestInterface.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestInterface.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestMethod.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestMethod.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestOptions.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestOptions.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestParameters.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestParameters.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestRequestOptions.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/RequestRequestOptions.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/ResponseHeaders.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/ResponseHeaders.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/Route.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/Route.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/Signal.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/Signal.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/StrategyInterface.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/StrategyInterface.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/Url.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/Url.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/VERSION.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/VERSION.js new file mode 100644 index 00000000..5464a548 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/VERSION.js @@ -0,0 +1 @@ +export const VERSION = "4.1.6"; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/generated/Endpoints.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/generated/Endpoints.js new file mode 100644 index 00000000..e69de29b diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/index.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/index.js new file mode 100644 index 00000000..5d2d5ae0 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-src/index.js @@ -0,0 +1,20 @@ +export * from "./AuthInterface"; +export * from "./EndpointDefaults"; +export * from "./EndpointInterface"; +export * from "./EndpointOptions"; +export * from "./Fetch"; +export * from "./OctokitResponse"; +export * from "./RequestHeaders"; +export * from "./RequestInterface"; +export * from "./RequestMethod"; +export * from "./RequestOptions"; +export * from "./RequestParameters"; +export * from "./RequestRequestOptions"; +export * from "./ResponseHeaders"; +export * from "./Route"; +export * from "./Signal"; +export * from "./StrategyInterface"; +export * from "./Url"; +export * from "./VERSION"; +export * from "./GetResponseTypeFromEndpointMethod"; +export * from "./generated/Endpoints"; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/AuthInterface.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/AuthInterface.d.ts new file mode 100644 index 00000000..0c19b50d --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/AuthInterface.d.ts @@ -0,0 +1,31 @@ +import { EndpointOptions } from "./EndpointOptions"; +import { OctokitResponse } from "./OctokitResponse"; +import { RequestInterface } from "./RequestInterface"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; +/** + * Interface to implement complex authentication strategies for Octokit. + * An object Implementing the AuthInterface can directly be passed as the + * `auth` option in the Octokit constructor. + * + * For the official implementations of the most common authentication + * strategies, see https://github.com/octokit/auth.js + */ +export interface AuthInterface { + (...args: AuthOptions): Promise; + hook: { + /** + * Sends a request using the passed `request` instance + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: RequestInterface, options: EndpointOptions): Promise>; + /** + * Sends a request using the passed `request` instance + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: RequestInterface, route: Route, parameters?: RequestParameters): Promise>; + }; +} diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts new file mode 100644 index 00000000..a2c23078 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts @@ -0,0 +1,21 @@ +import { RequestHeaders } from "./RequestHeaders"; +import { RequestMethod } from "./RequestMethod"; +import { RequestParameters } from "./RequestParameters"; +import { Url } from "./Url"; +/** + * The `.endpoint()` method is guaranteed to set all keys defined by RequestParameters + * as well as the method property. + */ +export declare type EndpointDefaults = RequestParameters & { + baseUrl: Url; + method: RequestMethod; + url?: Url; + headers: RequestHeaders & { + accept: string; + "user-agent": string; + }; + mediaType: { + format: string; + previews: string[]; + }; +}; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts new file mode 100644 index 00000000..df585bef --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts @@ -0,0 +1,65 @@ +import { EndpointDefaults } from "./EndpointDefaults"; +import { RequestOptions } from "./RequestOptions"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; +import { Endpoints } from "./generated/Endpoints"; +export interface EndpointInterface { + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {object} endpoint Must set `url` unless it's set defaults. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: O & { + method?: string; + } & ("url" extends keyof D ? { + url?: string; + } : { + url: string; + })): RequestOptions & Pick; + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: keyof Endpoints | R, parameters?: P): (R extends keyof Endpoints ? Endpoints[R]["request"] : RequestOptions) & Pick; + /** + * Object with current default route and parameters + */ + DEFAULTS: D & EndpointDefaults; + /** + * Returns a new `endpoint` interface with new defaults + */ + defaults: (newDefaults: O) => EndpointInterface; + merge: { + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * + */ + (route: keyof Endpoints | R, parameters?: P): D & (R extends keyof Endpoints ? Endpoints[R]["request"] & Endpoints[R]["parameters"] : EndpointDefaults) & P; + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ +

(options: P): EndpointDefaults & D & P; + /** + * Returns current default options. + * + * @deprecated use endpoint.DEFAULTS instead + */ + (): D & EndpointDefaults; + }; + /** + * Stateless method to turn endpoint options into request options. + * Calling `endpoint(options)` is the same as calling `endpoint.parse(endpoint.merge(options))`. + * + * @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + parse: (options: O) => RequestOptions & Pick; +} diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts new file mode 100644 index 00000000..b1b91f11 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts @@ -0,0 +1,7 @@ +import { RequestMethod } from "./RequestMethod"; +import { Url } from "./Url"; +import { RequestParameters } from "./RequestParameters"; +export declare type EndpointOptions = RequestParameters & { + method: RequestMethod; + url: Url; +}; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Fetch.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Fetch.d.ts new file mode 100644 index 00000000..cbbd5e8f --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Fetch.d.ts @@ -0,0 +1,4 @@ +/** + * Browser's fetch method (or compatible such as fetch-mock) + */ +export declare type Fetch = any; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts new file mode 100644 index 00000000..70e1a8d4 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts @@ -0,0 +1,5 @@ +declare type Unwrap = T extends Promise ? U : T; +declare type AnyFunction = (...args: any[]) => any; +export declare type GetResponseTypeFromEndpointMethod = Unwrap>; +export declare type GetResponseDataTypeFromEndpointMethod = Unwrap>["data"]; +export {}; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts new file mode 100644 index 00000000..9a2dd7f6 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts @@ -0,0 +1,17 @@ +import { ResponseHeaders } from "./ResponseHeaders"; +import { Url } from "./Url"; +export declare type OctokitResponse = { + headers: ResponseHeaders; + /** + * http response code + */ + status: number; + /** + * URL of response after all redirects + */ + url: Url; + /** + * This is the data you would see in https://developer.Octokit.com/v3/ + */ + data: T; +}; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts new file mode 100644 index 00000000..ac5aae0a --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts @@ -0,0 +1,15 @@ +export declare type RequestHeaders = { + /** + * Avoid setting `headers.accept`, use `mediaType.{format|previews}` option instead. + */ + accept?: string; + /** + * Use `authorization` to send authenticated request, remember `token ` / `bearer ` prefixes. Example: `token 1234567890abcdef1234567890abcdef12345678` + */ + authorization?: string; + /** + * `user-agent` is set do a default and can be overwritten as needed. + */ + "user-agent"?: string; + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestInterface.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestInterface.d.ts new file mode 100644 index 00000000..ef4d8d3a --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestInterface.d.ts @@ -0,0 +1,34 @@ +import { EndpointInterface } from "./EndpointInterface"; +import { OctokitResponse } from "./OctokitResponse"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; +import { Endpoints } from "./generated/Endpoints"; +export interface RequestInterface { + /** + * Sends a request based on endpoint options + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: O & { + method?: string; + } & ("url" extends keyof D ? { + url?: string; + } : { + url: string; + })): Promise>; + /** + * Sends a request based on endpoint options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/:org'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: keyof Endpoints | R, options?: R extends keyof Endpoints ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters): R extends keyof Endpoints ? Promise : Promise>; + /** + * Returns a new `request` with updated route and parameters + */ + defaults: (newDefaults: O) => RequestInterface; + /** + * Octokit endpoint API, see {@link https://github.com/octokit/endpoint.js|@octokit/endpoint} + */ + endpoint: EndpointInterface; +} diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestMethod.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestMethod.d.ts new file mode 100644 index 00000000..e999c8d9 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestMethod.d.ts @@ -0,0 +1,4 @@ +/** + * HTTP Verb supported by GitHub's REST API + */ +export declare type RequestMethod = "DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT"; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestOptions.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestOptions.d.ts new file mode 100644 index 00000000..97e2181c --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestOptions.d.ts @@ -0,0 +1,14 @@ +import { RequestHeaders } from "./RequestHeaders"; +import { RequestMethod } from "./RequestMethod"; +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { Url } from "./Url"; +/** + * Generic request options as they are returned by the `endpoint()` method + */ +export declare type RequestOptions = { + method: RequestMethod; + url: Url; + headers: RequestHeaders; + body?: any; + request?: RequestRequestOptions; +}; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestParameters.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestParameters.d.ts new file mode 100644 index 00000000..692d193b --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestParameters.d.ts @@ -0,0 +1,45 @@ +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { RequestHeaders } from "./RequestHeaders"; +import { Url } from "./Url"; +/** + * Parameters that can be passed into `request(route, parameters)` or `endpoint(route, parameters)` methods + */ +export declare type RequestParameters = { + /** + * Base URL to be used when a relative URL is passed, such as `/orgs/:org`. + * If `baseUrl` is `https://enterprise.acme-inc.com/api/v3`, then the request + * will be sent to `https://enterprise.acme-inc.com/api/v3/orgs/:org`. + */ + baseUrl?: Url; + /** + * HTTP headers. Use lowercase keys. + */ + headers?: RequestHeaders; + /** + * Media type options, see {@link https://developer.github.com/v3/media/|GitHub Developer Guide} + */ + mediaType?: { + /** + * `json` by default. Can be `raw`, `text`, `html`, `full`, `diff`, `patch`, `sha`, `base64`. Depending on endpoint + */ + format?: string; + /** + * Custom media type names of {@link https://developer.github.com/v3/media/|API Previews} without the `-preview` suffix. + * Example for single preview: `['squirrel-girl']`. + * Example for multiple previews: `['squirrel-girl', 'mister-fantastic']`. + */ + previews?: string[]; + }; + /** + * Pass custom meta information for the request. The `request` object will be returned as is. + */ + request?: RequestRequestOptions; + /** + * Any additional parameter will be passed as follows + * 1. URL parameter if `':parameter'` or `{parameter}` is part of `url` + * 2. Query parameter if `method` is `'GET'` or `'HEAD'` + * 3. Request body if `parameter` is `'data'` + * 4. JSON in the request body in the form of `body[parameter]` unless `parameter` key is `'data'` + */ + [parameter: string]: unknown; +}; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts new file mode 100644 index 00000000..4482a8a4 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts @@ -0,0 +1,26 @@ +/// +import { Agent } from "http"; +import { Fetch } from "./Fetch"; +import { Signal } from "./Signal"; +/** + * Octokit-specific request options which are ignored for the actual request, but can be used by Octokit or plugins to manipulate how the request is sent or how a response is handled + */ +export declare type RequestRequestOptions = { + /** + * Node only. Useful for custom proxy, certificate, or dns lookup. + */ + agent?: Agent; + /** + * Custom replacement for built-in fetch method. Useful for testing or request hooks. + */ + fetch?: Fetch; + /** + * Use an `AbortController` instance to cancel a request. In node you can only cancel streamed requests. + */ + signal?: Signal; + /** + * Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). `options.request.signal` is recommended instead. + */ + timeout?: number; + [option: string]: any; +}; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts new file mode 100644 index 00000000..c8fbe43f --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts @@ -0,0 +1,20 @@ +export declare type ResponseHeaders = { + "cache-control"?: string; + "content-length"?: number; + "content-type"?: string; + date?: string; + etag?: string; + "last-modified"?: string; + link?: string; + location?: string; + server?: string; + status?: string; + vary?: string; + "x-github-mediatype"?: string; + "x-github-request-id"?: string; + "x-oauth-scopes"?: string; + "x-ratelimit-limit"?: string; + "x-ratelimit-remaining"?: string; + "x-ratelimit-reset"?: string; + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Route.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Route.d.ts new file mode 100644 index 00000000..80790444 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Route.d.ts @@ -0,0 +1,4 @@ +/** + * String consisting of an optional HTTP method and relative path or absolute URL. Examples: `'/orgs/:org'`, `'PUT /orgs/:org'`, `GET https://example.com/foo/bar` + */ +export declare type Route = string; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Signal.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Signal.d.ts new file mode 100644 index 00000000..4ebcf24e --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Signal.d.ts @@ -0,0 +1,6 @@ +/** + * Abort signal + * + * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal + */ +export declare type Signal = any; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts new file mode 100644 index 00000000..405cbd23 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts @@ -0,0 +1,4 @@ +import { AuthInterface } from "./AuthInterface"; +export interface StrategyInterface { + (...args: StrategyOptions): AuthInterface; +} diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Url.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Url.d.ts new file mode 100644 index 00000000..acaad633 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/Url.d.ts @@ -0,0 +1,4 @@ +/** + * Relative or absolute URL. Examples: `'/orgs/:org'`, `https://example.com/foo/bar` + */ +export declare type Url = string; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/VERSION.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/VERSION.d.ts new file mode 100644 index 00000000..ef9d17e0 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/VERSION.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "4.1.6"; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts new file mode 100644 index 00000000..3835f2ba --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts @@ -0,0 +1,36972 @@ +import { OctokitResponse } from "../OctokitResponse"; +import { RequestHeaders } from "../RequestHeaders"; +import { RequestRequestOptions } from "../RequestRequestOptions"; +declare type RequiredPreview = { + mediaType: { + previews: [T, ...string[]]; + }; +}; +export interface Endpoints { + /** + * @see https://developer.github.com/v3/apps/#delete-an-installation + */ + "DELETE /app/installations/:installation_id": { + parameters: AppsDeleteInstallationEndpoint; + request: AppsDeleteInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#unsuspend-an-installation + */ + "DELETE /app/installations/:installation_id/suspended": { + parameters: AppsUnsuspendInstallationEndpoint; + request: AppsUnsuspendInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-authorization + */ + "DELETE /applications/:client_id/grant": { + parameters: AppsDeleteAuthorizationEndpoint; + request: AppsDeleteAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application + */ + "DELETE /applications/:client_id/grants/:access_token": { + parameters: AppsRevokeGrantForApplicationEndpoint; + request: AppsRevokeGrantForApplicationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-token + */ + "DELETE /applications/:client_id/token": { + parameters: AppsDeleteTokenEndpoint; + request: AppsDeleteTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application + */ + "DELETE /applications/:client_id/tokens/:access_token": { + parameters: AppsRevokeAuthorizationForApplicationEndpoint; + request: AppsRevokeAuthorizationForApplicationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#delete-a-grant + */ + "DELETE /applications/grants/:grant_id": { + parameters: OauthAuthorizationsDeleteGrantEndpoint; + request: OauthAuthorizationsDeleteGrantRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization + */ + "DELETE /authorizations/:authorization_id": { + parameters: OauthAuthorizationsDeleteAuthorizationEndpoint; + request: OauthAuthorizationsDeleteAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#delete-a-gist + */ + "DELETE /gists/:gist_id": { + parameters: GistsDeleteEndpoint; + request: GistsDeleteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#delete-a-gist-comment + */ + "DELETE /gists/:gist_id/comments/:comment_id": { + parameters: GistsDeleteCommentEndpoint; + request: GistsDeleteCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#unstar-a-gist + */ + "DELETE /gists/:gist_id/star": { + parameters: GistsUnstarEndpoint; + request: GistsUnstarRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#revoke-an-installation-token + */ + "DELETE /installation/token": { + parameters: AppsRevokeInstallationTokenEndpoint; + request: AppsRevokeInstallationTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription + */ + "DELETE /notifications/threads/:thread_id/subscription": { + parameters: ActivityDeleteThreadSubscriptionEndpoint; + request: ActivityDeleteThreadSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#delete-a-self-hosted-runner-from-an-organization + */ + "DELETE /orgs/:org/actions/runners/:runner_id": { + parameters: ActionsDeleteSelfHostedRunnerFromOrgEndpoint; + request: ActionsDeleteSelfHostedRunnerFromOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#delete-an-organization-secret + */ + "DELETE /orgs/:org/actions/secrets/:secret_name": { + parameters: ActionsDeleteOrgSecretEndpoint; + request: ActionsDeleteOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#remove-selected-repository-from-an-organization-secret + */ + "DELETE /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id": { + parameters: ActionsRemoveSelectedRepoFromOrgSecretEndpoint; + request: ActionsRemoveSelectedRepoFromOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/blocking/#unblock-a-user + */ + "DELETE /orgs/:org/blocks/:username": { + parameters: OrgsUnblockUserEndpoint; + request: OrgsUnblockUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#remove-a-credential-authorization-for-an-organization + */ + "DELETE /orgs/:org/credential-authorizations/:credential_id": { + parameters: OrgsRemoveCredentialAuthorizationEndpoint; + request: OrgsRemoveCredentialAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#delete-a-hook + */ + "DELETE /orgs/:org/hooks/:hook_id": { + parameters: OrgsDeleteHookEndpoint; + request: OrgsDeleteHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/orgs/#remove-interaction-restrictions-for-an-organization + */ + "DELETE /orgs/:org/interaction-limits": { + parameters: InteractionsRemoveRestrictionsForOrgEndpoint; + request: InteractionsRemoveRestrictionsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#remove-a-member + */ + "DELETE /orgs/:org/members/:username": { + parameters: OrgsRemoveMemberEndpoint; + request: OrgsRemoveMemberRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#remove-organization-membership + */ + "DELETE /orgs/:org/memberships/:username": { + parameters: OrgsRemoveMembershipEndpoint; + request: OrgsRemoveMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#delete-an-organization-migration-archive + */ + "DELETE /orgs/:org/migrations/:migration_id/archive": { + parameters: MigrationsDeleteArchiveForOrgEndpoint; + request: MigrationsDeleteArchiveForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#unlock-an-organization-repository + */ + "DELETE /orgs/:org/migrations/:migration_id/repos/:repo_name/lock": { + parameters: MigrationsUnlockRepoForOrgEndpoint; + request: MigrationsUnlockRepoForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator + */ + "DELETE /orgs/:org/outside_collaborators/:username": { + parameters: OrgsRemoveOutsideCollaboratorEndpoint; + request: OrgsRemoveOutsideCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#conceal-a-users-membership + */ + "DELETE /orgs/:org/public_members/:username": { + parameters: OrgsConcealMembershipEndpoint; + request: OrgsConcealMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#delete-a-team + */ + "DELETE /orgs/:org/teams/:team_slug": { + parameters: TeamsDeleteInOrgEndpoint; + request: TeamsDeleteInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#delete-a-discussion + */ + "DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number": { + parameters: TeamsDeleteDiscussionInOrgEndpoint; + request: TeamsDeleteDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#delete-a-discussion-comment + */ + "DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsDeleteDiscussionCommentInOrgEndpoint; + request: TeamsDeleteDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-team-discussion-comment-reaction + */ + "DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id": { + parameters: ReactionsDeleteForTeamDiscussionCommentEndpoint; + request: ReactionsDeleteForTeamDiscussionCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-team-discussion-reaction + */ + "DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id": { + parameters: ReactionsDeleteForTeamDiscussionEndpoint; + request: ReactionsDeleteForTeamDiscussionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#remove-team-membership-for-a-user + */ + "DELETE /orgs/:org/teams/:team_slug/memberships/:username": { + parameters: TeamsRemoveMembershipForUserInOrgEndpoint; + request: TeamsRemoveMembershipForUserInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#remove-a-project-from-a-team + */ + "DELETE /orgs/:org/teams/:team_slug/projects/:project_id": { + parameters: TeamsRemoveProjectInOrgEndpoint; + request: TeamsRemoveProjectInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#remove-a-repository-from-a-team + */ + "DELETE /orgs/:org/teams/:team_slug/repos/:owner/:repo": { + parameters: TeamsRemoveRepoInOrgEndpoint; + request: TeamsRemoveRepoInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#delete-a-project + */ + "DELETE /projects/:project_id": { + parameters: ProjectsDeleteEndpoint; + request: ProjectsDeleteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/collaborators/#remove-user-as-a-collaborator + */ + "DELETE /projects/:project_id/collaborators/:username": { + parameters: ProjectsRemoveCollaboratorEndpoint; + request: ProjectsRemoveCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#delete-a-project-column + */ + "DELETE /projects/columns/:column_id": { + parameters: ProjectsDeleteColumnEndpoint; + request: ProjectsDeleteColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#delete-a-project-card + */ + "DELETE /projects/columns/cards/:card_id": { + parameters: ProjectsDeleteCardEndpoint; + request: ProjectsDeleteCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-a-reaction-legacy + */ + "DELETE /reactions/:reaction_id": { + parameters: ReactionsDeleteLegacyEndpoint; + request: ReactionsDeleteLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#delete-a-repository + */ + "DELETE /repos/:owner/:repo": { + parameters: ReposDeleteEndpoint; + request: ReposDeleteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#delete-an-artifact + */ + "DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id": { + parameters: ActionsDeleteArtifactEndpoint; + request: ActionsDeleteArtifactRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#delete-a-self-hosted-runner-from-a-repository + */ + "DELETE /repos/:owner/:repo/actions/runners/:runner_id": { + parameters: ActionsDeleteSelfHostedRunnerFromRepoEndpoint; + request: ActionsDeleteSelfHostedRunnerFromRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#delete-workflow-run-logs + */ + "DELETE /repos/:owner/:repo/actions/runs/:run_id/logs": { + parameters: ActionsDeleteWorkflowRunLogsEndpoint; + request: ActionsDeleteWorkflowRunLogsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#delete-a-repository-secret + */ + "DELETE /repos/:owner/:repo/actions/secrets/:secret_name": { + parameters: ActionsDeleteRepoSecretEndpoint; + request: ActionsDeleteRepoSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#disable-automated-security-fixes + */ + "DELETE /repos/:owner/:repo/automated-security-fixes": { + parameters: ReposDisableAutomatedSecurityFixesEndpoint; + request: ReposDisableAutomatedSecurityFixesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-branch-protection + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection": { + parameters: ReposRemoveBranchProtectionEndpoint; + request: ReposRemoveBranchProtectionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-admin-enforcement-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins": { + parameters: ReposRemoveProtectedBranchAdminEnforcementEndpoint; + request: ReposRemoveProtectedBranchAdminEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": { + parameters: ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint; + request: ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-required-signatures-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures": { + parameters: ReposRemoveProtectedBranchRequiredSignaturesEndpoint; + request: ReposRemoveProtectedBranchRequiredSignaturesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-required-status-checks-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks": { + parameters: ReposRemoveProtectedBranchRequiredStatusChecksEndpoint; + request: ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-required-status-checks-contexts-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": { + parameters: ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint; + request: ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-restrictions-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions": { + parameters: ReposRemoveProtectedBranchRestrictionsEndpoint; + request: ReposRemoveProtectedBranchRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-app-restrictions-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": { + parameters: ReposRemoveProtectedBranchAppRestrictionsEndpoint; + request: ReposRemoveProtectedBranchAppRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-team-restrictions-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": { + parameters: ReposRemoveProtectedBranchTeamRestrictionsEndpoint; + request: ReposRemoveProtectedBranchTeamRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#remove-user-restrictions-of-protected-branch + */ + "DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users": { + parameters: ReposRemoveProtectedBranchUserRestrictionsEndpoint; + request: ReposRemoveProtectedBranchUserRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator + */ + "DELETE /repos/:owner/:repo/collaborators/:username": { + parameters: ReposRemoveCollaboratorEndpoint; + request: ReposRemoveCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#delete-a-commit-comment + */ + "DELETE /repos/:owner/:repo/comments/:comment_id": { + parameters: ReposDeleteCommitCommentEndpoint; + request: ReposDeleteCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-a-commit-comment-reaction + */ + "DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id": { + parameters: ReactionsDeleteForCommitCommentEndpoint; + request: ReactionsDeleteForCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#delete-a-file + */ + "DELETE /repos/:owner/:repo/contents/:path": { + parameters: ReposDeleteFileEndpoint; + request: ReposDeleteFileRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#delete-a-deployment + */ + "DELETE /repos/:owner/:repo/deployments/:deployment_id": { + parameters: ReposDeleteDeploymentEndpoint; + request: ReposDeleteDeploymentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/downloads/#delete-a-download + */ + "DELETE /repos/:owner/:repo/downloads/:download_id": { + parameters: ReposDeleteDownloadEndpoint; + request: ReposDeleteDownloadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#delete-a-reference + */ + "DELETE /repos/:owner/:repo/git/refs/:ref": { + parameters: GitDeleteRefEndpoint; + request: GitDeleteRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#delete-a-hook + */ + "DELETE /repos/:owner/:repo/hooks/:hook_id": { + parameters: ReposDeleteHookEndpoint; + request: ReposDeleteHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#cancel-an-import + */ + "DELETE /repos/:owner/:repo/import": { + parameters: MigrationsCancelImportEndpoint; + request: MigrationsCancelImportRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/repos/#remove-interaction-restrictions-for-a-repository + */ + "DELETE /repos/:owner/:repo/interaction-limits": { + parameters: InteractionsRemoveRestrictionsForRepoEndpoint; + request: InteractionsRemoveRestrictionsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation + */ + "DELETE /repos/:owner/:repo/invitations/:invitation_id": { + parameters: ReposDeleteInvitationEndpoint; + request: ReposDeleteInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/assignees": { + parameters: IssuesRemoveAssigneesEndpoint; + request: IssuesRemoveAssigneesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/labels": { + parameters: IssuesRemoveAllLabelsEndpoint; + request: IssuesRemoveAllLabelsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name": { + parameters: IssuesRemoveLabelEndpoint; + request: IssuesRemoveLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#unlock-an-issue + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/lock": { + parameters: IssuesUnlockEndpoint; + request: IssuesUnlockRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-an-issue-reaction + */ + "DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id": { + parameters: ReactionsDeleteForIssueEndpoint; + request: ReactionsDeleteForIssueRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#delete-an-issue-comment + */ + "DELETE /repos/:owner/:repo/issues/comments/:comment_id": { + parameters: IssuesDeleteCommentEndpoint; + request: IssuesDeleteCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-an-issue-comment-reaction + */ + "DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id": { + parameters: ReactionsDeleteForIssueCommentEndpoint; + request: ReactionsDeleteForIssueCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/keys/#remove-a-deploy-key + */ + "DELETE /repos/:owner/:repo/keys/:key_id": { + parameters: ReposRemoveDeployKeyEndpoint; + request: ReposRemoveDeployKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#delete-a-label + */ + "DELETE /repos/:owner/:repo/labels/:name": { + parameters: IssuesDeleteLabelEndpoint; + request: IssuesDeleteLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#delete-a-milestone + */ + "DELETE /repos/:owner/:repo/milestones/:milestone_number": { + parameters: IssuesDeleteMilestoneEndpoint; + request: IssuesDeleteMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#disable-a-pages-site + */ + "DELETE /repos/:owner/:repo/pages": { + parameters: ReposDisablePagesSiteEndpoint; + request: ReposDisablePagesSiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request + */ + "DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": { + parameters: PullsDeleteReviewRequestEndpoint; + request: PullsDeleteReviewRequestRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review + */ + "DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": { + parameters: PullsDeletePendingReviewEndpoint; + request: PullsDeletePendingReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#delete-a-comment + */ + "DELETE /repos/:owner/:repo/pulls/comments/:comment_id": { + parameters: PullsDeleteCommentEndpoint; + request: PullsDeleteCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#delete-a-pull-request-comment-reaction + */ + "DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id": { + parameters: ReactionsDeleteForPullRequestCommentEndpoint; + request: ReactionsDeleteForPullRequestCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#delete-a-release + */ + "DELETE /repos/:owner/:repo/releases/:release_id": { + parameters: ReposDeleteReleaseEndpoint; + request: ReposDeleteReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#delete-a-release-asset + */ + "DELETE /repos/:owner/:repo/releases/assets/:asset_id": { + parameters: ReposDeleteReleaseAssetEndpoint; + request: ReposDeleteReleaseAssetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription + */ + "DELETE /repos/:owner/:repo/subscription": { + parameters: ActivityDeleteRepoSubscriptionEndpoint; + request: ActivityDeleteRepoSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#disable-vulnerability-alerts + */ + "DELETE /repos/:owner/:repo/vulnerability-alerts": { + parameters: ReposDisableVulnerabilityAlertsEndpoint; + request: ReposDisableVulnerabilityAlertsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#remove-a-user-from-the-organization + */ + "DELETE /scim/v2/organizations/:org/Users/:scim_user_id": { + parameters: ScimRemoveUserFromOrgEndpoint; + request: ScimRemoveUserFromOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#delete-a-team-legacy + */ + "DELETE /teams/:team_id": { + parameters: TeamsDeleteLegacyEndpoint; + request: TeamsDeleteLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy + */ + "DELETE /teams/:team_id/discussions/:discussion_number": { + parameters: TeamsDeleteDiscussionLegacyEndpoint; + request: TeamsDeleteDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#delete-a-discussion-comment-legacy + */ + "DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsDeleteDiscussionCommentLegacyEndpoint; + request: TeamsDeleteDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#remove-team-member-legacy + */ + "DELETE /teams/:team_id/members/:username": { + parameters: TeamsRemoveMemberLegacyEndpoint; + request: TeamsRemoveMemberLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#remove-team-membership-for-a-user-legacy + */ + "DELETE /teams/:team_id/memberships/:username": { + parameters: TeamsRemoveMembershipForUserLegacyEndpoint; + request: TeamsRemoveMembershipForUserLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#remove-a-project-from-a-team-legacy + */ + "DELETE /teams/:team_id/projects/:project_id": { + parameters: TeamsRemoveProjectLegacyEndpoint; + request: TeamsRemoveProjectLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#remove-a-repository-from-a-team-legacy + */ + "DELETE /teams/:team_id/repos/:owner/:repo": { + parameters: TeamsRemoveRepoLegacyEndpoint; + request: TeamsRemoveRepoLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/blocking/#unblock-a-user + */ + "DELETE /user/blocks/:username": { + parameters: UsersUnblockEndpoint; + request: UsersUnblockRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#delete-email-addresses + */ + "DELETE /user/emails": { + parameters: UsersDeleteEmailsEndpoint; + request: UsersDeleteEmailsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#unfollow-a-user + */ + "DELETE /user/following/:username": { + parameters: UsersUnfollowEndpoint; + request: UsersUnfollowRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key + */ + "DELETE /user/gpg_keys/:gpg_key_id": { + parameters: UsersDeleteGpgKeyEndpoint; + request: UsersDeleteGpgKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#remove-repository-from-installation + */ + "DELETE /user/installations/:installation_id/repositories/:repository_id": { + parameters: AppsRemoveRepoFromInstallationEndpoint; + request: AppsRemoveRepoFromInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#delete-a-public-key + */ + "DELETE /user/keys/:key_id": { + parameters: UsersDeletePublicKeyEndpoint; + request: UsersDeletePublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#delete-a-user-migration-archive + */ + "DELETE /user/migrations/:migration_id/archive": { + parameters: MigrationsDeleteArchiveForAuthenticatedUserEndpoint; + request: MigrationsDeleteArchiveForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#unlock-a-user-repository + */ + "DELETE /user/migrations/:migration_id/repos/:repo_name/lock": { + parameters: MigrationsUnlockRepoForAuthenticatedUserEndpoint; + request: MigrationsUnlockRepoForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation + */ + "DELETE /user/repository_invitations/:invitation_id": { + parameters: ReposDeclineInvitationEndpoint; + request: ReposDeclineInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#unstar-a-repository-for-the-authenticated-user + */ + "DELETE /user/starred/:owner/:repo": { + parameters: ActivityUnstarRepoForAuthenticatedUserEndpoint; + request: ActivityUnstarRepoForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-the-authenticated-github-app + */ + "GET /app": { + parameters: AppsGetAuthenticatedEndpoint; + request: AppsGetAuthenticatedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#list-installations + */ + "GET /app/installations": { + parameters: AppsListInstallationsEndpoint; + request: AppsListInstallationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-an-installation + */ + "GET /app/installations/:installation_id": { + parameters: AppsGetInstallationEndpoint; + request: AppsGetInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization + */ + "GET /applications/:client_id/tokens/:access_token": { + parameters: AppsCheckAuthorizationEndpoint; + request: AppsCheckAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#list-your-grants + */ + "GET /applications/grants": { + parameters: OauthAuthorizationsListGrantsEndpoint; + request: OauthAuthorizationsListGrantsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant + */ + "GET /applications/grants/:grant_id": { + parameters: OauthAuthorizationsGetGrantEndpoint; + request: OauthAuthorizationsGetGrantRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-a-single-github-app + */ + "GET /apps/:app_slug": { + parameters: AppsGetBySlugEndpoint; + request: AppsGetBySlugRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations + */ + "GET /authorizations": { + parameters: OauthAuthorizationsListAuthorizationsEndpoint; + request: OauthAuthorizationsListAuthorizationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization + */ + "GET /authorizations/:authorization_id": { + parameters: OauthAuthorizationsGetAuthorizationEndpoint; + request: OauthAuthorizationsGetAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct + */ + "GET /codes_of_conduct": { + parameters: CodesOfConductGetAllCodesOfConductEndpoint; + request: CodesOfConductGetAllCodesOfConductRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct + */ + "GET /codes_of_conduct/:key": { + parameters: CodesOfConductGetConductCodeEndpoint; + request: CodesOfConductGetConductCodeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/emojis/#emojis + */ + "GET /emojis": { + parameters: EmojisGetEndpoint; + request: EmojisGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-events + */ + "GET /events": { + parameters: ActivityListPublicEventsEndpoint; + request: ActivityListPublicEventsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/feeds/#get-feeds + */ + "GET /feeds": { + parameters: ActivityGetFeedsEndpoint; + request: ActivityGetFeedsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-gists-for-the-authenticated-user + */ + "GET /gists": { + parameters: GistsListEndpoint; + request: GistsListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#get-a-gist + */ + "GET /gists/:gist_id": { + parameters: GistsGetEndpoint; + request: GistsGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#get-a-gist-revision + */ + "GET /gists/:gist_id/:sha": { + parameters: GistsGetRevisionEndpoint; + request: GistsGetRevisionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#list-gist-comments + */ + "GET /gists/:gist_id/comments": { + parameters: GistsListCommentsEndpoint; + request: GistsListCommentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#get-a-gist-comment + */ + "GET /gists/:gist_id/comments/:comment_id": { + parameters: GistsGetCommentEndpoint; + request: GistsGetCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-gist-commits + */ + "GET /gists/:gist_id/commits": { + parameters: GistsListCommitsEndpoint; + request: GistsListCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-gist-forks + */ + "GET /gists/:gist_id/forks": { + parameters: GistsListForksEndpoint; + request: GistsListForksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#check-if-a-gist-is-starred + */ + "GET /gists/:gist_id/star": { + parameters: GistsCheckIsStarredEndpoint; + request: GistsCheckIsStarredRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-public-gists + */ + "GET /gists/public": { + parameters: GistsListPublicEndpoint; + request: GistsListPublicRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-starred-gists + */ + "GET /gists/starred": { + parameters: GistsListStarredEndpoint; + request: GistsListStarredRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gitignore/#listing-available-templates + */ + "GET /gitignore/templates": { + parameters: GitignoreListTemplatesEndpoint; + request: GitignoreListTemplatesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gitignore/#get-a-single-template + */ + "GET /gitignore/templates/:name": { + parameters: GitignoreGetTemplateEndpoint; + request: GitignoreGetTemplateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#list-repositories + */ + "GET /installation/repositories": { + parameters: AppsListReposEndpoint; + request: AppsListReposRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#list-issues-assigned-to-the-authenticated-user + */ + "GET /issues": { + parameters: IssuesListEndpoint; + request: IssuesListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/licenses/#list-commonly-used-licenses + */ + "GET /licenses": { + parameters: LicensesListCommonlyUsedEndpoint; + request: LicensesListCommonlyUsedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/licenses/#get-an-individual-license + */ + "GET /licenses/:license": { + parameters: LicensesGetEndpoint; + request: LicensesGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#get-a-subscription-plan-for-an-account + */ + "GET /marketplace_listing/accounts/:account_id": { + parameters: AppsGetSubscriptionPlanForAccountEndpoint; + request: AppsGetSubscriptionPlanForAccountRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-plans + */ + "GET /marketplace_listing/plans": { + parameters: AppsListPlansEndpoint; + request: AppsListPlansRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-accounts-for-a-plan + */ + "GET /marketplace_listing/plans/:plan_id/accounts": { + parameters: AppsListAccountsForPlanEndpoint; + request: AppsListAccountsForPlanRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#get-a-subscription-plan-for-an-account-stubbed + */ + "GET /marketplace_listing/stubbed/accounts/:account_id": { + parameters: AppsGetSubscriptionPlanForAccountStubbedEndpoint; + request: AppsGetSubscriptionPlanForAccountStubbedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-plans-stubbed + */ + "GET /marketplace_listing/stubbed/plans": { + parameters: AppsListPlansStubbedEndpoint; + request: AppsListPlansStubbedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-accounts-for-a-plan-stubbed + */ + "GET /marketplace_listing/stubbed/plans/:plan_id/accounts": { + parameters: AppsListAccountsForPlanStubbedEndpoint; + request: AppsListAccountsForPlanStubbedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/meta/#meta + */ + "GET /meta": { + parameters: MetaGetEndpoint; + request: MetaGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories + */ + "GET /networks/:owner/:repo/events": { + parameters: ActivityListPublicEventsForRepoNetworkEndpoint; + request: ActivityListPublicEventsForRepoNetworkRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#list-notifications-for-the-authenticated-user + */ + "GET /notifications": { + parameters: ActivityListNotificationsForAuthenticatedUserEndpoint; + request: ActivityListNotificationsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#get-a-thread + */ + "GET /notifications/threads/:thread_id": { + parameters: ActivityGetThreadEndpoint; + request: ActivityGetThreadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription-for-the-authenticated-user + */ + "GET /notifications/threads/:thread_id/subscription": { + parameters: ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint; + request: ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-all-organizations + */ + "GET /organizations": { + parameters: OrgsListEndpoint; + request: OrgsListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#get-an-organization + */ + "GET /orgs/:org": { + parameters: OrgsGetEndpoint; + request: OrgsGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#list-self-hosted-runners-for-an-organization + */ + "GET /orgs/:org/actions/runners": { + parameters: ActionsListSelfHostedRunnersForOrgEndpoint; + request: ActionsListSelfHostedRunnersForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#get-a-self-hosted-runner-for-an-organization + */ + "GET /orgs/:org/actions/runners/:runner_id": { + parameters: ActionsGetSelfHostedRunnerForOrgEndpoint; + request: ActionsGetSelfHostedRunnerForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#list-runner-applications-for-an-organization + */ + "GET /orgs/:org/actions/runners/downloads": { + parameters: ActionsListRunnerApplicationsForOrgEndpoint; + request: ActionsListRunnerApplicationsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#list-organization-secrets + */ + "GET /orgs/:org/actions/secrets": { + parameters: ActionsListOrgSecretsEndpoint; + request: ActionsListOrgSecretsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#get-an-organization-secret + */ + "GET /orgs/:org/actions/secrets/:secret_name": { + parameters: ActionsGetOrgSecretEndpoint; + request: ActionsGetOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#list-selected-repositories-for-an-organization-secret + */ + "GET /orgs/:org/actions/secrets/:secret_name/repositories": { + parameters: ActionsListSelectedReposForOrgSecretEndpoint; + request: ActionsListSelectedReposForOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#get-an-organization-public-key + */ + "GET /orgs/:org/actions/secrets/public-key": { + parameters: ActionsGetOrgPublicKeyEndpoint; + request: ActionsGetOrgPublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/blocking/#list-blocked-users + */ + "GET /orgs/:org/blocks": { + parameters: OrgsListBlockedUsersEndpoint; + request: OrgsListBlockedUsersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/blocking/#check-whether-a-user-is-blocked-from-an-organization + */ + "GET /orgs/:org/blocks/:username": { + parameters: OrgsCheckBlockedUserEndpoint; + request: OrgsCheckBlockedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-credential-authorizations-for-an-organization + */ + "GET /orgs/:org/credential-authorizations": { + parameters: OrgsListCredentialAuthorizationsEndpoint; + request: OrgsListCredentialAuthorizationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-organization-events + */ + "GET /orgs/:org/events": { + parameters: ActivityListPublicOrgEventsEndpoint; + request: ActivityListPublicOrgEventsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#list-hooks + */ + "GET /orgs/:org/hooks": { + parameters: OrgsListHooksEndpoint; + request: OrgsListHooksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#get-single-hook + */ + "GET /orgs/:org/hooks/:hook_id": { + parameters: OrgsGetHookEndpoint; + request: OrgsGetHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-an-organization-installation + */ + "GET /orgs/:org/installation": { + parameters: AppsGetOrgInstallationEndpoint; + request: AppsGetOrgInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-installations-for-an-organization + */ + "GET /orgs/:org/installations": { + parameters: OrgsListInstallationsEndpoint; + request: OrgsListInstallationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/orgs/#get-interaction-restrictions-for-an-organization + */ + "GET /orgs/:org/interaction-limits": { + parameters: InteractionsGetRestrictionsForOrgEndpoint; + request: InteractionsGetRestrictionsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#list-pending-organization-invitations + */ + "GET /orgs/:org/invitations": { + parameters: OrgsListPendingInvitationsEndpoint; + request: OrgsListPendingInvitationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#list-organization-invitation-teams + */ + "GET /orgs/:org/invitations/:invitation_id/teams": { + parameters: OrgsListInvitationTeamsEndpoint; + request: OrgsListInvitationTeamsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#list-organization-issues-assigned-to-the-authenticated-user + */ + "GET /orgs/:org/issues": { + parameters: IssuesListForOrgEndpoint; + request: IssuesListForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#members-list + */ + "GET /orgs/:org/members": { + parameters: OrgsListMembersEndpoint; + request: OrgsListMembersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#check-membership + */ + "GET /orgs/:org/members/:username": { + parameters: OrgsCheckMembershipEndpoint; + request: OrgsCheckMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#get-organization-membership + */ + "GET /orgs/:org/memberships/:username": { + parameters: OrgsGetMembershipEndpoint; + request: OrgsGetMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#list-organization-migrations + */ + "GET /orgs/:org/migrations": { + parameters: MigrationsListForOrgEndpoint; + request: MigrationsListForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#get-an-organization-migration-status + */ + "GET /orgs/:org/migrations/:migration_id": { + parameters: MigrationsGetStatusForOrgEndpoint; + request: MigrationsGetStatusForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#download-an-organization-migration-archive + */ + "GET /orgs/:org/migrations/:migration_id/archive": { + parameters: MigrationsDownloadArchiveForOrgEndpoint; + request: MigrationsDownloadArchiveForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#list-repositories-in-an-organization-migration + */ + "GET /orgs/:org/migrations/:migration_id/repositories": { + parameters: MigrationsListReposForOrgEndpoint; + request: MigrationsListReposForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/outside_collaborators/#list-outside-collaborators + */ + "GET /orgs/:org/outside_collaborators": { + parameters: OrgsListOutsideCollaboratorsEndpoint; + request: OrgsListOutsideCollaboratorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#list-organization-projects + */ + "GET /orgs/:org/projects": { + parameters: ProjectsListForOrgEndpoint; + request: ProjectsListForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#public-members-list + */ + "GET /orgs/:org/public_members": { + parameters: OrgsListPublicMembersEndpoint; + request: OrgsListPublicMembersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#check-public-membership + */ + "GET /orgs/:org/public_members/:username": { + parameters: OrgsCheckPublicMembershipEndpoint; + request: OrgsCheckPublicMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-organization-repositories + */ + "GET /orgs/:org/repos": { + parameters: ReposListForOrgEndpoint; + request: ReposListForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#list-idp-groups-for-an-organization + */ + "GET /orgs/:org/team-sync/groups": { + parameters: TeamsListIdPGroupsForOrgEndpoint; + request: TeamsListIdPGroupsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-teams + */ + "GET /orgs/:org/teams": { + parameters: TeamsListEndpoint; + request: TeamsListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#get-a-team-by-name + */ + "GET /orgs/:org/teams/:team_slug": { + parameters: TeamsGetByNameEndpoint; + request: TeamsGetByNameRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#list-discussions + */ + "GET /orgs/:org/teams/:team_slug/discussions": { + parameters: TeamsListDiscussionsInOrgEndpoint; + request: TeamsListDiscussionsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#get-a-discussion + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number": { + parameters: TeamsGetDiscussionInOrgEndpoint; + request: TeamsGetDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#list-discussion-comments + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments": { + parameters: TeamsListDiscussionCommentsInOrgEndpoint; + request: TeamsListDiscussionCommentsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#get-a-discussion-comment + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsGetDiscussionCommentInOrgEndpoint; + request: TeamsGetDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions": { + parameters: ReactionsListForTeamDiscussionCommentInOrgEndpoint; + request: ReactionsListForTeamDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion + */ + "GET /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions": { + parameters: ReactionsListForTeamDiscussionInOrgEndpoint; + request: ReactionsListForTeamDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#list-pending-team-invitations + */ + "GET /orgs/:org/teams/:team_slug/invitations": { + parameters: TeamsListPendingInvitationsInOrgEndpoint; + request: TeamsListPendingInvitationsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#list-team-members + */ + "GET /orgs/:org/teams/:team_slug/members": { + parameters: TeamsListMembersInOrgEndpoint; + request: TeamsListMembersInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#get-team-membership-for-a-user + */ + "GET /orgs/:org/teams/:team_slug/memberships/:username": { + parameters: TeamsGetMembershipForUserInOrgEndpoint; + request: TeamsGetMembershipForUserInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-team-projects + */ + "GET /orgs/:org/teams/:team_slug/projects": { + parameters: TeamsListProjectsInOrgEndpoint; + request: TeamsListProjectsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#check-team-permissions-for-a-project + */ + "GET /orgs/:org/teams/:team_slug/projects/:project_id": { + parameters: TeamsCheckPermissionsForProjectInOrgEndpoint; + request: TeamsCheckPermissionsForProjectInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-team-repositories + */ + "GET /orgs/:org/teams/:team_slug/repos": { + parameters: TeamsListReposInOrgEndpoint; + request: TeamsListReposInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#check-team-permissions-for-a-repository + */ + "GET /orgs/:org/teams/:team_slug/repos/:owner/:repo": { + parameters: TeamsCheckPermissionsForRepoInOrgEndpoint; + request: TeamsCheckPermissionsForRepoInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#list-idp-groups-for-a-team + */ + "GET /orgs/:org/teams/:team_slug/team-sync/group-mappings": { + parameters: TeamsListIdPGroupsInOrgEndpoint; + request: TeamsListIdPGroupsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-child-teams + */ + "GET /orgs/:org/teams/:team_slug/teams": { + parameters: TeamsListChildInOrgEndpoint; + request: TeamsListChildInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#get-a-project + */ + "GET /projects/:project_id": { + parameters: ProjectsGetEndpoint; + request: ProjectsGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/collaborators/#list-collaborators + */ + "GET /projects/:project_id/collaborators": { + parameters: ProjectsListCollaboratorsEndpoint; + request: ProjectsListCollaboratorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/collaborators/#review-a-users-permission-level + */ + "GET /projects/:project_id/collaborators/:username/permission": { + parameters: ProjectsReviewUserPermissionLevelEndpoint; + request: ProjectsReviewUserPermissionLevelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#list-project-columns + */ + "GET /projects/:project_id/columns": { + parameters: ProjectsListColumnsEndpoint; + request: ProjectsListColumnsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#get-a-project-column + */ + "GET /projects/columns/:column_id": { + parameters: ProjectsGetColumnEndpoint; + request: ProjectsGetColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#list-project-cards + */ + "GET /projects/columns/:column_id/cards": { + parameters: ProjectsListCardsEndpoint; + request: ProjectsListCardsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#get-a-project-card + */ + "GET /projects/columns/cards/:card_id": { + parameters: ProjectsGetCardEndpoint; + request: ProjectsGetCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status + */ + "GET /rate_limit": { + parameters: RateLimitGetEndpoint; + request: RateLimitGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#get-a-repository + */ + "GET /repos/:owner/:repo": { + parameters: ReposGetEndpoint; + request: ReposGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#get-archive-link + */ + "GET /repos/:owner/:repo/:archive_format/:ref": { + parameters: ReposGetArchiveLinkEndpoint; + request: ReposGetArchiveLinkRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#list-artifacts-for-a-repository + */ + "GET /repos/:owner/:repo/actions/artifacts": { + parameters: ActionsListArtifactsForRepoEndpoint; + request: ActionsListArtifactsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#get-an-artifact + */ + "GET /repos/:owner/:repo/actions/artifacts/:artifact_id": { + parameters: ActionsGetArtifactEndpoint; + request: ActionsGetArtifactRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#download-an-artifact + */ + "GET /repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format": { + parameters: ActionsDownloadArtifactEndpoint; + request: ActionsDownloadArtifactRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-jobs/#get-a-workflow-job + */ + "GET /repos/:owner/:repo/actions/jobs/:job_id": { + parameters: ActionsGetWorkflowJobEndpoint; + request: ActionsGetWorkflowJobRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-jobs/#download-workflow-job-logs + */ + "GET /repos/:owner/:repo/actions/jobs/:job_id/logs": { + parameters: ActionsDownloadWorkflowJobLogsEndpoint; + request: ActionsDownloadWorkflowJobLogsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#list-self-hosted-runners-for-a-repository + */ + "GET /repos/:owner/:repo/actions/runners": { + parameters: ActionsListSelfHostedRunnersForRepoEndpoint; + request: ActionsListSelfHostedRunnersForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#get-a-self-hosted-runner-for-a-repository + */ + "GET /repos/:owner/:repo/actions/runners/:runner_id": { + parameters: ActionsGetSelfHostedRunnerForRepoEndpoint; + request: ActionsGetSelfHostedRunnerForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#list-runner-applications-for-a-repository + */ + "GET /repos/:owner/:repo/actions/runners/downloads": { + parameters: ActionsListRunnerApplicationsForRepoEndpoint; + request: ActionsListRunnerApplicationsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#list-repository-workflow-runs + */ + "GET /repos/:owner/:repo/actions/runs": { + parameters: ActionsListRepoWorkflowRunsEndpoint; + request: ActionsListRepoWorkflowRunsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#get-a-workflow-run + */ + "GET /repos/:owner/:repo/actions/runs/:run_id": { + parameters: ActionsGetWorkflowRunEndpoint; + request: ActionsGetWorkflowRunRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/artifacts/#list-workflow-run-artifacts + */ + "GET /repos/:owner/:repo/actions/runs/:run_id/artifacts": { + parameters: ActionsListWorkflowRunArtifactsEndpoint; + request: ActionsListWorkflowRunArtifactsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-jobs/#list-jobs-for-a-workflow-run + */ + "GET /repos/:owner/:repo/actions/runs/:run_id/jobs": { + parameters: ActionsListJobsForWorkflowRunEndpoint; + request: ActionsListJobsForWorkflowRunRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#download-workflow-run-logs + */ + "GET /repos/:owner/:repo/actions/runs/:run_id/logs": { + parameters: ActionsDownloadWorkflowRunLogsEndpoint; + request: ActionsDownloadWorkflowRunLogsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#get-workflow-run-usage + */ + "GET /repos/:owner/:repo/actions/runs/:run_id/timing": { + parameters: ActionsGetWorkflowRunUsageEndpoint; + request: ActionsGetWorkflowRunUsageRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#list-repository-secrets + */ + "GET /repos/:owner/:repo/actions/secrets": { + parameters: ActionsListRepoSecretsEndpoint; + request: ActionsListRepoSecretsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#get-a-repository-secret + */ + "GET /repos/:owner/:repo/actions/secrets/:secret_name": { + parameters: ActionsGetRepoSecretEndpoint; + request: ActionsGetRepoSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#get-a-repository-public-key + */ + "GET /repos/:owner/:repo/actions/secrets/public-key": { + parameters: ActionsGetRepoPublicKeyEndpoint; + request: ActionsGetRepoPublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflows/#list-repository-workflows + */ + "GET /repos/:owner/:repo/actions/workflows": { + parameters: ActionsListRepoWorkflowsEndpoint; + request: ActionsListRepoWorkflowsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflows/#get-a-workflow + */ + "GET /repos/:owner/:repo/actions/workflows/:workflow_id": { + parameters: ActionsGetWorkflowEndpoint; + request: ActionsGetWorkflowRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#list-workflow-runs + */ + "GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs": { + parameters: ActionsListWorkflowRunsEndpoint; + request: ActionsListWorkflowRunsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflows/#get-workflow-usage + */ + "GET /repos/:owner/:repo/actions/workflows/:workflow_id/timing": { + parameters: ActionsGetWorkflowUsageEndpoint; + request: ActionsGetWorkflowUsageRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/assignees/#list-assignees + */ + "GET /repos/:owner/:repo/assignees": { + parameters: IssuesListAssigneesEndpoint; + request: IssuesListAssigneesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/assignees/#check-if-a-user-can-be-assigned + */ + "GET /repos/:owner/:repo/assignees/:assignee": { + parameters: IssuesCheckUserCanBeAssignedEndpoint; + request: IssuesCheckUserCanBeAssignedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-branches + */ + "GET /repos/:owner/:repo/branches": { + parameters: ReposListBranchesEndpoint; + request: ReposListBranchesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-branch + */ + "GET /repos/:owner/:repo/branches/:branch": { + parameters: ReposGetBranchEndpoint; + request: ReposGetBranchRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-branch-protection + */ + "GET /repos/:owner/:repo/branches/:branch/protection": { + parameters: ReposGetBranchProtectionEndpoint; + request: ReposGetBranchProtectionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-admin-enforcement-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins": { + parameters: ReposGetProtectedBranchAdminEnforcementEndpoint; + request: ReposGetProtectedBranchAdminEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": { + parameters: ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint; + request: ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-required-signatures-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/required_signatures": { + parameters: ReposGetProtectedBranchRequiredSignaturesEndpoint; + request: ReposGetProtectedBranchRequiredSignaturesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-required-status-checks-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks": { + parameters: ReposGetProtectedBranchRequiredStatusChecksEndpoint; + request: ReposGetProtectedBranchRequiredStatusChecksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": { + parameters: ReposListProtectedBranchRequiredStatusChecksContextsEndpoint; + request: ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#get-restrictions-of-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions": { + parameters: ReposGetProtectedBranchRestrictionsEndpoint; + request: ReposGetProtectedBranchRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-apps-with-access-to-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": { + parameters: ReposGetAppsWithAccessToProtectedBranchEndpoint; + request: ReposGetAppsWithAccessToProtectedBranchRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-teams-with-access-to-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": { + parameters: ReposGetTeamsWithAccessToProtectedBranchEndpoint; + request: ReposGetTeamsWithAccessToProtectedBranchRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#list-users-with-access-to-protected-branch + */ + "GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users": { + parameters: ReposGetUsersWithAccessToProtectedBranchEndpoint; + request: ReposGetUsersWithAccessToProtectedBranchRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#get-a-check-run + */ + "GET /repos/:owner/:repo/check-runs/:check_run_id": { + parameters: ChecksGetEndpoint; + request: ChecksGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#list-check-run-annotations + */ + "GET /repos/:owner/:repo/check-runs/:check_run_id/annotations": { + parameters: ChecksListAnnotationsEndpoint; + request: ChecksListAnnotationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#get-a-check-suite + */ + "GET /repos/:owner/:repo/check-suites/:check_suite_id": { + parameters: ChecksGetSuiteEndpoint; + request: ChecksGetSuiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#list-check-runs-in-a-check-suite + */ + "GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs": { + parameters: ChecksListForSuiteEndpoint; + request: ChecksListForSuiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/code-scanning/#list-code-scanning-alerts-for-a-repository + */ + "GET /repos/:owner/:repo/code-scanning/alerts": { + parameters: CodeScanningListAlertsForRepoEndpoint; + request: CodeScanningListAlertsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/code-scanning/#get-a-code-scanning-alert + */ + "GET /repos/:owner/:repo/code-scanning/alerts/:alert_id": { + parameters: CodeScanningGetAlertEndpoint; + request: CodeScanningGetAlertRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#list-collaborators + */ + "GET /repos/:owner/:repo/collaborators": { + parameters: ReposListCollaboratorsEndpoint; + request: ReposListCollaboratorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator + */ + "GET /repos/:owner/:repo/collaborators/:username": { + parameters: ReposCheckCollaboratorEndpoint; + request: ReposCheckCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level + */ + "GET /repos/:owner/:repo/collaborators/:username/permission": { + parameters: ReposGetCollaboratorPermissionLevelEndpoint; + request: ReposGetCollaboratorPermissionLevelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository + */ + "GET /repos/:owner/:repo/comments": { + parameters: ReposListCommitCommentsEndpoint; + request: ReposListCommitCommentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment + */ + "GET /repos/:owner/:repo/comments/:comment_id": { + parameters: ReposGetCommitCommentEndpoint; + request: ReposGetCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment + */ + "GET /repos/:owner/:repo/comments/:comment_id/reactions": { + parameters: ReactionsListForCommitCommentEndpoint; + request: ReactionsListForCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository + */ + "GET /repos/:owner/:repo/commits": { + parameters: ReposListCommitsEndpoint; + request: ReposListCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#list-branches-for-head-commit + */ + "GET /repos/:owner/:repo/commits/:commit_sha/branches-where-head": { + parameters: ReposListBranchesForHeadCommitEndpoint; + request: ReposListBranchesForHeadCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit + */ + "GET /repos/:owner/:repo/commits/:commit_sha/comments": { + parameters: ReposListCommentsForCommitEndpoint; + request: ReposListCommentsForCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#list-pull-requests-associated-with-commit + */ + "GET /repos/:owner/:repo/commits/:commit_sha/pulls": { + parameters: ReposListPullRequestsAssociatedWithCommitEndpoint; + request: ReposListPullRequestsAssociatedWithCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#get-a-single-commit + */ + "GET /repos/:owner/:repo/commits/:ref": { + parameters: ReposGetCommitEndpoint; + request: ReposGetCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-git-reference + */ + "GET /repos/:owner/:repo/commits/:ref/check-runs": { + parameters: ChecksListForRefEndpoint; + request: ChecksListForRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-git-reference + */ + "GET /repos/:owner/:repo/commits/:ref/check-suites": { + parameters: ChecksListSuitesForRefEndpoint; + request: ChecksListSuitesForRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref + */ + "GET /repos/:owner/:repo/commits/:ref/status": { + parameters: ReposGetCombinedStatusForRefEndpoint; + request: ReposGetCombinedStatusForRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref + */ + "GET /repos/:owner/:repo/commits/:ref/statuses": { + parameters: ReposListStatusesForRefEndpoint; + request: ReposListStatusesForRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct + */ + "GET /repos/:owner/:repo/community/code_of_conduct": { + parameters: CodesOfConductGetForRepoEndpoint; + request: CodesOfConductGetForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics + */ + "GET /repos/:owner/:repo/community/profile": { + parameters: ReposRetrieveCommunityProfileMetricsEndpoint; + request: ReposRetrieveCommunityProfileMetricsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/commits/#compare-two-commits + */ + "GET /repos/:owner/:repo/compare/:base...:head": { + parameters: ReposCompareCommitsEndpoint; + request: ReposCompareCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#get-contents + */ + "GET /repos/:owner/:repo/contents/:path": { + parameters: ReposGetContentsEndpoint; + request: ReposGetContentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-contributors + */ + "GET /repos/:owner/:repo/contributors": { + parameters: ReposListContributorsEndpoint; + request: ReposListContributorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#list-deployments + */ + "GET /repos/:owner/:repo/deployments": { + parameters: ReposListDeploymentsEndpoint; + request: ReposListDeploymentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#get-a-single-deployment + */ + "GET /repos/:owner/:repo/deployments/:deployment_id": { + parameters: ReposGetDeploymentEndpoint; + request: ReposGetDeploymentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#list-deployment-statuses + */ + "GET /repos/:owner/:repo/deployments/:deployment_id/statuses": { + parameters: ReposListDeploymentStatusesEndpoint; + request: ReposListDeploymentStatusesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#get-a-single-deployment-status + */ + "GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id": { + parameters: ReposGetDeploymentStatusEndpoint; + request: ReposGetDeploymentStatusRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository + */ + "GET /repos/:owner/:repo/downloads": { + parameters: ReposListDownloadsEndpoint; + request: ReposListDownloadsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/downloads/#get-a-single-download + */ + "GET /repos/:owner/:repo/downloads/:download_id": { + parameters: ReposGetDownloadEndpoint; + request: ReposGetDownloadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-repository-events + */ + "GET /repos/:owner/:repo/events": { + parameters: ActivityListRepoEventsEndpoint; + request: ActivityListRepoEventsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/forks/#list-forks + */ + "GET /repos/:owner/:repo/forks": { + parameters: ReposListForksEndpoint; + request: ReposListForksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/blobs/#get-a-blob + */ + "GET /repos/:owner/:repo/git/blobs/:file_sha": { + parameters: GitGetBlobEndpoint; + request: GitGetBlobRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/commits/#get-a-commit + */ + "GET /repos/:owner/:repo/git/commits/:commit_sha": { + parameters: GitGetCommitEndpoint; + request: GitGetCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#list-matching-references + */ + "GET /repos/:owner/:repo/git/matching-refs/:ref": { + parameters: GitListMatchingRefsEndpoint; + request: GitListMatchingRefsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#get-a-reference + */ + "GET /repos/:owner/:repo/git/ref/:ref": { + parameters: GitGetRefEndpoint; + request: GitGetRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/tags/#get-a-tag + */ + "GET /repos/:owner/:repo/git/tags/:tag_sha": { + parameters: GitGetTagEndpoint; + request: GitGetTagRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/trees/#get-a-tree + */ + "GET /repos/:owner/:repo/git/trees/:tree_sha": { + parameters: GitGetTreeEndpoint; + request: GitGetTreeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#list-hooks + */ + "GET /repos/:owner/:repo/hooks": { + parameters: ReposListHooksEndpoint; + request: ReposListHooksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#get-single-hook + */ + "GET /repos/:owner/:repo/hooks/:hook_id": { + parameters: ReposGetHookEndpoint; + request: ReposGetHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#get-an-import-status + */ + "GET /repos/:owner/:repo/import": { + parameters: MigrationsGetImportStatusEndpoint; + request: MigrationsGetImportStatusRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#get-commit-authors + */ + "GET /repos/:owner/:repo/import/authors": { + parameters: MigrationsGetCommitAuthorsEndpoint; + request: MigrationsGetCommitAuthorsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#get-large-files + */ + "GET /repos/:owner/:repo/import/large_files": { + parameters: MigrationsGetLargeFilesEndpoint; + request: MigrationsGetLargeFilesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-a-repository-installation + */ + "GET /repos/:owner/:repo/installation": { + parameters: AppsGetRepoInstallationEndpoint; + request: AppsGetRepoInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/repos/#get-interaction-restrictions-for-a-repository + */ + "GET /repos/:owner/:repo/interaction-limits": { + parameters: InteractionsGetRestrictionsForRepoEndpoint; + request: InteractionsGetRestrictionsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository + */ + "GET /repos/:owner/:repo/invitations": { + parameters: ReposListInvitationsEndpoint; + request: ReposListInvitationsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#list-repository-issues + */ + "GET /repos/:owner/:repo/issues": { + parameters: IssuesListForRepoEndpoint; + request: IssuesListForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#get-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number": { + parameters: IssuesGetEndpoint; + request: IssuesGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#list-issue-comments + */ + "GET /repos/:owner/:repo/issues/:issue_number/comments": { + parameters: IssuesListCommentsEndpoint; + request: IssuesListCommentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/events/#list-issue-events + */ + "GET /repos/:owner/:repo/issues/:issue_number/events": { + parameters: IssuesListEventsEndpoint; + request: IssuesListEventsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#list-labels-for-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number/labels": { + parameters: IssuesListLabelsOnIssueEndpoint; + request: IssuesListLabelsOnIssueRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number/reactions": { + parameters: ReactionsListForIssueEndpoint; + request: ReactionsListForIssueRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/timeline/#list-timeline-events-for-an-issue + */ + "GET /repos/:owner/:repo/issues/:issue_number/timeline": { + parameters: IssuesListEventsForTimelineEndpoint; + request: IssuesListEventsForTimelineRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#list-issue-comments-for-a-repository + */ + "GET /repos/:owner/:repo/issues/comments": { + parameters: IssuesListCommentsForRepoEndpoint; + request: IssuesListCommentsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#get-an-issue-comment + */ + "GET /repos/:owner/:repo/issues/comments/:comment_id": { + parameters: IssuesGetCommentEndpoint; + request: IssuesGetCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment + */ + "GET /repos/:owner/:repo/issues/comments/:comment_id/reactions": { + parameters: ReactionsListForIssueCommentEndpoint; + request: ReactionsListForIssueCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/events/#list-issue-events-for-a-repository + */ + "GET /repos/:owner/:repo/issues/events": { + parameters: IssuesListEventsForRepoEndpoint; + request: IssuesListEventsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/events/#get-an-issue-event + */ + "GET /repos/:owner/:repo/issues/events/:event_id": { + parameters: IssuesGetEventEndpoint; + request: IssuesGetEventRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/keys/#list-deploy-keys + */ + "GET /repos/:owner/:repo/keys": { + parameters: ReposListDeployKeysEndpoint; + request: ReposListDeployKeysRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/keys/#get-a-deploy-key + */ + "GET /repos/:owner/:repo/keys/:key_id": { + parameters: ReposGetDeployKeyEndpoint; + request: ReposGetDeployKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#list-labels-for-a-repository + */ + "GET /repos/:owner/:repo/labels": { + parameters: IssuesListLabelsForRepoEndpoint; + request: IssuesListLabelsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#get-a-label + */ + "GET /repos/:owner/:repo/labels/:name": { + parameters: IssuesGetLabelEndpoint; + request: IssuesGetLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-languages + */ + "GET /repos/:owner/:repo/languages": { + parameters: ReposListLanguagesEndpoint; + request: ReposListLanguagesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license + */ + "GET /repos/:owner/:repo/license": { + parameters: LicensesGetForRepoEndpoint; + request: LicensesGetForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#list-milestones + */ + "GET /repos/:owner/:repo/milestones": { + parameters: IssuesListMilestonesEndpoint; + request: IssuesListMilestonesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#get-a-milestone + */ + "GET /repos/:owner/:repo/milestones/:milestone_number": { + parameters: IssuesGetMilestoneEndpoint; + request: IssuesGetMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#list-labels-for-issues-in-a-milestone + */ + "GET /repos/:owner/:repo/milestones/:milestone_number/labels": { + parameters: IssuesListLabelsForMilestoneEndpoint; + request: IssuesListLabelsForMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#list-repository-notifications-for-the-authenticated-user + */ + "GET /repos/:owner/:repo/notifications": { + parameters: ActivityListRepoNotificationsForAuthenticatedUserEndpoint; + request: ActivityListRepoNotificationsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site + */ + "GET /repos/:owner/:repo/pages": { + parameters: ReposGetPagesEndpoint; + request: ReposGetPagesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#list-pages-builds + */ + "GET /repos/:owner/:repo/pages/builds": { + parameters: ReposListPagesBuildsEndpoint; + request: ReposListPagesBuildsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#get-a-specific-pages-build + */ + "GET /repos/:owner/:repo/pages/builds/:build_id": { + parameters: ReposGetPagesBuildEndpoint; + request: ReposGetPagesBuildRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#get-latest-pages-build + */ + "GET /repos/:owner/:repo/pages/builds/latest": { + parameters: ReposGetLatestPagesBuildEndpoint; + request: ReposGetLatestPagesBuildRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#list-repository-projects + */ + "GET /repos/:owner/:repo/projects": { + parameters: ProjectsListForRepoEndpoint; + request: ProjectsListForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#list-pull-requests + */ + "GET /repos/:owner/:repo/pulls": { + parameters: PullsListEndpoint; + request: PullsListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#get-a-single-pull-request + */ + "GET /repos/:owner/:repo/pulls/:pull_number": { + parameters: PullsGetEndpoint; + request: PullsGetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request + */ + "GET /repos/:owner/:repo/pulls/:pull_number/comments": { + parameters: PullsListCommentsEndpoint; + request: PullsListCommentsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request + */ + "GET /repos/:owner/:repo/pulls/:pull_number/commits": { + parameters: PullsListCommitsEndpoint; + request: PullsListCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#list-pull-requests-files + */ + "GET /repos/:owner/:repo/pulls/:pull_number/files": { + parameters: PullsListFilesEndpoint; + request: PullsListFilesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged + */ + "GET /repos/:owner/:repo/pulls/:pull_number/merge": { + parameters: PullsCheckIfMergedEndpoint; + request: PullsCheckIfMergedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/review_requests/#list-review-requests + */ + "GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": { + parameters: PullsListReviewRequestsEndpoint; + request: PullsListReviewRequestsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request + */ + "GET /repos/:owner/:repo/pulls/:pull_number/reviews": { + parameters: PullsListReviewsEndpoint; + request: PullsListReviewsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#get-a-single-review + */ + "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": { + parameters: PullsGetReviewEndpoint; + request: PullsGetReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review + */ + "GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments": { + parameters: PullsGetCommentsForReviewEndpoint; + request: PullsGetCommentsForReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository + */ + "GET /repos/:owner/:repo/pulls/comments": { + parameters: PullsListCommentsForRepoEndpoint; + request: PullsListCommentsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#get-a-single-comment + */ + "GET /repos/:owner/:repo/pulls/comments/:comment_id": { + parameters: PullsGetCommentEndpoint; + request: PullsGetCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment + */ + "GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions": { + parameters: ReactionsListForPullRequestReviewCommentEndpoint; + request: ReactionsListForPullRequestReviewCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#get-the-readme + */ + "GET /repos/:owner/:repo/readme": { + parameters: ReposGetReadmeEndpoint; + request: ReposGetReadmeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository + */ + "GET /repos/:owner/:repo/releases": { + parameters: ReposListReleasesEndpoint; + request: ReposListReleasesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#get-a-single-release + */ + "GET /repos/:owner/:repo/releases/:release_id": { + parameters: ReposGetReleaseEndpoint; + request: ReposGetReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#list-assets-for-a-release + */ + "GET /repos/:owner/:repo/releases/:release_id/assets": { + parameters: ReposListAssetsForReleaseEndpoint; + request: ReposListAssetsForReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#get-a-single-release-asset + */ + "GET /repos/:owner/:repo/releases/assets/:asset_id": { + parameters: ReposGetReleaseAssetEndpoint; + request: ReposGetReleaseAssetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#get-the-latest-release + */ + "GET /repos/:owner/:repo/releases/latest": { + parameters: ReposGetLatestReleaseEndpoint; + request: ReposGetLatestReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name + */ + "GET /repos/:owner/:repo/releases/tags/:tag": { + parameters: ReposGetReleaseByTagEndpoint; + request: ReposGetReleaseByTagRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#list-stargazers + */ + "GET /repos/:owner/:repo/stargazers": { + parameters: ActivityListStargazersForRepoEndpoint; + request: ActivityListStargazersForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week + */ + "GET /repos/:owner/:repo/stats/code_frequency": { + parameters: ReposGetCodeFrequencyStatsEndpoint; + request: ReposGetCodeFrequencyStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data + */ + "GET /repos/:owner/:repo/stats/commit_activity": { + parameters: ReposGetCommitActivityStatsEndpoint; + request: ReposGetCommitActivityStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts + */ + "GET /repos/:owner/:repo/stats/contributors": { + parameters: ReposGetContributorsStatsEndpoint; + request: ReposGetContributorsStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else + */ + "GET /repos/:owner/:repo/stats/participation": { + parameters: ReposGetParticipationStatsEndpoint; + request: ReposGetParticipationStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day + */ + "GET /repos/:owner/:repo/stats/punch_card": { + parameters: ReposGetPunchCardStatsEndpoint; + request: ReposGetPunchCardStatsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#list-watchers + */ + "GET /repos/:owner/:repo/subscribers": { + parameters: ActivityListWatchersForRepoEndpoint; + request: ActivityListWatchersForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#get-a-repository-subscription + */ + "GET /repos/:owner/:repo/subscription": { + parameters: ActivityGetRepoSubscriptionEndpoint; + request: ActivityGetRepoSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-tags + */ + "GET /repos/:owner/:repo/tags": { + parameters: ReposListTagsEndpoint; + request: ReposListTagsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-teams + */ + "GET /repos/:owner/:repo/teams": { + parameters: ReposListTeamsEndpoint; + request: ReposListTeamsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#get-all-repository-topics + */ + "GET /repos/:owner/:repo/topics": { + parameters: ReposGetAllTopicsEndpoint; + request: ReposGetAllTopicsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/traffic/#clones + */ + "GET /repos/:owner/:repo/traffic/clones": { + parameters: ReposGetClonesEndpoint; + request: ReposGetClonesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/traffic/#list-paths + */ + "GET /repos/:owner/:repo/traffic/popular/paths": { + parameters: ReposGetTopPathsEndpoint; + request: ReposGetTopPathsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/traffic/#list-referrers + */ + "GET /repos/:owner/:repo/traffic/popular/referrers": { + parameters: ReposGetTopReferrersEndpoint; + request: ReposGetTopReferrersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/traffic/#views + */ + "GET /repos/:owner/:repo/traffic/views": { + parameters: ReposGetViewsEndpoint; + request: ReposGetViewsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#check-if-vulnerability-alerts-are-enabled-for-a-repository + */ + "GET /repos/:owner/:repo/vulnerability-alerts": { + parameters: ReposCheckVulnerabilityAlertsEndpoint; + request: ReposCheckVulnerabilityAlertsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-public-repositories + */ + "GET /repositories": { + parameters: ReposListPublicEndpoint; + request: ReposListPublicRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#get-a-list-of-provisioned-identities + */ + "GET /scim/v2/organizations/:org/Users": { + parameters: ScimListProvisionedIdentitiesEndpoint; + request: ScimListProvisionedIdentitiesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#get-provisioning-details-for-a-single-user + */ + "GET /scim/v2/organizations/:org/Users/:scim_user_id": { + parameters: ScimGetProvisioningDetailsForUserEndpoint; + request: ScimGetProvisioningDetailsForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-code + */ + "GET /search/code": { + parameters: SearchCodeEndpoint; + request: SearchCodeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-commits + */ + "GET /search/commits": { + parameters: SearchCommitsEndpoint; + request: SearchCommitsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-issues-and-pull-requests + */ + "GET /search/issues": { + parameters: SearchIssuesAndPullRequestsEndpoint; + request: SearchIssuesAndPullRequestsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-labels + */ + "GET /search/labels": { + parameters: SearchLabelsEndpoint; + request: SearchLabelsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-repositories + */ + "GET /search/repositories": { + parameters: SearchReposEndpoint; + request: SearchReposRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-topics + */ + "GET /search/topics": { + parameters: SearchTopicsEndpoint; + request: SearchTopicsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/search/#search-users + */ + "GET /search/users": { + parameters: SearchUsersEndpoint; + request: SearchUsersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#get-a-team-legacy + */ + "GET /teams/:team_id": { + parameters: TeamsGetLegacyEndpoint; + request: TeamsGetLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#list-discussions-legacy + */ + "GET /teams/:team_id/discussions": { + parameters: TeamsListDiscussionsLegacyEndpoint; + request: TeamsListDiscussionsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#get-a-discussion-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number": { + parameters: TeamsGetDiscussionLegacyEndpoint; + request: TeamsGetDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#list-discussion-comments-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number/comments": { + parameters: TeamsListDiscussionCommentsLegacyEndpoint; + request: TeamsListDiscussionCommentsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#get-a-discussion-comment-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsGetDiscussionCommentLegacyEndpoint; + request: TeamsGetDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": { + parameters: ReactionsListForTeamDiscussionCommentLegacyEndpoint; + request: ReactionsListForTeamDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy + */ + "GET /teams/:team_id/discussions/:discussion_number/reactions": { + parameters: ReactionsListForTeamDiscussionLegacyEndpoint; + request: ReactionsListForTeamDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy + */ + "GET /teams/:team_id/invitations": { + parameters: TeamsListPendingInvitationsLegacyEndpoint; + request: TeamsListPendingInvitationsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#list-team-members-legacy + */ + "GET /teams/:team_id/members": { + parameters: TeamsListMembersLegacyEndpoint; + request: TeamsListMembersLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#get-team-member-legacy + */ + "GET /teams/:team_id/members/:username": { + parameters: TeamsGetMemberLegacyEndpoint; + request: TeamsGetMemberLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#get-team-membership-for-a-user-legacy + */ + "GET /teams/:team_id/memberships/:username": { + parameters: TeamsGetMembershipForUserLegacyEndpoint; + request: TeamsGetMembershipForUserLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-team-projects-legacy + */ + "GET /teams/:team_id/projects": { + parameters: TeamsListProjectsLegacyEndpoint; + request: TeamsListProjectsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#check-team-permissions-for-a-project-legacy + */ + "GET /teams/:team_id/projects/:project_id": { + parameters: TeamsCheckPermissionsForProjectLegacyEndpoint; + request: TeamsCheckPermissionsForProjectLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-team-repositories-legacy + */ + "GET /teams/:team_id/repos": { + parameters: TeamsListReposLegacyEndpoint; + request: TeamsListReposLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#check-team-permissions-for-a-repository-legacy + */ + "GET /teams/:team_id/repos/:owner/:repo": { + parameters: TeamsCheckPermissionsForRepoLegacyEndpoint; + request: TeamsCheckPermissionsForRepoLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#list-idp-groups-for-a-team-legacy + */ + "GET /teams/:team_id/team-sync/group-mappings": { + parameters: TeamsListIdPGroupsForLegacyEndpoint; + request: TeamsListIdPGroupsForLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-child-teams-legacy + */ + "GET /teams/:team_id/teams": { + parameters: TeamsListChildLegacyEndpoint; + request: TeamsListChildLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#get-the-authenticated-user + */ + "GET /user": { + parameters: UsersGetAuthenticatedEndpoint; + request: UsersGetAuthenticatedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#list-repositories-for-a-user-migration + */ + "GET /user/:migration_id/repositories": { + parameters: MigrationsListReposForUserEndpoint; + request: MigrationsListReposForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/blocking/#list-blocked-users + */ + "GET /user/blocks": { + parameters: UsersListBlockedEndpoint; + request: UsersListBlockedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/blocking/#check-whether-youve-blocked-a-user + */ + "GET /user/blocks/:username": { + parameters: UsersCheckBlockedEndpoint; + request: UsersCheckBlockedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user + */ + "GET /user/emails": { + parameters: UsersListEmailsEndpoint; + request: UsersListEmailsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#list-followers-of-the-authenticated-user + */ + "GET /user/followers": { + parameters: UsersListFollowersForAuthenticatedUserEndpoint; + request: UsersListFollowersForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#list-users-followed-by-the-authenticated-user + */ + "GET /user/following": { + parameters: UsersListFollowedByAuthenticatedEndpoint; + request: UsersListFollowedByAuthenticatedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user + */ + "GET /user/following/:username": { + parameters: UsersCheckFollowingEndpoint; + request: UsersCheckFollowingRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#list-your-gpg-keys + */ + "GET /user/gpg_keys": { + parameters: UsersListGpgKeysEndpoint; + request: UsersListGpgKeysRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#get-a-single-gpg-key + */ + "GET /user/gpg_keys/:gpg_key_id": { + parameters: UsersGetGpgKeyEndpoint; + request: UsersGetGpgKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#list-installations-for-a-user + */ + "GET /user/installations": { + parameters: AppsListInstallationsForAuthenticatedUserEndpoint; + request: AppsListInstallationsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation + */ + "GET /user/installations/:installation_id/repositories": { + parameters: AppsListInstallationReposForAuthenticatedUserEndpoint; + request: AppsListInstallationReposForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#list-user-account-issues-assigned-to-the-authenticated-user + */ + "GET /user/issues": { + parameters: IssuesListForAuthenticatedUserEndpoint; + request: IssuesListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#list-your-public-keys + */ + "GET /user/keys": { + parameters: UsersListPublicKeysEndpoint; + request: UsersListPublicKeysRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#get-a-single-public-key + */ + "GET /user/keys/:key_id": { + parameters: UsersGetPublicKeyEndpoint; + request: UsersGetPublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-subscriptions-for-the-authenticated-user + */ + "GET /user/marketplace_purchases": { + parameters: AppsListSubscriptionsForAuthenticatedUserEndpoint; + request: AppsListSubscriptionsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/marketplace/#list-subscriptions-for-the-authenticated-user-stubbed + */ + "GET /user/marketplace_purchases/stubbed": { + parameters: AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint; + request: AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#list-your-organization-memberships + */ + "GET /user/memberships/orgs": { + parameters: OrgsListMembershipsEndpoint; + request: OrgsListMembershipsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#get-your-organization-membership + */ + "GET /user/memberships/orgs/:org": { + parameters: OrgsGetMembershipForAuthenticatedUserEndpoint; + request: OrgsGetMembershipForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#list-user-migrations + */ + "GET /user/migrations": { + parameters: MigrationsListForAuthenticatedUserEndpoint; + request: MigrationsListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#get-a-user-migration-status + */ + "GET /user/migrations/:migration_id": { + parameters: MigrationsGetStatusForAuthenticatedUserEndpoint; + request: MigrationsGetStatusForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#download-a-user-migration-archive + */ + "GET /user/migrations/:migration_id/archive": { + parameters: MigrationsGetArchiveForAuthenticatedUserEndpoint; + request: MigrationsGetArchiveForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-your-organizations + */ + "GET /user/orgs": { + parameters: OrgsListForAuthenticatedUserEndpoint; + request: OrgsListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#list-public-email-addresses-for-a-user + */ + "GET /user/public_emails": { + parameters: UsersListPublicEmailsEndpoint; + request: UsersListPublicEmailsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-repositories-for-the-authenticated-user + */ + "GET /user/repos": { + parameters: ReposListForAuthenticatedUserEndpoint; + request: ReposListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations + */ + "GET /user/repository_invitations": { + parameters: ReposListInvitationsForAuthenticatedUserEndpoint; + request: ReposListInvitationsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#list-repositories-starred-by-the-authenticated-user + */ + "GET /user/starred": { + parameters: ActivityListReposStarredByAuthenticatedUserEndpoint; + request: ActivityListReposStarredByAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#check-if-a-repository-is-starred-by-the-authenticated-user + */ + "GET /user/starred/:owner/:repo": { + parameters: ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint; + request: ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#list-repositories-watched-by-the-authenticated-user + */ + "GET /user/subscriptions": { + parameters: ActivityListWatchedReposForAuthenticatedUserEndpoint; + request: ActivityListWatchedReposForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#list-teams-for-the-authenticated-user + */ + "GET /user/teams": { + parameters: TeamsListForAuthenticatedUserEndpoint; + request: TeamsListForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#get-all-users + */ + "GET /users": { + parameters: UsersListEndpoint; + request: UsersListRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#get-a-single-user + */ + "GET /users/:username": { + parameters: UsersGetByUsernameEndpoint; + request: UsersGetByUsernameRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-events-for-the-authenticated-user + */ + "GET /users/:username/events": { + parameters: ActivityListEventsForAuthenticatedUserEndpoint; + request: ActivityListEventsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-organization-events-for-the-authenticated-user + */ + "GET /users/:username/events/orgs/:org": { + parameters: ActivityListOrgEventsForAuthenticatedUserEndpoint; + request: ActivityListOrgEventsForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-events-for-a-user + */ + "GET /users/:username/events/public": { + parameters: ActivityListPublicEventsForUserEndpoint; + request: ActivityListPublicEventsForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#list-followers-of-a-user + */ + "GET /users/:username/followers": { + parameters: UsersListFollowersForUserEndpoint; + request: UsersListFollowersForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user + */ + "GET /users/:username/following": { + parameters: UsersListFollowingForUserEndpoint; + request: UsersListFollowingForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#check-if-one-user-follows-another + */ + "GET /users/:username/following/:target_user": { + parameters: UsersCheckFollowingForUserEndpoint; + request: UsersCheckFollowingForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#list-gists-for-a-user + */ + "GET /users/:username/gists": { + parameters: GistsListForUserEndpoint; + request: GistsListForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#list-gpg-keys-for-a-user + */ + "GET /users/:username/gpg_keys": { + parameters: UsersListGpgKeysForUserEndpoint; + request: UsersListGpgKeysForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#get-contextual-information-about-a-user + */ + "GET /users/:username/hovercard": { + parameters: UsersGetContextForUserEndpoint; + request: UsersGetContextForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#get-a-user-installation + */ + "GET /users/:username/installation": { + parameters: AppsGetUserInstallationEndpoint; + request: AppsGetUserInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user + */ + "GET /users/:username/keys": { + parameters: UsersListPublicKeysForUserEndpoint; + request: UsersListPublicKeysForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#list-user-organizations + */ + "GET /users/:username/orgs": { + parameters: OrgsListForUserEndpoint; + request: OrgsListForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#list-user-projects + */ + "GET /users/:username/projects": { + parameters: ProjectsListForUserEndpoint; + request: ProjectsListForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-events-received-by-the-authenticated-user + */ + "GET /users/:username/received_events": { + parameters: ActivityListReceivedEventsForUserEndpoint; + request: ActivityListReceivedEventsForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/events/#list-public-events-received-by-a-user + */ + "GET /users/:username/received_events/public": { + parameters: ActivityListReceivedPublicEventsForUserEndpoint; + request: ActivityListReceivedPublicEventsForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#list-repositories-for-a-user + */ + "GET /users/:username/repos": { + parameters: ReposListForUserEndpoint; + request: ReposListForUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#list-repositories-starred-by-a-user + */ + "GET /users/:username/starred": { + parameters: ActivityListReposStarredByUserEndpoint; + request: ActivityListReposStarredByUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#list-repositories-watched-by-a-user + */ + "GET /users/:username/subscriptions": { + parameters: ActivityListReposWatchedByUserEndpoint; + request: ActivityListReposWatchedByUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#reset-a-token + */ + "PATCH /applications/:client_id/token": { + parameters: AppsResetTokenEndpoint; + request: AppsResetTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization + */ + "PATCH /authorizations/:authorization_id": { + parameters: OauthAuthorizationsUpdateAuthorizationEndpoint; + request: OauthAuthorizationsUpdateAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#update-a-gist + */ + "PATCH /gists/:gist_id": { + parameters: GistsUpdateEndpoint; + request: GistsUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#update-a-gist-comment + */ + "PATCH /gists/:gist_id/comments/:comment_id": { + parameters: GistsUpdateCommentEndpoint; + request: GistsUpdateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read + */ + "PATCH /notifications/threads/:thread_id": { + parameters: ActivityMarkThreadAsReadEndpoint; + request: ActivityMarkThreadAsReadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/#edit-an-organization + */ + "PATCH /orgs/:org": { + parameters: OrgsUpdateEndpoint; + request: OrgsUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#edit-a-hook + */ + "PATCH /orgs/:org/hooks/:hook_id": { + parameters: OrgsUpdateHookEndpoint; + request: OrgsUpdateHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#update-a-team + */ + "PATCH /orgs/:org/teams/:team_slug": { + parameters: TeamsUpdateInOrgEndpoint; + request: TeamsUpdateInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#update-a-discussion + */ + "PATCH /orgs/:org/teams/:team_slug/discussions/:discussion_number": { + parameters: TeamsUpdateDiscussionInOrgEndpoint; + request: TeamsUpdateDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#update-a-discussion-comment + */ + "PATCH /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsUpdateDiscussionCommentInOrgEndpoint; + request: TeamsUpdateDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#create-or-update-idp-group-connections + */ + "PATCH /orgs/:org/teams/:team_slug/team-sync/group-mappings": { + parameters: TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint; + request: TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#update-a-project + */ + "PATCH /projects/:project_id": { + parameters: ProjectsUpdateEndpoint; + request: ProjectsUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#update-a-project-column + */ + "PATCH /projects/columns/:column_id": { + parameters: ProjectsUpdateColumnEndpoint; + request: ProjectsUpdateColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#update-a-project-card + */ + "PATCH /projects/columns/cards/:card_id": { + parameters: ProjectsUpdateCardEndpoint; + request: ProjectsUpdateCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#update-a-repository + */ + "PATCH /repos/:owner/:repo": { + parameters: ReposUpdateEndpoint; + request: ReposUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch + */ + "PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews": { + parameters: ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint; + request: ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#update-required-status-checks-of-protected-branch + */ + "PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks": { + parameters: ReposUpdateProtectedBranchRequiredStatusChecksEndpoint; + request: ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#update-a-check-run + */ + "PATCH /repos/:owner/:repo/check-runs/:check_run_id": { + parameters: ChecksUpdateEndpoint; + request: ChecksUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#update-repository-preferences-for-check-suites + */ + "PATCH /repos/:owner/:repo/check-suites/preferences": { + parameters: ChecksSetSuitesPreferencesEndpoint; + request: ChecksSetSuitesPreferencesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#update-a-commit-comment + */ + "PATCH /repos/:owner/:repo/comments/:comment_id": { + parameters: ReposUpdateCommitCommentEndpoint; + request: ReposUpdateCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#update-a-reference + */ + "PATCH /repos/:owner/:repo/git/refs/:ref": { + parameters: GitUpdateRefEndpoint; + request: GitUpdateRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#edit-a-hook + */ + "PATCH /repos/:owner/:repo/hooks/:hook_id": { + parameters: ReposUpdateHookEndpoint; + request: ReposUpdateHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#update-an-import + */ + "PATCH /repos/:owner/:repo/import": { + parameters: MigrationsUpdateImportEndpoint; + request: MigrationsUpdateImportRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#map-a-commit-author + */ + "PATCH /repos/:owner/:repo/import/authors/:author_id": { + parameters: MigrationsMapCommitAuthorEndpoint; + request: MigrationsMapCommitAuthorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#update-git-lfs-preference + */ + "PATCH /repos/:owner/:repo/import/lfs": { + parameters: MigrationsSetLfsPreferenceEndpoint; + request: MigrationsSetLfsPreferenceRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation + */ + "PATCH /repos/:owner/:repo/invitations/:invitation_id": { + parameters: ReposUpdateInvitationEndpoint; + request: ReposUpdateInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#update-an-issue + */ + "PATCH /repos/:owner/:repo/issues/:issue_number": { + parameters: IssuesUpdateEndpoint; + request: IssuesUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#update-an-issue-comment + */ + "PATCH /repos/:owner/:repo/issues/comments/:comment_id": { + parameters: IssuesUpdateCommentEndpoint; + request: IssuesUpdateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#update-a-label + */ + "PATCH /repos/:owner/:repo/labels/:name": { + parameters: IssuesUpdateLabelEndpoint; + request: IssuesUpdateLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#update-a-milestone + */ + "PATCH /repos/:owner/:repo/milestones/:milestone_number": { + parameters: IssuesUpdateMilestoneEndpoint; + request: IssuesUpdateMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#update-a-pull-request + */ + "PATCH /repos/:owner/:repo/pulls/:pull_number": { + parameters: PullsUpdateEndpoint; + request: PullsUpdateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#edit-a-comment + */ + "PATCH /repos/:owner/:repo/pulls/comments/:comment_id": { + parameters: PullsUpdateCommentEndpoint; + request: PullsUpdateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#edit-a-release + */ + "PATCH /repos/:owner/:repo/releases/:release_id": { + parameters: ReposUpdateReleaseEndpoint; + request: ReposUpdateReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#edit-a-release-asset + */ + "PATCH /repos/:owner/:repo/releases/assets/:asset_id": { + parameters: ReposUpdateReleaseAssetEndpoint; + request: ReposUpdateReleaseAssetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#update-a-user-attribute + */ + "PATCH /scim/v2/organizations/:org/Users/:scim_user_id": { + parameters: ScimUpdateUserAttributeEndpoint; + request: ScimUpdateUserAttributeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#update-a-team-legacy + */ + "PATCH /teams/:team_id": { + parameters: TeamsUpdateLegacyEndpoint; + request: TeamsUpdateLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#update-a-discussion-legacy + */ + "PATCH /teams/:team_id/discussions/:discussion_number": { + parameters: TeamsUpdateDiscussionLegacyEndpoint; + request: TeamsUpdateDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#update-a-discussion-comment-legacy + */ + "PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number": { + parameters: TeamsUpdateDiscussionCommentLegacyEndpoint; + request: TeamsUpdateDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/team_sync/#create-or-update-idp-group-connections-legacy + */ + "PATCH /teams/:team_id/team-sync/group-mappings": { + parameters: TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint; + request: TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/#update-the-authenticated-user + */ + "PATCH /user": { + parameters: UsersUpdateAuthenticatedEndpoint; + request: UsersUpdateAuthenticatedRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#toggle-primary-email-visibility + */ + "PATCH /user/email/visibility": { + parameters: UsersTogglePrimaryEmailVisibilityEndpoint; + request: UsersTogglePrimaryEmailVisibilityRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#edit-your-organization-membership + */ + "PATCH /user/memberships/orgs/:org": { + parameters: OrgsUpdateMembershipEndpoint; + request: OrgsUpdateMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation + */ + "PATCH /user/repository_invitations/:invitation_id": { + parameters: ReposAcceptInvitationEndpoint; + request: ReposAcceptInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#create-a-github-app-from-a-manifest + */ + "POST /app-manifests/:code/conversions": { + parameters: AppsCreateFromManifestEndpoint; + request: AppsCreateFromManifestRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#create-a-new-installation-token + */ + "POST /app/installations/:installation_id/access_tokens": { + parameters: AppsCreateInstallationTokenEndpoint; + request: AppsCreateInstallationTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#check-a-token + */ + "POST /applications/:client_id/token": { + parameters: AppsCheckTokenEndpoint; + request: AppsCheckTokenRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization + */ + "POST /applications/:client_id/tokens/:access_token": { + parameters: AppsResetAuthorizationEndpoint; + request: AppsResetAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization + */ + "POST /authorizations": { + parameters: OauthAuthorizationsCreateAuthorizationEndpoint; + request: OauthAuthorizationsCreateAuthorizationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#create-a-content-attachment + */ + "POST /content_references/:content_reference_id/attachments": { + parameters: AppsCreateContentAttachmentEndpoint; + request: AppsCreateContentAttachmentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#create-a-gist + */ + "POST /gists": { + parameters: GistsCreateEndpoint; + request: GistsCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/comments/#create-a-gist-comment + */ + "POST /gists/:gist_id/comments": { + parameters: GistsCreateCommentEndpoint; + request: GistsCreateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#fork-a-gist + */ + "POST /gists/:gist_id/forks": { + parameters: GistsForkEndpoint; + request: GistsForkRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document + */ + "POST /markdown": { + parameters: MarkdownRenderEndpoint; + request: MarkdownRenderRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode + */ + "POST /markdown/raw": { + parameters: MarkdownRenderRawEndpoint; + request: MarkdownRenderRawRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#create-a-registration-token-for-an-organization + */ + "POST /orgs/:org/actions/runners/registration-token": { + parameters: ActionsCreateRegistrationTokenForOrgEndpoint; + request: ActionsCreateRegistrationTokenForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#create-a-remove-token-for-an-organization + */ + "POST /orgs/:org/actions/runners/remove-token": { + parameters: ActionsCreateRemoveTokenForOrgEndpoint; + request: ActionsCreateRemoveTokenForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#create-a-hook + */ + "POST /orgs/:org/hooks": { + parameters: OrgsCreateHookEndpoint; + request: OrgsCreateHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/hooks/#ping-a-hook + */ + "POST /orgs/:org/hooks/:hook_id/pings": { + parameters: OrgsPingHookEndpoint; + request: OrgsPingHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#create-organization-invitation + */ + "POST /orgs/:org/invitations": { + parameters: OrgsCreateInvitationEndpoint; + request: OrgsCreateInvitationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/orgs/#start-an-organization-migration + */ + "POST /orgs/:org/migrations": { + parameters: MigrationsStartForOrgEndpoint; + request: MigrationsStartForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#create-an-organization-project + */ + "POST /orgs/:org/projects": { + parameters: ProjectsCreateForOrgEndpoint; + request: ProjectsCreateForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#create-an-organization-repository + */ + "POST /orgs/:org/repos": { + parameters: ReposCreateInOrgEndpoint; + request: ReposCreateInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#create-a-team + */ + "POST /orgs/:org/teams": { + parameters: TeamsCreateEndpoint; + request: TeamsCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#create-a-discussion + */ + "POST /orgs/:org/teams/:team_slug/discussions": { + parameters: TeamsCreateDiscussionInOrgEndpoint; + request: TeamsCreateDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#create-a-discussion-comment + */ + "POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments": { + parameters: TeamsCreateDiscussionCommentInOrgEndpoint; + request: TeamsCreateDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment + */ + "POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions": { + parameters: ReactionsCreateForTeamDiscussionCommentInOrgEndpoint; + request: ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion + */ + "POST /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions": { + parameters: ReactionsCreateForTeamDiscussionInOrgEndpoint; + request: ReactionsCreateForTeamDiscussionInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#create-a-project-column + */ + "POST /projects/:project_id/columns": { + parameters: ProjectsCreateColumnEndpoint; + request: ProjectsCreateColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#create-a-project-card + */ + "POST /projects/columns/:column_id/cards": { + parameters: ProjectsCreateCardEndpoint; + request: ProjectsCreateCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/columns/#move-a-project-column + */ + "POST /projects/columns/:column_id/moves": { + parameters: ProjectsMoveColumnEndpoint; + request: ProjectsMoveColumnRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/cards/#move-a-project-card + */ + "POST /projects/columns/cards/:card_id/moves": { + parameters: ProjectsMoveCardEndpoint; + request: ProjectsMoveCardRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#create-a-registration-token-for-a-repository + */ + "POST /repos/:owner/:repo/actions/runners/registration-token": { + parameters: ActionsCreateRegistrationTokenForRepoEndpoint; + request: ActionsCreateRegistrationTokenForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/self-hosted-runners/#create-a-remove-token-for-a-repository + */ + "POST /repos/:owner/:repo/actions/runners/remove-token": { + parameters: ActionsCreateRemoveTokenForRepoEndpoint; + request: ActionsCreateRemoveTokenForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#cancel-a-workflow-run + */ + "POST /repos/:owner/:repo/actions/runs/:run_id/cancel": { + parameters: ActionsCancelWorkflowRunEndpoint; + request: ActionsCancelWorkflowRunRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/workflow-runs/#re-run-a-workflow + */ + "POST /repos/:owner/:repo/actions/runs/:run_id/rerun": { + parameters: ActionsReRunWorkflowEndpoint; + request: ActionsReRunWorkflowRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-admin-enforcement-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins": { + parameters: ReposAddProtectedBranchAdminEnforcementEndpoint; + request: ReposAddProtectedBranchAdminEnforcementRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-required-signatures-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/required_signatures": { + parameters: ReposAddProtectedBranchRequiredSignaturesEndpoint; + request: ReposAddProtectedBranchRequiredSignaturesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-required-status-checks-contexts-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": { + parameters: ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint; + request: ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-app-restrictions-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": { + parameters: ReposAddProtectedBranchAppRestrictionsEndpoint; + request: ReposAddProtectedBranchAppRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-team-restrictions-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": { + parameters: ReposAddProtectedBranchTeamRestrictionsEndpoint; + request: ReposAddProtectedBranchTeamRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#add-user-restrictions-of-protected-branch + */ + "POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users": { + parameters: ReposAddProtectedBranchUserRestrictionsEndpoint; + request: ReposAddProtectedBranchUserRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/runs/#create-a-check-run + */ + "POST /repos/:owner/:repo/check-runs": { + parameters: ChecksCreateEndpoint; + request: ChecksCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#create-a-check-suite + */ + "POST /repos/:owner/:repo/check-suites": { + parameters: ChecksCreateSuiteEndpoint; + request: ChecksCreateSuiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/checks/suites/#rerequest-a-check-suite + */ + "POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest": { + parameters: ChecksRerequestSuiteEndpoint; + request: ChecksRerequestSuiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment + */ + "POST /repos/:owner/:repo/comments/:comment_id/reactions": { + parameters: ReactionsCreateForCommitCommentEndpoint; + request: ReactionsCreateForCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/comments/#create-a-commit-comment + */ + "POST /repos/:owner/:repo/commits/:commit_sha/comments": { + parameters: ReposCreateCommitCommentEndpoint; + request: ReposCreateCommitCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#create-a-deployment + */ + "POST /repos/:owner/:repo/deployments": { + parameters: ReposCreateDeploymentEndpoint; + request: ReposCreateDeploymentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status + */ + "POST /repos/:owner/:repo/deployments/:deployment_id/statuses": { + parameters: ReposCreateDeploymentStatusEndpoint; + request: ReposCreateDeploymentStatusRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#create-a-repository-dispatch-event + */ + "POST /repos/:owner/:repo/dispatches": { + parameters: ReposCreateDispatchEventEndpoint; + request: ReposCreateDispatchEventRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/forks/#create-a-fork + */ + "POST /repos/:owner/:repo/forks": { + parameters: ReposCreateForkEndpoint; + request: ReposCreateForkRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/blobs/#create-a-blob + */ + "POST /repos/:owner/:repo/git/blobs": { + parameters: GitCreateBlobEndpoint; + request: GitCreateBlobRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/commits/#create-a-commit + */ + "POST /repos/:owner/:repo/git/commits": { + parameters: GitCreateCommitEndpoint; + request: GitCreateCommitRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/refs/#create-a-reference + */ + "POST /repos/:owner/:repo/git/refs": { + parameters: GitCreateRefEndpoint; + request: GitCreateRefRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/tags/#create-a-tag-object + */ + "POST /repos/:owner/:repo/git/tags": { + parameters: GitCreateTagEndpoint; + request: GitCreateTagRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/git/trees/#create-a-tree + */ + "POST /repos/:owner/:repo/git/trees": { + parameters: GitCreateTreeEndpoint; + request: GitCreateTreeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#create-a-hook + */ + "POST /repos/:owner/:repo/hooks": { + parameters: ReposCreateHookEndpoint; + request: ReposCreateHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#ping-a-hook + */ + "POST /repos/:owner/:repo/hooks/:hook_id/pings": { + parameters: ReposPingHookEndpoint; + request: ReposPingHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/hooks/#test-a-push-hook + */ + "POST /repos/:owner/:repo/hooks/:hook_id/tests": { + parameters: ReposTestPushHookEndpoint; + request: ReposTestPushHookRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#create-an-issue + */ + "POST /repos/:owner/:repo/issues": { + parameters: IssuesCreateEndpoint; + request: IssuesCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue + */ + "POST /repos/:owner/:repo/issues/:issue_number/assignees": { + parameters: IssuesAddAssigneesEndpoint; + request: IssuesAddAssigneesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/comments/#create-an-issue-comment + */ + "POST /repos/:owner/:repo/issues/:issue_number/comments": { + parameters: IssuesCreateCommentEndpoint; + request: IssuesCreateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue + */ + "POST /repos/:owner/:repo/issues/:issue_number/labels": { + parameters: IssuesAddLabelsEndpoint; + request: IssuesAddLabelsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-an-issue + */ + "POST /repos/:owner/:repo/issues/:issue_number/reactions": { + parameters: ReactionsCreateForIssueEndpoint; + request: ReactionsCreateForIssueRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment + */ + "POST /repos/:owner/:repo/issues/comments/:comment_id/reactions": { + parameters: ReactionsCreateForIssueCommentEndpoint; + request: ReactionsCreateForIssueCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key + */ + "POST /repos/:owner/:repo/keys": { + parameters: ReposAddDeployKeyEndpoint; + request: ReposAddDeployKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#create-a-label + */ + "POST /repos/:owner/:repo/labels": { + parameters: IssuesCreateLabelEndpoint; + request: IssuesCreateLabelRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/merging/#perform-a-merge + */ + "POST /repos/:owner/:repo/merges": { + parameters: ReposMergeEndpoint; + request: ReposMergeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/milestones/#create-a-milestone + */ + "POST /repos/:owner/:repo/milestones": { + parameters: IssuesCreateMilestoneEndpoint; + request: IssuesCreateMilestoneRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#enable-a-pages-site + */ + "POST /repos/:owner/:repo/pages": { + parameters: ReposEnablePagesSiteEndpoint; + request: ReposEnablePagesSiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#request-a-page-build + */ + "POST /repos/:owner/:repo/pages/builds": { + parameters: ReposRequestPageBuildEndpoint; + request: ReposRequestPageBuildRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#create-a-repository-project + */ + "POST /repos/:owner/:repo/projects": { + parameters: ProjectsCreateForRepoEndpoint; + request: ProjectsCreateForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#create-a-pull-request + */ + "POST /repos/:owner/:repo/pulls": { + parameters: PullsCreateEndpoint; + request: PullsCreateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#create-a-comment + */ + "POST /repos/:owner/:repo/pulls/:pull_number/comments": { + parameters: PullsCreateCommentEndpoint; + request: PullsCreateCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/comments/#create-a-review-comment-reply + */ + "POST /repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies": { + parameters: PullsCreateReviewCommentReplyEndpoint; + request: PullsCreateReviewCommentReplyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/review_requests/#create-a-review-request + */ + "POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers": { + parameters: PullsCreateReviewRequestEndpoint; + request: PullsCreateReviewRequestRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review + */ + "POST /repos/:owner/:repo/pulls/:pull_number/reviews": { + parameters: PullsCreateReviewEndpoint; + request: PullsCreateReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review + */ + "POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events": { + parameters: PullsSubmitReviewEndpoint; + request: PullsSubmitReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment + */ + "POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions": { + parameters: ReactionsCreateForPullRequestReviewCommentEndpoint; + request: ReactionsCreateForPullRequestReviewCommentRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#create-a-release + */ + "POST /repos/:owner/:repo/releases": { + parameters: ReposCreateReleaseEndpoint; + request: ReposCreateReleaseRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/releases/#upload-a-release-asset + */ + "POST /repos/:owner/:repo/releases/:release_id/assets{?name,label}": { + parameters: ReposUploadReleaseAssetEndpoint; + request: ReposUploadReleaseAssetRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/statuses/#create-a-status + */ + "POST /repos/:owner/:repo/statuses/:sha": { + parameters: ReposCreateStatusEndpoint; + request: ReposCreateStatusRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#transfer-a-repository + */ + "POST /repos/:owner/:repo/transfer": { + parameters: ReposTransferEndpoint; + request: ReposTransferRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#create-a-repository-using-a-template + */ + "POST /repos/:template_owner/:template_repo/generate": { + parameters: ReposCreateUsingTemplateEndpoint; + request: ReposCreateUsingTemplateRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#provision-and-invite-users + */ + "POST /scim/v2/organizations/:org/Users": { + parameters: ScimProvisionAndInviteUsersEndpoint; + request: ScimProvisionAndInviteUsersRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy + */ + "POST /teams/:team_id/discussions": { + parameters: TeamsCreateDiscussionLegacyEndpoint; + request: TeamsCreateDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/discussion_comments/#create-a-discussion-comment-legacy + */ + "POST /teams/:team_id/discussions/:discussion_number/comments": { + parameters: TeamsCreateDiscussionCommentLegacyEndpoint; + request: TeamsCreateDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy + */ + "POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions": { + parameters: ReactionsCreateForTeamDiscussionCommentLegacyEndpoint; + request: ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy + */ + "POST /teams/:team_id/discussions/:discussion_number/reactions": { + parameters: ReactionsCreateForTeamDiscussionLegacyEndpoint; + request: ReactionsCreateForTeamDiscussionLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/emails/#add-email-addresses + */ + "POST /user/emails": { + parameters: UsersAddEmailsEndpoint; + request: UsersAddEmailsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key + */ + "POST /user/gpg_keys": { + parameters: UsersCreateGpgKeyEndpoint; + request: UsersCreateGpgKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/keys/#create-a-public-key + */ + "POST /user/keys": { + parameters: UsersCreatePublicKeyEndpoint; + request: UsersCreatePublicKeyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/users/#start-a-user-migration + */ + "POST /user/migrations": { + parameters: MigrationsStartForAuthenticatedUserEndpoint; + request: MigrationsStartForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/#create-a-user-project + */ + "POST /user/projects": { + parameters: ProjectsCreateForAuthenticatedUserEndpoint; + request: ProjectsCreateForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#create-a-repository-for-the-authenticated-user + */ + "POST /user/repos": { + parameters: ReposCreateForAuthenticatedUserEndpoint; + request: ReposCreateForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/#suspend-an-installation + */ + "PUT /app/installations/:installation_id/suspended": { + parameters: AppsSuspendInstallationEndpoint; + request: AppsSuspendInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app + */ + "PUT /authorizations/clients/:client_id": { + parameters: OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint; + request: OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint + */ + "PUT /authorizations/clients/:client_id/:fingerprint": { + parameters: OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint; + request: OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/gists/#star-a-gist + */ + "PUT /gists/:gist_id/star": { + parameters: GistsStarEndpoint; + request: GistsStarRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read + */ + "PUT /notifications": { + parameters: ActivityMarkNotificationsAsReadEndpoint; + request: ActivityMarkNotificationsAsReadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription + */ + "PUT /notifications/threads/:thread_id/subscription": { + parameters: ActivitySetThreadSubscriptionEndpoint; + request: ActivitySetThreadSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#create-or-update-an-organization-secret + */ + "PUT /orgs/:org/actions/secrets/:secret_name": { + parameters: ActionsCreateOrUpdateOrgSecretEndpoint; + request: ActionsCreateOrUpdateOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#set-selected-repositories-for-an-organization-secret + */ + "PUT /orgs/:org/actions/secrets/:secret_name/repositories": { + parameters: ActionsSetSelectedReposForOrgSecretEndpoint; + request: ActionsSetSelectedReposForOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#add-selected-repository-to-an-organization-secret + */ + "PUT /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id": { + parameters: ActionsAddSelectedRepoToOrgSecretEndpoint; + request: ActionsAddSelectedRepoToOrgSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/blocking/#block-a-user + */ + "PUT /orgs/:org/blocks/:username": { + parameters: OrgsBlockUserEndpoint; + request: OrgsBlockUserRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/orgs/#add-or-update-interaction-restrictions-for-an-organization + */ + "PUT /orgs/:org/interaction-limits": { + parameters: InteractionsAddOrUpdateRestrictionsForOrgEndpoint; + request: InteractionsAddOrUpdateRestrictionsForOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership + */ + "PUT /orgs/:org/memberships/:username": { + parameters: OrgsAddOrUpdateMembershipEndpoint; + request: OrgsAddOrUpdateMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator + */ + "PUT /orgs/:org/outside_collaborators/:username": { + parameters: OrgsConvertMemberToOutsideCollaboratorEndpoint; + request: OrgsConvertMemberToOutsideCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/orgs/members/#publicize-a-users-membership + */ + "PUT /orgs/:org/public_members/:username": { + parameters: OrgsPublicizeMembershipEndpoint; + request: OrgsPublicizeMembershipRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-for-a-user + */ + "PUT /orgs/:org/teams/:team_slug/memberships/:username": { + parameters: TeamsAddOrUpdateMembershipForUserInOrgEndpoint; + request: TeamsAddOrUpdateMembershipForUserInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#add-or-update-team-project-permissions + */ + "PUT /orgs/:org/teams/:team_slug/projects/:project_id": { + parameters: TeamsAddOrUpdateProjectPermissionsInOrgEndpoint; + request: TeamsAddOrUpdateProjectPermissionsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#add-or-update-team-repository-permissions + */ + "PUT /orgs/:org/teams/:team_slug/repos/:owner/:repo": { + parameters: TeamsAddOrUpdateRepoPermissionsInOrgEndpoint; + request: TeamsAddOrUpdateRepoPermissionsInOrgRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator + */ + "PUT /projects/:project_id/collaborators/:username": { + parameters: ProjectsAddCollaboratorEndpoint; + request: ProjectsAddCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/actions/secrets/#create-or-update-a-repository-secret + */ + "PUT /repos/:owner/:repo/actions/secrets/:secret_name": { + parameters: ActionsCreateOrUpdateRepoSecretEndpoint; + request: ActionsCreateOrUpdateRepoSecretRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#enable-automated-security-fixes + */ + "PUT /repos/:owner/:repo/automated-security-fixes": { + parameters: ReposEnableAutomatedSecurityFixesEndpoint; + request: ReposEnableAutomatedSecurityFixesRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#update-branch-protection + */ + "PUT /repos/:owner/:repo/branches/:branch/protection": { + parameters: ReposUpdateBranchProtectionEndpoint; + request: ReposUpdateBranchProtectionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#replace-required-status-checks-contexts-of-protected-branch + */ + "PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts": { + parameters: ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint; + request: ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#replace-app-restrictions-of-protected-branch + */ + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps": { + parameters: ReposReplaceProtectedBranchAppRestrictionsEndpoint; + request: ReposReplaceProtectedBranchAppRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#replace-team-restrictions-of-protected-branch + */ + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams": { + parameters: ReposReplaceProtectedBranchTeamRestrictionsEndpoint; + request: ReposReplaceProtectedBranchTeamRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/branches/#replace-user-restrictions-of-protected-branch + */ + "PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users": { + parameters: ReposReplaceProtectedBranchUserRestrictionsEndpoint; + request: ReposReplaceProtectedBranchUserRestrictionsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator + */ + "PUT /repos/:owner/:repo/collaborators/:username": { + parameters: ReposAddCollaboratorEndpoint; + request: ReposAddCollaboratorRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/contents/#create-or-update-a-file + */ + "PUT /repos/:owner/:repo/contents/:path": { + parameters: ReposCreateOrUpdateFileEndpoint; + request: ReposCreateOrUpdateFileRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/migrations/source_imports/#start-an-import + */ + "PUT /repos/:owner/:repo/import": { + parameters: MigrationsStartImportEndpoint; + request: MigrationsStartImportRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/interactions/repos/#add-or-update-interaction-restrictions-for-a-repository + */ + "PUT /repos/:owner/:repo/interaction-limits": { + parameters: InteractionsAddOrUpdateRestrictionsForRepoEndpoint; + request: InteractionsAddOrUpdateRestrictionsForRepoRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/labels/#set-labels-for-an-issue + */ + "PUT /repos/:owner/:repo/issues/:issue_number/labels": { + parameters: IssuesSetLabelsEndpoint; + request: IssuesSetLabelsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/issues/#lock-an-issue + */ + "PUT /repos/:owner/:repo/issues/:issue_number/lock": { + parameters: IssuesLockEndpoint; + request: IssuesLockRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/notifications/#mark-repository-notifications-as-read + */ + "PUT /repos/:owner/:repo/notifications": { + parameters: ActivityMarkRepoNotificationsAsReadEndpoint; + request: ActivityMarkRepoNotificationsAsReadRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/pages/#update-information-about-a-pages-site + */ + "PUT /repos/:owner/:repo/pages": { + parameters: ReposUpdateInformationAboutPagesSiteEndpoint; + request: ReposUpdateInformationAboutPagesSiteRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button + */ + "PUT /repos/:owner/:repo/pulls/:pull_number/merge": { + parameters: PullsMergeEndpoint; + request: PullsMergeRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#update-a-pull-request-review + */ + "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id": { + parameters: PullsUpdateReviewEndpoint; + request: PullsUpdateReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review + */ + "PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals": { + parameters: PullsDismissReviewEndpoint; + request: PullsDismissReviewRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/pulls/#update-a-pull-request-branch + */ + "PUT /repos/:owner/:repo/pulls/:pull_number/update-branch": { + parameters: PullsUpdateBranchEndpoint; + request: PullsUpdateBranchRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/watching/#set-a-repository-subscription + */ + "PUT /repos/:owner/:repo/subscription": { + parameters: ActivitySetRepoSubscriptionEndpoint; + request: ActivitySetRepoSubscriptionRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#replace-all-repository-topics + */ + "PUT /repos/:owner/:repo/topics": { + parameters: ReposReplaceAllTopicsEndpoint; + request: ReposReplaceAllTopicsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/repos/#enable-vulnerability-alerts + */ + "PUT /repos/:owner/:repo/vulnerability-alerts": { + parameters: ReposEnableVulnerabilityAlertsEndpoint; + request: ReposEnableVulnerabilityAlertsRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/scim/#replace-a-provisioned-users-information + */ + "PUT /scim/v2/organizations/:org/Users/:scim_user_id": { + parameters: ScimReplaceProvisionedUserInformationEndpoint; + request: ScimReplaceProvisionedUserInformationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#add-team-member-legacy + */ + "PUT /teams/:team_id/members/:username": { + parameters: TeamsAddMemberLegacyEndpoint; + request: TeamsAddMemberLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-for-a-user-legacy + */ + "PUT /teams/:team_id/memberships/:username": { + parameters: TeamsAddOrUpdateMembershipForUserLegacyEndpoint; + request: TeamsAddOrUpdateMembershipForUserLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#add-or-update-team-project-permissions-legacy + */ + "PUT /teams/:team_id/projects/:project_id": { + parameters: TeamsAddOrUpdateProjectPermissionsLegacyEndpoint; + request: TeamsAddOrUpdateProjectPermissionsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/teams/#add-or-update-team-repository-permissions-legacy + */ + "PUT /teams/:team_id/repos/:owner/:repo": { + parameters: TeamsAddOrUpdateRepoPermissionsLegacyEndpoint; + request: TeamsAddOrUpdateRepoPermissionsLegacyRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/blocking/#block-a-user + */ + "PUT /user/blocks/:username": { + parameters: UsersBlockEndpoint; + request: UsersBlockRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/users/followers/#follow-a-user + */ + "PUT /user/following/:username": { + parameters: UsersFollowEndpoint; + request: UsersFollowRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/apps/installations/#add-repository-to-installation + */ + "PUT /user/installations/:installation_id/repositories/:repository_id": { + parameters: AppsAddRepoToInstallationEndpoint; + request: AppsAddRepoToInstallationRequestOptions; + response: OctokitResponse; + }; + /** + * @see https://developer.github.com/v3/activity/starring/#star-a-repository-for-the-authenticated-user + */ + "PUT /user/starred/:owner/:repo": { + parameters: ActivityStarRepoForAuthenticatedUserEndpoint; + request: ActivityStarRepoForAuthenticatedUserRequestOptions; + response: OctokitResponse; + }; +} +declare type AppsGetAuthenticatedEndpoint = {} & RequiredPreview<"machine-man">; +declare type AppsGetAuthenticatedRequestOptions = { + method: "GET"; + url: "/app"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetAuthenticatedResponseData { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + installations_count: number; +} +declare type AppsCreateFromManifestEndpoint = { + code: string; +}; +declare type AppsCreateFromManifestRequestOptions = { + method: "POST"; + url: "/app-manifests/:code/conversions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsCreateFromManifestResponseData { + id: number; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + client_id: string; + client_secret: string; + webhook_secret: string; + pem: string; +} +declare type AppsListInstallationsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"machine-man">; +declare type AppsListInstallationsRequestOptions = { + method: "GET"; + url: "/app/installations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListInstallationsResponseData = { + id: number; + account: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + checks: string; + metadata: string; + contents: string; + }; + events: string[]; + single_file_name: string; + repository_selection: "all" | "selected"; +}[]; +declare type AppsGetInstallationEndpoint = { + installation_id: number; +} & RequiredPreview<"machine-man">; +declare type AppsGetInstallationRequestOptions = { + method: "GET"; + url: "/app/installations/:installation_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetInstallationResponseData { + id: number; + account: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + checks: string; + metadata: string; + contents: string; + }; + events: string[]; + single_file_name: string; + repository_selection: "all" | "selected"; +} +declare type AppsDeleteInstallationEndpoint = { + installation_id: number; +} & RequiredPreview<"machine-man">; +declare type AppsDeleteInstallationRequestOptions = { + method: "DELETE"; + url: "/app/installations/:installation_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsCreateInstallationTokenEndpoint = { + installation_id: number; + /** + * The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the "[List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token. + */ + repository_ids?: number[]; + /** + * The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see "[GitHub App permissions](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions)." + */ + permissions?: AppsCreateInstallationTokenParamsPermissions; +} & RequiredPreview<"machine-man">; +declare type AppsCreateInstallationTokenRequestOptions = { + method: "POST"; + url: "/app/installations/:installation_id/access_tokens"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsCreateInstallationTokenResponseData { + token: string; + expires_at: string; + permissions: { + issues: string; + contents: string; + }; + repository_selection: "all" | "selected"; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; +} +declare type AppsSuspendInstallationEndpoint = { + installation_id: number; +}; +declare type AppsSuspendInstallationRequestOptions = { + method: "PUT"; + url: "/app/installations/:installation_id/suspended"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsUnsuspendInstallationEndpoint = { + installation_id: number; +}; +declare type AppsUnsuspendInstallationRequestOptions = { + method: "DELETE"; + url: "/app/installations/:installation_id/suspended"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OauthAuthorizationsListGrantsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OauthAuthorizationsListGrantsRequestOptions = { + method: "GET"; + url: "/applications/grants"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OauthAuthorizationsListGrantsResponseData = { + id: number; + url: string; + app: { + url: string; + name: string; + client_id: string; + }; + created_at: string; + updated_at: string; + scopes: string[]; +}[]; +declare type OauthAuthorizationsGetGrantEndpoint = { + grant_id: number; +}; +declare type OauthAuthorizationsGetGrantRequestOptions = { + method: "GET"; + url: "/applications/grants/:grant_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OauthAuthorizationsGetGrantResponseData { + id: number; + url: string; + app: { + url: string; + name: string; + client_id: string; + }; + created_at: string; + updated_at: string; + scopes: string[]; +} +declare type OauthAuthorizationsDeleteGrantEndpoint = { + grant_id: number; +}; +declare type OauthAuthorizationsDeleteGrantRequestOptions = { + method: "DELETE"; + url: "/applications/grants/:grant_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsDeleteAuthorizationEndpoint = { + client_id: string; + /** + * The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; +}; +declare type AppsDeleteAuthorizationRequestOptions = { + method: "DELETE"; + url: "/applications/:client_id/grant"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsRevokeGrantForApplicationEndpoint = { + client_id: string; + access_token: string; +}; +declare type AppsRevokeGrantForApplicationRequestOptions = { + method: "DELETE"; + url: "/applications/:client_id/grants/:access_token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsCheckTokenEndpoint = { + client_id: string; + /** + * The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; +}; +declare type AppsCheckTokenRequestOptions = { + method: "POST"; + url: "/applications/:client_id/token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsCheckTokenResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type AppsResetTokenEndpoint = { + client_id: string; + /** + * The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; +}; +declare type AppsResetTokenRequestOptions = { + method: "PATCH"; + url: "/applications/:client_id/token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsResetTokenResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type AppsDeleteTokenEndpoint = { + client_id: string; + /** + * The OAuth access token used to authenticate to the GitHub API. + */ + access_token?: string; +}; +declare type AppsDeleteTokenRequestOptions = { + method: "DELETE"; + url: "/applications/:client_id/token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsCheckAuthorizationEndpoint = { + client_id: string; + access_token: string; +}; +declare type AppsCheckAuthorizationRequestOptions = { + method: "GET"; + url: "/applications/:client_id/tokens/:access_token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsCheckAuthorizationResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type AppsResetAuthorizationEndpoint = { + client_id: string; + access_token: string; +}; +declare type AppsResetAuthorizationRequestOptions = { + method: "POST"; + url: "/applications/:client_id/tokens/:access_token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsResetAuthorizationResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type AppsRevokeAuthorizationForApplicationEndpoint = { + client_id: string; + access_token: string; +}; +declare type AppsRevokeAuthorizationForApplicationRequestOptions = { + method: "DELETE"; + url: "/applications/:client_id/tokens/:access_token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsGetBySlugEndpoint = { + app_slug: string; +} & RequiredPreview<"machine-man">; +declare type AppsGetBySlugRequestOptions = { + method: "GET"; + url: "/apps/:app_slug"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetBySlugResponseData { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; +} +declare type OauthAuthorizationsListAuthorizationsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OauthAuthorizationsListAuthorizationsRequestOptions = { + method: "GET"; + url: "/authorizations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OauthAuthorizationsListAuthorizationsResponseData = { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +}[]; +declare type OauthAuthorizationsCreateAuthorizationEndpoint = { + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. + */ + note: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * The 20 character OAuth app client key for which to create the token. + */ + client_id?: string; + /** + * The 40 character OAuth app client secret for which to create the token. + */ + client_secret?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; +}; +declare type OauthAuthorizationsCreateAuthorizationRequestOptions = { + method: "POST"; + url: "/authorizations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OauthAuthorizationsCreateAuthorizationResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +declare type OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint = { + client_id: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint). + */ + fingerprint?: string; +}; +declare type OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions = { + method: "PUT"; + url: "/authorizations/clients/:client_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OauthAuthorizationsGetOrCreateAuthorizationForAppResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +export interface OauthAuthorizationsGetOrCreateAuthorizationForAppResponse201Data { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +declare type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint = { + client_id: string; + fingerprint: string; + /** + * The 40 character OAuth app client secret associated with the client ID specified in the URL. + */ + client_secret: string; + /** + * A list of scopes that this authorization is in. + */ + scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; +}; +declare type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions = { + method: "PUT"; + url: "/authorizations/clients/:client_id/:fingerprint"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +export interface OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse201Data { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +declare type OauthAuthorizationsGetAuthorizationEndpoint = { + authorization_id: number; +}; +declare type OauthAuthorizationsGetAuthorizationRequestOptions = { + method: "GET"; + url: "/authorizations/:authorization_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OauthAuthorizationsGetAuthorizationResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +declare type OauthAuthorizationsUpdateAuthorizationEndpoint = { + authorization_id: number; + /** + * Replaces the authorization scopes with these. + */ + scopes?: string[]; + /** + * A list of scopes to add to this authorization. + */ + add_scopes?: string[]; + /** + * A list of scopes to remove from this authorization. + */ + remove_scopes?: string[]; + /** + * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. + */ + note?: string; + /** + * A URL to remind you what app the OAuth token is for. + */ + note_url?: string; + /** + * A unique string to distinguish an authorization from others created for the same client ID and user. + */ + fingerprint?: string; +}; +declare type OauthAuthorizationsUpdateAuthorizationRequestOptions = { + method: "PATCH"; + url: "/authorizations/:authorization_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OauthAuthorizationsUpdateAuthorizationResponseData { + id: number; + url: string; + scopes: string[]; + token: string; + token_last_eight: string; + hashed_token: string; + app: { + url: string; + name: string; + client_id: string; + }; + note: string; + note_url: string; + updated_at: string; + created_at: string; + fingerprint: string; +} +declare type OauthAuthorizationsDeleteAuthorizationEndpoint = { + authorization_id: number; +}; +declare type OauthAuthorizationsDeleteAuthorizationRequestOptions = { + method: "DELETE"; + url: "/authorizations/:authorization_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type CodesOfConductGetAllCodesOfConductEndpoint = {} & RequiredPreview<"scarlet-witch">; +declare type CodesOfConductGetAllCodesOfConductRequestOptions = { + method: "GET"; + url: "/codes_of_conduct"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type CodesOfConductGetAllCodesOfConductResponseData = { + key: string; + name: string; + url: string; +}[]; +declare type CodesOfConductGetConductCodeEndpoint = { + key: string; +} & RequiredPreview<"scarlet-witch">; +declare type CodesOfConductGetConductCodeRequestOptions = { + method: "GET"; + url: "/codes_of_conduct/:key"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface CodesOfConductGetConductCodeResponseData { + key: string; + name: string; + url: string; + body: string; +} +declare type AppsCreateContentAttachmentEndpoint = { + content_reference_id: number; + /** + * The title of the content attachment displayed in the body or comment of an issue or pull request. + */ + title: string; + /** + * The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown. + */ + body: string; +} & RequiredPreview<"corsair">; +declare type AppsCreateContentAttachmentRequestOptions = { + method: "POST"; + url: "/content_references/:content_reference_id/attachments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsCreateContentAttachmentResponseData { + id: number; + title: string; + body: string; +} +declare type EmojisGetEndpoint = {}; +declare type EmojisGetRequestOptions = { + method: "GET"; + url: "/emojis"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListPublicEventsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListPublicEventsRequestOptions = { + method: "GET"; + url: "/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityGetFeedsEndpoint = {}; +declare type ActivityGetFeedsRequestOptions = { + method: "GET"; + url: "/feeds"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActivityGetFeedsResponseData { + timeline_url: string; + user_url: string; + current_user_public_url: string; + current_user_url: string; + current_user_actor_url: string; + current_user_organization_url: string; + current_user_organization_urls: string[]; + security_advisories_url: string; + _links: { + timeline: { + href: string; + type: string; + }; + user: { + href: string; + type: string; + }; + current_user_public: { + href: string; + type: string; + }; + current_user: { + href: string; + type: string; + }; + current_user_actor: { + href: string; + type: string; + }; + current_user_organization: { + href: string; + type: string; + }; + current_user_organizations: { + href: string; + type: string; + }[]; + security_advisories: { + href: string; + type: string; + }; + }; +} +declare type GistsListEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListRequestOptions = { + method: "GET"; + url: "/gists"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; +}[]; +declare type GistsCreateEndpoint = { + /** + * The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`. + */ + files: GistsCreateParamsFiles; + /** + * A descriptive name for this gist. + */ + description?: string; + /** + * When `true`, the gist will be public and available for anyone to see. + */ + public?: boolean; +}; +declare type GistsCreateRequestOptions = { + method: "POST"; + url: "/gists"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsCreateResponseData { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; + forks: { + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + url: string; + id: string; + created_at: string; + updated_at: string; + }[]; + history: { + url: string; + version: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + change_status: { + deletions: number; + additions: number; + total: number; + }; + committed_at: string; + }[]; +} +declare type GistsListPublicEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListPublicRequestOptions = { + method: "GET"; + url: "/gists/public"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListPublicResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; +}[]; +declare type GistsListStarredEndpoint = { + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListStarredRequestOptions = { + method: "GET"; + url: "/gists/starred"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListStarredResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; +}[]; +declare type GistsGetEndpoint = { + gist_id: string; +}; +declare type GistsGetRequestOptions = { + method: "GET"; + url: "/gists/:gist_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsGetResponseData { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; + forks: { + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + url: string; + id: string; + created_at: string; + updated_at: string; + }[]; + history: { + url: string; + version: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + change_status: { + deletions: number; + additions: number; + total: number; + }; + committed_at: string; + }[]; +} +declare type GistsUpdateEndpoint = { + gist_id: string; + /** + * A descriptive name for this gist. + */ + description?: string; + /** + * The filenames and content that make up this gist. + */ + files?: GistsUpdateParamsFiles; +}; +declare type GistsUpdateRequestOptions = { + method: "PATCH"; + url: "/gists/:gist_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsUpdateResponseData { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; + forks: { + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + url: string; + id: string; + created_at: string; + updated_at: string; + }[]; + history: { + url: string; + version: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + change_status: { + deletions: number; + additions: number; + total: number; + }; + committed_at: string; + }[]; +} +declare type GistsDeleteEndpoint = { + gist_id: string; +}; +declare type GistsDeleteRequestOptions = { + method: "DELETE"; + url: "/gists/:gist_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GistsListCommentsEndpoint = { + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListCommentsRequestOptions = { + method: "GET"; + url: "/gists/:gist_id/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListCommentsResponseData = { + id: number; + node_id: string; + url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type GistsCreateCommentEndpoint = { + gist_id: string; + /** + * The comment text. + */ + body: string; +}; +declare type GistsCreateCommentRequestOptions = { + method: "POST"; + url: "/gists/:gist_id/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsCreateCommentResponseData { + id: number; + node_id: string; + url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type GistsGetCommentEndpoint = { + gist_id: string; + comment_id: number; +}; +declare type GistsGetCommentRequestOptions = { + method: "GET"; + url: "/gists/:gist_id/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsGetCommentResponseData { + id: number; + node_id: string; + url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type GistsUpdateCommentEndpoint = { + gist_id: string; + comment_id: number; + /** + * The comment text. + */ + body: string; +}; +declare type GistsUpdateCommentRequestOptions = { + method: "PATCH"; + url: "/gists/:gist_id/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsUpdateCommentResponseData { + id: number; + node_id: string; + url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type GistsDeleteCommentEndpoint = { + gist_id: string; + comment_id: number; +}; +declare type GistsDeleteCommentRequestOptions = { + method: "DELETE"; + url: "/gists/:gist_id/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GistsListCommitsEndpoint = { + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListCommitsRequestOptions = { + method: "GET"; + url: "/gists/:gist_id/commits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListCommitsResponseData = { + url: string; + version: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + change_status: { + deletions: number; + additions: number; + total: number; + }; + committed_at: string; +}[]; +declare type GistsForkEndpoint = { + gist_id: string; +}; +declare type GistsForkRequestOptions = { + method: "POST"; + url: "/gists/:gist_id/forks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsForkResponseData { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; +} +declare type GistsListForksEndpoint = { + gist_id: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListForksRequestOptions = { + method: "GET"; + url: "/gists/:gist_id/forks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListForksResponseData = { + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + url: string; + id: string; + created_at: string; + updated_at: string; +}[]; +declare type GistsStarEndpoint = { + gist_id: string; +}; +declare type GistsStarRequestOptions = { + method: "PUT"; + url: "/gists/:gist_id/star"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GistsUnstarEndpoint = { + gist_id: string; +}; +declare type GistsUnstarRequestOptions = { + method: "DELETE"; + url: "/gists/:gist_id/star"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GistsCheckIsStarredEndpoint = { + gist_id: string; +}; +declare type GistsCheckIsStarredRequestOptions = { + method: "GET"; + url: "/gists/:gist_id/star"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GistsGetRevisionEndpoint = { + gist_id: string; + sha: string; +}; +declare type GistsGetRevisionRequestOptions = { + method: "GET"; + url: "/gists/:gist_id/:sha"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GistsGetRevisionResponseData { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; + forks: { + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + url: string; + id: string; + created_at: string; + updated_at: string; + }[]; + history: { + url: string; + version: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + change_status: { + deletions: number; + additions: number; + total: number; + }; + committed_at: string; + }[]; +} +declare type GitignoreListTemplatesEndpoint = {}; +declare type GitignoreListTemplatesRequestOptions = { + method: "GET"; + url: "/gitignore/templates"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GitignoreListTemplatesResponseData = string[]; +declare type GitignoreGetTemplateEndpoint = { + name: string; +}; +declare type GitignoreGetTemplateRequestOptions = { + method: "GET"; + url: "/gitignore/templates/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitignoreGetTemplateResponseData { + name: string; + source: string; +} +declare type AppsListReposEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"machine-man">; +declare type AppsListReposRequestOptions = { + method: "GET"; + url: "/installation/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsListReposResponseData { + total_count: number; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; +} +declare type AppsRevokeInstallationTokenEndpoint = {}; +declare type AppsRevokeInstallationTokenRequestOptions = { + method: "DELETE"; + url: "/installation/token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesListEndpoint = { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListRequestOptions = { + method: "GET"; + url: "/issues"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +}[]; +declare type LicensesListCommonlyUsedEndpoint = {}; +declare type LicensesListCommonlyUsedRequestOptions = { + method: "GET"; + url: "/licenses"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type LicensesListCommonlyUsedResponseData = { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; +}[]; +declare type LicensesGetEndpoint = { + license: string; +}; +declare type LicensesGetRequestOptions = { + method: "GET"; + url: "/licenses/:license"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface LicensesGetResponseData { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + html_url: string; + description: string; + implementation: string; + permissions: string[]; + conditions: string[]; + limitations: string[]; + body: string; + featured: boolean; +} +declare type MarkdownRenderEndpoint = { + /** + * The Markdown text to render in HTML. Markdown content must be 400 KB or less. + */ + text: string; + /** + * The rendering mode. Can be either: + * \* `markdown` to render a document in plain Markdown, just like README.md files are rendered. + * \* `gfm` to render a document in [GitHub Flavored Markdown](https://github.github.com/gfm/), which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests. + */ + mode?: "markdown" | "gfm"; + /** + * The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode. + */ + context?: string; +}; +declare type MarkdownRenderRequestOptions = { + method: "POST"; + url: "/markdown"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MarkdownRenderRawEndpoint = { + /** + * data parameter + */ + data: string; +} & { + headers: { + "content-type": "text/plain; charset=utf-8"; + }; +}; +declare type MarkdownRenderRawRequestOptions = { + method: "POST"; + url: "/markdown/raw"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsGetSubscriptionPlanForAccountEndpoint = { + account_id: number; +}; +declare type AppsGetSubscriptionPlanForAccountRequestOptions = { + method: "GET"; + url: "/marketplace_listing/accounts/:account_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetSubscriptionPlanForAccountResponseData { + url: string; + type: string; + id: number; + login: string; + email: string; + organization_billing_email: string; + marketplace_pending_change: { + effective_date: string; + unit_count: string; + id: number; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + state: string; + unit_name: string; + bullets: string[]; + }; + }; + marketplace_purchase: { + billing_cycle: string; + next_billing_date: string; + unit_count: string; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; + }; + }; +} +declare type AppsListPlansEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type AppsListPlansRequestOptions = { + method: "GET"; + url: "/marketplace_listing/plans"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListPlansResponseData = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; +}[]; +declare type AppsListAccountsForPlanEndpoint = { + plan_id: number; + /** + * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type AppsListAccountsForPlanRequestOptions = { + method: "GET"; + url: "/marketplace_listing/plans/:plan_id/accounts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListAccountsForPlanResponseData = { + url: string; + type: string; + id: number; + login: string; + email: string; + organization_billing_email: string; + marketplace_pending_change: { + effective_date: string; + unit_count: string; + id: number; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + state: string; + unit_name: string; + bullets: string[]; + }; + }; + marketplace_purchase: { + billing_cycle: string; + next_billing_date: string; + unit_count: string; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; + }; + }; +}[]; +declare type AppsGetSubscriptionPlanForAccountStubbedEndpoint = { + account_id: number; +}; +declare type AppsGetSubscriptionPlanForAccountStubbedRequestOptions = { + method: "GET"; + url: "/marketplace_listing/stubbed/accounts/:account_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetSubscriptionPlanForAccountStubbedResponseData { + url: string; + type: string; + id: number; + login: string; + email: string; + organization_billing_email: string; + marketplace_pending_change: { + effective_date: string; + unit_count: string; + id: number; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + state: string; + unit_name: string; + bullets: string[]; + }; + }; + marketplace_purchase: { + billing_cycle: string; + next_billing_date: string; + unit_count: string; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; + }; + }; +} +declare type AppsListPlansStubbedEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type AppsListPlansStubbedRequestOptions = { + method: "GET"; + url: "/marketplace_listing/stubbed/plans"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListPlansStubbedResponseData = { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; +}[]; +declare type AppsListAccountsForPlanStubbedEndpoint = { + plan_id: number; + /** + * Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type AppsListAccountsForPlanStubbedRequestOptions = { + method: "GET"; + url: "/marketplace_listing/stubbed/plans/:plan_id/accounts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListAccountsForPlanStubbedResponseData = { + url: string; + type: string; + id: number; + login: string; + email: string; + organization_billing_email: string; + marketplace_pending_change: { + effective_date: string; + unit_count: string; + id: number; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + state: string; + unit_name: string; + bullets: string[]; + }; + }; + marketplace_purchase: { + billing_cycle: string; + next_billing_date: string; + unit_count: string; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; + }; + }; +}[]; +declare type MetaGetEndpoint = {}; +declare type MetaGetRequestOptions = { + method: "GET"; + url: "/meta"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MetaGetResponseData { + verifiable_password_authentication: boolean; + ssh_key_fingerprints: { + MD5_RSA: string; + MD5_DSA: string; + SHA256_RSA: string; + SHA256_DSA: string; + }; + hooks: string[]; + web: string[]; + api: string[]; + git: string[]; + pages: string[]; + importer: string[]; +} +declare type ActivityListPublicEventsForRepoNetworkEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListPublicEventsForRepoNetworkRequestOptions = { + method: "GET"; + url: "/networks/:owner/:repo/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListNotificationsForAuthenticatedUserEndpoint = { + /** + * If `true`, show notifications marked as read. + */ + all?: boolean; + /** + * If `true`, only shows notifications in which the user is directly participating or mentioned. + */ + participating?: boolean; + /** + * Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + before?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListNotificationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/notifications"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListNotificationsForAuthenticatedUserResponseData = { + id: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + subject: { + title: string; + url: string; + latest_comment_url: string; + type: string; + }; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string; + url: string; +}[]; +declare type ActivityMarkNotificationsAsReadEndpoint = { + /** + * Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; +}; +declare type ActivityMarkNotificationsAsReadRequestOptions = { + method: "PUT"; + url: "/notifications"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityGetThreadEndpoint = { + thread_id: number; +}; +declare type ActivityGetThreadRequestOptions = { + method: "GET"; + url: "/notifications/threads/:thread_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActivityGetThreadResponseData { + id: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + subject: { + title: string; + url: string; + latest_comment_url: string; + type: string; + }; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string; + url: string; +} +declare type ActivityMarkThreadAsReadEndpoint = { + thread_id: number; +}; +declare type ActivityMarkThreadAsReadRequestOptions = { + method: "PATCH"; + url: "/notifications/threads/:thread_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint = { + thread_id: number; +}; +declare type ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/notifications/threads/:thread_id/subscription"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActivityGetThreadSubscriptionForAuthenticatedUserResponseData { + subscribed: boolean; + ignored: boolean; + reason: string; + created_at: string; + url: string; + thread_url: string; +} +declare type ActivitySetThreadSubscriptionEndpoint = { + thread_id: number; + /** + * Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread. + */ + ignored?: boolean; +}; +declare type ActivitySetThreadSubscriptionRequestOptions = { + method: "PUT"; + url: "/notifications/threads/:thread_id/subscription"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActivitySetThreadSubscriptionResponseData { + subscribed: boolean; + ignored: boolean; + reason: string; + created_at: string; + url: string; + thread_url: string; +} +declare type ActivityDeleteThreadSubscriptionEndpoint = { + thread_id: number; +}; +declare type ActivityDeleteThreadSubscriptionRequestOptions = { + method: "DELETE"; + url: "/notifications/threads/:thread_id/subscription"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsListEndpoint = { + /** + * The integer ID of the last organization that you've seen. + */ + since?: number; +}; +declare type OrgsListRequestOptions = { + method: "GET"; + url: "/organizations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListResponseData = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}[]; +declare type OrgsGetEndpoint = { + org: string; +}; +declare type OrgsGetRequestOptions = { + method: "GET"; + url: "/orgs/:org"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsGetResponseData { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + total_private_repos: number; + owned_private_repos: number; + private_gists: number; + disk_usage: number; + collaborators: number; + billing_email: string; + plan: { + name: string; + space: number; + private_repos: number; + }; + default_repository_permission: string; + members_can_create_repositories: boolean; + two_factor_requirement_enabled: boolean; + members_allowed_repository_creation_type: string; + members_can_create_public_repositories: boolean; + members_can_create_private_repositories: boolean; + members_can_create_internal_repositories: boolean; +} +declare type OrgsUpdateEndpoint = { + org: string; + /** + * Billing email address. This address is not publicized. + */ + billing_email?: string; + /** + * The company name. + */ + company?: string; + /** + * The publicly visible email address. + */ + email?: string; + /** + * The Twitter username of the company. + */ + twitter_username?: string; + /** + * The location. + */ + location?: string; + /** + * The shorthand name of the company. + */ + name?: string; + /** + * The description of the company. + */ + description?: string; + /** + * Toggles whether an organization can use organization projects. + */ + has_organization_projects?: boolean; + /** + * Toggles whether repositories that belong to the organization can use repository projects. + */ + has_repository_projects?: boolean; + /** + * Default permission level members have for organization repositories: + * \* `read` - can pull, but not push to or administer this repository. + * \* `write` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push, and administer this repository. + * \* `none` - no permissions granted by default. + */ + default_repository_permission?: "read" | "write" | "admin" | "none"; + /** + * Toggles the ability of non-admin organization members to create repositories. Can be one of: + * \* `true` - all organization members can create repositories. + * \* `false` - only organization owners can create repositories. + * Default: `true` + * **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. + */ + members_can_create_repositories?: boolean; + /** + * Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: + * \* `true` - all organization members can create internal repositories. + * \* `false` - only organization owners can create internal repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_internal_repositories?: boolean; + /** + * Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: + * \* `true` - all organization members can create private repositories. + * \* `false` - only organization owners can create private repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_private_repositories?: boolean; + /** + * Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: + * \* `true` - all organization members can create public repositories. + * \* `false` - only organization owners can create public repositories. + * Default: `true`. For more information, see "[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + */ + members_can_create_public_repositories?: boolean; + /** + * Specifies which types of repositories non-admin organization members can create. Can be one of: + * \* `all` - all organization members can create public and private repositories. + * \* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. + * \* `none` - only admin members can create repositories. + * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. + */ + members_allowed_repository_creation_type?: "all" | "private" | "none"; +}; +declare type OrgsUpdateRequestOptions = { + method: "PATCH"; + url: "/orgs/:org"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsUpdateResponseData { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + total_private_repos: number; + owned_private_repos: number; + private_gists: number; + disk_usage: number; + collaborators: number; + billing_email: string; + plan: { + name: string; + space: number; + private_repos: number; + }; + default_repository_permission: string; + members_can_create_repositories: boolean; + two_factor_requirement_enabled: boolean; + members_allowed_repository_creation_type: string; + members_can_create_public_repositories: boolean; + members_can_create_private_repositories: boolean; + members_can_create_internal_repositories: boolean; +} +declare type ActionsListSelfHostedRunnersForOrgEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListSelfHostedRunnersForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/runners"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListSelfHostedRunnersForOrgResponseData { + total_count: number; + runners: { + id: number; + name: string; + os: string; + status: string; + }[]; +} +declare type ActionsListRunnerApplicationsForOrgEndpoint = { + org: string; +}; +declare type ActionsListRunnerApplicationsForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/runners/downloads"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActionsListRunnerApplicationsForOrgResponseData = { + os: string; + architecture: string; + download_url: string; + filename: string; +}[]; +declare type ActionsCreateRegistrationTokenForOrgEndpoint = { + org: string; +}; +declare type ActionsCreateRegistrationTokenForOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/actions/runners/registration-token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsCreateRegistrationTokenForOrgResponseData { + token: string; + expires_at: string; +} +declare type ActionsCreateRemoveTokenForOrgEndpoint = { + org: string; +}; +declare type ActionsCreateRemoveTokenForOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/actions/runners/remove-token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsCreateRemoveTokenForOrgResponseData { + token: string; + expires_at: string; +} +declare type ActionsGetSelfHostedRunnerForOrgEndpoint = { + org: string; + runner_id: number; +}; +declare type ActionsGetSelfHostedRunnerForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/runners/:runner_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetSelfHostedRunnerForOrgResponseData { + id: number; + name: string; + os: string; + status: string; +} +declare type ActionsDeleteSelfHostedRunnerFromOrgEndpoint = { + org: string; + runner_id: number; +}; +declare type ActionsDeleteSelfHostedRunnerFromOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/actions/runners/:runner_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsListOrgSecretsEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListOrgSecretsRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/secrets"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListOrgSecretsResponseData { + total_count: number; + secrets: { + name: string; + created_at: string; + updated_at: string; + visibility: string; + selected_repositories_url: string; + }[]; +} +declare type ActionsGetOrgPublicKeyEndpoint = { + org: string; +}; +declare type ActionsGetOrgPublicKeyRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/secrets/public-key"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetOrgPublicKeyResponseData { + key_id: string; + key: string; +} +declare type ActionsGetOrgSecretEndpoint = { + org: string; + secret_name: string; +}; +declare type ActionsGetOrgSecretRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/secrets/:secret_name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetOrgSecretResponseData { + name: string; + created_at: string; + updated_at: string; + visibility: string; + selected_repositories_url: string; +} +declare type ActionsCreateOrUpdateOrgSecretEndpoint = { + org: string; + secret_name: string; + /** + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://developer.github.com/v3/actions/secrets/#get-an-organization-public-key) endpoint. + */ + encrypted_value?: string; + /** + * ID of the key you used to encrypt the secret. + */ + key_id?: string; + /** + * Configures the access that repositories have to the organization secret. Can be one of: + * \- `all` - All repositories in an organization can access the secret. + * \- `private` - Private repositories in an organization can access the secret. + * \- `selected` - Only specific repositories can access the secret. + */ + visibility?: "all" | "private" | "selected"; + /** + * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://developer.github.com/v3/actions/secrets/#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://developer.github.com/v3/actions/secrets/#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://developer.github.com/v3/actions/secrets/#remove-selected-repository-from-an-organization-secret) endpoints. + */ + selected_repository_ids?: string[]; +}; +declare type ActionsCreateOrUpdateOrgSecretRequestOptions = { + method: "PUT"; + url: "/orgs/:org/actions/secrets/:secret_name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsDeleteOrgSecretEndpoint = { + org: string; + secret_name: string; +}; +declare type ActionsDeleteOrgSecretRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/actions/secrets/:secret_name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsListSelectedReposForOrgSecretEndpoint = { + org: string; + secret_name: string; +}; +declare type ActionsListSelectedReposForOrgSecretRequestOptions = { + method: "GET"; + url: "/orgs/:org/actions/secrets/:secret_name/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListSelectedReposForOrgSecretResponseData { + total_count: number; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }[]; +} +declare type ActionsSetSelectedReposForOrgSecretEndpoint = { + org: string; + secret_name: string; + /** + * An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://developer.github.com/v3/actions/secrets/#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://developer.github.com/v3/actions/secrets/#remove-selected-repository-from-an-organization-secret) endpoints. + */ + selected_repository_ids?: number[]; +}; +declare type ActionsSetSelectedReposForOrgSecretRequestOptions = { + method: "PUT"; + url: "/orgs/:org/actions/secrets/:secret_name/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsAddSelectedRepoToOrgSecretEndpoint = { + org: string; + secret_name: string; + repository_id: number; +}; +declare type ActionsAddSelectedRepoToOrgSecretRequestOptions = { + method: "PUT"; + url: "/orgs/:org/actions/secrets/:secret_name/repositories/:repository_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsRemoveSelectedRepoFromOrgSecretEndpoint = { + org: string; + secret_name: string; + repository_id: number; +}; +declare type ActionsRemoveSelectedRepoFromOrgSecretRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/actions/secrets/:secret_name/repositories/:repository_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsListBlockedUsersEndpoint = { + org: string; +}; +declare type OrgsListBlockedUsersRequestOptions = { + method: "GET"; + url: "/orgs/:org/blocks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListBlockedUsersResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type OrgsCheckBlockedUserEndpoint = { + org: string; + username: string; +}; +declare type OrgsCheckBlockedUserRequestOptions = { + method: "GET"; + url: "/orgs/:org/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsBlockUserEndpoint = { + org: string; + username: string; +}; +declare type OrgsBlockUserRequestOptions = { + method: "PUT"; + url: "/orgs/:org/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsUnblockUserEndpoint = { + org: string; + username: string; +}; +declare type OrgsUnblockUserRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsListCredentialAuthorizationsEndpoint = { + org: string; +}; +declare type OrgsListCredentialAuthorizationsRequestOptions = { + method: "GET"; + url: "/orgs/:org/credential-authorizations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListCredentialAuthorizationsResponseData = { + login: string; + credential_id: string; + credential_type: string; + token_last_eight: string; + credential_authorized_at: string; + scopes: string[]; +}[]; +declare type OrgsRemoveCredentialAuthorizationEndpoint = { + org: string; + credential_id: number; +}; +declare type OrgsRemoveCredentialAuthorizationRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/credential-authorizations/:credential_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListPublicOrgEventsEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListPublicOrgEventsRequestOptions = { + method: "GET"; + url: "/orgs/:org/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsListHooksEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListHooksRequestOptions = { + method: "GET"; + url: "/orgs/:org/hooks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListHooksResponseData = { + id: number; + url: string; + ping_url: string; + name: string; + events: string[]; + active: boolean; + config: { + url: string; + content_type: string; + }; + updated_at: string; + created_at: string; +}[]; +declare type OrgsCreateHookEndpoint = { + org: string; + /** + * Must be passed as "web". + */ + name: string; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params). + */ + config: OrgsCreateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/webhooks/event-payloads) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +declare type OrgsCreateHookRequestOptions = { + method: "POST"; + url: "/orgs/:org/hooks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsCreateHookResponseData { + id: number; + url: string; + ping_url: string; + name: string; + events: string[]; + active: boolean; + config: { + url: string; + content_type: string; + }; + updated_at: string; + created_at: string; +} +declare type OrgsGetHookEndpoint = { + org: string; + hook_id: number; +}; +declare type OrgsGetHookRequestOptions = { + method: "GET"; + url: "/orgs/:org/hooks/:hook_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsGetHookResponseData { + id: number; + url: string; + ping_url: string; + name: string; + events: string[]; + active: boolean; + config: { + url: string; + content_type: string; + }; + updated_at: string; + created_at: string; +} +declare type OrgsUpdateHookEndpoint = { + org: string; + hook_id: number; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params). + */ + config?: OrgsUpdateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/webhooks/event-payloads) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +declare type OrgsUpdateHookRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/hooks/:hook_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsUpdateHookResponseData { + id: number; + url: string; + ping_url: string; + name: string; + events: string[]; + active: boolean; + config: { + url: string; + content_type: string; + }; + updated_at: string; + created_at: string; +} +declare type OrgsDeleteHookEndpoint = { + org: string; + hook_id: number; +}; +declare type OrgsDeleteHookRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/hooks/:hook_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsPingHookEndpoint = { + org: string; + hook_id: number; +}; +declare type OrgsPingHookRequestOptions = { + method: "POST"; + url: "/orgs/:org/hooks/:hook_id/pings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsGetOrgInstallationEndpoint = { + org: string; +} & RequiredPreview<"machine-man">; +declare type AppsGetOrgInstallationRequestOptions = { + method: "GET"; + url: "/orgs/:org/installation"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetOrgInstallationResponseData { + id: number; + account: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repository_selection: "all" | "selected"; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + checks: string; + metadata: string; + contents: string; + }; + events: string[]; + created_at: string; + updated_at: string; + single_file_name: string; +} +declare type OrgsListInstallationsEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"machine-man">; +declare type OrgsListInstallationsRequestOptions = { + method: "GET"; + url: "/orgs/:org/installations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsListInstallationsResponseData { + total_count: number; + installations: { + id: number; + account: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repository_selection: "all" | "selected"; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + deployments: string; + metadata: string; + pull_requests: string; + statuses: string; + }; + events: string[]; + created_at: string; + updated_at: string; + single_file_name: string; + }[]; +} +declare type InteractionsGetRestrictionsForOrgEndpoint = { + org: string; +} & RequiredPreview<"sombra">; +declare type InteractionsGetRestrictionsForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/interaction-limits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface InteractionsGetRestrictionsForOrgResponseData { + limit: string; + origin: string; + expires_at: string; +} +declare type InteractionsAddOrUpdateRestrictionsForOrgEndpoint = { + org: string; + /** + * Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`. + */ + limit: "existing_users" | "contributors_only" | "collaborators_only"; +} & RequiredPreview<"sombra">; +declare type InteractionsAddOrUpdateRestrictionsForOrgRequestOptions = { + method: "PUT"; + url: "/orgs/:org/interaction-limits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface InteractionsAddOrUpdateRestrictionsForOrgResponseData { + limit: string; + origin: string; + expires_at: string; +} +declare type InteractionsRemoveRestrictionsForOrgEndpoint = { + org: string; +} & RequiredPreview<"sombra">; +declare type InteractionsRemoveRestrictionsForOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/interaction-limits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsListPendingInvitationsEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListPendingInvitationsRequestOptions = { + method: "GET"; + url: "/orgs/:org/invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListPendingInvitationsResponseData = { + id: number; + login: string; + email: string; + role: string; + created_at: string; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + team_count: number; + invitation_team_url: string; +}[]; +declare type OrgsCreateInvitationEndpoint = { + org: string; + /** + * **Required unless you provide `email`**. GitHub user ID for the person you are inviting. + */ + invitee_id?: number; + /** + * **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. + */ + email?: string; + /** + * Specify role for new member. Can be one of: + * \* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * \* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * \* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + */ + role?: "admin" | "direct_member" | "billing_manager"; + /** + * Specify IDs for the teams you want to invite new members to. + */ + team_ids?: number[]; +}; +declare type OrgsCreateInvitationRequestOptions = { + method: "POST"; + url: "/orgs/:org/invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsCreateInvitationResponseData { + id: number; + login: string; + email: string; + role: string; + created_at: string; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + team_count: number; + invitation_team_url: string; +} +declare type OrgsListInvitationTeamsEndpoint = { + org: string; + invitation_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListInvitationTeamsRequestOptions = { + method: "GET"; + url: "/orgs/:org/invitations/:invitation_id/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListInvitationTeamsResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type IssuesListForOrgEndpoint = { + org: string; + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/issues"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListForOrgResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +}[]; +declare type OrgsListMembersEndpoint = { + org: string; + /** + * Filter members returned in the list. Can be one of: + * \* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. + * \* `all` - All members the authenticated user can see. + */ + filter?: "2fa_disabled" | "all"; + /** + * Filter members returned by their role. Can be one of: + * \* `all` - All members of the organization, regardless of role. + * \* `admin` - Organization owners. + * \* `member` - Non-owner organization members. + */ + role?: "all" | "admin" | "member"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListMembersRequestOptions = { + method: "GET"; + url: "/orgs/:org/members"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListMembersResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type OrgsCheckMembershipEndpoint = { + org: string; + username: string; +}; +declare type OrgsCheckMembershipRequestOptions = { + method: "GET"; + url: "/orgs/:org/members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsRemoveMemberEndpoint = { + org: string; + username: string; +}; +declare type OrgsRemoveMemberRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsGetMembershipEndpoint = { + org: string; + username: string; +}; +declare type OrgsGetMembershipRequestOptions = { + method: "GET"; + url: "/orgs/:org/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsGetMembershipResponseData { + url: string; + state: string; + role: string; + organization_url: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type OrgsAddOrUpdateMembershipEndpoint = { + org: string; + username: string; + /** + * The role to give the user in the organization. Can be one of: + * \* `admin` - The user will become an owner of the organization. + * \* `member` - The user will become a non-owner member of the organization. + */ + role?: "admin" | "member"; +}; +declare type OrgsAddOrUpdateMembershipRequestOptions = { + method: "PUT"; + url: "/orgs/:org/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsAddOrUpdateMembershipResponseData { + url: string; + state: string; + role: string; + organization_url: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type OrgsRemoveMembershipEndpoint = { + org: string; + username: string; +}; +declare type OrgsRemoveMembershipRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsStartForOrgEndpoint = { + org: string; + /** + * A list of arrays indicating which repositories should be migrated. + */ + repositories: string[]; + /** + * Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + */ + lock_repositories?: boolean; + /** + * Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + */ + exclude_attachments?: boolean; +}; +declare type MigrationsStartForOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/migrations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsStartForOrgResponseData { + id: number; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; + url: string; + created_at: string; + updated_at: string; +} +declare type MigrationsListForOrgEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsListForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/migrations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type MigrationsListForOrgResponseData = { + id: number; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; + url: string; + created_at: string; + updated_at: string; +}[]; +declare type MigrationsGetStatusForOrgEndpoint = { + org: string; + migration_id: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsGetStatusForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/migrations/:migration_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsGetStatusForOrgResponseData { + id: number; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; + url: string; + created_at: string; + updated_at: string; +} +declare type MigrationsDownloadArchiveForOrgEndpoint = { + org: string; + migration_id: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsDownloadArchiveForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/migrations/:migration_id/archive"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsDeleteArchiveForOrgEndpoint = { + org: string; + migration_id: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsDeleteArchiveForOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/migrations/:migration_id/archive"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsUnlockRepoForOrgEndpoint = { + org: string; + migration_id: number; + repo_name: string; +} & RequiredPreview<"wyandotte">; +declare type MigrationsUnlockRepoForOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/migrations/:migration_id/repos/:repo_name/lock"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsListReposForOrgEndpoint = { + org: string; + migration_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsListReposForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/migrations/:migration_id/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type MigrationsListReposForOrgResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type OrgsListOutsideCollaboratorsEndpoint = { + org: string; + /** + * Filter the list of outside collaborators. Can be one of: + * \* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. + * \* `all`: All outside collaborators. + */ + filter?: "2fa_disabled" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListOutsideCollaboratorsRequestOptions = { + method: "GET"; + url: "/orgs/:org/outside_collaborators"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListOutsideCollaboratorsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type OrgsRemoveOutsideCollaboratorEndpoint = { + org: string; + username: string; +}; +declare type OrgsRemoveOutsideCollaboratorRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/outside_collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsRemoveOutsideCollaboratorResponseData { + message: string; + documentation_url: string; +} +declare type OrgsConvertMemberToOutsideCollaboratorEndpoint = { + org: string; + username: string; +}; +declare type OrgsConvertMemberToOutsideCollaboratorRequestOptions = { + method: "PUT"; + url: "/orgs/:org/outside_collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsConvertMemberToOutsideCollaboratorResponseData { + message: string; + documentation_url: string; +} +declare type ProjectsListForOrgEndpoint = { + org: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsListForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ProjectsListForOrgResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type ProjectsCreateForOrgEndpoint = { + org: string; + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +} & RequiredPreview<"inertia">; +declare type ProjectsCreateForOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsCreateForOrgResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type OrgsListPublicMembersEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListPublicMembersRequestOptions = { + method: "GET"; + url: "/orgs/:org/public_members"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListPublicMembersResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type OrgsCheckPublicMembershipEndpoint = { + org: string; + username: string; +}; +declare type OrgsCheckPublicMembershipRequestOptions = { + method: "GET"; + url: "/orgs/:org/public_members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsPublicizeMembershipEndpoint = { + org: string; + username: string; +}; +declare type OrgsPublicizeMembershipRequestOptions = { + method: "PUT"; + url: "/orgs/:org/public_members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsConcealMembershipEndpoint = { + org: string; + username: string; +}; +declare type OrgsConcealMembershipRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/public_members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListForOrgEndpoint = { + org: string; + /** + * Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. + */ + type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListForOrgResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type ReposCreateInOrgEndpoint = { + org: string; + /** + * The name of the repository. + */ + name: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to create a private repository or `false` to create a public one. + */ + private?: boolean; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see "[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + */ + team_id?: number; + /** + * Pass `true` to create an initial commit with empty README. + */ + auto_init?: boolean; + /** + * Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". + */ + gitignore_template?: string; + /** + * Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". + */ + license_template?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; +}; +declare type ReposCreateInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateInOrgResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +} +declare type TeamsListIdPGroupsForOrgEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListIdPGroupsForOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/team-sync/groups"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsListIdPGroupsForOrgResponseData { + groups: { + group_id: string; + group_name: string; + group_description: string; + }[]; +} +declare type TeamsListEndpoint = { + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type TeamsCreateEndpoint = { + org: string; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * List GitHub IDs for organization members who will become team maintainers. + */ + maintainers?: string[]; + /** + * The full name (e.g., "organization-name/repository-name") of repositories to add the team to. + */ + repo_names?: string[]; + /** + * The level of privacy this team should have. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + * Default for child team: `closed` + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; +}; +declare type TeamsCreateRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + }; +} +declare type TeamsGetByNameEndpoint = { + org: string; + team_slug: string; +}; +declare type TeamsGetByNameRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetByNameResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + }; +} +declare type TeamsUpdateInOrgEndpoint = { + org: string; + team_slug: string; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; +}; +declare type TeamsUpdateInOrgRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/teams/:team_slug"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsUpdateInOrgResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + }; +} +declare type TeamsDeleteInOrgEndpoint = { + org: string; + team_slug: string; +}; +declare type TeamsDeleteInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListDiscussionsInOrgEndpoint = { + org: string; + team_slug: string; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListDiscussionsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListDiscussionsInOrgResponseData = { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +}[]; +declare type TeamsCreateDiscussionInOrgEndpoint = { + org: string; + team_slug: string; + /** + * The discussion post's title. + */ + title: string; + /** + * The discussion post's body text. + */ + body: string; + /** + * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + */ + private?: boolean; +}; +declare type TeamsCreateDiscussionInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams/:team_slug/discussions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateDiscussionInOrgResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsGetDiscussionInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; +}; +declare type TeamsGetDiscussionInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetDiscussionInOrgResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsUpdateDiscussionInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + /** + * The discussion post's title. + */ + title?: string; + /** + * The discussion post's body text. + */ + body?: string; +}; +declare type TeamsUpdateDiscussionInOrgRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsUpdateDiscussionInOrgResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsDeleteDiscussionInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; +}; +declare type TeamsDeleteDiscussionInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListDiscussionCommentsInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListDiscussionCommentsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListDiscussionCommentsInOrgResponseData = { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +}[]; +declare type TeamsCreateDiscussionCommentInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +declare type TeamsCreateDiscussionCommentInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateDiscussionCommentInOrgResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsGetDiscussionCommentInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + comment_number: number; +}; +declare type TeamsGetDiscussionCommentInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetDiscussionCommentInOrgResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsUpdateDiscussionCommentInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + comment_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +declare type TeamsUpdateDiscussionCommentInOrgRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsUpdateDiscussionCommentInOrgResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsDeleteDiscussionCommentInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + comment_number: number; +}; +declare type TeamsDeleteDiscussionCommentInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForTeamDiscussionCommentInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + comment_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForTeamDiscussionCommentInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForTeamDiscussionCommentInOrgResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForTeamDiscussionCommentInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + comment_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForTeamDiscussionCommentInOrgResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsDeleteForTeamDiscussionCommentEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + comment_number: number; + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteForTeamDiscussionCommentRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForTeamDiscussionInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForTeamDiscussionInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForTeamDiscussionInOrgResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForTeamDiscussionInOrgEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForTeamDiscussionInOrgRequestOptions = { + method: "POST"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForTeamDiscussionInOrgResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsDeleteForTeamDiscussionEndpoint = { + org: string; + team_slug: string; + discussion_number: number; + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteForTeamDiscussionRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListPendingInvitationsInOrgEndpoint = { + org: string; + team_slug: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListPendingInvitationsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListPendingInvitationsInOrgResponseData = { + id: number; + login: string; + email: string; + role: string; + created_at: string; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + team_count: number; + invitation_team_url: string; +}[]; +declare type TeamsListMembersInOrgEndpoint = { + org: string; + team_slug: string; + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListMembersInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/members"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListMembersInOrgResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type TeamsGetMembershipForUserInOrgEndpoint = { + org: string; + team_slug: string; + username: string; +}; +declare type TeamsGetMembershipForUserInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetMembershipForUserInOrgResponseData { + url: string; + role: string; + state: string; +} +declare type TeamsAddOrUpdateMembershipForUserInOrgEndpoint = { + org: string; + team_slug: string; + username: string; + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; +}; +declare type TeamsAddOrUpdateMembershipForUserInOrgRequestOptions = { + method: "PUT"; + url: "/orgs/:org/teams/:team_slug/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsAddOrUpdateMembershipForUserInOrgResponseData { + url: string; + role: string; + state: string; +} +export interface TeamsAddOrUpdateMembershipForUserInOrgResponse422Data { + message: string; + errors: { + code: string; + field: string; + resource: string; + }[]; +} +declare type TeamsRemoveMembershipForUserInOrgEndpoint = { + org: string; + team_slug: string; + username: string; +}; +declare type TeamsRemoveMembershipForUserInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListProjectsInOrgEndpoint = { + org: string; + team_slug: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type TeamsListProjectsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListProjectsInOrgResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + organization_permission: string; + private: boolean; + permissions: { + read: boolean; + write: boolean; + admin: boolean; + }; +}[]; +declare type TeamsCheckPermissionsForProjectInOrgEndpoint = { + org: string; + team_slug: string; + project_id: number; +} & RequiredPreview<"inertia">; +declare type TeamsCheckPermissionsForProjectInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCheckPermissionsForProjectInOrgResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + organization_permission: string; + private: boolean; + permissions: { + read: boolean; + write: boolean; + admin: boolean; + }; +} +declare type TeamsAddOrUpdateProjectPermissionsInOrgEndpoint = { + org: string; + team_slug: string; + project_id: number; + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + */ + permission?: "read" | "write" | "admin"; +} & RequiredPreview<"inertia">; +declare type TeamsAddOrUpdateProjectPermissionsInOrgRequestOptions = { + method: "PUT"; + url: "/orgs/:org/teams/:team_slug/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsAddOrUpdateProjectPermissionsInOrgResponseData { + message: string; + documentation_url: string; +} +declare type TeamsRemoveProjectInOrgEndpoint = { + org: string; + team_slug: string; + project_id: number; +}; +declare type TeamsRemoveProjectInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListReposInOrgEndpoint = { + org: string; + team_slug: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListReposInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListReposInOrgResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type TeamsCheckPermissionsForRepoInOrgEndpoint = { + org: string; + team_slug: string; + owner: string; + repo: string; +}; +declare type TeamsCheckPermissionsForRepoInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCheckPermissionsForRepoInOrgResponseData { + organization: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parent: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + source: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + permissions: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; +} +declare type TeamsAddOrUpdateRepoPermissionsInOrgEndpoint = { + org: string; + team_slug: string; + owner: string; + repo: string; + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * \* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. + * \* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + */ + permission?: "pull" | "push" | "admin" | "maintain" | "triage"; +}; +declare type TeamsAddOrUpdateRepoPermissionsInOrgRequestOptions = { + method: "PUT"; + url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsRemoveRepoInOrgEndpoint = { + org: string; + team_slug: string; + owner: string; + repo: string; +}; +declare type TeamsRemoveRepoInOrgRequestOptions = { + method: "DELETE"; + url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListIdPGroupsInOrgEndpoint = { + org: string; + team_slug: string; +}; +declare type TeamsListIdPGroupsInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/team-sync/group-mappings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsListIdPGroupsInOrgResponseData { + groups: { + group_id: string; + group_name: string; + group_description: string; + }[]; +} +declare type TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint = { + org: string; + team_slug: string; + /** + * The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. + */ + groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups[]; +}; +declare type TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions = { + method: "PATCH"; + url: "/orgs/:org/teams/:team_slug/team-sync/group-mappings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateOrUpdateIdPGroupConnectionsInOrgResponseData { + groups: { + group_id: string; + group_name: string; + group_description: string; + }; +} +declare type TeamsListChildInOrgEndpoint = { + org: string; + team_slug: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListChildInOrgRequestOptions = { + method: "GET"; + url: "/orgs/:org/teams/:team_slug/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListChildInOrgResponseData = { + id: number; + node_id: string; + url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + }; +}[]; +declare type ProjectsGetCardEndpoint = { + card_id: number; +} & RequiredPreview<"inertia">; +declare type ProjectsGetCardRequestOptions = { + method: "GET"; + url: "/projects/columns/cards/:card_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsGetCardResponseData { + url: string; + id: number; + node_id: string; + note: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + archived: boolean; + column_url: string; + content_url: string; + project_url: string; +} +declare type ProjectsUpdateCardEndpoint = { + card_id: number; + /** + * The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`. + */ + note?: string; + /** + * Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card. + */ + archived?: boolean; +} & RequiredPreview<"inertia">; +declare type ProjectsUpdateCardRequestOptions = { + method: "PATCH"; + url: "/projects/columns/cards/:card_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsUpdateCardResponseData { + url: string; + id: number; + node_id: string; + note: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + archived: boolean; + column_url: string; + content_url: string; + project_url: string; +} +declare type ProjectsDeleteCardEndpoint = { + card_id: number; +} & RequiredPreview<"inertia">; +declare type ProjectsDeleteCardRequestOptions = { + method: "DELETE"; + url: "/projects/columns/cards/:card_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsMoveCardEndpoint = { + card_id: number; + /** + * Can be one of `top`, `bottom`, or `after:`, where `` is the `id` value of a card in the same column, or in the new column specified by `column_id`. + */ + position: string; + /** + * The `id` value of a column in the same project. + */ + column_id?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsMoveCardRequestOptions = { + method: "POST"; + url: "/projects/columns/cards/:card_id/moves"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsGetColumnEndpoint = { + column_id: number; +} & RequiredPreview<"inertia">; +declare type ProjectsGetColumnRequestOptions = { + method: "GET"; + url: "/projects/columns/:column_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsGetColumnResponseData { + url: string; + project_url: string; + cards_url: string; + id: number; + node_id: string; + name: string; + created_at: string; + updated_at: string; +} +declare type ProjectsUpdateColumnEndpoint = { + column_id: number; + /** + * The new name of the column. + */ + name: string; +} & RequiredPreview<"inertia">; +declare type ProjectsUpdateColumnRequestOptions = { + method: "PATCH"; + url: "/projects/columns/:column_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsUpdateColumnResponseData { + url: string; + project_url: string; + cards_url: string; + id: number; + node_id: string; + name: string; + created_at: string; + updated_at: string; +} +declare type ProjectsDeleteColumnEndpoint = { + column_id: number; +} & RequiredPreview<"inertia">; +declare type ProjectsDeleteColumnRequestOptions = { + method: "DELETE"; + url: "/projects/columns/:column_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsListCardsEndpoint = { + column_id: number; + /** + * Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`. + */ + archived_state?: "all" | "archived" | "not_archived"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsListCardsRequestOptions = { + method: "GET"; + url: "/projects/columns/:column_id/cards"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ProjectsListCardsResponseData = { + url: string; + id: number; + node_id: string; + note: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + archived: boolean; + column_url: string; + content_url: string; + project_url: string; +}[]; +declare type ProjectsCreateCardEndpoint = { + column_id: number; + /** + * The card's note content. Only valid for cards without another type of content, so you must omit when specifying `content_id` and `content_type`. + */ + note?: string; + /** + * The issue or pull request id you want to associate with this card. You can use the [List repository issues](https://developer.github.com/v3/issues/#list-repository-issues) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. + * **Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`. + */ + content_id?: number; + /** + * **Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id. + */ + content_type?: string; +} & RequiredPreview<"inertia">; +declare type ProjectsCreateCardRequestOptions = { + method: "POST"; + url: "/projects/columns/:column_id/cards"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsCreateCardResponseData { + url: string; + id: number; + node_id: string; + note: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + archived: boolean; + column_url: string; + content_url: string; + project_url: string; +} +declare type ProjectsMoveColumnEndpoint = { + column_id: number; + /** + * Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project. + */ + position: string; +} & RequiredPreview<"inertia">; +declare type ProjectsMoveColumnRequestOptions = { + method: "POST"; + url: "/projects/columns/:column_id/moves"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsGetEndpoint = { + project_id: number; +} & RequiredPreview<"inertia">; +declare type ProjectsGetRequestOptions = { + method: "GET"; + url: "/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsGetResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type ProjectsUpdateEndpoint = { + project_id: number; + /** + * The name of the project. + */ + name?: string; + /** + * The description of the project. + */ + body?: string; + /** + * State of the project. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project permissions](https://developer.github.com/v3/teams/#add-or-update-team-project-permissions) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). + * + * **Note:** Updating a project's `organization_permission` requires `admin` access to the project. + * + * Can be one of: + * \* `read` - Organization members can read, but not write to or administer this project. + * \* `write` - Organization members can read and write, but not administer this project. + * \* `admin` - Organization members can read, write and administer this project. + * \* `none` - Organization members can only see this project if it is public. + */ + organization_permission?: string; + /** + * Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. + * + * Can be one of: + * \* `false` - Anyone can see the project. + * \* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account. + */ + private?: boolean; +} & RequiredPreview<"inertia">; +declare type ProjectsUpdateRequestOptions = { + method: "PATCH"; + url: "/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsUpdateResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type ProjectsDeleteEndpoint = { + project_id: number; +} & RequiredPreview<"inertia">; +declare type ProjectsDeleteRequestOptions = { + method: "DELETE"; + url: "/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsListCollaboratorsEndpoint = { + project_id: number; + /** + * Filters the collaborators by their affiliation. Can be one of: + * \* `outside`: Outside collaborators of a project that are not a member of the project's organization. + * \* `direct`: Collaborators with permissions to a project, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsListCollaboratorsRequestOptions = { + method: "GET"; + url: "/projects/:project_id/collaborators"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ProjectsListCollaboratorsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type ProjectsAddCollaboratorEndpoint = { + project_id: number; + username: string; + /** + * The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." Can be one of: + * \* `read` - can read, but not write to or administer this project. + * \* `write` - can read and write, but not administer this project. + * \* `admin` - can read, write and administer this project. + */ + permission?: "read" | "write" | "admin"; +} & RequiredPreview<"inertia">; +declare type ProjectsAddCollaboratorRequestOptions = { + method: "PUT"; + url: "/projects/:project_id/collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsRemoveCollaboratorEndpoint = { + project_id: number; + username: string; +} & RequiredPreview<"inertia">; +declare type ProjectsRemoveCollaboratorRequestOptions = { + method: "DELETE"; + url: "/projects/:project_id/collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ProjectsReviewUserPermissionLevelEndpoint = { + project_id: number; + username: string; +} & RequiredPreview<"inertia">; +declare type ProjectsReviewUserPermissionLevelRequestOptions = { + method: "GET"; + url: "/projects/:project_id/collaborators/:username/permission"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsReviewUserPermissionLevelResponseData { + permission: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type ProjectsListColumnsEndpoint = { + project_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsListColumnsRequestOptions = { + method: "GET"; + url: "/projects/:project_id/columns"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ProjectsListColumnsResponseData = { + url: string; + project_url: string; + cards_url: string; + id: number; + node_id: string; + name: string; + created_at: string; + updated_at: string; +}[]; +declare type ProjectsCreateColumnEndpoint = { + project_id: number; + /** + * The name of the column. + */ + name: string; +} & RequiredPreview<"inertia">; +declare type ProjectsCreateColumnRequestOptions = { + method: "POST"; + url: "/projects/:project_id/columns"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsCreateColumnResponseData { + url: string; + project_url: string; + cards_url: string; + id: number; + node_id: string; + name: string; + created_at: string; + updated_at: string; +} +declare type RateLimitGetEndpoint = {}; +declare type RateLimitGetRequestOptions = { + method: "GET"; + url: "/rate_limit"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface RateLimitGetResponseData { + resources: { + core: { + limit: number; + remaining: number; + reset: number; + }; + search: { + limit: number; + remaining: number; + reset: number; + }; + graphql: { + limit: number; + remaining: number; + reset: number; + }; + integration_manifest: { + limit: number; + remaining: number; + reset: number; + }; + }; + rate: { + limit: number; + remaining: number; + reset: number; + }; +} +declare type ReactionsDeleteLegacyEndpoint = { + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteLegacyRequestOptions = { + method: "DELETE"; + url: "/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; + organization: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parent: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + source: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +} +declare type ReposUpdateEndpoint = { + owner: string; + repo: string; + /** + * The name of the repository. + */ + name?: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to make the repository private or `false` to make it public. Default: `false`. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + */ + private?: boolean; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * Updates the default branch for this repository. + */ + default_branch?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; + /** + * `true` to archive this repository. **Note**: You cannot unarchive repositories through the API. + */ + archived?: boolean; +}; +declare type ReposUpdateRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + organization: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parent: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + source: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +} +declare type ReposDeleteEndpoint = { + owner: string; + repo: string; +}; +declare type ReposDeleteRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposDeleteResponseData { + message: string; + documentation_url: string; +} +declare type ActionsListArtifactsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListArtifactsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/artifacts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListArtifactsForRepoResponseData { + total_count: number; + artifacts: { + id: number; + node_id: string; + name: string; + size_in_bytes: number; + url: string; + archive_download_url: string; + expired: boolean; + created_at: string; + expires_at: string; + }[]; +} +declare type ActionsGetArtifactEndpoint = { + owner: string; + repo: string; + artifact_id: number; +}; +declare type ActionsGetArtifactRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetArtifactResponseData { + id: number; + node_id: string; + name: string; + size_in_bytes: number; + url: string; + archive_download_url: string; + expired: boolean; + created_at: string; + expires_at: string; +} +declare type ActionsDeleteArtifactEndpoint = { + owner: string; + repo: string; + artifact_id: number; +}; +declare type ActionsDeleteArtifactRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsDownloadArtifactEndpoint = { + owner: string; + repo: string; + artifact_id: number; + archive_format: string; +}; +declare type ActionsDownloadArtifactRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsGetWorkflowJobEndpoint = { + owner: string; + repo: string; + job_id: number; +}; +declare type ActionsGetWorkflowJobRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/jobs/:job_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetWorkflowJobResponseData { + id: number; + run_id: number; + run_url: string; + node_id: string; + head_sha: string; + url: string; + html_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + name: string; + steps: { + name: string; + status: string; + conclusion: string; + number: number; + started_at: string; + completed_at: string; + }[]; + check_run_url: string; +} +declare type ActionsDownloadWorkflowJobLogsEndpoint = { + owner: string; + repo: string; + job_id: number; +}; +declare type ActionsDownloadWorkflowJobLogsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/jobs/:job_id/logs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsListSelfHostedRunnersForRepoEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListSelfHostedRunnersForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runners"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListSelfHostedRunnersForRepoResponseData { + total_count: number; + runners: { + id: number; + name: string; + os: string; + status: string; + }[]; +} +declare type ActionsListRunnerApplicationsForRepoEndpoint = { + owner: string; + repo: string; +}; +declare type ActionsListRunnerApplicationsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runners/downloads"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActionsListRunnerApplicationsForRepoResponseData = { + os: string; + architecture: string; + download_url: string; + filename: string; +}[]; +declare type ActionsCreateRegistrationTokenForRepoEndpoint = { + owner: string; + repo: string; +}; +declare type ActionsCreateRegistrationTokenForRepoRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/actions/runners/registration-token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsCreateRegistrationTokenForRepoResponseData { + token: string; + expires_at: string; +} +declare type ActionsCreateRemoveTokenForRepoEndpoint = { + owner: string; + repo: string; +}; +declare type ActionsCreateRemoveTokenForRepoRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/actions/runners/remove-token"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsCreateRemoveTokenForRepoResponseData { + token: string; + expires_at: string; +} +declare type ActionsGetSelfHostedRunnerForRepoEndpoint = { + owner: string; + repo: string; + runner_id: number; +}; +declare type ActionsGetSelfHostedRunnerForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runners/:runner_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetSelfHostedRunnerForRepoResponseData { + id: number; + name: string; + os: string; + status: string; +} +declare type ActionsDeleteSelfHostedRunnerFromRepoEndpoint = { + owner: string; + repo: string; + runner_id: number; +}; +declare type ActionsDeleteSelfHostedRunnerFromRepoRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/actions/runners/:runner_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsListRepoWorkflowRunsEndpoint = { + owner: string; + repo: string; + /** + * Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. + */ + actor?: string; + /** + * Returns workflow runs associated with a branch. Use the name of the branch of the `push`. + */ + branch?: string; + /** + * Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)" in the GitHub Help documentation. + */ + event?: string; + /** + * Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in "[Create a check run](https://developer.github.com/v3/checks/runs/#create-a-check-run)." + */ + status?: "completed" | "status" | "conclusion"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListRepoWorkflowRunsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListRepoWorkflowRunsResponseData { + total_count: number; + workflow_runs: { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + run_number: number; + event: string; + status: string; + conclusion: string; + workflow_id: number; + url: string; + html_url: string; + pull_requests: unknown[]; + created_at: string; + updated_at: string; + jobs_url: string; + logs_url: string; + check_suite_url: string; + artifacts_url: string; + cancel_url: string; + rerun_url: string; + workflow_url: string; + head_commit: { + id: string; + tree_id: string; + message: string; + timestamp: string; + author: { + name: string; + email: string; + }; + committer: { + name: string; + email: string; + }; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + head_repository: { + id: number; + node_id: string; + name: string; + full_name: string; + private: boolean; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + html_url: string; + description: string; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; + }; + }[]; +} +declare type ActionsGetWorkflowRunEndpoint = { + owner: string; + repo: string; + run_id: number; +}; +declare type ActionsGetWorkflowRunRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetWorkflowRunResponseData { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + run_number: number; + event: string; + status: string; + conclusion: string; + workflow_id: number; + url: string; + html_url: string; + pull_requests: unknown[]; + created_at: string; + updated_at: string; + jobs_url: string; + logs_url: string; + check_suite_url: string; + artifacts_url: string; + cancel_url: string; + rerun_url: string; + workflow_url: string; + head_commit: { + id: string; + tree_id: string; + message: string; + timestamp: string; + author: { + name: string; + email: string; + }; + committer: { + name: string; + email: string; + }; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + head_repository: { + id: number; + node_id: string; + name: string; + full_name: string; + private: boolean; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + html_url: string; + description: string; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; + }; +} +declare type ActionsListWorkflowRunArtifactsEndpoint = { + owner: string; + repo: string; + run_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListWorkflowRunArtifactsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id/artifacts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListWorkflowRunArtifactsResponseData { + total_count: number; + artifacts: { + id: number; + node_id: string; + name: string; + size_in_bytes: number; + url: string; + archive_download_url: string; + expired: boolean; + created_at: string; + expires_at: string; + }[]; +} +declare type ActionsCancelWorkflowRunEndpoint = { + owner: string; + repo: string; + run_id: number; +}; +declare type ActionsCancelWorkflowRunRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/actions/runs/:run_id/cancel"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsListJobsForWorkflowRunEndpoint = { + owner: string; + repo: string; + run_id: number; + /** + * Filters jobs by their `completed_at` timestamp. Can be one of: + * \* `latest`: Returns jobs from the most recent execution of the workflow run. + * \* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListJobsForWorkflowRunRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id/jobs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListJobsForWorkflowRunResponseData { + total_count: number; + jobs: { + id: number; + run_id: number; + run_url: string; + node_id: string; + head_sha: string; + url: string; + html_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + name: string; + steps: { + name: string; + status: string; + conclusion: string; + number: number; + started_at: string; + completed_at: string; + }[]; + check_run_url: string; + }[]; +} +declare type ActionsDownloadWorkflowRunLogsEndpoint = { + owner: string; + repo: string; + run_id: number; +}; +declare type ActionsDownloadWorkflowRunLogsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id/logs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsDeleteWorkflowRunLogsEndpoint = { + owner: string; + repo: string; + run_id: number; +}; +declare type ActionsDeleteWorkflowRunLogsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/actions/runs/:run_id/logs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsReRunWorkflowEndpoint = { + owner: string; + repo: string; + run_id: number; +}; +declare type ActionsReRunWorkflowRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/actions/runs/:run_id/rerun"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsGetWorkflowRunUsageEndpoint = { + owner: string; + repo: string; + run_id: number; +}; +declare type ActionsGetWorkflowRunUsageRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/runs/:run_id/timing"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetWorkflowRunUsageResponseData { + billable: { + UBUNTU: { + total_ms: number; + jobs: number; + }; + MACOS: { + total_ms: number; + jobs: number; + }; + WINDOWS: { + total_ms: number; + jobs: number; + }; + }; + run_duration_ms: number; +} +declare type ActionsListRepoSecretsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListRepoSecretsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/secrets"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListRepoSecretsResponseData { + total_count: number; + secrets: { + name: string; + created_at: string; + updated_at: string; + }[]; +} +declare type ActionsGetRepoPublicKeyEndpoint = { + owner: string; + repo: string; +}; +declare type ActionsGetRepoPublicKeyRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/secrets/public-key"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetRepoPublicKeyResponseData { + key_id: string; + key: string; +} +declare type ActionsGetRepoSecretEndpoint = { + owner: string; + repo: string; + secret_name: string; +}; +declare type ActionsGetRepoSecretRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/secrets/:secret_name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetRepoSecretResponseData { + name: string; + created_at: string; + updated_at: string; +} +declare type ActionsCreateOrUpdateRepoSecretEndpoint = { + owner: string; + repo: string; + secret_name: string; + /** + * Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://developer.github.com/v3/actions/secrets/#get-a-repository-public-key) endpoint. + */ + encrypted_value?: string; + /** + * ID of the key you used to encrypt the secret. + */ + key_id?: string; +}; +declare type ActionsCreateOrUpdateRepoSecretRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/actions/secrets/:secret_name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsDeleteRepoSecretEndpoint = { + owner: string; + repo: string; + secret_name: string; +}; +declare type ActionsDeleteRepoSecretRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/actions/secrets/:secret_name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActionsListRepoWorkflowsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListRepoWorkflowsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/workflows"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListRepoWorkflowsResponseData { + total_count: number; + workflows: { + id: number; + node_id: string; + name: string; + path: string; + state: string; + created_at: string; + updated_at: string; + url: string; + html_url: string; + badge_url: string; + }[]; +} +declare type ActionsGetWorkflowEndpoint = { + owner: string; + repo: string; + workflow_id: number; +}; +declare type ActionsGetWorkflowRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/workflows/:workflow_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetWorkflowResponseData { + id: number; + node_id: string; + name: string; + path: string; + state: string; + created_at: string; + updated_at: string; + url: string; + html_url: string; + badge_url: string; +} +declare type ActionsListWorkflowRunsEndpoint = { + owner: string; + repo: string; + workflow_id: number; + /** + * Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. + */ + actor?: string; + /** + * Returns workflow runs associated with a branch. Use the name of the branch of the `push`. + */ + branch?: string; + /** + * Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)" in the GitHub Help documentation. + */ + event?: string; + /** + * Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in "[Create a check run](https://developer.github.com/v3/checks/runs/#create-a-check-run)." + */ + status?: "completed" | "status" | "conclusion"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActionsListWorkflowRunsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/workflows/:workflow_id/runs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsListWorkflowRunsResponseData { + total_count: number; + workflow_runs: { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + run_number: number; + event: string; + status: string; + conclusion: string; + workflow_id: number; + url: string; + html_url: string; + pull_requests: unknown[]; + created_at: string; + updated_at: string; + jobs_url: string; + logs_url: string; + check_suite_url: string; + artifacts_url: string; + cancel_url: string; + rerun_url: string; + workflow_url: string; + head_commit: { + id: string; + tree_id: string; + message: string; + timestamp: string; + author: { + name: string; + email: string; + }; + committer: { + name: string; + email: string; + }; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + head_repository: { + id: number; + node_id: string; + name: string; + full_name: string; + private: boolean; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + html_url: string; + description: string; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; + }; + }[]; +} +declare type ActionsGetWorkflowUsageEndpoint = { + owner: string; + repo: string; + workflow_id: number; +}; +declare type ActionsGetWorkflowUsageRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/actions/workflows/:workflow_id/timing"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActionsGetWorkflowUsageResponseData { + billable: { + UBUNTU: { + total_ms: number; + }; + MACOS: { + total_ms: number; + }; + WINDOWS: { + total_ms: number; + }; + }; +} +declare type IssuesListAssigneesEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListAssigneesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/assignees"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListAssigneesResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type IssuesCheckUserCanBeAssignedEndpoint = { + owner: string; + repo: string; + assignee: string; +}; +declare type IssuesCheckUserCanBeAssignedRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/assignees/:assignee"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposEnableAutomatedSecurityFixesEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"london">; +declare type ReposEnableAutomatedSecurityFixesRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/automated-security-fixes"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposDisableAutomatedSecurityFixesEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"london">; +declare type ReposDisableAutomatedSecurityFixesRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/automated-security-fixes"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListBranchesEndpoint = { + owner: string; + repo: string; + /** + * Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. + */ + protected?: boolean; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListBranchesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListBranchesResponseData = { + name: string; + commit: { + sha: string; + url: string; + }; + protected: boolean; + protection: { + enabled: boolean; + required_status_checks: { + enforcement_level: string; + contexts: string[]; + }; + }; + protection_url: string; +}[]; +declare type ReposGetBranchEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetBranchRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetBranchResponseData { + name: string; + commit: { + sha: string; + node_id: string; + commit: { + author: { + name: string; + date: string; + email: string; + }; + url: string; + message: string; + tree: { + sha: string; + url: string; + }; + committer: { + name: string; + date: string; + email: string; + }; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + gravatar_id: string; + avatar_url: string; + url: string; + id: number; + login: string; + }; + parents: { + sha: string; + url: string; + }[]; + url: string; + committer: { + gravatar_id: string; + avatar_url: string; + url: string; + id: number; + login: string; + }; + }; + _links: { + html: string; + self: string; + }; + protected: boolean; + protection: { + enabled: boolean; + required_status_checks: { + enforcement_level: string; + contexts: string[]; + }; + }; + protection_url: string; +} +declare type ReposGetBranchProtectionEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetBranchProtectionRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetBranchProtectionResponseData { + url: string; + required_status_checks: { + url: string; + strict: boolean; + contexts: string[]; + contexts_url: string; + }; + enforce_admins: { + url: string; + enabled: boolean; + }; + required_pull_request_reviews: { + url: string; + dismissal_restrictions: { + url: string; + users_url: string; + teams_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + }; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count: number; + }; + restrictions: { + url: string; + users_url: string; + teams_url: string; + apps_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + apps: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }[]; + }; + required_linear_history: { + enabled: boolean; + }; + allow_force_pushes: { + enabled: boolean; + }; + allow_deletions: { + enabled: boolean; + }; +} +declare type ReposUpdateBranchProtectionEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * Require status checks to pass before merging. Set to `null` to disable. + */ + required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null; + /** + * Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + */ + enforce_admins: boolean | null; + /** + * Require at least one approving review on a pull request, before merging. Set to `null` to disable. + */ + required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null; + /** + * Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + */ + restrictions: ReposUpdateBranchProtectionParamsRestrictions | null; + /** + * Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. + */ + required_linear_history?: boolean; + /** + * Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." + */ + allow_force_pushes?: boolean | null; + /** + * Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. + */ + allow_deletions?: boolean; +}; +declare type ReposUpdateBranchProtectionRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/branches/:branch/protection"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateBranchProtectionResponseData { + url: string; + required_status_checks: { + url: string; + strict: boolean; + contexts: string[]; + contexts_url: string; + }; + enforce_admins: { + url: string; + enabled: boolean; + }; + required_pull_request_reviews: { + url: string; + dismissal_restrictions: { + url: string; + users_url: string; + teams_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + }; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count: number; + }; + restrictions: { + url: string; + users_url: string; + teams_url: string; + apps_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + apps: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }[]; + }; + required_linear_history: { + enabled: boolean; + }; + allow_force_pushes: { + enabled: boolean; + }; + allow_deletions: { + enabled: boolean; + }; +} +declare type ReposRemoveBranchProtectionEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposRemoveBranchProtectionRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetProtectedBranchAdminEnforcementEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetProtectedBranchAdminEnforcementRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetProtectedBranchAdminEnforcementResponseData { + url: string; + enabled: boolean; +} +declare type ReposAddProtectedBranchAdminEnforcementEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposAddProtectedBranchAdminEnforcementRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposAddProtectedBranchAdminEnforcementResponseData { + url: string; + enabled: boolean; +} +declare type ReposRemoveProtectedBranchAdminEnforcementEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposRemoveProtectedBranchAdminEnforcementRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetProtectedBranchPullRequestReviewEnforcementResponseData { + url: string; + dismissal_restrictions: { + url: string; + users_url: string; + teams_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + }; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count: number; +} +declare type ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. + */ + dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions; + /** + * Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. + */ + dismiss_stale_reviews?: boolean; + /** + * Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed. + */ + require_code_owner_reviews?: boolean; + /** + * Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6. + */ + required_approving_review_count?: number; +}; +declare type ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseData { + url: string; + dismissal_restrictions: { + url: string; + users_url: string; + teams_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + }; + dismiss_stale_reviews: boolean; + require_code_owner_reviews: boolean; + required_approving_review_count: number; +} +declare type ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetProtectedBranchRequiredSignaturesEndpoint = { + owner: string; + repo: string; + branch: string; +} & RequiredPreview<"zzzax">; +declare type ReposGetProtectedBranchRequiredSignaturesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetProtectedBranchRequiredSignaturesResponseData { + url: string; + enabled: boolean; +} +declare type ReposAddProtectedBranchRequiredSignaturesEndpoint = { + owner: string; + repo: string; + branch: string; +} & RequiredPreview<"zzzax">; +declare type ReposAddProtectedBranchRequiredSignaturesRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposAddProtectedBranchRequiredSignaturesResponseData { + url: string; + enabled: boolean; +} +declare type ReposRemoveProtectedBranchRequiredSignaturesEndpoint = { + owner: string; + repo: string; + branch: string; +} & RequiredPreview<"zzzax">; +declare type ReposRemoveProtectedBranchRequiredSignaturesRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetProtectedBranchRequiredStatusChecksEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetProtectedBranchRequiredStatusChecksRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetProtectedBranchRequiredStatusChecksResponseData { + url: string; + strict: boolean; + contexts: string[]; + contexts_url: string; +} +declare type ReposUpdateProtectedBranchRequiredStatusChecksEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * Require branches to be up to date before merging. + */ + strict?: boolean; + /** + * The list of status checks to require in order to merge into this branch + */ + contexts?: string[]; +}; +declare type ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateProtectedBranchRequiredStatusChecksResponseData { + url: string; + strict: boolean; + contexts: string[]; + contexts_url: string; +} +declare type ReposRemoveProtectedBranchRequiredStatusChecksEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListProtectedBranchRequiredStatusChecksContextsEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListProtectedBranchRequiredStatusChecksContextsResponseData = string[]; +declare type ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +declare type ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposReplaceProtectedBranchRequiredStatusChecksContextsResponseData = string[]; +declare type ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +declare type ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposAddProtectedBranchRequiredStatusChecksContextsResponseData = string[]; +declare type ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * contexts parameter + */ + contexts: string[]; +}; +declare type ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposRemoveProtectedBranchRequiredStatusChecksContextsResponseData = string[]; +declare type ReposGetProtectedBranchRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetProtectedBranchRestrictionsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetProtectedBranchRestrictionsResponseData { + url: string; + users_url: string; + teams_url: string; + apps_url: string; + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + apps: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }[]; +} +declare type ReposRemoveProtectedBranchRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposRemoveProtectedBranchRestrictionsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetAppsWithAccessToProtectedBranchEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetAppsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetAppsWithAccessToProtectedBranchResponseData = { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; +}[]; +declare type ReposReplaceProtectedBranchAppRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +declare type ReposReplaceProtectedBranchAppRestrictionsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposReplaceProtectedBranchAppRestrictionsResponseData = { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; +}[]; +declare type ReposAddProtectedBranchAppRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +declare type ReposAddProtectedBranchAppRestrictionsRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposAddProtectedBranchAppRestrictionsResponseData = { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; +}[]; +declare type ReposRemoveProtectedBranchAppRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * apps parameter + */ + apps: string[]; +}; +declare type ReposRemoveProtectedBranchAppRestrictionsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposRemoveProtectedBranchAppRestrictionsResponseData = { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; +}[]; +declare type ReposGetTeamsWithAccessToProtectedBranchEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetTeamsWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetTeamsWithAccessToProtectedBranchResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type ReposReplaceProtectedBranchTeamRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +declare type ReposReplaceProtectedBranchTeamRestrictionsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposReplaceProtectedBranchTeamRestrictionsResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type ReposAddProtectedBranchTeamRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +declare type ReposAddProtectedBranchTeamRestrictionsRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposAddProtectedBranchTeamRestrictionsResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type ReposRemoveProtectedBranchTeamRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * teams parameter + */ + teams: string[]; +}; +declare type ReposRemoveProtectedBranchTeamRestrictionsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposRemoveProtectedBranchTeamRestrictionsResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type ReposGetUsersWithAccessToProtectedBranchEndpoint = { + owner: string; + repo: string; + branch: string; +}; +declare type ReposGetUsersWithAccessToProtectedBranchRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetUsersWithAccessToProtectedBranchResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type ReposReplaceProtectedBranchUserRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * users parameter + */ + users: string[]; +}; +declare type ReposReplaceProtectedBranchUserRestrictionsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposReplaceProtectedBranchUserRestrictionsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type ReposAddProtectedBranchUserRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * users parameter + */ + users: string[]; +}; +declare type ReposAddProtectedBranchUserRestrictionsRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposAddProtectedBranchUserRestrictionsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type ReposRemoveProtectedBranchUserRestrictionsEndpoint = { + owner: string; + repo: string; + branch: string; + /** + * users parameter + */ + users: string[]; +}; +declare type ReposRemoveProtectedBranchUserRestrictionsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposRemoveProtectedBranchUserRestrictionsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type ChecksCreateEndpoint = { + owner: string; + repo: string; + /** + * The name of the check. For example, "code-coverage". + */ + name: string; + /** + * The SHA of the commit. + */ + head_sha: string; + /** + * The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. + */ + details_url?: string; + /** + * A reference for the run on the integrator's system. + */ + external_id?: string; + /** + * The current status. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`. + */ + conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required"; + /** + * The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** + * Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description. + */ + output?: ChecksCreateParamsOutput; + /** + * Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + */ + actions?: ChecksCreateParamsActions[]; +} & RequiredPreview<"antiope">; +declare type ChecksCreateRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/check-runs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksCreateResponseData { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: { + title: string; + summary: string; + text: string; + }; + name: string; + check_suite: { + id: number; + }; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + pull_requests: { + url: string; + id: number; + number: number; + head: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + }[]; +} +declare type ChecksUpdateEndpoint = { + owner: string; + repo: string; + check_run_id: number; + /** + * The name of the check. For example, "code-coverage". + */ + name?: string; + /** + * The URL of the integrator's site that has the full details of the check. + */ + details_url?: string; + /** + * A reference for the run on the integrator's system. + */ + external_id?: string; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * The current status. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`. + */ + conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required"; + /** + * The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** + * Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description. + */ + output?: ChecksUpdateParamsOutput; + /** + * Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." + */ + actions?: ChecksUpdateParamsActions[]; +} & RequiredPreview<"antiope">; +declare type ChecksUpdateRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/check-runs/:check_run_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksUpdateResponseData { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: { + title: string; + summary: string; + text: string; + annotations_count: number; + annotations_url: string; + }; + name: string; + check_suite: { + id: number; + }; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + pull_requests: { + url: string; + id: number; + number: number; + head: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + }[]; +} +declare type ChecksGetEndpoint = { + owner: string; + repo: string; + check_run_id: number; +} & RequiredPreview<"antiope">; +declare type ChecksGetRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/check-runs/:check_run_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksGetResponseData { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: { + title: string; + summary: string; + text: string; + annotations_count: number; + annotations_url: string; + }; + name: string; + check_suite: { + id: number; + }; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + pull_requests: { + url: string; + id: number; + number: number; + head: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + }[]; +} +declare type ChecksListAnnotationsEndpoint = { + owner: string; + repo: string; + check_run_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"antiope">; +declare type ChecksListAnnotationsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/check-runs/:check_run_id/annotations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ChecksListAnnotationsResponseData = { + path: string; + start_line: number; + end_line: number; + start_column: number; + end_column: number; + annotation_level: string; + title: string; + message: string; + raw_details: string; +}[]; +declare type ChecksCreateSuiteEndpoint = { + owner: string; + repo: string; + /** + * The sha of the head commit. + */ + head_sha: string; +} & RequiredPreview<"antiope">; +declare type ChecksCreateSuiteRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/check-suites"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksCreateSuiteResponseData { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + status: string; + conclusion: string; + url: string; + before: string; + after: string; + pull_requests: unknown[]; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +} +declare type ChecksSetSuitesPreferencesEndpoint = { + owner: string; + repo: string; + /** + * Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details. + */ + auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]; +} & RequiredPreview<"antiope">; +declare type ChecksSetSuitesPreferencesRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/check-suites/preferences"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksSetSuitesPreferencesResponseData { + preferences: { + auto_trigger_checks: { + app_id: number; + setting: boolean; + }[]; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +} +declare type ChecksGetSuiteEndpoint = { + owner: string; + repo: string; + check_suite_id: number; +} & RequiredPreview<"antiope">; +declare type ChecksGetSuiteRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/check-suites/:check_suite_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksGetSuiteResponseData { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + status: string; + conclusion: string; + url: string; + before: string; + after: string; + pull_requests: unknown[]; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +} +declare type ChecksListForSuiteEndpoint = { + owner: string; + repo: string; + check_suite_id: number; + /** + * Returns check runs with the specified `name`. + */ + check_name?: string; + /** + * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"antiope">; +declare type ChecksListForSuiteRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksListForSuiteResponseData { + total_count: number; + check_runs: { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: { + title: string; + summary: string; + text: string; + annotations_count: number; + annotations_url: string; + }; + name: string; + check_suite: { + id: number; + }; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + pull_requests: { + url: string; + id: number; + number: number; + head: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + }[]; + }[]; +} +declare type ChecksRerequestSuiteEndpoint = { + owner: string; + repo: string; + check_suite_id: number; +} & RequiredPreview<"antiope">; +declare type ChecksRerequestSuiteRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type CodeScanningListAlertsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Set to `closed` to list only closed code scanning alerts. + */ + state?: string; + /** + * Returns a list of code scanning alerts for a specific brach reference. The `ref` must be formatted as `heads/`. + */ + ref?: string; +}; +declare type CodeScanningListAlertsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/code-scanning/alerts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type CodeScanningListAlertsForRepoResponseData = { + rule_id: string; + rule_severity: string; + rule_description: string; + tool: string; + created_at: string; + open: boolean; + closed_by: string; + closed_at: string; + url: string; + html_url: string; +}[]; +declare type CodeScanningGetAlertEndpoint = { + owner: string; + repo: string; + alert_id: number; +}; +declare type CodeScanningGetAlertRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/code-scanning/alerts/:alert_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface CodeScanningGetAlertResponseData { + rule_id: string; + rule_severity: string; + rule_description: string; + tool: string; + created_at: string; + open: boolean; + closed_by: string; + closed_at: string; + url: string; + html_url: string; +} +declare type ReposListCollaboratorsEndpoint = { + owner: string; + repo: string; + /** + * Filter collaborators returned by their affiliation. Can be one of: + * \* `outside`: All outside collaborators of an organization-owned repository. + * \* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. + * \* `all`: All collaborators the authenticated user can see. + */ + affiliation?: "outside" | "direct" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListCollaboratorsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/collaborators"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListCollaboratorsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + permissions: { + pull: boolean; + push: boolean; + admin: boolean; + }; +}[]; +declare type ReposCheckCollaboratorEndpoint = { + owner: string; + repo: string; + username: string; +}; +declare type ReposCheckCollaboratorRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposAddCollaboratorEndpoint = { + owner: string; + repo: string; + username: string; + /** + * The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: + * \* `pull` - can pull, but not push to or administer this repository. + * \* `push` - can pull and push, but not administer this repository. + * \* `admin` - can pull, push and administer this repository. + * \* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. + * \* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. + */ + permission?: "pull" | "push" | "admin" | "maintain" | "triage"; +}; +declare type ReposAddCollaboratorRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposAddCollaboratorResponseData { + id: number; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + invitee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + permissions: string; + created_at: string; + url: string; + html_url: string; +} +declare type ReposRemoveCollaboratorEndpoint = { + owner: string; + repo: string; + username: string; +}; +declare type ReposRemoveCollaboratorRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/collaborators/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetCollaboratorPermissionLevelEndpoint = { + owner: string; + repo: string; + username: string; +}; +declare type ReposGetCollaboratorPermissionLevelRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/collaborators/:username/permission"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetCollaboratorPermissionLevelResponseData { + permission: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type ReposListCommitCommentsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListCommitCommentsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListCommitCommentsResponseData = { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type ReposGetCommitCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; +}; +declare type ReposGetCommitCommentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetCommitCommentResponseData { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type ReposUpdateCommitCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * The contents of the comment + */ + body: string; +}; +declare type ReposUpdateCommitCommentRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateCommitCommentResponseData { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type ReposDeleteCommitCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; +}; +declare type ReposDeleteCommitCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForCommitCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForCommitCommentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/comments/:comment_id/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForCommitCommentResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForCommitCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForCommitCommentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/comments/:comment_id/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForCommitCommentResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsDeleteForCommitCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteForCommitCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListCommitsEndpoint = { + owner: string; + repo: string; + /** + * SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`). + */ + sha?: string; + /** + * Only commits containing this file path will be returned. + */ + path?: string; + /** + * GitHub login or email address by which to filter by commit author. + */ + author?: string; + /** + * Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + until?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListCommitsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListCommitsResponseData = { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + name: string; + email: string; + date: string; + }; + committer: { + name: string; + email: string; + date: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + sha: string; + }[]; +}[]; +declare type ReposListBranchesForHeadCommitEndpoint = { + owner: string; + repo: string; + commit_sha: string; +} & RequiredPreview<"groot">; +declare type ReposListBranchesForHeadCommitRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:commit_sha/branches-where-head"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListBranchesForHeadCommitResponseData = { + name: string; + commit: { + sha: string; + url: string; + }; + protected: boolean; +}[]; +declare type ReposListCommentsForCommitEndpoint = { + owner: string; + repo: string; + commit_sha: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListCommentsForCommitRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:commit_sha/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListCommentsForCommitResponseData = { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type ReposCreateCommitCommentEndpoint = { + owner: string; + repo: string; + commit_sha: string; + /** + * The contents of the comment. + */ + body: string; + /** + * Relative path of the file to comment on. + */ + path?: string; + /** + * Line index in the diff to comment on. + */ + position?: number; + /** + * **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. + */ + line?: number; +}; +declare type ReposCreateCommitCommentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/commits/:commit_sha/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateCommitCommentResponseData { + html_url: string; + url: string; + id: number; + node_id: string; + body: string; + path: string; + position: number; + line: number; + commit_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type ReposListPullRequestsAssociatedWithCommitEndpoint = { + owner: string; + repo: string; + commit_sha: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"groot">; +declare type ReposListPullRequestsAssociatedWithCommitRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:commit_sha/pulls"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListPullRequestsAssociatedWithCommitResponseData = { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_reviewers: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + head: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + base: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + issue: { + href: string; + }; + comments: { + href: string; + }; + review_comments: { + href: string; + }; + review_comment: { + href: string; + }; + commits: { + href: string; + }; + statuses: { + href: string; + }; + }; + author_association: string; + draft: boolean; +}[]; +declare type ReposGetCommitEndpoint = { + owner: string; + repo: string; + ref: string; +}; +declare type ReposGetCommitRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:ref"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetCommitResponseData { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + name: string; + email: string; + date: string; + }; + committer: { + name: string; + email: string; + date: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + sha: string; + }[]; + stats: { + additions: number; + deletions: number; + total: number; + }; + files: { + filename: string; + additions: number; + deletions: number; + changes: number; + status: string; + raw_url: string; + blob_url: string; + patch: string; + }[]; +} +declare type ChecksListForRefEndpoint = { + owner: string; + repo: string; + ref: string; + /** + * Returns check runs with the specified `name`. + */ + check_name?: string; + /** + * Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`. + */ + status?: "queued" | "in_progress" | "completed"; + /** + * Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`. + */ + filter?: "latest" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"antiope">; +declare type ChecksListForRefRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:ref/check-runs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksListForRefResponseData { + total_count: number; + check_runs: { + id: number; + head_sha: string; + node_id: string; + external_id: string; + url: string; + html_url: string; + details_url: string; + status: string; + conclusion: string; + started_at: string; + completed_at: string; + output: { + title: string; + summary: string; + text: string; + annotations_count: number; + annotations_url: string; + }; + name: string; + check_suite: { + id: number; + }; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + pull_requests: { + url: string; + id: number; + number: number; + head: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + id: number; + url: string; + name: string; + }; + }; + }[]; + }[]; +} +declare type ChecksListSuitesForRefEndpoint = { + owner: string; + repo: string; + ref: string; + /** + * Filters check suites by GitHub App `id`. + */ + app_id?: number; + /** + * Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/). + */ + check_name?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"antiope">; +declare type ChecksListSuitesForRefRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:ref/check-suites"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ChecksListSuitesForRefResponseData { + total_count: number; + check_suites: { + id: number; + node_id: string; + head_branch: string; + head_sha: string; + status: string; + conclusion: string; + url: string; + before: string; + after: string; + pull_requests: unknown[]; + app: { + id: number; + slug: string; + node_id: string; + owner: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + name: string; + description: string; + external_url: string; + html_url: string; + created_at: string; + updated_at: string; + permissions: { + metadata: string; + contents: string; + issues: string; + single_file: string; + }; + events: string[]; + }; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }[]; +} +declare type ReposGetCombinedStatusForRefEndpoint = { + owner: string; + repo: string; + ref: string; +}; +declare type ReposGetCombinedStatusForRefRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:ref/status"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetCombinedStatusForRefResponseData { + state: string; + statuses: { + url: string; + avatar_url: string; + id: number; + node_id: string; + state: string; + description: string; + target_url: string; + context: string; + created_at: string; + updated_at: string; + }[]; + sha: string; + total_count: number; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + commit_url: string; + url: string; +} +declare type ReposListStatusesForRefEndpoint = { + owner: string; + repo: string; + ref: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListStatusesForRefRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/commits/:ref/statuses"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListStatusesForRefResponseData = { + url: string; + avatar_url: string; + id: number; + node_id: string; + state: string; + description: string; + target_url: string; + context: string; + created_at: string; + updated_at: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +}[]; +declare type CodesOfConductGetForRepoEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"scarlet-witch">; +declare type CodesOfConductGetForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/community/code_of_conduct"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface CodesOfConductGetForRepoResponseData { + key: string; + name: string; + url: string; + body: string; +} +declare type ReposRetrieveCommunityProfileMetricsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposRetrieveCommunityProfileMetricsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/community/profile"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposRetrieveCommunityProfileMetricsResponseData { + health_percentage: number; + description: string; + documentation: boolean; + files: { + code_of_conduct: { + name: string; + key: string; + url: string; + html_url: string; + }; + contributing: { + url: string; + html_url: string; + }; + issue_template: { + url: string; + html_url: string; + }; + pull_request_template: { + url: string; + html_url: string; + }; + license: { + name: string; + key: string; + spdx_id: string; + url: string; + html_url: string; + }; + readme: { + url: string; + html_url: string; + }; + }; + updated_at: string; +} +declare type ReposCompareCommitsEndpoint = { + owner: string; + repo: string; + base: string; + head: string; +}; +declare type ReposCompareCommitsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/compare/:base...:head"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCompareCommitsResponseData { + url: string; + html_url: string; + permalink_url: string; + diff_url: string; + patch_url: string; + base_commit: { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + name: string; + email: string; + date: string; + }; + committer: { + name: string; + email: string; + date: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + sha: string; + }[]; + }; + merge_base_commit: { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + name: string; + email: string; + date: string; + }; + committer: { + name: string; + email: string; + date: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + sha: string; + }[]; + }; + status: string; + ahead_by: number; + behind_by: number; + total_commits: number; + commits: { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + name: string; + email: string; + date: string; + }; + committer: { + name: string; + email: string; + date: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + sha: string; + }[]; + }[]; + files: { + sha: string; + filename: string; + status: string; + additions: number; + deletions: number; + changes: number; + blob_url: string; + raw_url: string; + contents_url: string; + patch: string; + }[]; +} +declare type ReposGetContentsEndpoint = { + owner: string; + repo: string; + path: string; + /** + * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) + */ + ref?: string; +}; +declare type ReposGetContentsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/contents/:path"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetContentsResponseData { + type: string; + encoding: string; + size: number; + name: string; + path: string; + content: string; + sha: string; + url: string; + git_url: string; + html_url: string; + download_url: string; + _links: { + git: string; + self: string; + html: string; + }; +} +declare type ReposCreateOrUpdateFileEndpoint = { + owner: string; + repo: string; + path: string; + /** + * The commit message. + */ + message: string; + /** + * The new file content, using Base64 encoding. + */ + content: string; + /** + * **Required if you are updating a file**. The blob SHA of the file being replaced. + */ + sha?: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * The person that committed the file. Default: the authenticated user. + */ + committer?: ReposCreateOrUpdateFileParamsCommitter; + /** + * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. + */ + author?: ReposCreateOrUpdateFileParamsAuthor; +}; +declare type ReposCreateOrUpdateFileRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/contents/:path"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateOrUpdateFileResponseData { + content: { + name: string; + path: string; + sha: string; + size: number; + url: string; + html_url: string; + git_url: string; + download_url: string; + type: string; + _links: { + self: string; + git: string; + html: string; + }; + }; + commit: { + sha: string; + node_id: string; + url: string; + html_url: string; + author: { + date: string; + name: string; + email: string; + }; + committer: { + date: string; + name: string; + email: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + parents: { + url: string; + html_url: string; + sha: string; + }[]; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; +} +export interface ReposCreateOrUpdateFileResponse201Data { + content: { + name: string; + path: string; + sha: string; + size: number; + url: string; + html_url: string; + git_url: string; + download_url: string; + type: string; + _links: { + self: string; + git: string; + html: string; + }; + }; + commit: { + sha: string; + node_id: string; + url: string; + html_url: string; + author: { + date: string; + name: string; + email: string; + }; + committer: { + date: string; + name: string; + email: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + parents: { + url: string; + html_url: string; + sha: string; + }[]; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; +} +declare type ReposDeleteFileEndpoint = { + owner: string; + repo: string; + path: string; + /** + * The commit message. + */ + message: string; + /** + * The blob SHA of the file being replaced. + */ + sha: string; + /** + * The branch name. Default: the repository’s default branch (usually `master`) + */ + branch?: string; + /** + * object containing information about the committer. + */ + committer?: ReposDeleteFileParamsCommitter; + /** + * object containing information about the author. + */ + author?: ReposDeleteFileParamsAuthor; +}; +declare type ReposDeleteFileRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/contents/:path"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposDeleteFileResponseData { + content: string; + commit: { + sha: string; + node_id: string; + url: string; + html_url: string; + author: { + date: string; + name: string; + email: string; + }; + committer: { + date: string; + name: string; + email: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + parents: { + url: string; + html_url: string; + sha: string; + }[]; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; +} +declare type ReposListContributorsEndpoint = { + owner: string; + repo: string; + /** + * Set to `1` or `true` to include anonymous contributors in results. + */ + anon?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListContributorsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/contributors"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListContributorsResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + contributions: number; +}[]; +declare type ReposListDeploymentsEndpoint = { + owner: string; + repo: string; + /** + * The SHA recorded at creation time. + */ + sha?: string; + /** + * The name of the ref. This can be a branch, tag, or SHA. + */ + ref?: string; + /** + * The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). + */ + task?: string; + /** + * The name of the environment that was deployed to (e.g., `staging` or `production`). + */ + environment?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListDeploymentsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/deployments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListDeploymentsResponseData = { + url: string; + id: number; + node_id: string; + sha: string; + ref: string; + task: string; + payload: { + deploy: string; + }; + original_environment: string; + environment: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + statuses_url: string; + repository_url: string; + transient_environment: boolean; + production_environment: boolean; +}[]; +declare type ReposCreateDeploymentEndpoint = { + owner: string; + repo: string; + /** + * The ref to deploy. This can be a branch, tag, or SHA. + */ + ref: string; + /** + * Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). + */ + task?: string; + /** + * Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. + */ + auto_merge?: boolean; + /** + * The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. + */ + required_contexts?: string[]; + /** + * JSON payload with extra information about the deployment. + */ + payload?: string; + /** + * Name for the target deployment environment (e.g., `production`, `staging`, `qa`). + */ + environment?: string; + /** + * Short description of the deployment. + */ + description?: string; + /** + * Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + transient_environment?: boolean; + /** + * Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + production_environment?: boolean; +}; +declare type ReposCreateDeploymentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/deployments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateDeploymentResponseData { + url: string; + id: number; + node_id: string; + sha: string; + ref: string; + task: string; + payload: { + deploy: string; + }; + original_environment: string; + environment: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + statuses_url: string; + repository_url: string; + transient_environment: boolean; + production_environment: boolean; +} +export interface ReposCreateDeploymentResponse202Data { + message: string; +} +export interface ReposCreateDeploymentResponse409Data { + message: string; +} +declare type ReposGetDeploymentEndpoint = { + owner: string; + repo: string; + deployment_id: number; +}; +declare type ReposGetDeploymentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/deployments/:deployment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetDeploymentResponseData { + url: string; + id: number; + node_id: string; + sha: string; + ref: string; + task: string; + payload: { + deploy: string; + }; + original_environment: string; + environment: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + statuses_url: string; + repository_url: string; + transient_environment: boolean; + production_environment: boolean; +} +declare type ReposDeleteDeploymentEndpoint = { + owner: string; + repo: string; + deployment_id: number; +}; +declare type ReposDeleteDeploymentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/deployments/:deployment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListDeploymentStatusesEndpoint = { + owner: string; + repo: string; + deployment_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListDeploymentStatusesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/deployments/:deployment_id/statuses"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListDeploymentStatusesResponseData = { + url: string; + id: number; + node_id: string; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + description: string; + environment: string; + target_url: string; + created_at: string; + updated_at: string; + deployment_url: string; + repository_url: string; + environment_url: string; + log_url: string; +}[]; +declare type ReposCreateDeploymentStatusEndpoint = { + owner: string; + repo: string; + deployment_id: number; + /** + * The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. + */ + state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; + /** + * The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + */ + target_url?: string; + /** + * The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + log_url?: string; + /** + * A short description of the status. The maximum description length is 140 characters. + */ + description?: string; + /** + * Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + */ + environment?: "production" | "staging" | "qa"; + /** + * Sets the URL for accessing your environment. Default: `""` + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + environment_url?: string; + /** + * Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` + * **Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. + * **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. + */ + auto_inactive?: boolean; +}; +declare type ReposCreateDeploymentStatusRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/deployments/:deployment_id/statuses"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateDeploymentStatusResponseData { + url: string; + id: number; + node_id: string; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + description: string; + environment: string; + target_url: string; + created_at: string; + updated_at: string; + deployment_url: string; + repository_url: string; + environment_url: string; + log_url: string; +} +declare type ReposGetDeploymentStatusEndpoint = { + owner: string; + repo: string; + deployment_id: number; + status_id: number; +}; +declare type ReposGetDeploymentStatusRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetDeploymentStatusResponseData { + url: string; + id: number; + node_id: string; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + description: string; + environment: string; + target_url: string; + created_at: string; + updated_at: string; + deployment_url: string; + repository_url: string; + environment_url: string; + log_url: string; +} +declare type ReposCreateDispatchEventEndpoint = { + owner: string; + repo: string; + /** + * **Required:** A custom webhook event name. + */ + event_type?: string; + /** + * JSON payload with extra information about the webhook event that your action or worklow may use. + */ + client_payload?: ReposCreateDispatchEventParamsClientPayload; +}; +declare type ReposCreateDispatchEventRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/dispatches"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListDownloadsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListDownloadsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/downloads"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListDownloadsResponseData = { + url: string; + html_url: string; + id: number; + name: string; + description: string; + size: number; + download_count: number; + content_type: string; +}[]; +declare type ReposGetDownloadEndpoint = { + owner: string; + repo: string; + download_id: number; +}; +declare type ReposGetDownloadRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/downloads/:download_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetDownloadResponseData { + url: string; + html_url: string; + id: number; + name: string; + description: string; + size: number; + download_count: number; + content_type: string; +} +declare type ReposDeleteDownloadEndpoint = { + owner: string; + repo: string; + download_id: number; +}; +declare type ReposDeleteDownloadRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/downloads/:download_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListRepoEventsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListRepoEventsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListForksEndpoint = { + owner: string; + repo: string; + /** + * The sort order. Can be either `newest`, `oldest`, or `stargazers`. + */ + sort?: "newest" | "oldest" | "stargazers"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListForksRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/forks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListForksResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type ReposCreateForkEndpoint = { + owner: string; + repo: string; + /** + * Optional parameter to specify the organization name if forking into an organization. + */ + organization?: string; +}; +declare type ReposCreateForkRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/forks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateForkResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +} +declare type GitCreateBlobEndpoint = { + owner: string; + repo: string; + /** + * The new blob's content. + */ + content: string; + /** + * The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + */ + encoding?: string; +}; +declare type GitCreateBlobRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/git/blobs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitCreateBlobResponseData { + url: string; + sha: string; +} +declare type GitGetBlobEndpoint = { + owner: string; + repo: string; + file_sha: string; +}; +declare type GitGetBlobRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/git/blobs/:file_sha"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitGetBlobResponseData { + content: string; + encoding: string; + url: string; + sha: string; + size: number; +} +declare type GitCreateCommitEndpoint = { + owner: string; + repo: string; + /** + * The commit message + */ + message: string; + /** + * The SHA of the tree object this commit points to + */ + tree: string; + /** + * The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. + */ + parents: string[]; + /** + * Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. + */ + author?: GitCreateCommitParamsAuthor; + /** + * Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. + */ + committer?: GitCreateCommitParamsCommitter; + /** + * The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. + */ + signature?: string; +}; +declare type GitCreateCommitRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/git/commits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitCreateCommitResponseData { + sha: string; + node_id: string; + url: string; + author: { + date: string; + name: string; + email: string; + }; + committer: { + date: string; + name: string; + email: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + parents: { + url: string; + sha: string; + }[]; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; +} +declare type GitGetCommitEndpoint = { + owner: string; + repo: string; + commit_sha: string; +}; +declare type GitGetCommitRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/git/commits/:commit_sha"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitGetCommitResponseData { + sha: string; + node_id: string; + url: string; + author: { + date: string; + name: string; + email: string; + }; + committer: { + date: string; + name: string; + email: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + parents: { + url: string; + sha: string; + }[]; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; +} +declare type GitListMatchingRefsEndpoint = { + owner: string; + repo: string; + ref: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GitListMatchingRefsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/git/matching-refs/:ref"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GitListMatchingRefsResponseData = { + ref: string; + node_id: string; + url: string; + object: { + type: string; + sha: string; + url: string; + }; +}[]; +declare type GitGetRefEndpoint = { + owner: string; + repo: string; + ref: string; +}; +declare type GitGetRefRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/git/ref/:ref"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitGetRefResponseData { + ref: string; + node_id: string; + url: string; + object: { + type: string; + sha: string; + url: string; + }; +} +declare type GitCreateRefEndpoint = { + owner: string; + repo: string; + /** + * The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. + */ + ref: string; + /** + * The SHA1 value for this reference. + */ + sha: string; +}; +declare type GitCreateRefRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/git/refs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitCreateRefResponseData { + ref: string; + node_id: string; + url: string; + object: { + type: string; + sha: string; + url: string; + }; +} +declare type GitUpdateRefEndpoint = { + owner: string; + repo: string; + ref: string; + /** + * The SHA1 value to set this reference to + */ + sha: string; + /** + * Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. + */ + force?: boolean; +}; +declare type GitUpdateRefRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/git/refs/:ref"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitUpdateRefResponseData { + ref: string; + node_id: string; + url: string; + object: { + type: string; + sha: string; + url: string; + }; +} +declare type GitDeleteRefEndpoint = { + owner: string; + repo: string; + ref: string; +}; +declare type GitDeleteRefRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/git/refs/:ref"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GitCreateTagEndpoint = { + owner: string; + repo: string; + /** + * The tag's name. This is typically a version (e.g., "v0.0.1"). + */ + tag: string; + /** + * The tag message. + */ + message: string; + /** + * The SHA of the git object this is tagging. + */ + object: string; + /** + * The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. + */ + type: "commit" | "tree" | "blob"; + /** + * An object with information about the individual creating the tag. + */ + tagger?: GitCreateTagParamsTagger; +}; +declare type GitCreateTagRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/git/tags"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitCreateTagResponseData { + node_id: string; + tag: string; + sha: string; + url: string; + message: string; + tagger: { + name: string; + email: string; + date: string; + }; + object: { + type: string; + sha: string; + url: string; + }; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; +} +declare type GitGetTagEndpoint = { + owner: string; + repo: string; + tag_sha: string; +}; +declare type GitGetTagRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/git/tags/:tag_sha"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitGetTagResponseData { + node_id: string; + tag: string; + sha: string; + url: string; + message: string; + tagger: { + name: string; + email: string; + date: string; + }; + object: { + type: string; + sha: string; + url: string; + }; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; +} +declare type GitCreateTreeEndpoint = { + owner: string; + repo: string; + /** + * Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. + */ + tree: GitCreateTreeParamsTree[]; + /** + * The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted. + */ + base_tree?: string; +}; +declare type GitCreateTreeRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/git/trees"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitCreateTreeResponseData { + sha: string; + url: string; + tree: { + path: string; + mode: string; + type: string; + size: number; + sha: string; + url: string; + }[]; +} +declare type GitGetTreeEndpoint = { + owner: string; + repo: string; + tree_sha: string; + /** + * Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. + */ + recursive?: string; +}; +declare type GitGetTreeRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/git/trees/:tree_sha"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface GitGetTreeResponseData { + sha: string; + url: string; + tree: { + path: string; + mode: string; + type: string; + size: number; + sha: string; + url: string; + }[]; + truncated: boolean; +} +declare type ReposListHooksEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListHooksRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/hooks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListHooksResponseData = { + type: string; + id: number; + name: string; + active: boolean; + events: string[]; + config: { + content_type: string; + insecure_ssl: string; + url: string; + }; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: { + code: string; + status: string; + message: string; + }; +}[]; +declare type ReposCreateHookEndpoint = { + owner: string; + repo: string; + /** + * Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. + */ + name?: string; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). + */ + config: ReposCreateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/webhooks/event-payloads) the hook is triggered for. + */ + events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +declare type ReposCreateHookRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/hooks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateHookResponseData { + type: string; + id: number; + name: string; + active: boolean; + events: string[]; + config: { + content_type: string; + insecure_ssl: string; + url: string; + }; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: { + code: string; + status: string; + message: string; + }; +} +declare type ReposGetHookEndpoint = { + owner: string; + repo: string; + hook_id: number; +}; +declare type ReposGetHookRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/hooks/:hook_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetHookResponseData { + type: string; + id: number; + name: string; + active: boolean; + events: string[]; + config: { + content_type: string; + insecure_ssl: string; + url: string; + }; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: { + code: string; + status: string; + message: string; + }; +} +declare type ReposUpdateHookEndpoint = { + owner: string; + repo: string; + hook_id: number; + /** + * Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params). + */ + config?: ReposUpdateHookParamsConfig; + /** + * Determines what [events](https://developer.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. + */ + events?: string[]; + /** + * Determines a list of events to be added to the list of events that the Hook triggers for. + */ + add_events?: string[]; + /** + * Determines a list of events to be removed from the list of events that the Hook triggers for. + */ + remove_events?: string[]; + /** + * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + */ + active?: boolean; +}; +declare type ReposUpdateHookRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/hooks/:hook_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateHookResponseData { + type: string; + id: number; + name: string; + active: boolean; + events: string[]; + config: { + content_type: string; + insecure_ssl: string; + url: string; + }; + updated_at: string; + created_at: string; + url: string; + test_url: string; + ping_url: string; + last_response: { + code: string; + status: string; + message: string; + }; +} +declare type ReposDeleteHookEndpoint = { + owner: string; + repo: string; + hook_id: number; +}; +declare type ReposDeleteHookRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/hooks/:hook_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposPingHookEndpoint = { + owner: string; + repo: string; + hook_id: number; +}; +declare type ReposPingHookRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/hooks/:hook_id/pings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposTestPushHookEndpoint = { + owner: string; + repo: string; + hook_id: number; +}; +declare type ReposTestPushHookRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/hooks/:hook_id/tests"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsStartImportEndpoint = { + owner: string; + repo: string; + /** + * The URL of the originating repository. + */ + vcs_url: string; + /** + * The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. + */ + vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + /** + * If authentication is required, the username to provide to `vcs_url`. + */ + vcs_username?: string; + /** + * If authentication is required, the password to provide to `vcs_url`. + */ + vcs_password?: string; + /** + * For a tfvc import, the name of the project that is being imported. + */ + tfvc_project?: string; +}; +declare type MigrationsStartImportRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/import"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsStartImportResponseData { + vcs: string; + use_lfs: string; + vcs_url: string; + status: string; + status_text: string; + has_large_files: boolean; + large_files_size: number; + large_files_count: number; + authors_count: number; + percent: number; + commit_count: number; + url: string; + html_url: string; + authors_url: string; + repository_url: string; +} +declare type MigrationsGetImportStatusEndpoint = { + owner: string; + repo: string; +}; +declare type MigrationsGetImportStatusRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/import"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsGetImportStatusResponseData { + vcs: string; + use_lfs: string; + vcs_url: string; + status: string; + status_text: string; + has_large_files: boolean; + large_files_size: number; + large_files_count: number; + authors_count: number; + url: string; + html_url: string; + authors_url: string; + repository_url: string; +} +declare type MigrationsUpdateImportEndpoint = { + owner: string; + repo: string; + /** + * The username to provide to the originating repository. + */ + vcs_username?: string; + /** + * The password to provide to the originating repository. + */ + vcs_password?: string; +}; +declare type MigrationsUpdateImportRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/import"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsUpdateImportResponseData { + vcs: string; + use_lfs: string; + vcs_url: string; + status: string; + url: string; + html_url: string; + authors_url: string; + repository_url: string; +} +declare type MigrationsCancelImportEndpoint = { + owner: string; + repo: string; +}; +declare type MigrationsCancelImportRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/import"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsGetCommitAuthorsEndpoint = { + owner: string; + repo: string; + /** + * Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step. + */ + since?: string; +}; +declare type MigrationsGetCommitAuthorsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/import/authors"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type MigrationsGetCommitAuthorsResponseData = { + id: number; + remote_id: string; + remote_name: string; + email: string; + name: string; + url: string; + import_url: string; +}[]; +declare type MigrationsMapCommitAuthorEndpoint = { + owner: string; + repo: string; + author_id: number; + /** + * The new Git author email. + */ + email?: string; + /** + * The new Git author name. + */ + name?: string; +}; +declare type MigrationsMapCommitAuthorRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/import/authors/:author_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsMapCommitAuthorResponseData { + id: number; + remote_id: string; + remote_name: string; + email: string; + name: string; + url: string; + import_url: string; +} +declare type MigrationsGetLargeFilesEndpoint = { + owner: string; + repo: string; +}; +declare type MigrationsGetLargeFilesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/import/large_files"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type MigrationsGetLargeFilesResponseData = { + ref_name: string; + path: string; + oid: string; + size: number; +}[]; +declare type MigrationsSetLfsPreferenceEndpoint = { + owner: string; + repo: string; + /** + * Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import). + */ + use_lfs: "opt_in" | "opt_out"; +}; +declare type MigrationsSetLfsPreferenceRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/import/lfs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsSetLfsPreferenceResponseData { + vcs: string; + use_lfs: string; + vcs_url: string; + status: string; + status_text: string; + has_large_files: boolean; + large_files_size: number; + large_files_count: number; + authors_count: number; + url: string; + html_url: string; + authors_url: string; + repository_url: string; +} +declare type AppsGetRepoInstallationEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"machine-man">; +declare type AppsGetRepoInstallationRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/installation"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetRepoInstallationResponseData { + id: number; + account: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repository_selection: "all" | "selected"; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + checks: string; + metadata: string; + contents: string; + }; + events: string[]; + created_at: string; + updated_at: string; + single_file_name: string; +} +declare type InteractionsGetRestrictionsForRepoEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"sombra">; +declare type InteractionsGetRestrictionsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/interaction-limits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface InteractionsGetRestrictionsForRepoResponseData { + limit: string; + origin: string; + expires_at: string; +} +declare type InteractionsAddOrUpdateRestrictionsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`. + */ + limit: "existing_users" | "contributors_only" | "collaborators_only"; +} & RequiredPreview<"sombra">; +declare type InteractionsAddOrUpdateRestrictionsForRepoRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/interaction-limits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface InteractionsAddOrUpdateRestrictionsForRepoResponseData { + limit: string; + origin: string; + expires_at: string; +} +declare type InteractionsRemoveRestrictionsForRepoEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"sombra">; +declare type InteractionsRemoveRestrictionsForRepoRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/interaction-limits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListInvitationsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListInvitationsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListInvitationsResponseData = { + id: number; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + invitee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + permissions: string; + created_at: string; + url: string; + html_url: string; +}[]; +declare type ReposDeleteInvitationEndpoint = { + owner: string; + repo: string; + invitation_id: number; +}; +declare type ReposDeleteInvitationRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/invitations/:invitation_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposUpdateInvitationEndpoint = { + owner: string; + repo: string; + invitation_id: number; + /** + * The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. + */ + permissions?: "read" | "write" | "maintain" | "triage" | "admin"; +}; +declare type ReposUpdateInvitationRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/invitations/:invitation_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateInvitationResponseData { + id: number; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + invitee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + permissions: string; + created_at: string; + url: string; + html_url: string; +} +declare type IssuesListForRepoEndpoint = { + owner: string; + repo: string; + /** + * If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. + */ + milestone?: string; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. + */ + assignee?: string; + /** + * The user that created the issue. + */ + creator?: string; + /** + * A user that's mentioned in the issue. + */ + mentioned?: string; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListForRepoResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; +}[]; +declare type IssuesCreateEndpoint = { + owner: string; + repo: string; + /** + * The title of the issue. + */ + title: string; + /** + * The contents of the issue. + */ + body?: string; + /** + * Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ + */ + assignee?: string; + /** + * The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._ + */ + milestone?: number; + /** + * Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ + */ + labels?: string[]; + /** + * Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + */ + assignees?: string[]; +}; +declare type IssuesCreateRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/issues"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesCreateResponseData { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + closed_by: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type IssuesListCommentsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Either `created` or `updated`. + */ + sort?: "created" | "updated"; + /** + * Either `asc` or `desc`. Ignored without the `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListCommentsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListCommentsForRepoResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type IssuesGetCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; +}; +declare type IssuesGetCommentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesGetCommentResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type IssuesUpdateCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * The contents of the comment. + */ + body: string; +}; +declare type IssuesUpdateCommentRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/issues/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesUpdateCommentResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type IssuesDeleteCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; +}; +declare type IssuesDeleteCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForIssueCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForIssueCommentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForIssueCommentResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForIssueCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForIssueCommentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForIssueCommentResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsDeleteForIssueCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteForIssueCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesListEventsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListEventsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListEventsForRepoResponseData = { + id: number; + node_id: string; + url: string; + actor: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + event: string; + commit_id: string; + commit_url: string; + created_at: string; + issue: { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + }; +}[]; +declare type IssuesGetEventEndpoint = { + owner: string; + repo: string; + event_id: number; +}; +declare type IssuesGetEventRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/events/:event_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesGetEventResponseData { + id: number; + node_id: string; + url: string; + actor: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + event: string; + commit_id: string; + commit_url: string; + created_at: string; + issue: { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + }; +} +declare type IssuesGetEndpoint = { + owner: string; + repo: string; + issue_number: number; +}; +declare type IssuesGetRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/:issue_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesGetResponseData { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + closed_by: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type IssuesUpdateEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * The title of the issue. + */ + title?: string; + /** + * The contents of the issue. + */ + body?: string; + /** + * Login for the user that this issue should be assigned to. **This field is deprecated.** + */ + assignee?: string; + /** + * State of the issue. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ + */ + milestone?: number | null; + /** + * Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ + */ + labels?: string[]; + /** + * Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + */ + assignees?: string[]; +}; +declare type IssuesUpdateRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/issues/:issue_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesUpdateResponseData { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + closed_by: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type IssuesAddAssigneesEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ + */ + assignees?: string[]; +}; +declare type IssuesAddAssigneesRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/issues/:issue_number/assignees"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesAddAssigneesResponseData { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; +} +declare type IssuesRemoveAssigneesEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ + */ + assignees?: string[]; +}; +declare type IssuesRemoveAssigneesRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/:issue_number/assignees"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesRemoveAssigneesResponseData { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; +} +declare type IssuesListCommentsEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListCommentsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/:issue_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListCommentsResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type IssuesCreateCommentEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * The contents of the comment. + */ + body: string; +}; +declare type IssuesCreateCommentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/issues/:issue_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesCreateCommentResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type IssuesListEventsEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListEventsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/:issue_number/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListEventsResponseData = { + id: number; + node_id: string; + url: string; + actor: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + event: string; + commit_id: string; + commit_url: string; + created_at: string; +}[]; +declare type IssuesListLabelsOnIssueEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListLabelsOnIssueRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/:issue_number/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListLabelsOnIssueResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}[]; +declare type IssuesAddLabelsEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. + */ + labels: string[]; +}; +declare type IssuesAddLabelsRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/issues/:issue_number/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesAddLabelsResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}[]; +declare type IssuesSetLabelsEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. + */ + labels?: string[]; +}; +declare type IssuesSetLabelsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/issues/:issue_number/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesSetLabelsResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}[]; +declare type IssuesRemoveAllLabelsEndpoint = { + owner: string; + repo: string; + issue_number: number; +}; +declare type IssuesRemoveAllLabelsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/:issue_number/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesRemoveLabelEndpoint = { + owner: string; + repo: string; + issue_number: number; + name: string; +}; +declare type IssuesRemoveLabelRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/:issue_number/labels/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesRemoveLabelResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}[]; +declare type IssuesLockEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: + * \* `off-topic` + * \* `too heated` + * \* `resolved` + * \* `spam` + */ + lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; +}; +declare type IssuesLockRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/issues/:issue_number/lock"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesUnlockEndpoint = { + owner: string; + repo: string; + issue_number: number; +}; +declare type IssuesUnlockRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/:issue_number/lock"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForIssueEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForIssueRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/:issue_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForIssueResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForIssueEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForIssueRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/issues/:issue_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForIssueResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsDeleteForIssueEndpoint = { + owner: string; + repo: string; + issue_number: number; + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteForIssueRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesListEventsForTimelineEndpoint = { + owner: string; + repo: string; + issue_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"mockingbird">; +declare type IssuesListEventsForTimelineRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/issues/:issue_number/timeline"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListEventsForTimelineResponseData = { + id: number; + node_id: string; + url: string; + actor: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + event: string; + commit_id: string; + commit_url: string; + created_at: string; +}[]; +declare type ReposListDeployKeysEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListDeployKeysRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListDeployKeysResponseData = { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; +}[]; +declare type ReposAddDeployKeyEndpoint = { + owner: string; + repo: string; + /** + * A name for the key. + */ + title?: string; + /** + * The contents of the key. + */ + key: string; + /** + * If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + * + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/)." + */ + read_only?: boolean; +}; +declare type ReposAddDeployKeyRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposAddDeployKeyResponseData { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; +} +declare type ReposGetDeployKeyEndpoint = { + owner: string; + repo: string; + key_id: number; +}; +declare type ReposGetDeployKeyRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/keys/:key_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetDeployKeyResponseData { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; +} +declare type ReposRemoveDeployKeyEndpoint = { + owner: string; + repo: string; + key_id: number; +}; +declare type ReposRemoveDeployKeyRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/keys/:key_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesListLabelsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListLabelsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListLabelsForRepoResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}[]; +declare type IssuesCreateLabelEndpoint = { + owner: string; + repo: string; + /** + * The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). + */ + name: string; + /** + * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + */ + color: string; + /** + * A short description of the label. + */ + description?: string; +}; +declare type IssuesCreateLabelRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesCreateLabelResponseData { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +} +declare type IssuesGetLabelEndpoint = { + owner: string; + repo: string; + name: string; +}; +declare type IssuesGetLabelRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/labels/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesGetLabelResponseData { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +} +declare type IssuesUpdateLabelEndpoint = { + owner: string; + repo: string; + name: string; + /** + * The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). + */ + new_name?: string; + /** + * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + */ + color?: string; + /** + * A short description of the label. + */ + description?: string; +}; +declare type IssuesUpdateLabelRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/labels/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesUpdateLabelResponseData { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +} +declare type IssuesDeleteLabelEndpoint = { + owner: string; + repo: string; + name: string; +}; +declare type IssuesDeleteLabelRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/labels/:name"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListLanguagesEndpoint = { + owner: string; + repo: string; +}; +declare type ReposListLanguagesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/languages"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposListLanguagesResponseData { + C: number; + Python: number; +} +declare type LicensesGetForRepoEndpoint = { + owner: string; + repo: string; +}; +declare type LicensesGetForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/license"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface LicensesGetForRepoResponseData { + name: string; + path: string; + sha: string; + size: number; + url: string; + html_url: string; + git_url: string; + download_url: string; + type: string; + content: string; + encoding: string; + _links: { + self: string; + git: string; + html: string; + }; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +} +declare type ReposMergeEndpoint = { + owner: string; + repo: string; + /** + * The name of the base branch that the head will be merged into. + */ + base: string; + /** + * The head to merge. This can be a branch name or a commit SHA1. + */ + head: string; + /** + * Commit message to use for the merge commit. If omitted, a default message will be used. + */ + commit_message?: string; +}; +declare type ReposMergeRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/merges"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposMergeResponseData { + sha: string; + node_id: string; + commit: { + author: { + name: string; + date: string; + email: string; + }; + committer: { + name: string; + date: string; + email: string; + }; + message: string; + tree: { + sha: string; + url: string; + }; + url: string; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + url: string; + html_url: string; + comments_url: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + sha: string; + url: string; + }[]; +} +export interface ReposMergeResponse404Data { + message: string; +} +export interface ReposMergeResponse409Data { + message: string; +} +declare type IssuesListMilestonesEndpoint = { + owner: string; + repo: string; + /** + * The state of the milestone. Either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * What to sort results by. Either `due_on` or `completeness`. + */ + sort?: "due_on" | "completeness"; + /** + * The direction of the sort. Either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListMilestonesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/milestones"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListMilestonesResponseData = { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +}[]; +declare type IssuesCreateMilestoneEndpoint = { + owner: string; + repo: string; + /** + * The title of the milestone. + */ + title: string; + /** + * The state of the milestone. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * A description of the milestone. + */ + description?: string; + /** + * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + due_on?: string; +}; +declare type IssuesCreateMilestoneRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/milestones"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesCreateMilestoneResponseData { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +} +declare type IssuesGetMilestoneEndpoint = { + owner: string; + repo: string; + milestone_number: number; +}; +declare type IssuesGetMilestoneRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/milestones/:milestone_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesGetMilestoneResponseData { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +} +declare type IssuesUpdateMilestoneEndpoint = { + owner: string; + repo: string; + milestone_number: number; + /** + * The title of the milestone. + */ + title?: string; + /** + * The state of the milestone. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * A description of the milestone. + */ + description?: string; + /** + * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + due_on?: string; +}; +declare type IssuesUpdateMilestoneRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/milestones/:milestone_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface IssuesUpdateMilestoneResponseData { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; +} +declare type IssuesDeleteMilestoneEndpoint = { + owner: string; + repo: string; + milestone_number: number; +}; +declare type IssuesDeleteMilestoneRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/milestones/:milestone_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesListLabelsForMilestoneEndpoint = { + owner: string; + repo: string; + milestone_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListLabelsForMilestoneRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/milestones/:milestone_number/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListLabelsForMilestoneResponseData = { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; +}[]; +declare type ActivityListRepoNotificationsForAuthenticatedUserEndpoint = { + owner: string; + repo: string; + /** + * If `true`, show notifications marked as read. + */ + all?: boolean; + /** + * If `true`, only shows notifications in which the user is directly participating or mentioned. + */ + participating?: boolean; + /** + * Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + before?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListRepoNotificationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/notifications"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListRepoNotificationsForAuthenticatedUserResponseData = { + id: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + subject: { + title: string; + url: string; + latest_comment_url: string; + type: string; + }; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string; + url: string; +}[]; +declare type ActivityMarkRepoNotificationsAsReadEndpoint = { + owner: string; + repo: string; + /** + * Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; +}; +declare type ActivityMarkRepoNotificationsAsReadRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/notifications"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetPagesEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetPagesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pages"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetPagesResponseData { + url: string; + status: string; + cname: string; + custom_404: boolean; + html_url: string; + source: { + branch: string; + directory: string; + }; +} +declare type ReposEnablePagesSiteEndpoint = { + owner: string; + repo: string; + source?: ReposEnablePagesSiteParamsSource; +} & RequiredPreview<"switcheroo">; +declare type ReposEnablePagesSiteRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pages"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposEnablePagesSiteResponseData { + url: string; + status: string; + cname: string; + custom_404: boolean; + html_url: string; + source: { + branch: string; + directory: string; + }; +} +declare type ReposDisablePagesSiteEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"switcheroo">; +declare type ReposDisablePagesSiteRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/pages"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposUpdateInformationAboutPagesSiteEndpoint = { + owner: string; + repo: string; + /** + * Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/)." + */ + cname?: string; + /** + * Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `"gh-pages"`, `"master"`, and `"master /docs"`. + */ + source?: '"gh-pages"' | '"master"' | '"master /docs"'; +}; +declare type ReposUpdateInformationAboutPagesSiteRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/pages"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposRequestPageBuildEndpoint = { + owner: string; + repo: string; +}; +declare type ReposRequestPageBuildRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pages/builds"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposRequestPageBuildResponseData { + url: string; + status: string; +} +declare type ReposListPagesBuildsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListPagesBuildsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pages/builds"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListPagesBuildsResponseData = { + url: string; + status: string; + error: { + message: string; + }; + pusher: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + commit: string; + duration: number; + created_at: string; + updated_at: string; +}[]; +declare type ReposGetLatestPagesBuildEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetLatestPagesBuildRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pages/builds/latest"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetLatestPagesBuildResponseData { + url: string; + status: string; + error: { + message: string; + }; + pusher: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + commit: string; + duration: number; + created_at: string; + updated_at: string; +} +declare type ReposGetPagesBuildEndpoint = { + owner: string; + repo: string; + build_id: number; +}; +declare type ReposGetPagesBuildRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pages/builds/:build_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetPagesBuildResponseData { + url: string; + status: string; + error: { + message: string; + }; + pusher: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + commit: string; + duration: number; + created_at: string; + updated_at: string; +} +declare type ProjectsListForRepoEndpoint = { + owner: string; + repo: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsListForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ProjectsListForRepoResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type ProjectsCreateForRepoEndpoint = { + owner: string; + repo: string; + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +} & RequiredPreview<"inertia">; +declare type ProjectsCreateForRepoRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsCreateForRepoResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type PullsListEndpoint = { + owner: string; + repo: string; + /** + * Either `open`, `closed`, or `all` to filter by state. + */ + state?: "open" | "closed" | "all"; + /** + * Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. + */ + head?: string; + /** + * Filter pulls by base branch name. Example: `gh-pages`. + */ + base?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month). + */ + sort?: "created" | "updated" | "popularity" | "long-running"; + /** + * The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsListResponseData = { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_reviewers: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + head: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + base: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + issue: { + href: string; + }; + comments: { + href: string; + }; + review_comments: { + href: string; + }; + review_comment: { + href: string; + }; + commits: { + href: string; + }; + statuses: { + href: string; + }; + }; + author_association: string; + draft: boolean; +}[]; +declare type PullsCreateEndpoint = { + owner: string; + repo: string; + /** + * The title of the new pull request. + */ + title: string; + /** + * The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. + */ + head: string; + /** + * The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. + */ + base: string; + /** + * The contents of the pull request. + */ + body?: string; + /** + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + */ + maintainer_can_modify?: boolean; + /** + * Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. + */ + draft?: boolean; +}; +declare type PullsCreateRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsCreateResponseData { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_reviewers: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + head: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + base: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + issue: { + href: string; + }; + comments: { + href: string; + }; + review_comments: { + href: string; + }; + review_comment: { + href: string; + }; + commits: { + href: string; + }; + statuses: { + href: string; + }; + }; + author_association: string; + draft: boolean; + merged: boolean; + mergeable: boolean; + rebaseable: boolean; + mergeable_state: string; + merged_by: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + comments: number; + review_comments: number; + maintainer_can_modify: boolean; + commits: number; + additions: number; + deletions: number; + changed_files: number; +} +declare type PullsListCommentsForRepoEndpoint = { + owner: string; + repo: string; + /** + * Can be either `created` or `updated` comments. + */ + sort?: "created" | "updated"; + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListCommentsForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsListCommentsForRepoResponseData = { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +}[]; +declare type PullsGetCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; +}; +declare type PullsGetCommentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsGetCommentResponseData { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +} +declare type PullsUpdateCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * The text of the reply to the review comment. + */ + body: string; +}; +declare type PullsUpdateCommentRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsUpdateCommentResponseData { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +} +declare type PullsDeleteCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; +}; +declare type PullsDeleteCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForPullRequestReviewCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForPullRequestReviewCommentRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForPullRequestReviewCommentResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForPullRequestReviewCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForPullRequestReviewCommentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForPullRequestReviewCommentResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsDeleteForPullRequestCommentEndpoint = { + owner: string; + repo: string; + comment_id: number; + reaction_id: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsDeleteForPullRequestCommentRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type PullsGetEndpoint = { + owner: string; + repo: string; + pull_number: number; +}; +declare type PullsGetRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsGetResponseData { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_reviewers: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + head: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + base: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + issue: { + href: string; + }; + comments: { + href: string; + }; + review_comments: { + href: string; + }; + review_comment: { + href: string; + }; + commits: { + href: string; + }; + statuses: { + href: string; + }; + }; + author_association: string; + draft: boolean; + merged: boolean; + mergeable: boolean; + rebaseable: boolean; + mergeable_state: string; + merged_by: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + comments: number; + review_comments: number; + maintainer_can_modify: boolean; + commits: number; + additions: number; + deletions: number; + changed_files: number; +} +declare type PullsUpdateEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * The title of the pull request. + */ + title?: string; + /** + * The contents of the pull request. + */ + body?: string; + /** + * State of this Pull Request. Either `open` or `closed`. + */ + state?: "open" | "closed"; + /** + * The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. + */ + base?: string; + /** + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + */ + maintainer_can_modify?: boolean; +}; +declare type PullsUpdateRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/pulls/:pull_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsUpdateResponseData { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_reviewers: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + head: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + base: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + issue: { + href: string; + }; + comments: { + href: string; + }; + review_comments: { + href: string; + }; + review_comment: { + href: string; + }; + commits: { + href: string; + }; + statuses: { + href: string; + }; + }; + author_association: string; + draft: boolean; + merged: boolean; + mergeable: boolean; + rebaseable: boolean; + mergeable_state: string; + merged_by: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + comments: number; + review_comments: number; + maintainer_can_modify: boolean; + commits: number; + additions: number; + deletions: number; + changed_files: number; +} +declare type PullsListCommentsEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * Can be either `created` or `updated` comments. + */ + sort?: "created" | "updated"; + /** + * Can be either `asc` or `desc`. Ignored without `sort` parameter. + */ + direction?: "asc" | "desc"; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListCommentsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsListCommentsResponseData = { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +}[]; +declare type PullsCreateCommentEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * The text of the review comment. + */ + body: string; + /** + * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. + */ + commit_id: string; + /** + * The relative path to the file that necessitates a comment. + */ + path: string; + /** + * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + */ + position?: number; + /** + * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + */ + side?: "LEFT" | "RIGHT"; + /** + * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. + */ + line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. + */ + start_line?: number; + /** + * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + */ + start_side?: "LEFT" | "RIGHT" | "side"; +}; +declare type PullsCreateCommentRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls/:pull_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsCreateCommentResponseData { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + start_line: number; + original_start_line: number; + start_side: string; + line: number; + original_line: number; + side: string; +} +declare type PullsCreateReviewCommentReplyEndpoint = { + owner: string; + repo: string; + pull_number: number; + comment_id: number; + /** + * The text of the review comment. + */ + body: string; +}; +declare type PullsCreateReviewCommentReplyRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsCreateReviewCommentReplyResponseData { + url: string; + pull_request_review_id: number; + id: number; + node_id: string; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; +} +declare type PullsListCommitsEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListCommitsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/commits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsListCommitsResponseData = { + url: string; + sha: string; + node_id: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + name: string; + email: string; + date: string; + }; + committer: { + name: string; + email: string; + date: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + verification: { + verified: boolean; + reason: string; + signature: string; + payload: string; + }; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + sha: string; + }[]; +}[]; +declare type PullsListFilesEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListFilesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/files"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsListFilesResponseData = { + sha: string; + filename: string; + status: string; + additions: number; + deletions: number; + changes: number; + blob_url: string; + raw_url: string; + contents_url: string; + patch: string; +}[]; +declare type PullsCheckIfMergedEndpoint = { + owner: string; + repo: string; + pull_number: number; +}; +declare type PullsCheckIfMergedRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/merge"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type PullsMergeEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * Title for the automatic commit message. + */ + commit_title?: string; + /** + * Extra detail to append to automatic commit message. + */ + commit_message?: string; + /** + * SHA that pull request head must match to allow merge. + */ + sha?: string; + /** + * Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. + */ + merge_method?: "merge" | "squash" | "rebase"; +}; +declare type PullsMergeRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/pulls/:pull_number/merge"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsMergeResponseData { + sha: string; + merged: boolean; + message: string; +} +export interface PullsMergeResponse405Data { + message: string; + documentation_url: string; +} +export interface PullsMergeResponse409Data { + message: string; + documentation_url: string; +} +declare type PullsListReviewRequestsEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListReviewRequestsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsListReviewRequestsResponseData { + users: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; +} +declare type PullsCreateReviewRequestEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * An array of user `login`s that will be requested. + */ + reviewers?: string[]; + /** + * An array of team `slug`s that will be requested. + */ + team_reviewers?: string[]; +}; +declare type PullsCreateReviewRequestRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsCreateReviewRequestResponseData { + url: string; + id: number; + node_id: string; + html_url: string; + diff_url: string; + patch_url: string; + issue_url: string; + commits_url: string; + review_comments_url: string; + review_comment_url: string; + comments_url: string; + statuses_url: string; + number: number; + state: string; + locked: boolean; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + active_lock_reason: string; + created_at: string; + updated_at: string; + closed_at: string; + merged_at: string; + merge_commit_sha: string; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_reviewers: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + requested_teams: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + }[]; + head: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + base: { + label: string; + ref: string; + sha: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + }; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + issue: { + href: string; + }; + comments: { + href: string; + }; + review_comments: { + href: string; + }; + review_comment: { + href: string; + }; + commits: { + href: string; + }; + statuses: { + href: string; + }; + }; + author_association: string; + draft: boolean; +} +declare type PullsDeleteReviewRequestEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * An array of user `login`s that will be removed. + */ + reviewers?: string[]; + /** + * An array of team `slug`s that will be removed. + */ + team_reviewers?: string[]; +}; +declare type PullsDeleteReviewRequestRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type PullsListReviewsEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsListReviewsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsListReviewsResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + submitted_at: string; + commit_id: string; +}[]; +declare type PullsCreateReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. + */ + commit_id?: string; + /** + * **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. + */ + body?: string; + /** + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready. + */ + event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + /** + * Use the following table to specify the location, destination, and contents of the draft review comment. + */ + comments?: PullsCreateReviewParamsComments[]; +}; +declare type PullsCreateReviewRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsCreateReviewResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + submitted_at: string; + commit_id: string; +} +declare type PullsGetReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + review_id: number; +}; +declare type PullsGetReviewRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsGetReviewResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + submitted_at: string; + commit_id: string; +} +declare type PullsDeletePendingReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + review_id: number; +}; +declare type PullsDeletePendingReviewRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsDeletePendingReviewResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + commit_id: string; +} +declare type PullsUpdateReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + review_id: number; + /** + * The body text of the pull request review. + */ + body: string; +}; +declare type PullsUpdateReviewRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsUpdateReviewResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + submitted_at: string; + commit_id: string; +} +declare type PullsGetCommentsForReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + review_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type PullsGetCommentsForReviewRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type PullsGetCommentsForReviewResponseData = { + url: string; + id: number; + node_id: string; + pull_request_review_id: number; + diff_hunk: string; + path: string; + position: number; + original_position: number; + commit_id: string; + original_commit_id: string; + in_reply_to_id: number; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + created_at: string; + updated_at: string; + html_url: string; + pull_request_url: string; + author_association: string; + _links: { + self: { + href: string; + }; + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; +}[]; +declare type PullsDismissReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + review_id: number; + /** + * The message for the pull request review dismissal + */ + message: string; +}; +declare type PullsDismissReviewRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsDismissReviewResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + submitted_at: string; + commit_id: string; +} +declare type PullsSubmitReviewEndpoint = { + owner: string; + repo: string; + pull_number: number; + review_id: number; + /** + * The body text of the pull request review + */ + body?: string; + /** + * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. + */ + event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; +}; +declare type PullsSubmitReviewRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsSubmitReviewResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + state: string; + html_url: string; + pull_request_url: string; + _links: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + submitted_at: string; + commit_id: string; +} +declare type PullsUpdateBranchEndpoint = { + owner: string; + repo: string; + pull_number: number; + /** + * The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. + */ + expected_head_sha?: string; +} & RequiredPreview<"lydian">; +declare type PullsUpdateBranchRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/pulls/:pull_number/update-branch"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface PullsUpdateBranchResponseData { + message: string; + url: string; +} +declare type ReposGetReadmeEndpoint = { + owner: string; + repo: string; + /** + * The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`) + */ + ref?: string; +}; +declare type ReposGetReadmeRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/readme"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetReadmeResponseData { + type: string; + encoding: string; + size: number; + name: string; + path: string; + content: string; + sha: string; + url: string; + git_url: string; + html_url: string; + download_url: string; + _links: { + git: string; + self: string; + html: string; + }; +} +declare type ReposListReleasesEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListReleasesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/releases"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListReleasesResponseData = { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assets: { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + }[]; +}[]; +declare type ReposCreateReleaseEndpoint = { + owner: string; + repo: string; + /** + * The name of the tag. + */ + tag_name: string; + /** + * Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). + */ + target_commitish?: string; + /** + * The name of the release. + */ + name?: string; + /** + * Text describing the contents of the tag. + */ + body?: string; + /** + * `true` to create a draft (unpublished) release, `false` to create a published one. + */ + draft?: boolean; + /** + * `true` to identify the release as a prerelease. `false` to identify the release as a full release. + */ + prerelease?: boolean; +}; +declare type ReposCreateReleaseRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/releases"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateReleaseResponseData { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assets: unknown[]; +} +declare type ReposGetReleaseAssetEndpoint = { + owner: string; + repo: string; + asset_id: number; +}; +declare type ReposGetReleaseAssetRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/releases/assets/:asset_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetReleaseAssetResponseData { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type ReposUpdateReleaseAssetEndpoint = { + owner: string; + repo: string; + asset_id: number; + /** + * The file name of the asset. + */ + name?: string; + /** + * An alternate short description of the asset. Used in place of the filename. + */ + label?: string; +}; +declare type ReposUpdateReleaseAssetRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/releases/assets/:asset_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateReleaseAssetResponseData { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type ReposDeleteReleaseAssetEndpoint = { + owner: string; + repo: string; + asset_id: number; +}; +declare type ReposDeleteReleaseAssetRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/releases/assets/:asset_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetLatestReleaseEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetLatestReleaseRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/releases/latest"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetLatestReleaseResponseData { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assets: { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + }[]; +} +declare type ReposGetReleaseByTagEndpoint = { + owner: string; + repo: string; + tag: string; +}; +declare type ReposGetReleaseByTagRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/releases/tags/:tag"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetReleaseByTagResponseData { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assets: { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + }[]; +} +declare type ReposGetReleaseEndpoint = { + owner: string; + repo: string; + release_id: number; +}; +declare type ReposGetReleaseRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/releases/:release_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetReleaseResponseData { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assets: { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + }[]; +} +declare type ReposUpdateReleaseEndpoint = { + owner: string; + repo: string; + release_id: number; + /** + * The name of the tag. + */ + tag_name?: string; + /** + * Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`). + */ + target_commitish?: string; + /** + * The name of the release. + */ + name?: string; + /** + * Text describing the contents of the tag. + */ + body?: string; + /** + * `true` makes the release a draft, and `false` publishes the release. + */ + draft?: boolean; + /** + * `true` to identify the release as a prerelease, `false` to identify the release as a full release. + */ + prerelease?: boolean; +}; +declare type ReposUpdateReleaseRequestOptions = { + method: "PATCH"; + url: "/repos/:owner/:repo/releases/:release_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUpdateReleaseResponseData { + url: string; + html_url: string; + assets_url: string; + upload_url: string; + tarball_url: string; + zipball_url: string; + id: number; + node_id: string; + tag_name: string; + target_commitish: string; + name: string; + body: string; + draft: boolean; + prerelease: boolean; + created_at: string; + published_at: string; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assets: { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + }[]; +} +declare type ReposDeleteReleaseEndpoint = { + owner: string; + repo: string; + release_id: number; +}; +declare type ReposDeleteReleaseRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/releases/:release_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListAssetsForReleaseEndpoint = { + owner: string; + repo: string; + release_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListAssetsForReleaseRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/releases/:release_id/assets"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListAssetsForReleaseResponseData = { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +}[]; +declare type ReposUploadReleaseAssetEndpoint = { + /** + * owner parameter + */ + owner: string; + /** + * repo parameter + */ + repo: string; + /** + * release_id parameter + */ + release_id: number; + /** + * name parameter + */ + name?: string; + /** + * label parameter + */ + label?: string; + /** + * The raw file data + */ + data: string; + /** + * The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint + */ + origin?: string; + /** + * For https://api.github.com, set `baseUrl` to `https://uploads.github.com`. For GitHub Enterprise Server, set it to `/api/uploads` + */ + baseUrl: string; +} & { + headers: { + "content-type": string; + }; +}; +declare type ReposUploadReleaseAssetRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/releases/:release_id/assets{?name,label}"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposUploadReleaseAssetResponseData { + url: string; + browser_download_url: string; + id: number; + node_id: string; + name: string; + label: string; + state: string; + content_type: string; + size: number; + download_count: number; + created_at: string; + updated_at: string; + uploader: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type ActivityListStargazersForRepoEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListStargazersForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/stargazers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListStargazersForRepoResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +export declare type ActivityListStargazersForRepoResponse200Data = { + starred_at: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +}[]; +declare type ReposGetCodeFrequencyStatsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetCodeFrequencyStatsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/stats/code_frequency"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetCodeFrequencyStatsResponseData = number[][]; +declare type ReposGetCommitActivityStatsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetCommitActivityStatsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/stats/commit_activity"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetCommitActivityStatsResponseData = { + days: number[]; + total: number; + week: number; +}[]; +declare type ReposGetContributorsStatsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetContributorsStatsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/stats/contributors"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetContributorsStatsResponseData = { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + total: number; + weeks: { + w: string; + a: number; + d: number; + c: number; + }[]; +}[]; +declare type ReposGetParticipationStatsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetParticipationStatsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/stats/participation"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetParticipationStatsResponseData { + all: number[]; + owner: number[]; +} +declare type ReposGetPunchCardStatsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetPunchCardStatsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/stats/punch_card"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetPunchCardStatsResponseData = number[][]; +declare type ReposCreateStatusEndpoint = { + owner: string; + repo: string; + sha: string; + /** + * The state of the status. Can be one of `error`, `failure`, `pending`, or `success`. + */ + state: "error" | "failure" | "pending" | "success"; + /** + * The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` + */ + target_url?: string; + /** + * A short description of the status. + */ + description?: string; + /** + * A string label to differentiate this status from the status of other systems. + */ + context?: string; +}; +declare type ReposCreateStatusRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/statuses/:sha"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateStatusResponseData { + url: string; + avatar_url: string; + id: number; + node_id: string; + state: string; + description: string; + target_url: string; + context: string; + created_at: string; + updated_at: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type ActivityListWatchersForRepoEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListWatchersForRepoRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/subscribers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListWatchersForRepoResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type ActivityGetRepoSubscriptionEndpoint = { + owner: string; + repo: string; +}; +declare type ActivityGetRepoSubscriptionRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/subscription"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActivityGetRepoSubscriptionResponseData { + subscribed: boolean; + ignored: boolean; + reason: string; + created_at: string; + url: string; + repository_url: string; +} +declare type ActivitySetRepoSubscriptionEndpoint = { + owner: string; + repo: string; + /** + * Determines if notifications should be received from this repository. + */ + subscribed?: boolean; + /** + * Determines if all notifications should be blocked from this repository. + */ + ignored?: boolean; +}; +declare type ActivitySetRepoSubscriptionRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/subscription"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ActivitySetRepoSubscriptionResponseData { + subscribed: boolean; + ignored: boolean; + reason: string; + created_at: string; + url: string; + repository_url: string; +} +declare type ActivityDeleteRepoSubscriptionEndpoint = { + owner: string; + repo: string; +}; +declare type ActivityDeleteRepoSubscriptionRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/subscription"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListTagsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListTagsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/tags"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListTagsResponseData = { + name: string; + commit: { + sha: string; + url: string; + }; + zipball_url: string; + tarball_url: string; +}[]; +declare type ReposListTeamsEndpoint = { + owner: string; + repo: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListTeamsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListTeamsResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; +}[]; +declare type ReposGetAllTopicsEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"mercy">; +declare type ReposGetAllTopicsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/topics"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetAllTopicsResponseData { + names: string[]; +} +declare type ReposReplaceAllTopicsEndpoint = { + owner: string; + repo: string; + /** + * An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. + */ + names: string[]; +} & RequiredPreview<"mercy">; +declare type ReposReplaceAllTopicsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/topics"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposReplaceAllTopicsResponseData { + names: string[]; +} +declare type ReposGetClonesEndpoint = { + owner: string; + repo: string; + /** + * Must be one of: `day`, `week`. + */ + per?: "day" | "week"; +}; +declare type ReposGetClonesRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/traffic/clones"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetClonesResponseData { + count: number; + uniques: number; + clones: { + timestamp: string; + count: number; + uniques: number; + }[]; +} +declare type ReposGetTopPathsEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetTopPathsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/traffic/popular/paths"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetTopPathsResponseData = { + path: string; + title: string; + count: number; + uniques: number; +}[]; +declare type ReposGetTopReferrersEndpoint = { + owner: string; + repo: string; +}; +declare type ReposGetTopReferrersRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/traffic/popular/referrers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposGetTopReferrersResponseData = { + referrer: string; + count: number; + uniques: number; +}[]; +declare type ReposGetViewsEndpoint = { + owner: string; + repo: string; + /** + * Must be one of: `day`, `week`. + */ + per?: "day" | "week"; +}; +declare type ReposGetViewsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/traffic/views"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposGetViewsResponseData { + count: number; + uniques: number; + views: { + timestamp: string; + count: number; + uniques: number; + }[]; +} +declare type ReposTransferEndpoint = { + owner: string; + repo: string; + /** + * **Required:** The username or organization name the repository will be transferred to. + */ + new_owner?: string; + /** + * ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. + */ + team_ids?: number[]; +}; +declare type ReposTransferRequestOptions = { + method: "POST"; + url: "/repos/:owner/:repo/transfer"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposTransferResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +} +declare type ReposCheckVulnerabilityAlertsEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"dorian">; +declare type ReposCheckVulnerabilityAlertsRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/vulnerability-alerts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposEnableVulnerabilityAlertsEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"dorian">; +declare type ReposEnableVulnerabilityAlertsRequestOptions = { + method: "PUT"; + url: "/repos/:owner/:repo/vulnerability-alerts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposDisableVulnerabilityAlertsEndpoint = { + owner: string; + repo: string; +} & RequiredPreview<"dorian">; +declare type ReposDisableVulnerabilityAlertsRequestOptions = { + method: "DELETE"; + url: "/repos/:owner/:repo/vulnerability-alerts"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposGetArchiveLinkEndpoint = { + owner: string; + repo: string; + archive_format: string; + ref: string; +}; +declare type ReposGetArchiveLinkRequestOptions = { + method: "GET"; + url: "/repos/:owner/:repo/:archive_format/:ref"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposCreateUsingTemplateEndpoint = { + template_owner: string; + template_repo: string; + /** + * The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. + */ + owner?: string; + /** + * The name of the new repository. + */ + name: string; + /** + * A short description of the new repository. + */ + description?: string; + /** + * Either `true` to create a new private repository or `false` to create a new public one. + */ + private?: boolean; +} & RequiredPreview<"baptiste">; +declare type ReposCreateUsingTemplateRequestOptions = { + method: "POST"; + url: "/repos/:template_owner/:template_repo/generate"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateUsingTemplateResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +} +declare type ReposListPublicEndpoint = { + /** + * The integer ID of the last repository that you've seen. + */ + since?: number; +}; +declare type ReposListPublicRequestOptions = { + method: "GET"; + url: "/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListPublicResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; +}[]; +declare type ScimListProvisionedIdentitiesEndpoint = { + org: string; + /** + * Used for pagination: the index of the first result to return. + */ + startIndex?: number; + /** + * Used for pagination: the number of results to return. + */ + count?: number; + /** + * Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: `?filter=userName%20eq%20\"Octocat\"`. + */ + filter?: string; +}; +declare type ScimListProvisionedIdentitiesRequestOptions = { + method: "GET"; + url: "/scim/v2/organizations/:org/Users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ScimListProvisionedIdentitiesResponseData { + schemas: string[]; + totalResults: number; + itemsPerPage: number; + startIndex: number; + Resources: { + schemas: string[]; + id: string; + externalId: string; + userName: string; + name: { + givenName: string; + familyName: string; + }; + emails: { + value: string; + primary: boolean; + type: string; + }[]; + active: boolean; + meta: { + resourceType: string; + created: string; + lastModified: string; + location: string; + }; + }[]; +} +declare type ScimProvisionAndInviteUsersEndpoint = { + org: string; +}; +declare type ScimProvisionAndInviteUsersRequestOptions = { + method: "POST"; + url: "/scim/v2/organizations/:org/Users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ScimProvisionAndInviteUsersResponseData { + schemas: string[]; + id: string; + externalId: string; + userName: string; + name: { + givenName: string; + familyName: string; + }; + emails: { + value: string; + type: string; + primary: boolean; + }[]; + active: boolean; + meta: { + resourceType: string; + created: string; + lastModified: string; + location: string; + }; +} +declare type ScimGetProvisioningDetailsForUserEndpoint = { + org: string; + scim_user_id: number; +}; +declare type ScimGetProvisioningDetailsForUserRequestOptions = { + method: "GET"; + url: "/scim/v2/organizations/:org/Users/:scim_user_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ScimGetProvisioningDetailsForUserResponseData { + schemas: string[]; + id: string; + externalId: string; + userName: string; + name: { + givenName: string; + familyName: string; + }; + emails: { + value: string; + type: string; + primary: boolean; + }[]; + active: boolean; + meta: { + resourceType: string; + created: string; + lastModified: string; + location: string; + }; +} +declare type ScimReplaceProvisionedUserInformationEndpoint = { + org: string; + scim_user_id: number; +}; +declare type ScimReplaceProvisionedUserInformationRequestOptions = { + method: "PUT"; + url: "/scim/v2/organizations/:org/Users/:scim_user_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ScimReplaceProvisionedUserInformationResponseData { + schemas: string[]; + id: string; + externalId: string; + userName: string; + name: { + givenName: string; + familyName: string; + }; + emails: { + value: string; + type: string; + primary: boolean; + }[]; + active: boolean; + meta: { + resourceType: string; + created: string; + lastModified: string; + location: string; + }; +} +declare type ScimUpdateUserAttributeEndpoint = { + org: string; + scim_user_id: number; +}; +declare type ScimUpdateUserAttributeRequestOptions = { + method: "PATCH"; + url: "/scim/v2/organizations/:org/Users/:scim_user_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ScimUpdateUserAttributeResponseData { + schemas: string[]; + id: string; + externalId: string; + userName: string; + name: { + givenName: string; + familyName: string; + }; + emails: { + value: string; + type: string; + primary: boolean; + }[]; + active: boolean; + meta: { + resourceType: string; + created: string; + lastModified: string; + location: string; + }; +} +declare type ScimRemoveUserFromOrgEndpoint = { + org: string; + scim_user_id: number; +}; +declare type ScimRemoveUserFromOrgRequestOptions = { + method: "DELETE"; + url: "/scim/v2/organizations/:org/Users/:scim_user_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type SearchCodeEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching code](https://help.github.com/articles/searching-code/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "indexed"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type SearchCodeRequestOptions = { + method: "GET"; + url: "/search/code"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchCodeResponseData { + total_count: number; + incomplete_results: boolean; + items: { + name: string; + path: string; + sha: string; + url: string; + git_url: string; + html_url: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + }; + score: number; + }[]; +} +declare type SearchCommitsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching commits](https://help.github.com/articles/searching-commits/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "author-date" | "committer-date"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"cloak">; +declare type SearchCommitsRequestOptions = { + method: "GET"; + url: "/search/commits"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchCommitsResponseData { + total_count: number; + incomplete_results: boolean; + items: { + url: string; + sha: string; + html_url: string; + comments_url: string; + commit: { + url: string; + author: { + date: string; + name: string; + email: string; + }; + committer: { + date: string; + name: string; + email: string; + }; + message: string; + tree: { + url: string; + sha: string; + }; + comment_count: number; + }; + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + committer: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parents: { + url: string; + html_url: string; + sha: string; + }[]; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; + teams_url: string; + hooks_url: string; + issue_events_url: string; + events_url: string; + assignees_url: string; + branches_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; + languages_url: string; + stargazers_url: string; + contributors_url: string; + subscribers_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; + merges_url: string; + archive_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; + deployments_url: string; + }; + score: number; + }[]; +} +declare type SearchIssuesAndPullRequestsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type SearchIssuesAndPullRequestsRequestOptions = { + method: "GET"; + url: "/search/issues"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchIssuesAndPullRequestsResponseData { + total_count: number; + incomplete_results: boolean; + items: { + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + id: number; + node_id: string; + number: number; + title: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + color: string; + }[]; + state: string; + assignee: string; + milestone: string; + comments: number; + created_at: string; + updated_at: string; + closed_at: string; + pull_request: { + html_url: string; + diff_url: string; + patch_url: string; + }; + body: string; + score: number; + }[]; +} +declare type SearchLabelsEndpoint = { + /** + * The id of the repository. + */ + repository_id: number; + /** + * The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). + */ + q: string; + /** + * Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "created" | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; +}; +declare type SearchLabelsRequestOptions = { + method: "GET"; + url: "/search/labels"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchLabelsResponseData { + total_count: number; + incomplete_results: boolean; + items: { + id: number; + node_id: string; + url: string; + name: string; + color: string; + default: boolean; + description: string; + score: number; + }[]; +} +declare type SearchReposEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type SearchReposRequestOptions = { + method: "GET"; + url: "/search/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchReposResponseData { + total_count: number; + incomplete_results: boolean; + items: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + received_events_url: string; + type: string; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + created_at: string; + updated_at: string; + pushed_at: string; + homepage: string; + size: number; + stargazers_count: number; + watchers_count: number; + language: string; + forks_count: number; + open_issues_count: number; + master_branch: string; + default_branch: string; + score: number; + }[]; +} +declare type SearchTopicsEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). + */ + q: string; +}; +declare type SearchTopicsRequestOptions = { + method: "GET"; + url: "/search/topics"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchTopicsResponseData { + total_count: number; + incomplete_results: boolean; + items: { + name: string; + display_name: string; + short_description: string; + description: string; + created_by: string; + released: string; + created_at: string; + updated_at: string; + featured: boolean; + curated: boolean; + score: number; + }[]; +} +declare type SearchUsersEndpoint = { + /** + * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching users](https://help.github.com/articles/searching-users/)" for a detailed list of qualifiers. + */ + q: string; + /** + * Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) + */ + sort?: "followers" | "repositories" | "joined"; + /** + * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + */ + order?: "desc" | "asc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type SearchUsersRequestOptions = { + method: "GET"; + url: "/search/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface SearchUsersResponseData { + total_count: number; + incomplete_results: boolean; + items: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + received_events_url: string; + type: string; + score: number; + }[]; +} +declare type TeamsGetLegacyEndpoint = { + team_id: number; +}; +declare type TeamsGetLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetLegacyResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + }; +} +declare type TeamsUpdateLegacyEndpoint = { + team_id: number; + /** + * The name of the team. + */ + name: string; + /** + * The description of the team. + */ + description?: string; + /** + * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: + * **For a non-nested team:** + * \* `secret` - only visible to organization owners and members of this team. + * \* `closed` - visible to all members of this organization. + * **For a parent or child team:** + * \* `closed` - visible to all members of this organization. + */ + privacy?: "secret" | "closed"; + /** + * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: + * \* `pull` - team members can pull, but not push to or administer newly-added repositories. + * \* `push` - team members can pull and push, but not administer newly-added repositories. + * \* `admin` - team members can pull, push and administer newly-added repositories. + */ + permission?: "pull" | "push" | "admin"; + /** + * The ID of a team to set as the parent team. + */ + parent_team_id?: number; +}; +declare type TeamsUpdateLegacyRequestOptions = { + method: "PATCH"; + url: "/teams/:team_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsUpdateLegacyResponseData { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + }; +} +declare type TeamsDeleteLegacyEndpoint = { + team_id: number; +}; +declare type TeamsDeleteLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListDiscussionsLegacyEndpoint = { + team_id: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListDiscussionsLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/discussions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListDiscussionsLegacyResponseData = { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +}[]; +declare type TeamsCreateDiscussionLegacyEndpoint = { + team_id: number; + /** + * The discussion post's title. + */ + title: string; + /** + * The discussion post's body text. + */ + body: string; + /** + * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. + */ + private?: boolean; +}; +declare type TeamsCreateDiscussionLegacyRequestOptions = { + method: "POST"; + url: "/teams/:team_id/discussions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateDiscussionLegacyResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsGetDiscussionLegacyEndpoint = { + team_id: number; + discussion_number: number; +}; +declare type TeamsGetDiscussionLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetDiscussionLegacyResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsUpdateDiscussionLegacyEndpoint = { + team_id: number; + discussion_number: number; + /** + * The discussion post's title. + */ + title?: string; + /** + * The discussion post's body text. + */ + body?: string; +}; +declare type TeamsUpdateDiscussionLegacyRequestOptions = { + method: "PATCH"; + url: "/teams/:team_id/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsUpdateDiscussionLegacyResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + last_edited_at: string; + html_url: string; + node_id: string; + number: number; + pinned: boolean; + private: boolean; + team_url: string; + title: string; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsDeleteDiscussionLegacyEndpoint = { + team_id: number; + discussion_number: number; +}; +declare type TeamsDeleteDiscussionLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id/discussions/:discussion_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListDiscussionCommentsLegacyEndpoint = { + team_id: number; + discussion_number: number; + /** + * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListDiscussionCommentsLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/discussions/:discussion_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListDiscussionCommentsLegacyResponseData = { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +}[]; +declare type TeamsCreateDiscussionCommentLegacyEndpoint = { + team_id: number; + discussion_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +declare type TeamsCreateDiscussionCommentLegacyRequestOptions = { + method: "POST"; + url: "/teams/:team_id/discussions/:discussion_number/comments"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateDiscussionCommentLegacyResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsGetDiscussionCommentLegacyEndpoint = { + team_id: number; + discussion_number: number; + comment_number: number; +}; +declare type TeamsGetDiscussionCommentLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetDiscussionCommentLegacyResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsUpdateDiscussionCommentLegacyEndpoint = { + team_id: number; + discussion_number: number; + comment_number: number; + /** + * The discussion comment's body text. + */ + body: string; +}; +declare type TeamsUpdateDiscussionCommentLegacyRequestOptions = { + method: "PATCH"; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsUpdateDiscussionCommentLegacyResponseData { + author: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + body: string; + body_html: string; + body_version: string; + created_at: string; + last_edited_at: string; + discussion_url: string; + html_url: string; + node_id: string; + number: number; + updated_at: string; + url: string; + reactions: { + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + }; +} +declare type TeamsDeleteDiscussionCommentLegacyEndpoint = { + team_id: number; + discussion_number: number; + comment_number: number; +}; +declare type TeamsDeleteDiscussionCommentLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReactionsListForTeamDiscussionCommentLegacyEndpoint = { + team_id: number; + discussion_number: number; + comment_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForTeamDiscussionCommentLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForTeamDiscussionCommentLegacyResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForTeamDiscussionCommentLegacyEndpoint = { + team_id: number; + discussion_number: number; + comment_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions = { + method: "POST"; + url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForTeamDiscussionCommentLegacyResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type ReactionsListForTeamDiscussionLegacyEndpoint = { + team_id: number; + discussion_number: number; + /** + * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. + */ + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsListForTeamDiscussionLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/discussions/:discussion_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReactionsListForTeamDiscussionLegacyResponseData = { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +}[]; +declare type ReactionsCreateForTeamDiscussionLegacyEndpoint = { + team_id: number; + discussion_number: number; + /** + * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; +} & RequiredPreview<"squirrel-girl">; +declare type ReactionsCreateForTeamDiscussionLegacyRequestOptions = { + method: "POST"; + url: "/teams/:team_id/discussions/:discussion_number/reactions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReactionsCreateForTeamDiscussionLegacyResponseData { + id: number; + node_id: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + content: string; + created_at: string; +} +declare type TeamsListPendingInvitationsLegacyEndpoint = { + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListPendingInvitationsLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListPendingInvitationsLegacyResponseData = { + id: number; + login: string; + email: string; + role: string; + created_at: string; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + team_count: number; + invitation_team_url: string; +}[]; +declare type TeamsListMembersLegacyEndpoint = { + team_id: number; + /** + * Filters members returned by their role in the team. Can be one of: + * \* `member` - normal members of the team. + * \* `maintainer` - team maintainers. + * \* `all` - all members of the team. + */ + role?: "member" | "maintainer" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListMembersLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/members"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListMembersLegacyResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type TeamsGetMemberLegacyEndpoint = { + team_id: number; + username: string; +}; +declare type TeamsGetMemberLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsAddMemberLegacyEndpoint = { + team_id: number; + username: string; +}; +declare type TeamsAddMemberLegacyRequestOptions = { + method: "PUT"; + url: "/teams/:team_id/members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsAddMemberLegacyResponseData { + message: string; + errors: { + code: string; + field: string; + resource: string; + }[]; +} +declare type TeamsRemoveMemberLegacyEndpoint = { + team_id: number; + username: string; +}; +declare type TeamsRemoveMemberLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id/members/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsGetMembershipForUserLegacyEndpoint = { + team_id: number; + username: string; +}; +declare type TeamsGetMembershipForUserLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsGetMembershipForUserLegacyResponseData { + url: string; + role: string; + state: string; +} +declare type TeamsAddOrUpdateMembershipForUserLegacyEndpoint = { + team_id: number; + username: string; + /** + * The role that this user should have in the team. Can be one of: + * \* `member` - a normal member of the team. + * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. + */ + role?: "member" | "maintainer"; +}; +declare type TeamsAddOrUpdateMembershipForUserLegacyRequestOptions = { + method: "PUT"; + url: "/teams/:team_id/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsAddOrUpdateMembershipForUserLegacyResponseData { + url: string; + role: string; + state: string; +} +export interface TeamsAddOrUpdateMembershipForUserLegacyResponse422Data { + message: string; + errors: { + code: string; + field: string; + resource: string; + }[]; +} +declare type TeamsRemoveMembershipForUserLegacyEndpoint = { + team_id: number; + username: string; +}; +declare type TeamsRemoveMembershipForUserLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id/memberships/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListProjectsLegacyEndpoint = { + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type TeamsListProjectsLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListProjectsLegacyResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + organization_permission: string; + private: boolean; + permissions: { + read: boolean; + write: boolean; + admin: boolean; + }; +}[]; +declare type TeamsCheckPermissionsForProjectLegacyEndpoint = { + team_id: number; + project_id: number; +} & RequiredPreview<"inertia">; +declare type TeamsCheckPermissionsForProjectLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCheckPermissionsForProjectLegacyResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; + organization_permission: string; + private: boolean; + permissions: { + read: boolean; + write: boolean; + admin: boolean; + }; +} +declare type TeamsAddOrUpdateProjectPermissionsLegacyEndpoint = { + team_id: number; + project_id: number; + /** + * The permission to grant to the team for this project. Can be one of: + * \* `read` - team members can read, but not write to or administer this project. + * \* `write` - team members can read and write, but not administer this project. + * \* `admin` - team members can read, write and administer this project. + * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." + */ + permission?: "read" | "write" | "admin"; +} & RequiredPreview<"inertia">; +declare type TeamsAddOrUpdateProjectPermissionsLegacyRequestOptions = { + method: "PUT"; + url: "/teams/:team_id/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsAddOrUpdateProjectPermissionsLegacyResponseData { + message: string; + documentation_url: string; +} +declare type TeamsRemoveProjectLegacyEndpoint = { + team_id: number; + project_id: number; +}; +declare type TeamsRemoveProjectLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id/projects/:project_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListReposLegacyEndpoint = { + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListReposLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListReposLegacyResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type TeamsCheckPermissionsForRepoLegacyEndpoint = { + team_id: number; + owner: string; + repo: string; +}; +declare type TeamsCheckPermissionsForRepoLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCheckPermissionsForRepoLegacyResponseData { + organization: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + parent: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + source: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; + permissions: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; +} +declare type TeamsAddOrUpdateRepoPermissionsLegacyEndpoint = { + team_id: number; + owner: string; + repo: string; + /** + * The permission to grant the team on this repository. Can be one of: + * \* `pull` - team members can pull, but not push to or administer this repository. + * \* `push` - team members can pull and push, but not administer this repository. + * \* `admin` - team members can pull, push and administer this repository. + * + * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + */ + permission?: "pull" | "push" | "admin"; +}; +declare type TeamsAddOrUpdateRepoPermissionsLegacyRequestOptions = { + method: "PUT"; + url: "/teams/:team_id/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsRemoveRepoLegacyEndpoint = { + team_id: number; + owner: string; + repo: string; +}; +declare type TeamsRemoveRepoLegacyRequestOptions = { + method: "DELETE"; + url: "/teams/:team_id/repos/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type TeamsListIdPGroupsForLegacyEndpoint = { + team_id: number; +}; +declare type TeamsListIdPGroupsForLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/team-sync/group-mappings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsListIdPGroupsForLegacyResponseData { + groups: { + group_id: string; + group_name: string; + group_description: string; + }[]; +} +declare type TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint = { + team_id: number; + /** + * The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove. + */ + groups: TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups[]; +}; +declare type TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions = { + method: "PATCH"; + url: "/teams/:team_id/team-sync/group-mappings"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface TeamsCreateOrUpdateIdPGroupConnectionsLegacyResponseData { + groups: { + group_id: string; + group_name: string; + group_description: string; + }[]; +} +declare type TeamsListChildLegacyEndpoint = { + team_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListChildLegacyRequestOptions = { + method: "GET"; + url: "/teams/:team_id/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListChildLegacyResponseData = { + id: number; + node_id: string; + url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + }; +}[]; +declare type UsersGetAuthenticatedEndpoint = {}; +declare type UsersGetAuthenticatedRequestOptions = { + method: "GET"; + url: "/user"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersGetAuthenticatedResponseData { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string; + company: string; + blog: string; + location: string; + email: string; + hireable: boolean; + bio: string; + twitter_username: string; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; + private_gists: number; + total_private_repos: number; + owned_private_repos: number; + disk_usage: number; + collaborators: number; + two_factor_authentication: boolean; + plan: { + name: string; + space: number; + private_repos: number; + collaborators: number; + }; +} +declare type UsersUpdateAuthenticatedEndpoint = { + /** + * The new name of the user. + */ + name?: string; + /** + * The publicly visible email address of the user. + */ + email?: string; + /** + * The new blog URL of the user. + */ + blog?: string; + /** + * The new company of the user. + */ + company?: string; + /** + * The new location of the user. + */ + location?: string; + /** + * The new hiring availability of the user. + */ + hireable?: boolean; + /** + * The new short biography of the user. + */ + bio?: string; + /** + * The new Twitter username of the user. + */ + twitter_username?: string; +}; +declare type UsersUpdateAuthenticatedRequestOptions = { + method: "PATCH"; + url: "/user"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersUpdateAuthenticatedResponseData { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string; + company: string; + blog: string; + location: string; + email: string; + hireable: boolean; + bio: string; + twitter_username: string; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; + private_gists: number; + total_private_repos: number; + owned_private_repos: number; + disk_usage: number; + collaborators: number; + two_factor_authentication: boolean; + plan: { + name: string; + space: number; + private_repos: number; + collaborators: number; + }; +} +declare type UsersListBlockedEndpoint = {}; +declare type UsersListBlockedRequestOptions = { + method: "GET"; + url: "/user/blocks"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListBlockedResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type UsersCheckBlockedEndpoint = { + username: string; +}; +declare type UsersCheckBlockedRequestOptions = { + method: "GET"; + url: "/user/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersBlockEndpoint = { + username: string; +}; +declare type UsersBlockRequestOptions = { + method: "PUT"; + url: "/user/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersUnblockEndpoint = { + username: string; +}; +declare type UsersUnblockRequestOptions = { + method: "DELETE"; + url: "/user/blocks/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersTogglePrimaryEmailVisibilityEndpoint = { + /** + * Specify the _primary_ email address that needs a visibility change. + */ + email: string; + /** + * Use `public` to enable an authenticated user to view the specified email address, or use `private` so this primary email address cannot be seen publicly. + */ + visibility: string; +}; +declare type UsersTogglePrimaryEmailVisibilityRequestOptions = { + method: "PATCH"; + url: "/user/email/visibility"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersTogglePrimaryEmailVisibilityResponseData = { + email: string; + primary: boolean; + verified: boolean; + visibility: string; +}[]; +declare type UsersListEmailsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListEmailsRequestOptions = { + method: "GET"; + url: "/user/emails"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListEmailsResponseData = { + email: string; + verified: boolean; + primary: boolean; + visibility: string; +}[]; +declare type UsersAddEmailsEndpoint = { + /** + * Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. + */ + emails: string[]; +}; +declare type UsersAddEmailsRequestOptions = { + method: "POST"; + url: "/user/emails"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersAddEmailsResponseData = { + email: string; + primary: boolean; + verified: boolean; + visibility: string; +}[]; +declare type UsersDeleteEmailsEndpoint = { + /** + * Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. + */ + emails: string[]; +}; +declare type UsersDeleteEmailsRequestOptions = { + method: "DELETE"; + url: "/user/emails"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersListFollowersForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListFollowersForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/followers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListFollowersForAuthenticatedUserResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type UsersListFollowedByAuthenticatedEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListFollowedByAuthenticatedRequestOptions = { + method: "GET"; + url: "/user/following"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListFollowedByAuthenticatedResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type UsersCheckFollowingEndpoint = { + username: string; +}; +declare type UsersCheckFollowingRequestOptions = { + method: "GET"; + url: "/user/following/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersFollowEndpoint = { + username: string; +}; +declare type UsersFollowRequestOptions = { + method: "PUT"; + url: "/user/following/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersUnfollowEndpoint = { + username: string; +}; +declare type UsersUnfollowRequestOptions = { + method: "DELETE"; + url: "/user/following/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersListGpgKeysEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListGpgKeysRequestOptions = { + method: "GET"; + url: "/user/gpg_keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListGpgKeysResponseData = { + id: number; + primary_key_id: string; + key_id: string; + public_key: string; + emails: { + email: string; + verified: boolean; + }[]; + subkeys: { + id: number; + primary_key_id: number; + key_id: string; + public_key: string; + emails: unknown[]; + subkeys: unknown[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; + }[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; +}[]; +declare type UsersCreateGpgKeyEndpoint = { + /** + * Your GPG key, generated in ASCII-armored format. See "[Generating a new GPG key](https://help.github.com/articles/generating-a-new-gpg-key/)" for help creating a GPG key. + */ + armored_public_key?: string; +}; +declare type UsersCreateGpgKeyRequestOptions = { + method: "POST"; + url: "/user/gpg_keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersCreateGpgKeyResponseData { + id: number; + primary_key_id: string; + key_id: string; + public_key: string; + emails: { + email: string; + verified: boolean; + }[]; + subkeys: { + id: number; + primary_key_id: number; + key_id: string; + public_key: string; + emails: unknown[]; + subkeys: unknown[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; + }[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; +} +declare type UsersGetGpgKeyEndpoint = { + gpg_key_id: number; +}; +declare type UsersGetGpgKeyRequestOptions = { + method: "GET"; + url: "/user/gpg_keys/:gpg_key_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersGetGpgKeyResponseData { + id: number; + primary_key_id: string; + key_id: string; + public_key: string; + emails: { + email: string; + verified: boolean; + }[]; + subkeys: { + id: number; + primary_key_id: number; + key_id: string; + public_key: string; + emails: unknown[]; + subkeys: unknown[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; + }[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; +} +declare type UsersDeleteGpgKeyEndpoint = { + gpg_key_id: number; +}; +declare type UsersDeleteGpgKeyRequestOptions = { + method: "DELETE"; + url: "/user/gpg_keys/:gpg_key_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsListInstallationsForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"machine-man">; +declare type AppsListInstallationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/installations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsListInstallationsForAuthenticatedUserResponseData { + total_count: number; + installations: { + id: number; + account: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + gravatar_id: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + checks: string; + metadata: string; + contents: string; + }; + events: string[]; + single_file_name: string; + }[]; +} +declare type AppsListInstallationReposForAuthenticatedUserEndpoint = { + installation_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"machine-man">; +declare type AppsListInstallationReposForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/installations/:installation_id/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsListInstallationReposForAuthenticatedUserResponseData { + total_count: number; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; +} +declare type AppsAddRepoToInstallationEndpoint = { + installation_id: number; + repository_id: number; +} & RequiredPreview<"machine-man">; +declare type AppsAddRepoToInstallationRequestOptions = { + method: "PUT"; + url: "/user/installations/:installation_id/repositories/:repository_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsRemoveRepoFromInstallationEndpoint = { + installation_id: number; + repository_id: number; +} & RequiredPreview<"machine-man">; +declare type AppsRemoveRepoFromInstallationRequestOptions = { + method: "DELETE"; + url: "/user/installations/:installation_id/repositories/:repository_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type IssuesListForAuthenticatedUserEndpoint = { + /** + * Indicates which sorts of issues to return. Can be one of: + * \* `assigned`: Issues assigned to you + * \* `created`: Issues created by you + * \* `mentioned`: Issues mentioning you + * \* `subscribed`: Issues you're subscribed to updates for + * \* `all`: All issues the authenticated user can see, regardless of participation or creation + */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; + /** + * Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * A list of comma separated label names. Example: `bug,ui,@high` + */ + labels?: string; + /** + * What to sort results by. Can be either `created`, `updated`, `comments`. + */ + sort?: "created" | "updated" | "comments"; + /** + * The direction of the sort. Can be either `asc` or `desc`. + */ + direction?: "asc" | "desc"; + /** + * Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type IssuesListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/issues"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type IssuesListForAuthenticatedUserResponseData = { + id: number; + node_id: string; + url: string; + repository_url: string; + labels_url: string; + comments_url: string; + events_url: string; + html_url: string; + number: number; + state: string; + title: string; + body: string; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + labels: { + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + assignee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + assignees: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }[]; + milestone: { + url: string; + html_url: string; + labels_url: string; + id: number; + node_id: string; + number: number; + state: string; + title: string; + description: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + open_issues: number; + closed_issues: number; + created_at: string; + updated_at: string; + closed_at: string; + due_on: string; + }; + locked: boolean; + active_lock_reason: string; + comments: number; + pull_request: { + url: string; + html_url: string; + diff_url: string; + patch_url: string; + }; + closed_at: string; + created_at: string; + updated_at: string; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +}[]; +declare type UsersListPublicKeysEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListPublicKeysRequestOptions = { + method: "GET"; + url: "/user/keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListPublicKeysResponseData = { + key_id: string; + key: string; +}[]; +declare type UsersCreatePublicKeyEndpoint = { + /** + * A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air". + */ + title?: string; + /** + * The public SSH key to add to your GitHub account. See "[Generating a new SSH key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)" for guidance on how to create a public SSH key. + */ + key?: string; +}; +declare type UsersCreatePublicKeyRequestOptions = { + method: "POST"; + url: "/user/keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersCreatePublicKeyResponseData { + key_id: string; + key: string; +} +declare type UsersGetPublicKeyEndpoint = { + key_id: number; +}; +declare type UsersGetPublicKeyRequestOptions = { + method: "GET"; + url: "/user/keys/:key_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersGetPublicKeyResponseData { + key_id: string; + key: string; +} +declare type UsersDeletePublicKeyEndpoint = { + key_id: number; +}; +declare type UsersDeletePublicKeyRequestOptions = { + method: "DELETE"; + url: "/user/keys/:key_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type AppsListSubscriptionsForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type AppsListSubscriptionsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/marketplace_purchases"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListSubscriptionsForAuthenticatedUserResponseData = { + billing_cycle: string; + next_billing_date: string; + unit_count: string; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + account: { + login: string; + id: number; + url: string; + email: string; + organization_billing_email: string; + type: string; + }; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; + }; +}[]; +declare type AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions = { + method: "GET"; + url: "/user/marketplace_purchases/stubbed"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type AppsListSubscriptionsForAuthenticatedUserStubbedResponseData = { + billing_cycle: string; + next_billing_date: string; + unit_count: string; + on_free_trial: boolean; + free_trial_ends_on: string; + updated_at: string; + account: { + login: string; + id: number; + url: string; + email: string; + organization_billing_email: string; + type: string; + }; + plan: { + url: string; + accounts_url: string; + id: number; + number: number; + name: string; + description: string; + monthly_price_in_cents: number; + yearly_price_in_cents: number; + price_model: string; + has_free_trial: boolean; + unit_name: string; + state: string; + bullets: string[]; + }; +}[]; +declare type OrgsListMembershipsEndpoint = { + /** + * Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships. + */ + state?: "active" | "pending"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListMembershipsRequestOptions = { + method: "GET"; + url: "/user/memberships/orgs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListMembershipsResponseData = { + url: string; + state: string; + role: string; + organization_url: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +}[]; +declare type OrgsGetMembershipForAuthenticatedUserEndpoint = { + org: string; +}; +declare type OrgsGetMembershipForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/memberships/orgs/:org"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsGetMembershipForAuthenticatedUserResponseData { + url: string; + state: string; + role: string; + organization_url: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type OrgsUpdateMembershipEndpoint = { + org: string; + /** + * The state that the membership should be in. Only `"active"` will be accepted. + */ + state: "active"; +}; +declare type OrgsUpdateMembershipRequestOptions = { + method: "PATCH"; + url: "/user/memberships/orgs/:org"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface OrgsUpdateMembershipResponseData { + url: string; + state: string; + role: string; + organization_url: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + }; + user: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; +} +declare type MigrationsStartForAuthenticatedUserEndpoint = { + /** + * An array of repositories to include in the migration. + */ + repositories: string[]; + /** + * Locks the `repositories` to prevent changes during the migration when set to `true`. + */ + lock_repositories?: boolean; + /** + * Does not include attachments uploaded to GitHub.com in the migration data when set to `true`. Excluding attachments will reduce the migration archive file size. + */ + exclude_attachments?: boolean; +}; +declare type MigrationsStartForAuthenticatedUserRequestOptions = { + method: "POST"; + url: "/user/migrations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsStartForAuthenticatedUserResponseData { + id: number; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; + url: string; + created_at: string; + updated_at: string; +} +declare type MigrationsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/migrations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type MigrationsListForAuthenticatedUserResponseData = { + id: number; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; + url: string; + created_at: string; + updated_at: string; +}[]; +declare type MigrationsGetStatusForAuthenticatedUserEndpoint = { + migration_id: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsGetStatusForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/migrations/:migration_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface MigrationsGetStatusForAuthenticatedUserResponseData { + id: number; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + guid: string; + state: string; + lock_repositories: boolean; + exclude_attachments: boolean; + repositories: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }[]; + url: string; + created_at: string; + updated_at: string; +} +declare type MigrationsGetArchiveForAuthenticatedUserEndpoint = { + migration_id: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsGetArchiveForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/migrations/:migration_id/archive"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsDeleteArchiveForAuthenticatedUserEndpoint = { + migration_id: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsDeleteArchiveForAuthenticatedUserRequestOptions = { + method: "DELETE"; + url: "/user/migrations/:migration_id/archive"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type MigrationsUnlockRepoForAuthenticatedUserEndpoint = { + migration_id: number; + repo_name: string; +} & RequiredPreview<"wyandotte">; +declare type MigrationsUnlockRepoForAuthenticatedUserRequestOptions = { + method: "DELETE"; + url: "/user/migrations/:migration_id/repos/:repo_name/lock"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type OrgsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/orgs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListForAuthenticatedUserResponseData = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}[]; +declare type ProjectsCreateForAuthenticatedUserEndpoint = { + /** + * The name of the project. + */ + name: string; + /** + * The description of the project. + */ + body?: string; +} & RequiredPreview<"inertia">; +declare type ProjectsCreateForAuthenticatedUserRequestOptions = { + method: "POST"; + url: "/user/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ProjectsCreateForAuthenticatedUserResponseData { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +} +declare type UsersListPublicEmailsEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListPublicEmailsRequestOptions = { + method: "GET"; + url: "/user/public_emails"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListPublicEmailsResponseData = { + email: string; + verified: boolean; + primary: boolean; + visibility: string; +}[]; +declare type ReposListForAuthenticatedUserEndpoint = { + /** + * Can be one of `all`, `public`, or `private`. + */ + visibility?: "all" | "public" | "private"; + /** + * Comma-separated list of values. Can include: + * \* `owner`: Repositories that are owned by the authenticated user. + * \* `collaborator`: Repositories that the user has been added to as a collaborator. + * \* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. + */ + affiliation?: string; + /** + * Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` + * + * Will cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. + */ + type?: "all" | "owner" | "public" | "private" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposCreateForAuthenticatedUserEndpoint = { + /** + * The name of the repository. + */ + name: string; + /** + * A short description of the repository. + */ + description?: string; + /** + * A URL with more information about the repository. + */ + homepage?: string; + /** + * Either `true` to create a private repository or `false` to create a public one. + */ + private?: boolean; + /** + * Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see "[Creating an internal repository](https://help.github.com/github/creating-cloning-and-archiving-repositories/creating-an-internal-repository)" in the GitHub Help documentation. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + */ + visibility?: "public" | "private" | "visibility" | "internal"; + /** + * Either `true` to enable issues for this repository or `false` to disable them. + */ + has_issues?: boolean; + /** + * Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + */ + has_projects?: boolean; + /** + * Either `true` to enable the wiki for this repository or `false` to disable it. + */ + has_wiki?: boolean; + /** + * Either `true` to make this repo available as a template repository or `false` to prevent it. + */ + is_template?: boolean; + /** + * The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + */ + team_id?: number; + /** + * Pass `true` to create an initial commit with empty README. + */ + auto_init?: boolean; + /** + * Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". + */ + gitignore_template?: string; + /** + * Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". + */ + license_template?: string; + /** + * Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + */ + allow_squash_merge?: boolean; + /** + * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + */ + allow_merge_commit?: boolean; + /** + * Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + */ + allow_rebase_merge?: boolean; + /** + * Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + */ + delete_branch_on_merge?: boolean; +}; +declare type ReposCreateForAuthenticatedUserRequestOptions = { + method: "POST"; + url: "/user/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface ReposCreateForAuthenticatedUserResponseData { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +} +declare type ReposListInvitationsForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListInvitationsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/repository_invitations"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ReposListInvitationsForAuthenticatedUserResponseData = { + id: number; + repository: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + }; + invitee: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + inviter: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + permissions: string; + created_at: string; + url: string; + html_url: string; +}[]; +declare type ReposAcceptInvitationEndpoint = { + invitation_id: number; +}; +declare type ReposAcceptInvitationRequestOptions = { + method: "PATCH"; + url: "/user/repository_invitations/:invitation_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposDeclineInvitationEndpoint = { + invitation_id: number; +}; +declare type ReposDeclineInvitationRequestOptions = { + method: "DELETE"; + url: "/user/repository_invitations/:invitation_id"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListReposStarredByAuthenticatedUserEndpoint = { + /** + * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). + */ + sort?: "created" | "updated"; + /** + * One of `asc` (ascending) or `desc` (descending). + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListReposStarredByAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/starred"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListReposStarredByAuthenticatedUserResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}[]; +export declare type ActivityListReposStarredByAuthenticatedUserResponse200Data = { + starred_at: string; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +}[]; +declare type ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint = { + owner: string; + repo: string; +}; +declare type ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/starred/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityStarRepoForAuthenticatedUserEndpoint = { + owner: string; + repo: string; +}; +declare type ActivityStarRepoForAuthenticatedUserRequestOptions = { + method: "PUT"; + url: "/user/starred/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityUnstarRepoForAuthenticatedUserEndpoint = { + owner: string; + repo: string; +}; +declare type ActivityUnstarRepoForAuthenticatedUserRequestOptions = { + method: "DELETE"; + url: "/user/starred/:owner/:repo"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListWatchedReposForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListWatchedReposForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/subscriptions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListWatchedReposForAuthenticatedUserResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type TeamsListForAuthenticatedUserEndpoint = { + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type TeamsListForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/user/teams"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type TeamsListForAuthenticatedUserResponseData = { + id: number; + node_id: string; + url: string; + html_url: string; + name: string; + slug: string; + description: string; + privacy: string; + permission: string; + members_url: string; + repositories_url: string; + parent: string; + members_count: number; + repos_count: number; + created_at: string; + updated_at: string; + organization: { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; + name: string; + company: string; + blog: string; + location: string; + email: string; + twitter_username: string; + is_verified: boolean; + has_organization_projects: boolean; + has_repository_projects: boolean; + public_repos: number; + public_gists: number; + followers: number; + following: number; + html_url: string; + created_at: string; + type: string; + }; +}[]; +declare type MigrationsListReposForUserEndpoint = { + migration_id: number; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"wyandotte">; +declare type MigrationsListReposForUserRequestOptions = { + method: "GET"; + url: "/user/:migration_id/repositories"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type MigrationsListReposForUserResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type UsersListEndpoint = { + /** + * The integer ID of the last User that you've seen. + */ + since?: string; +}; +declare type UsersListRequestOptions = { + method: "GET"; + url: "/users"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type UsersGetByUsernameEndpoint = { + username: string; +}; +declare type UsersGetByUsernameRequestOptions = { + method: "GET"; + url: "/users/:username"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersGetByUsernameResponseData { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + name: string; + company: string; + blog: string; + location: string; + email: string; + hireable: boolean; + bio: string; + twitter_username: string; + public_repos: number; + public_gists: number; + followers: number; + following: number; + created_at: string; + updated_at: string; +} +declare type ActivityListEventsForAuthenticatedUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListEventsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/users/:username/events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListOrgEventsForAuthenticatedUserEndpoint = { + username: string; + org: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListOrgEventsForAuthenticatedUserRequestOptions = { + method: "GET"; + url: "/users/:username/events/orgs/:org"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListPublicEventsForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListPublicEventsForUserRequestOptions = { + method: "GET"; + url: "/users/:username/events/public"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type UsersListFollowersForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListFollowersForUserRequestOptions = { + method: "GET"; + url: "/users/:username/followers"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListFollowersForUserResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type UsersListFollowingForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListFollowingForUserRequestOptions = { + method: "GET"; + url: "/users/:username/following"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListFollowingForUserResponseData = { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; +}[]; +declare type UsersCheckFollowingForUserEndpoint = { + username: string; + target_user: string; +}; +declare type UsersCheckFollowingForUserRequestOptions = { + method: "GET"; + url: "/users/:username/following/:target_user"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type GistsListForUserEndpoint = { + username: string; + /** + * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned. + */ + since?: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type GistsListForUserRequestOptions = { + method: "GET"; + url: "/users/:username/gists"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type GistsListForUserResponseData = { + url: string; + forks_url: string; + commits_url: string; + id: string; + node_id: string; + git_pull_url: string; + git_push_url: string; + html_url: string; + files: { + [k: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + [k: string]: unknown; + }; + }; + public: boolean; + created_at: string; + updated_at: string; + description: string; + comments: number; + user: string; + comments_url: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + truncated: boolean; +}[]; +declare type UsersListGpgKeysForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListGpgKeysForUserRequestOptions = { + method: "GET"; + url: "/users/:username/gpg_keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListGpgKeysForUserResponseData = { + id: number; + primary_key_id: string; + key_id: string; + public_key: string; + emails: { + email: string; + verified: boolean; + }[]; + subkeys: { + id: number; + primary_key_id: number; + key_id: string; + public_key: string; + emails: unknown[]; + subkeys: unknown[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; + }[]; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; + can_certify: boolean; + created_at: string; + expires_at: string; +}[]; +declare type UsersGetContextForUserEndpoint = { + username: string; + /** + * Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. + */ + subject_type?: "organization" | "repository" | "issue" | "pull_request"; + /** + * Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. + */ + subject_id?: string; +}; +declare type UsersGetContextForUserRequestOptions = { + method: "GET"; + url: "/users/:username/hovercard"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface UsersGetContextForUserResponseData { + contexts: { + message: string; + octicon: string; + }[]; +} +declare type AppsGetUserInstallationEndpoint = { + username: string; +} & RequiredPreview<"machine-man">; +declare type AppsGetUserInstallationRequestOptions = { + method: "GET"; + url: "/users/:username/installation"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export interface AppsGetUserInstallationResponseData { + id: number; + account: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + repository_selection: "all" | "selected"; + access_tokens_url: string; + repositories_url: string; + html_url: string; + app_id: number; + target_id: number; + target_type: string; + permissions: { + checks: string; + metadata: string; + contents: string; + }; + events: string[]; + created_at: string; + updated_at: string; + single_file_name: string; +} +declare type UsersListPublicKeysForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type UsersListPublicKeysForUserRequestOptions = { + method: "GET"; + url: "/users/:username/keys"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type UsersListPublicKeysForUserResponseData = { + id: number; + key: string; +}[]; +declare type OrgsListForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type OrgsListForUserRequestOptions = { + method: "GET"; + url: "/users/:username/orgs"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type OrgsListForUserResponseData = { + login: string; + id: number; + node_id: string; + url: string; + repos_url: string; + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string; +}[]; +declare type ProjectsListForUserEndpoint = { + username: string; + /** + * Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. + */ + state?: "open" | "closed" | "all"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +} & RequiredPreview<"inertia">; +declare type ProjectsListForUserRequestOptions = { + method: "GET"; + url: "/users/:username/projects"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ProjectsListForUserResponseData = { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string; + number: number; + state: string; + creator: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + created_at: string; + updated_at: string; +}[]; +declare type ActivityListReceivedEventsForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListReceivedEventsForUserRequestOptions = { + method: "GET"; + url: "/users/:username/received_events"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListReceivedPublicEventsForUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListReceivedPublicEventsForUserRequestOptions = { + method: "GET"; + url: "/users/:username/received_events/public"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ReposListForUserEndpoint = { + username: string; + /** + * Can be one of `all`, `owner`, `member`. + */ + type?: "all" | "owner" | "member"; + /** + * Can be one of `created`, `updated`, `pushed`, `full_name`. + */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** + * Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc` + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ReposListForUserRequestOptions = { + method: "GET"; + url: "/users/:username/repos"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +declare type ActivityListReposStarredByUserEndpoint = { + username: string; + /** + * One of `created` (when the repository was starred) or `updated` (when it was last pushed to). + */ + sort?: "created" | "updated"; + /** + * One of `asc` (ascending) or `desc` (descending). + */ + direction?: "asc" | "desc"; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListReposStarredByUserRequestOptions = { + method: "GET"; + url: "/users/:username/starred"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListReposStarredByUserResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; +}[]; +export declare type ActivityListReposStarredByUserResponse200Data = { + starred_at: string; + repo: { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + allow_rebase_merge: boolean; + template_repository: string; + temp_clone_token: string; + allow_squash_merge: boolean; + allow_merge_commit: boolean; + subscribers_count: number; + network_count: number; + }; +}[]; +declare type ActivityListReposWatchedByUserEndpoint = { + username: string; + /** + * Results per page (max 100) + */ + per_page?: number; + /** + * Page number of the results to fetch. + */ + page?: number; +}; +declare type ActivityListReposWatchedByUserRequestOptions = { + method: "GET"; + url: "/users/:username/subscriptions"; + headers: RequestHeaders; + request: RequestRequestOptions; +}; +export declare type ActivityListReposWatchedByUserResponseData = { + id: number; + node_id: string; + name: string; + full_name: string; + owner: { + login: string; + id: number; + node_id: string; + avatar_url: string; + gravatar_id: string; + url: string; + html_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; + subscriptions_url: string; + organizations_url: string; + repos_url: string; + events_url: string; + received_events_url: string; + type: string; + site_admin: boolean; + }; + private: boolean; + html_url: string; + description: string; + fork: boolean; + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + downloads_url: string; + events_url: string; + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; + clone_url: string; + mirror_url: string; + hooks_url: string; + svn_url: string; + homepage: string; + language: string; + forks_count: number; + stargazers_count: number; + watchers_count: number; + size: number; + default_branch: string; + open_issues_count: number; + is_template: boolean; + topics: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads: boolean; + archived: boolean; + disabled: boolean; + visibility: string; + pushed_at: string; + created_at: string; + updated_at: string; + permissions: { + admin: boolean; + push: boolean; + pull: boolean; + }; + template_repository: string; + temp_clone_token: string; + subscribers_count: number; + network_count: number; + license: { + key: string; + name: string; + spdx_id: string; + url: string; + node_id: string; + }; +}[]; +declare type AppsCreateInstallationTokenParamsPermissions = {}; +declare type GistsCreateParamsFiles = { + [key: string]: GistsCreateParamsFilesKeyString; +}; +declare type GistsCreateParamsFilesKeyString = { + content: string; +}; +declare type GistsUpdateParamsFiles = { + [key: string]: GistsUpdateParamsFilesKeyString; +}; +declare type GistsUpdateParamsFilesKeyString = { + content: string; + filename: string; +}; +declare type OrgsCreateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +declare type OrgsUpdateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +declare type TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups = { + group_id: string; + group_name: string; + group_description: string; +}; +declare type ReposUpdateBranchProtectionParamsRequiredStatusChecks = { + strict: boolean; + contexts: string[]; +}; +declare type ReposUpdateBranchProtectionParamsRequiredPullRequestReviews = { + dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions; + dismiss_stale_reviews?: boolean; + require_code_owner_reviews?: boolean; + required_approving_review_count?: number; +}; +declare type ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions = { + users?: string[]; + teams?: string[]; +}; +declare type ReposUpdateBranchProtectionParamsRestrictions = { + users: string[]; + teams: string[]; + apps?: string[]; +}; +declare type ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions = { + users?: string[]; + teams?: string[]; +}; +declare type ChecksCreateParamsOutput = { + title: string; + summary: string; + text?: string; + annotations?: ChecksCreateParamsOutputAnnotations[]; + images?: ChecksCreateParamsOutputImages[]; +}; +declare type ChecksCreateParamsOutputAnnotations = { + path: string; + start_line: number; + end_line: number; + start_column?: number; + end_column?: number; + annotation_level: "notice" | "warning" | "failure"; + message: string; + title?: string; + raw_details?: string; +}; +declare type ChecksCreateParamsOutputImages = { + alt: string; + image_url: string; + caption?: string; +}; +declare type ChecksCreateParamsActions = { + label: string; + description: string; + identifier: string; +}; +declare type ChecksUpdateParamsOutput = { + title?: string; + summary: string; + text?: string; + annotations?: ChecksUpdateParamsOutputAnnotations[]; + images?: ChecksUpdateParamsOutputImages[]; +}; +declare type ChecksUpdateParamsOutputAnnotations = { + path: string; + start_line: number; + end_line: number; + start_column?: number; + end_column?: number; + annotation_level: "notice" | "warning" | "failure"; + message: string; + title?: string; + raw_details?: string; +}; +declare type ChecksUpdateParamsOutputImages = { + alt: string; + image_url: string; + caption?: string; +}; +declare type ChecksUpdateParamsActions = { + label: string; + description: string; + identifier: string; +}; +declare type ChecksSetSuitesPreferencesParamsAutoTriggerChecks = { + app_id: number; + setting: boolean; +}; +declare type ReposCreateOrUpdateFileParamsCommitter = { + name: string; + email: string; +}; +declare type ReposCreateOrUpdateFileParamsAuthor = { + name: string; + email: string; +}; +declare type ReposDeleteFileParamsCommitter = { + name?: string; + email?: string; +}; +declare type ReposDeleteFileParamsAuthor = { + name?: string; + email?: string; +}; +declare type ReposCreateDispatchEventParamsClientPayload = {}; +declare type GitCreateCommitParamsAuthor = { + name?: string; + email?: string; + date?: string; +}; +declare type GitCreateCommitParamsCommitter = { + name?: string; + email?: string; + date?: string; +}; +declare type GitCreateTagParamsTagger = { + name?: string; + email?: string; + date?: string; +}; +declare type GitCreateTreeParamsTree = { + path?: string; + mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + type?: "blob" | "tree" | "commit"; + sha?: string | null; + content?: string; +}; +declare type ReposCreateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +declare type ReposUpdateHookParamsConfig = { + url: string; + content_type?: string; + secret?: string; + insecure_ssl?: string; +}; +declare type ReposEnablePagesSiteParamsSource = { + branch?: "master" | "gh-pages"; + path?: string; +}; +declare type PullsCreateReviewParamsComments = { + path: string; + position: number; + body: string; +}; +declare type TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups = { + group_id: string; + group_name: string; + group_description: string; +}; +export {}; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/index.d.ts b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/index.d.ts new file mode 100644 index 00000000..5d2d5ae0 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/index.d.ts @@ -0,0 +1,20 @@ +export * from "./AuthInterface"; +export * from "./EndpointDefaults"; +export * from "./EndpointInterface"; +export * from "./EndpointOptions"; +export * from "./Fetch"; +export * from "./OctokitResponse"; +export * from "./RequestHeaders"; +export * from "./RequestInterface"; +export * from "./RequestMethod"; +export * from "./RequestOptions"; +export * from "./RequestParameters"; +export * from "./RequestRequestOptions"; +export * from "./ResponseHeaders"; +export * from "./Route"; +export * from "./Signal"; +export * from "./StrategyInterface"; +export * from "./Url"; +export * from "./VERSION"; +export * from "./GetResponseTypeFromEndpointMethod"; +export * from "./generated/Endpoints"; diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-web/index.js b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-web/index.js new file mode 100644 index 00000000..1e76cdfc --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-web/index.js @@ -0,0 +1,4 @@ +const VERSION = "4.1.6"; + +export { VERSION }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-web/index.js.map b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-web/index.js.map new file mode 100644 index 00000000..cd0e254a --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/VERSION.js"],"sourcesContent":["export const VERSION = \"0.0.0-development\";\n"],"names":[],"mappings":"AAAY,MAAC,OAAO,GAAG;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/package.json b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/package.json new file mode 100644 index 00000000..bd8d8964 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types/package.json @@ -0,0 +1,49 @@ +{ + "name": "@octokit/types", + "description": "Shared TypeScript definitions for Octokit projects", + "version": "4.1.6", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "github", + "api", + "sdk", + "toolkit", + "typescript" + ], + "repository": "https://github.com/octokit/types.ts", + "dependencies": { + "@types/node": ">= 8" + }, + "devDependencies": { + "@octokit/graphql": "^4.2.2", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "handlebars": "^4.7.6", + "json-schema-to-typescript": "^9.1.0", + "lodash.set": "^4.3.2", + "npm-run-all": "^4.1.5", + "pascal-case": "^3.1.1", + "prettier": "^2.0.0", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "sort-keys": "^4.0.0", + "string-to-jsdoc-comment": "^1.0.0", + "typedoc": "^0.17.0", + "typescript": "^3.6.4" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/request/node_modules/@octokit/request-error/package.json b/node_modules/@octokit/request/node_modules/@octokit/request-error/package.json new file mode 100644 index 00000000..7559a549 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/@octokit/request-error/package.json @@ -0,0 +1,54 @@ +{ + "name": "@octokit/request-error", + "description": "Error class for Octokit request errors", + "version": "2.0.1", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "octokit", + "github", + "api", + "error" + ], + "homepage": "https://github.com/octokit/request-error.js#readme", + "bugs": { + "url": "https://github.com/octokit/request-error.js/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/octokit/request-error.js.git" + }, + "dependencies": { + "@octokit/types": "^4.0.1", + "deprecation": "^2.0.0", + "once": "^1.4.0" + }, + "devDependencies": { + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-bundle-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/jest": "^25.1.0", + "@types/node": "^14.0.4", + "@types/once": "^1.4.0", + "jest": "^25.1.0", + "pika-plugin-unpkg-field": "^1.1.0", + "prettier": "^2.0.1", + "semantic-release": "^17.0.0", + "ts-jest": "^25.1.0", + "typescript": "^3.4.5" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/request/node_modules/is-plain-object/LICENSE b/node_modules/@octokit/request/node_modules/is-plain-object/LICENSE new file mode 100644 index 00000000..3f2eca18 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/is-plain-object/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014-2017, Jon Schlinkert. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/@octokit/request/node_modules/is-plain-object/README.md b/node_modules/@octokit/request/node_modules/is-plain-object/README.md new file mode 100644 index 00000000..5c074ab0 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/is-plain-object/README.md @@ -0,0 +1,125 @@ +# is-plain-object [![NPM version](https://img.shields.io/npm/v/is-plain-object.svg?style=flat)](https://www.npmjs.com/package/is-plain-object) [![NPM monthly downloads](https://img.shields.io/npm/dm/is-plain-object.svg?style=flat)](https://npmjs.org/package/is-plain-object) [![NPM total downloads](https://img.shields.io/npm/dt/is-plain-object.svg?style=flat)](https://npmjs.org/package/is-plain-object) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/is-plain-object.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/is-plain-object) + +> Returns true if an object was created by the `Object` constructor, or Object.create(null). + +Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. + +## Install + +Install with [npm](https://www.npmjs.com/): + +```sh +$ npm install --save is-plain-object +``` + +Use [isobject](https://github.com/jonschlinkert/isobject) if you only want to check if the value is an object and not an array or null. + +## Usage + +with es modules +```js +import { isPlainObject } from 'is-plain-object'; +``` + +or with commonjs +```js +const { isPlainObject } = require('is-plain-object'); +``` + +**true** when created by the `Object` constructor, or Object.create(null). + +```js +isPlainObject(Object.create({})); +//=> true +isPlainObject(Object.create(Object.prototype)); +//=> true +isPlainObject({foo: 'bar'}); +//=> true +isPlainObject({}); +//=> true +isPlainObject(null); +//=> true +``` + +**false** when not created by the `Object` constructor. + +```js +isPlainObject(1); +//=> false +isPlainObject(['foo', 'bar']); +//=> false +isPlainObject([]); +//=> false +isPlainObject(new Foo); +//=> false +isPlainObject(Object.create(null)); +//=> false +``` + +## About + +

+Contributing + +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). + +
+ +
+Running Tests + +Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: + +```sh +$ npm install && npm test +``` + +
+ +
+Building docs + +_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ + +To generate the readme, run the following command: + +```sh +$ npm install -g verbose/verb#dev verb-generate-readme && verb +``` + +
+ +### Related projects + +You might also be interested in these projects: + +* [is-number](https://www.npmjs.com/package/is-number): Returns true if a number or string value is a finite number. Useful for regex… [more](https://github.com/jonschlinkert/is-number) | [homepage](https://github.com/jonschlinkert/is-number "Returns true if a number or string value is a finite number. Useful for regex matches, parsing, user input, etc.") +* [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject "Returns true if the value is an object and not an array or null.") +* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of "Get the native type of a value.") + +### Contributors + +| **Commits** | **Contributor** | +| --- | --- | +| 19 | [jonschlinkert](https://github.com/jonschlinkert) | +| 6 | [TrySound](https://github.com/TrySound) | +| 6 | [stevenvachon](https://github.com/stevenvachon) | +| 3 | [onokumus](https://github.com/onokumus) | +| 1 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) | + +### Author + +**Jon Schlinkert** + +* [GitHub Profile](https://github.com/jonschlinkert) +* [Twitter Profile](https://twitter.com/jonschlinkert) +* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert) + +### License + +Copyright © 2019, [Jon Schlinkert](https://github.com/jonschlinkert). +Released under the [MIT License](LICENSE). + +*** + +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on April 28, 2019._ diff --git a/node_modules/@octokit/request/node_modules/is-plain-object/dist/is-plain-object.js b/node_modules/@octokit/request/node_modules/is-plain-object/dist/is-plain-object.js new file mode 100644 index 00000000..d134e4f2 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/is-plain-object/dist/is-plain-object.js @@ -0,0 +1,38 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +/*! + * is-plain-object + * + * Copyright (c) 2014-2017, Jon Schlinkert. + * Released under the MIT License. + */ + +function isObject(o) { + return Object.prototype.toString.call(o) === '[object Object]'; +} + +function isPlainObject(o) { + var ctor,prot; + + if (isObject(o) === false) return false; + + // If has modified constructor + ctor = o.constructor; + if (ctor === undefined) return true; + + // If has modified prototype + prot = ctor.prototype; + if (isObject(prot) === false) return false; + + // If constructor does not have an Object-specific method + if (prot.hasOwnProperty('isPrototypeOf') === false) { + return false; + } + + // Most likely a plain Object + return true; +} + +exports.isPlainObject = isPlainObject; diff --git a/node_modules/@octokit/request/node_modules/is-plain-object/dist/is-plain-object.mjs b/node_modules/@octokit/request/node_modules/is-plain-object/dist/is-plain-object.mjs new file mode 100644 index 00000000..c2d9f351 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/is-plain-object/dist/is-plain-object.mjs @@ -0,0 +1,34 @@ +/*! + * is-plain-object + * + * Copyright (c) 2014-2017, Jon Schlinkert. + * Released under the MIT License. + */ + +function isObject(o) { + return Object.prototype.toString.call(o) === '[object Object]'; +} + +function isPlainObject(o) { + var ctor,prot; + + if (isObject(o) === false) return false; + + // If has modified constructor + ctor = o.constructor; + if (ctor === undefined) return true; + + // If has modified prototype + prot = ctor.prototype; + if (isObject(prot) === false) return false; + + // If constructor does not have an Object-specific method + if (prot.hasOwnProperty('isPrototypeOf') === false) { + return false; + } + + // Most likely a plain Object + return true; +} + +export { isPlainObject }; diff --git a/node_modules/@octokit/request/node_modules/is-plain-object/is-plain-object.d.ts b/node_modules/@octokit/request/node_modules/is-plain-object/is-plain-object.d.ts new file mode 100644 index 00000000..a359940d --- /dev/null +++ b/node_modules/@octokit/request/node_modules/is-plain-object/is-plain-object.d.ts @@ -0,0 +1 @@ +export function isPlainObject(o: any): boolean; diff --git a/node_modules/@octokit/request/node_modules/is-plain-object/package.json b/node_modules/@octokit/request/node_modules/is-plain-object/package.json new file mode 100644 index 00000000..3ea169a7 --- /dev/null +++ b/node_modules/@octokit/request/node_modules/is-plain-object/package.json @@ -0,0 +1,85 @@ +{ + "name": "is-plain-object", + "description": "Returns true if an object was created by the `Object` constructor, or Object.create(null).", + "version": "5.0.0", + "homepage": "https://github.com/jonschlinkert/is-plain-object", + "author": "Jon Schlinkert (https://github.com/jonschlinkert)", + "contributors": [ + "Jon Schlinkert (http://twitter.com/jonschlinkert)", + "Osman Nuri Okumuş (http://onokumus.com)", + "Steven Vachon (https://svachon.com)", + "(https://github.com/wtgtybhertgeghgtwtg)", + "Bogdan Chadkin (https://github.com/TrySound)" + ], + "repository": "jonschlinkert/is-plain-object", + "bugs": { + "url": "https://github.com/jonschlinkert/is-plain-object/issues" + }, + "license": "MIT", + "main": "dist/is-plain-object.js", + "module": "dist/is-plain-object.mjs", + "types": "is-plain-object.d.ts", + "files": [ + "is-plain-object.d.ts", + "dist" + ], + "exports": { + ".": { + "import": "./dist/is-plain-object.mjs", + "require": "./dist/is-plain-object.js" + }, + "./package.json": "./package.json" + }, + "engines": { + "node": ">=0.10.0" + }, + "scripts": { + "build": "rollup -c", + "test_browser": "mocha-headless-chrome --args=disable-web-security -f test/browser.html", + "test_node": "mocha -r esm", + "test": "npm run test_node && npm run build && npm run test_browser", + "prepare": "rollup -c" + }, + "devDependencies": { + "chai": "^4.2.0", + "esm": "^3.2.22", + "gulp-format-md": "^1.0.0", + "mocha": "^6.1.4", + "mocha-headless-chrome": "^3.1.0", + "rollup": "^2.22.1" + }, + "keywords": [ + "check", + "is", + "is-object", + "isobject", + "javascript", + "kind", + "kind-of", + "object", + "plain", + "type", + "typeof", + "value" + ], + "verb": { + "toc": false, + "layout": "default", + "tasks": [ + "readme" + ], + "plugins": [ + "gulp-format-md" + ], + "related": { + "list": [ + "is-number", + "isobject", + "kind-of" + ] + }, + "lint": { + "reflinks": true + } + } +} diff --git a/node_modules/@octokit/request/package.json b/node_modules/@octokit/request/package.json new file mode 100644 index 00000000..970cf377 --- /dev/null +++ b/node_modules/@octokit/request/package.json @@ -0,0 +1,55 @@ +{ + "name": "@octokit/request", + "description": "Send parameterized requests to GitHub’s APIs with sensible defaults in browsers and Node", + "version": "5.4.15", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "octokit", + "github", + "api", + "request" + ], + "repository": "github:octokit/request.js", + "dependencies": { + "@octokit/endpoint": "^6.0.1", + "@octokit/request-error": "^2.0.0", + "@octokit/types": "^6.7.1", + "is-plain-object": "^5.0.0", + "node-fetch": "^2.6.1", + "universal-user-agent": "^6.0.0" + }, + "devDependencies": { + "@octokit/auth-app": "^3.0.0", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/fetch-mock": "^7.2.4", + "@types/jest": "^26.0.0", + "@types/lolex": "^5.1.0", + "@types/node": "^14.0.0", + "@types/node-fetch": "^2.3.3", + "@types/once": "^1.4.0", + "fetch-mock": "^9.3.1", + "jest": "^26.0.1", + "lolex": "^6.0.0", + "prettier": "^2.0.1", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "ts-jest": "^26.1.0", + "typescript": "^4.0.2" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@octokit/types/LICENSE b/node_modules/@octokit/types/LICENSE new file mode 100644 index 00000000..57bee5f1 --- /dev/null +++ b/node_modules/@octokit/types/LICENSE @@ -0,0 +1,7 @@ +MIT License Copyright (c) 2019 Octokit contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/@octokit/types/README.md b/node_modules/@octokit/types/README.md new file mode 100644 index 00000000..c48ce424 --- /dev/null +++ b/node_modules/@octokit/types/README.md @@ -0,0 +1,65 @@ +# types.ts + +> Shared TypeScript definitions for Octokit projects + +[![@latest](https://img.shields.io/npm/v/@octokit/types.svg)](https://www.npmjs.com/package/@octokit/types) +[![Build Status](https://github.com/octokit/types.ts/workflows/Test/badge.svg)](https://github.com/octokit/types.ts/actions?workflow=Test) + + + +- [Usage](#usage) +- [Examples](#examples) + - [Get parameter and response data types for a REST API endpoint](#get-parameter-and-response-data-types-for-a-rest-api-endpoint) + - [Get response types from endpoint methods](#get-response-types-from-endpoint-methods) +- [Contributing](#contributing) +- [License](#license) + + + +## Usage + +See all exported types at https://octokit.github.io/types.ts + +## Examples + +### Get parameter and response data types for a REST API endpoint + +```ts +import { Endpoints } from "@octokit/types"; + +type listUserReposParameters = + Endpoints["GET /repos/{owner}/{repo}"]["parameters"]; +type listUserReposResponse = Endpoints["GET /repos/{owner}/{repo}"]["response"]; + +async function listRepos( + options: listUserReposParameters +): listUserReposResponse["data"] { + // ... +} +``` + +### Get response types from endpoint methods + +```ts +import { + GetResponseTypeFromEndpointMethod, + GetResponseDataTypeFromEndpointMethod, +} from "@octokit/types"; +import { Octokit } from "@octokit/rest"; + +const octokit = new Octokit(); +type CreateLabelResponseType = GetResponseTypeFromEndpointMethod< + typeof octokit.issues.createLabel +>; +type CreateLabelResponseDataType = GetResponseDataTypeFromEndpointMethod< + typeof octokit.issues.createLabel +>; +``` + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) + +## License + +[MIT](LICENSE) diff --git a/node_modules/@octokit/types/dist-node/index.js b/node_modules/@octokit/types/dist-node/index.js new file mode 100644 index 00000000..10af3b51 --- /dev/null +++ b/node_modules/@octokit/types/dist-node/index.js @@ -0,0 +1,8 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +const VERSION = "6.16.0"; + +exports.VERSION = VERSION; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/types/dist-node/index.js.map b/node_modules/@octokit/types/dist-node/index.js.map new file mode 100644 index 00000000..2d148d3b --- /dev/null +++ b/node_modules/@octokit/types/dist-node/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/VERSION.js"],"sourcesContent":["export const VERSION = \"0.0.0-development\";\n"],"names":["VERSION"],"mappings":";;;;MAAaA,OAAO,GAAG;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/types/dist-src/AuthInterface.js b/node_modules/@octokit/types/dist-src/AuthInterface.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/AuthInterface.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/EndpointDefaults.js b/node_modules/@octokit/types/dist-src/EndpointDefaults.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/EndpointDefaults.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/EndpointInterface.js b/node_modules/@octokit/types/dist-src/EndpointInterface.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/EndpointInterface.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/EndpointOptions.js b/node_modules/@octokit/types/dist-src/EndpointOptions.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/EndpointOptions.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/Fetch.js b/node_modules/@octokit/types/dist-src/Fetch.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/Fetch.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js b/node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/GetResponseTypeFromEndpointMethod.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/OctokitResponse.js b/node_modules/@octokit/types/dist-src/OctokitResponse.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/OctokitResponse.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestError.js b/node_modules/@octokit/types/dist-src/RequestError.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestError.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestHeaders.js b/node_modules/@octokit/types/dist-src/RequestHeaders.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestHeaders.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestInterface.js b/node_modules/@octokit/types/dist-src/RequestInterface.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestInterface.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestMethod.js b/node_modules/@octokit/types/dist-src/RequestMethod.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestMethod.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestOptions.js b/node_modules/@octokit/types/dist-src/RequestOptions.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestOptions.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestParameters.js b/node_modules/@octokit/types/dist-src/RequestParameters.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestParameters.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/RequestRequestOptions.js b/node_modules/@octokit/types/dist-src/RequestRequestOptions.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/RequestRequestOptions.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/ResponseHeaders.js b/node_modules/@octokit/types/dist-src/ResponseHeaders.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/ResponseHeaders.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/Route.js b/node_modules/@octokit/types/dist-src/Route.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/Route.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/Signal.js b/node_modules/@octokit/types/dist-src/Signal.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/Signal.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/StrategyInterface.js b/node_modules/@octokit/types/dist-src/StrategyInterface.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/StrategyInterface.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/Url.js b/node_modules/@octokit/types/dist-src/Url.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/Url.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/VERSION.js b/node_modules/@octokit/types/dist-src/VERSION.js new file mode 100644 index 00000000..39a2e0c2 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/VERSION.js @@ -0,0 +1 @@ +export const VERSION = "6.16.0"; diff --git a/node_modules/@octokit/types/dist-src/generated/Endpoints.js b/node_modules/@octokit/types/dist-src/generated/Endpoints.js new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/generated/Endpoints.js @@ -0,0 +1 @@ +export {}; diff --git a/node_modules/@octokit/types/dist-src/index.js b/node_modules/@octokit/types/dist-src/index.js new file mode 100644 index 00000000..004ae9b2 --- /dev/null +++ b/node_modules/@octokit/types/dist-src/index.js @@ -0,0 +1,21 @@ +export * from "./AuthInterface"; +export * from "./EndpointDefaults"; +export * from "./EndpointInterface"; +export * from "./EndpointOptions"; +export * from "./Fetch"; +export * from "./OctokitResponse"; +export * from "./RequestError"; +export * from "./RequestHeaders"; +export * from "./RequestInterface"; +export * from "./RequestMethod"; +export * from "./RequestOptions"; +export * from "./RequestParameters"; +export * from "./RequestRequestOptions"; +export * from "./ResponseHeaders"; +export * from "./Route"; +export * from "./Signal"; +export * from "./StrategyInterface"; +export * from "./Url"; +export * from "./VERSION"; +export * from "./GetResponseTypeFromEndpointMethod"; +export * from "./generated/Endpoints"; diff --git a/node_modules/@octokit/types/dist-types/AuthInterface.d.ts b/node_modules/@octokit/types/dist-types/AuthInterface.d.ts new file mode 100644 index 00000000..8b39d612 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/AuthInterface.d.ts @@ -0,0 +1,31 @@ +import { EndpointOptions } from "./EndpointOptions"; +import { OctokitResponse } from "./OctokitResponse"; +import { RequestInterface } from "./RequestInterface"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; +/** + * Interface to implement complex authentication strategies for Octokit. + * An object Implementing the AuthInterface can directly be passed as the + * `auth` option in the Octokit constructor. + * + * For the official implementations of the most common authentication + * strategies, see https://github.com/octokit/auth.js + */ +export interface AuthInterface { + (...args: AuthOptions): Promise; + hook: { + /** + * Sends a request using the passed `request` instance + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: RequestInterface, options: EndpointOptions): Promise>; + /** + * Sends a request using the passed `request` instance + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (request: RequestInterface, route: Route, parameters?: RequestParameters): Promise>; + }; +} diff --git a/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts b/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts new file mode 100644 index 00000000..a2c23078 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/EndpointDefaults.d.ts @@ -0,0 +1,21 @@ +import { RequestHeaders } from "./RequestHeaders"; +import { RequestMethod } from "./RequestMethod"; +import { RequestParameters } from "./RequestParameters"; +import { Url } from "./Url"; +/** + * The `.endpoint()` method is guaranteed to set all keys defined by RequestParameters + * as well as the method property. + */ +export declare type EndpointDefaults = RequestParameters & { + baseUrl: Url; + method: RequestMethod; + url?: Url; + headers: RequestHeaders & { + accept: string; + "user-agent": string; + }; + mediaType: { + format: string; + previews: string[]; + }; +}; diff --git a/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts b/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts new file mode 100644 index 00000000..d7b40092 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/EndpointInterface.d.ts @@ -0,0 +1,65 @@ +import { EndpointDefaults } from "./EndpointDefaults"; +import { RequestOptions } from "./RequestOptions"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; +import { Endpoints } from "./generated/Endpoints"; +export interface EndpointInterface { + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {object} endpoint Must set `url` unless it's set defaults. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: O & { + method?: string; + } & ("url" extends keyof D ? { + url?: string; + } : { + url: string; + })): RequestOptions & Pick; + /** + * Transforms a GitHub REST API endpoint into generic request options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: keyof Endpoints | R, parameters?: P): (R extends keyof Endpoints ? Endpoints[R]["request"] : RequestOptions) & Pick; + /** + * Object with current default route and parameters + */ + DEFAULTS: D & EndpointDefaults; + /** + * Returns a new `endpoint` interface with new defaults + */ + defaults: (newDefaults: O) => EndpointInterface; + merge: { + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + * + */ + (route: keyof Endpoints | R, parameters?: P): D & (R extends keyof Endpoints ? Endpoints[R]["request"] & Endpoints[R]["parameters"] : EndpointDefaults) & P; + /** + * Merges current endpoint defaults with passed route and parameters, + * without transforming them into request options. + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ +

(options: P): EndpointDefaults & D & P; + /** + * Returns current default options. + * + * @deprecated use endpoint.DEFAULTS instead + */ + (): D & EndpointDefaults; + }; + /** + * Stateless method to turn endpoint options into request options. + * Calling `endpoint(options)` is the same as calling `endpoint.parse(endpoint.merge(options))`. + * + * @param {object} options `method`, `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + parse: (options: O) => RequestOptions & Pick; +} diff --git a/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts b/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts new file mode 100644 index 00000000..b1b91f11 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/EndpointOptions.d.ts @@ -0,0 +1,7 @@ +import { RequestMethod } from "./RequestMethod"; +import { Url } from "./Url"; +import { RequestParameters } from "./RequestParameters"; +export declare type EndpointOptions = RequestParameters & { + method: RequestMethod; + url: Url; +}; diff --git a/node_modules/@octokit/types/dist-types/Fetch.d.ts b/node_modules/@octokit/types/dist-types/Fetch.d.ts new file mode 100644 index 00000000..cbbd5e8f --- /dev/null +++ b/node_modules/@octokit/types/dist-types/Fetch.d.ts @@ -0,0 +1,4 @@ +/** + * Browser's fetch method (or compatible such as fetch-mock) + */ +export declare type Fetch = any; diff --git a/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts b/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts new file mode 100644 index 00000000..70e1a8d4 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/GetResponseTypeFromEndpointMethod.d.ts @@ -0,0 +1,5 @@ +declare type Unwrap = T extends Promise ? U : T; +declare type AnyFunction = (...args: any[]) => any; +export declare type GetResponseTypeFromEndpointMethod = Unwrap>; +export declare type GetResponseDataTypeFromEndpointMethod = Unwrap>["data"]; +export {}; diff --git a/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts b/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts new file mode 100644 index 00000000..28fdfb88 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/OctokitResponse.d.ts @@ -0,0 +1,17 @@ +import { ResponseHeaders } from "./ResponseHeaders"; +import { Url } from "./Url"; +export declare type OctokitResponse = { + headers: ResponseHeaders; + /** + * http response code + */ + status: S; + /** + * URL of response after all redirects + */ + url: Url; + /** + * Response data as documented in the REST API reference documentation at https://docs.github.com/rest/reference + */ + data: T; +}; diff --git a/node_modules/@octokit/types/dist-types/RequestError.d.ts b/node_modules/@octokit/types/dist-types/RequestError.d.ts new file mode 100644 index 00000000..89174e6e --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestError.d.ts @@ -0,0 +1,11 @@ +export declare type RequestError = { + name: string; + status: number; + documentation_url: string; + errors?: Array<{ + resource: string; + code: string; + field: string; + message?: string; + }>; +}; diff --git a/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts b/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts new file mode 100644 index 00000000..ac5aae0a --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestHeaders.d.ts @@ -0,0 +1,15 @@ +export declare type RequestHeaders = { + /** + * Avoid setting `headers.accept`, use `mediaType.{format|previews}` option instead. + */ + accept?: string; + /** + * Use `authorization` to send authenticated request, remember `token ` / `bearer ` prefixes. Example: `token 1234567890abcdef1234567890abcdef12345678` + */ + authorization?: string; + /** + * `user-agent` is set do a default and can be overwritten as needed. + */ + "user-agent"?: string; + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/types/dist-types/RequestInterface.d.ts b/node_modules/@octokit/types/dist-types/RequestInterface.d.ts new file mode 100644 index 00000000..851811ff --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestInterface.d.ts @@ -0,0 +1,34 @@ +import { EndpointInterface } from "./EndpointInterface"; +import { OctokitResponse } from "./OctokitResponse"; +import { RequestParameters } from "./RequestParameters"; +import { Route } from "./Route"; +import { Endpoints } from "./generated/Endpoints"; +export interface RequestInterface { + /** + * Sends a request based on endpoint options + * + * @param {object} endpoint Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (options: O & { + method?: string; + } & ("url" extends keyof D ? { + url?: string; + } : { + url: string; + })): Promise>; + /** + * Sends a request based on endpoint options + * + * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'` + * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.{format|previews}`, `request`, or `baseUrl`. + */ + (route: keyof Endpoints | R, options?: R extends keyof Endpoints ? Endpoints[R]["parameters"] & RequestParameters : RequestParameters): R extends keyof Endpoints ? Promise : Promise>; + /** + * Returns a new `request` with updated route and parameters + */ + defaults: (newDefaults: O) => RequestInterface; + /** + * Octokit endpoint API, see {@link https://github.com/octokit/endpoint.js|@octokit/endpoint} + */ + endpoint: EndpointInterface; +} diff --git a/node_modules/@octokit/types/dist-types/RequestMethod.d.ts b/node_modules/@octokit/types/dist-types/RequestMethod.d.ts new file mode 100644 index 00000000..e999c8d9 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestMethod.d.ts @@ -0,0 +1,4 @@ +/** + * HTTP Verb supported by GitHub's REST API + */ +export declare type RequestMethod = "DELETE" | "GET" | "HEAD" | "PATCH" | "POST" | "PUT"; diff --git a/node_modules/@octokit/types/dist-types/RequestOptions.d.ts b/node_modules/@octokit/types/dist-types/RequestOptions.d.ts new file mode 100644 index 00000000..97e2181c --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestOptions.d.ts @@ -0,0 +1,14 @@ +import { RequestHeaders } from "./RequestHeaders"; +import { RequestMethod } from "./RequestMethod"; +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { Url } from "./Url"; +/** + * Generic request options as they are returned by the `endpoint()` method + */ +export declare type RequestOptions = { + method: RequestMethod; + url: Url; + headers: RequestHeaders; + body?: any; + request?: RequestRequestOptions; +}; diff --git a/node_modules/@octokit/types/dist-types/RequestParameters.d.ts b/node_modules/@octokit/types/dist-types/RequestParameters.d.ts new file mode 100644 index 00000000..b056a0e2 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestParameters.d.ts @@ -0,0 +1,45 @@ +import { RequestRequestOptions } from "./RequestRequestOptions"; +import { RequestHeaders } from "./RequestHeaders"; +import { Url } from "./Url"; +/** + * Parameters that can be passed into `request(route, parameters)` or `endpoint(route, parameters)` methods + */ +export declare type RequestParameters = { + /** + * Base URL to be used when a relative URL is passed, such as `/orgs/{org}`. + * If `baseUrl` is `https://enterprise.acme-inc.com/api/v3`, then the request + * will be sent to `https://enterprise.acme-inc.com/api/v3/orgs/{org}`. + */ + baseUrl?: Url; + /** + * HTTP headers. Use lowercase keys. + */ + headers?: RequestHeaders; + /** + * Media type options, see {@link https://developer.github.com/v3/media/|GitHub Developer Guide} + */ + mediaType?: { + /** + * `json` by default. Can be `raw`, `text`, `html`, `full`, `diff`, `patch`, `sha`, `base64`. Depending on endpoint + */ + format?: string; + /** + * Custom media type names of {@link https://developer.github.com/v3/media/|API Previews} without the `-preview` suffix. + * Example for single preview: `['squirrel-girl']`. + * Example for multiple previews: `['squirrel-girl', 'mister-fantastic']`. + */ + previews?: string[]; + }; + /** + * Pass custom meta information for the request. The `request` object will be returned as is. + */ + request?: RequestRequestOptions; + /** + * Any additional parameter will be passed as follows + * 1. URL parameter if `':parameter'` or `{parameter}` is part of `url` + * 2. Query parameter if `method` is `'GET'` or `'HEAD'` + * 3. Request body if `parameter` is `'data'` + * 4. JSON in the request body in the form of `body[parameter]` unless `parameter` key is `'data'` + */ + [parameter: string]: unknown; +}; diff --git a/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts b/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts new file mode 100644 index 00000000..8f5c43a9 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/RequestRequestOptions.d.ts @@ -0,0 +1,26 @@ +import { Fetch } from "./Fetch"; +import { Signal } from "./Signal"; +/** + * Octokit-specific request options which are ignored for the actual request, but can be used by Octokit or plugins to manipulate how the request is sent or how a response is handled + */ +export declare type RequestRequestOptions = { + /** + * Node only. Useful for custom proxy, certificate, or dns lookup. + * + * @see https://nodejs.org/api/http.html#http_class_http_agent + */ + agent?: unknown; + /** + * Custom replacement for built-in fetch method. Useful for testing or request hooks. + */ + fetch?: Fetch; + /** + * Use an `AbortController` instance to cancel a request. In node you can only cancel streamed requests. + */ + signal?: Signal; + /** + * Node only. Request/response timeout in ms, it resets on redirect. 0 to disable (OS limit applies). `options.request.signal` is recommended instead. + */ + timeout?: number; + [option: string]: any; +}; diff --git a/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts b/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts new file mode 100644 index 00000000..c8fbe43f --- /dev/null +++ b/node_modules/@octokit/types/dist-types/ResponseHeaders.d.ts @@ -0,0 +1,20 @@ +export declare type ResponseHeaders = { + "cache-control"?: string; + "content-length"?: number; + "content-type"?: string; + date?: string; + etag?: string; + "last-modified"?: string; + link?: string; + location?: string; + server?: string; + status?: string; + vary?: string; + "x-github-mediatype"?: string; + "x-github-request-id"?: string; + "x-oauth-scopes"?: string; + "x-ratelimit-limit"?: string; + "x-ratelimit-remaining"?: string; + "x-ratelimit-reset"?: string; + [header: string]: string | number | undefined; +}; diff --git a/node_modules/@octokit/types/dist-types/Route.d.ts b/node_modules/@octokit/types/dist-types/Route.d.ts new file mode 100644 index 00000000..dcaac75b --- /dev/null +++ b/node_modules/@octokit/types/dist-types/Route.d.ts @@ -0,0 +1,4 @@ +/** + * String consisting of an optional HTTP method and relative path or absolute URL. Examples: `'/orgs/{org}'`, `'PUT /orgs/{org}'`, `GET https://example.com/foo/bar` + */ +export declare type Route = string; diff --git a/node_modules/@octokit/types/dist-types/Signal.d.ts b/node_modules/@octokit/types/dist-types/Signal.d.ts new file mode 100644 index 00000000..4ebcf24e --- /dev/null +++ b/node_modules/@octokit/types/dist-types/Signal.d.ts @@ -0,0 +1,6 @@ +/** + * Abort signal + * + * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal + */ +export declare type Signal = any; diff --git a/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts b/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts new file mode 100644 index 00000000..405cbd23 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/StrategyInterface.d.ts @@ -0,0 +1,4 @@ +import { AuthInterface } from "./AuthInterface"; +export interface StrategyInterface { + (...args: StrategyOptions): AuthInterface; +} diff --git a/node_modules/@octokit/types/dist-types/Url.d.ts b/node_modules/@octokit/types/dist-types/Url.d.ts new file mode 100644 index 00000000..3e699160 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/Url.d.ts @@ -0,0 +1,4 @@ +/** + * Relative or absolute URL. Examples: `'/orgs/{org}'`, `https://example.com/foo/bar` + */ +export declare type Url = string; diff --git a/node_modules/@octokit/types/dist-types/VERSION.d.ts b/node_modules/@octokit/types/dist-types/VERSION.d.ts new file mode 100644 index 00000000..f5c47fa4 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/VERSION.d.ts @@ -0,0 +1 @@ +export declare const VERSION = "6.16.0"; diff --git a/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts b/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts new file mode 100644 index 00000000..df80b47d --- /dev/null +++ b/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts @@ -0,0 +1,3174 @@ +import { paths } from "@octokit/openapi-types"; +import { OctokitResponse } from "../OctokitResponse"; +import { RequestHeaders } from "../RequestHeaders"; +import { RequestRequestOptions } from "../RequestRequestOptions"; +declare type UnionToIntersection = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never; +declare type ExtractParameters = "parameters" extends keyof T ? UnionToIntersection<{ + [K in keyof T["parameters"]]: T["parameters"][K]; +}[keyof T["parameters"]]> : {}; +declare type ExtractRequestBody = "requestBody" extends keyof T ? "content" extends keyof T["requestBody"] ? "application/json" extends keyof T["requestBody"]["content"] ? T["requestBody"]["content"]["application/json"] : { + data: { + [K in keyof T["requestBody"]["content"]]: T["requestBody"]["content"][K]; + }[keyof T["requestBody"]["content"]]; +} : "application/json" extends keyof T["requestBody"] ? T["requestBody"]["application/json"] : { + data: { + [K in keyof T["requestBody"]]: T["requestBody"][K]; + }[keyof T["requestBody"]]; +} : {}; +declare type ToOctokitParameters = ExtractParameters & ExtractRequestBody; +declare type RequiredPreview = T extends string ? { + mediaType: { + previews: [T, ...string[]]; + }; +} : {}; +declare type Operation = { + parameters: ToOctokitParameters & RequiredPreview; + request: { + method: Method extends keyof MethodsMap ? MethodsMap[Method] : never; + url: Url; + headers: RequestHeaders; + request: RequestRequestOptions; + }; + response: Url extends keyof EndpointsWithMissingRequiredResponseDataSchema ? Method extends EndpointsWithMissingRequiredResponseDataSchema[Url] ? DeepRequired> : ExtractOctokitResponse : ExtractOctokitResponse; +}; +declare type MethodsMap = { + delete: "DELETE"; + get: "GET"; + patch: "PATCH"; + post: "POST"; + put: "PUT"; +}; +declare type SuccessStatuses = 200 | 201 | 202 | 204; +declare type RedirectStatuses = 301 | 302; +declare type EmptyResponseStatuses = 201 | 204; +declare type KnownJsonResponseTypes = "application/json" | "application/scim+json" | "text/html"; +declare type SuccessResponseDataType = { + [K in SuccessStatuses & keyof Responses]: GetContentKeyIfPresent extends never ? never : OctokitResponse, K>; +}[SuccessStatuses & keyof Responses]; +declare type RedirectResponseDataType = { + [K in RedirectStatuses & keyof Responses]: OctokitResponse; +}[RedirectStatuses & keyof Responses]; +declare type EmptyResponseDataType = { + [K in EmptyResponseStatuses & keyof Responses]: OctokitResponse; +}[EmptyResponseStatuses & keyof Responses]; +declare type GetContentKeyIfPresent = "content" extends keyof T ? DataType : DataType; +declare type DataType = { + [K in KnownJsonResponseTypes & keyof T]: T[K]; +}[KnownJsonResponseTypes & keyof T]; +declare type ExtractOctokitResponse = "responses" extends keyof R ? SuccessResponseDataType extends never ? RedirectResponseDataType extends never ? EmptyResponseDataType : RedirectResponseDataType : SuccessResponseDataType : unknown; +declare type EndpointsWithMissingRequiredResponseDataSchema = { + "/app/hook/config": "get" | "patch"; + "/app/installations/{installation_id}/access_tokens": "post"; + "/emojis": "get"; + "/enterprises/{enterprise}/actions/permissions": "get"; + "/enterprises/{enterprise}/actions/permissions/organizations": "get"; + "/enterprises/{enterprise}/actions/permissions/selected-actions": "get"; + "/enterprises/{enterprise}/actions/runner-groups": "get" | "post"; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": "get" | "patch"; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": "get"; + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": "get"; + "/enterprises/{enterprise}/actions/runners": "get"; + "/enterprises/{enterprise}/actions/runners/downloads": "get"; + "/enterprises/{enterprise}/settings/billing/actions": "get"; + "/enterprises/{enterprise}/settings/billing/packages": "get"; + "/enterprises/{enterprise}/settings/billing/shared-storage": "get"; + "/installation/repositories": "get"; + "/notifications": "get"; + "/notifications/threads/{thread_id}": "get"; + "/orgs/{org}/actions/permissions": "get"; + "/orgs/{org}/actions/permissions/repositories": "get"; + "/orgs/{org}/actions/permissions/selected-actions": "get"; + "/orgs/{org}/actions/runner-groups": "get" | "post"; + "/orgs/{org}/actions/runner-groups/{runner_group_id}": "get" | "patch"; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": "get"; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": "get"; + "/orgs/{org}/actions/runners": "get"; + "/orgs/{org}/actions/runners/downloads": "get"; + "/orgs/{org}/actions/secrets": "get"; + "/orgs/{org}/actions/secrets/{secret_name}/repositories": "get"; + "/orgs/{org}/hooks/{hook_id}/config": "get" | "patch"; + "/orgs/{org}/installations": "get"; + "/orgs/{org}/invitations": "get" | "post"; + "/orgs/{org}/settings/billing/actions": "get"; + "/orgs/{org}/settings/billing/packages": "get"; + "/orgs/{org}/settings/billing/shared-storage": "get"; + "/orgs/{org}/team-sync/groups": "get"; + "/orgs/{org}/teams/{team_slug}/invitations": "get"; + "/orgs/{org}/teams/{team_slug}/projects": "get"; + "/orgs/{org}/teams/{team_slug}/projects/{project_id}": "get"; + "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": "get" | "patch"; + "/projects/columns/cards/{card_id}/moves": "post"; + "/projects/columns/{column_id}/moves": "post"; + "/repos/{owner}/{repo}/actions/artifacts": "get"; + "/repos/{owner}/{repo}/actions/permissions": "get"; + "/repos/{owner}/{repo}/actions/permissions/selected-actions": "get"; + "/repos/{owner}/{repo}/actions/runners": "get"; + "/repos/{owner}/{repo}/actions/runners/downloads": "get"; + "/repos/{owner}/{repo}/actions/runs": "get"; + "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": "get"; + "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": "get"; + "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": "get"; + "/repos/{owner}/{repo}/actions/secrets": "get"; + "/repos/{owner}/{repo}/actions/workflows": "get"; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": "get"; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": "get"; + "/repos/{owner}/{repo}/check-suites/preferences": "patch"; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": "get"; + "/repos/{owner}/{repo}/code-scanning/alerts": "get"; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": "get" | "patch"; + "/repos/{owner}/{repo}/code-scanning/analyses": "get"; + "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": "get"; + "/repos/{owner}/{repo}/commits/{ref}/check-runs": "get"; + "/repos/{owner}/{repo}/commits/{ref}/check-suites": "get"; + "/repos/{owner}/{repo}/commits/{ref}/statuses": "get"; + "/repos/{owner}/{repo}/contents/{path}": "put" | "delete"; + "/repos/{owner}/{repo}/git/blobs": "post"; + "/repos/{owner}/{repo}/git/commits": "post"; + "/repos/{owner}/{repo}/git/commits/{commit_sha}": "get"; + "/repos/{owner}/{repo}/git/matching-refs/{ref}": "get"; + "/repos/{owner}/{repo}/git/ref/{ref}": "get"; + "/repos/{owner}/{repo}/git/refs": "post"; + "/repos/{owner}/{repo}/git/refs/{ref}": "patch"; + "/repos/{owner}/{repo}/hooks/{hook_id}/config": "get" | "patch"; + "/repos/{owner}/{repo}/issues/{issue_number}/events": "get"; + "/repos/{owner}/{repo}/issues/{issue_number}/timeline": "get"; + "/repos/{owner}/{repo}/keys": "get" | "post"; + "/repos/{owner}/{repo}/keys/{key_id}": "get"; + "/repos/{owner}/{repo}/languages": "get"; + "/repos/{owner}/{repo}/notifications": "get"; + "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": "get"; + "/repos/{owner}/{repo}/stats/participation": "get"; + "/repos/{owner}/{repo}/statuses/{sha}": "post"; + "/repos/{owner}/{repo}/topics": "get" | "put"; + "/scim/v2/enterprises/{enterprise}/Groups": "get" | "post"; + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": "get" | "put" | "patch"; + "/scim/v2/enterprises/{enterprise}/Users": "get" | "post"; + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": "get" | "put" | "patch"; + "/search/code": "get"; + "/search/commits": "get"; + "/search/issues": "get"; + "/search/labels": "get"; + "/search/repositories": "get"; + "/search/topics": "get"; + "/search/users": "get"; + "/teams/{team_id}/invitations": "get"; + "/teams/{team_id}/projects": "get"; + "/teams/{team_id}/projects/{project_id}": "get"; + "/teams/{team_id}/team-sync/group-mappings": "get" | "patch"; + "/user/installations": "get"; + "/user/installations/{installation_id}/repositories": "get"; + "/user/keys": "get" | "post"; + "/user/keys/{key_id}": "get"; + "/users/{username}/settings/billing/actions": "get"; + "/users/{username}/settings/billing/packages": "get"; + "/users/{username}/settings/billing/shared-storage": "get"; +}; +declare type NotNill = T extends null | undefined ? never : T; +declare type Primitive = undefined | null | boolean | string | number | Function; +declare type DeepRequired = T extends Primitive ? NotNill : { + [P in keyof T]-?: T[P] extends Array ? Array> : T[P] extends ReadonlyArray ? DeepRequired : DeepRequired; +}; +export interface Endpoints { + /** + * @see https://docs.github.com/rest/reference/apps#delete-an-installation-for-the-authenticated-app + */ + "DELETE /app/installations/{installation_id}": Operation<"/app/installations/{installation_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#unsuspend-an-app-installation + */ + "DELETE /app/installations/{installation_id}/suspended": Operation<"/app/installations/{installation_id}/suspended", "delete">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#delete-a-grant + */ + "DELETE /applications/grants/{grant_id}": Operation<"/applications/grants/{grant_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#delete-an-app-authorization + */ + "DELETE /applications/{client_id}/grant": Operation<"/applications/{client_id}/grant", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#revoke-a-grant-for-an-application + */ + "DELETE /applications/{client_id}/grants/{access_token}": Operation<"/applications/{client_id}/grants/{access_token}", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#delete-an-app-token + */ + "DELETE /applications/{client_id}/token": Operation<"/applications/{client_id}/token", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#revoke-an-authorization-for-an-application + */ + "DELETE /applications/{client_id}/tokens/{access_token}": Operation<"/applications/{client_id}/tokens/{access_token}", "delete">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#delete-an-authorization + */ + "DELETE /authorizations/{authorization_id}": Operation<"/authorizations/{authorization_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise + */ + "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}": Operation<"/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise + */ + "DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + */ + "DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise + */ + "DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise + */ + "DELETE /enterprises/{enterprise}/actions/runners/{runner_id}": Operation<"/enterprises/{enterprise}/actions/runners/{runner_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/gists#delete-a-gist + */ + "DELETE /gists/{gist_id}": Operation<"/gists/{gist_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/gists#delete-a-gist-comment + */ + "DELETE /gists/{gist_id}/comments/{comment_id}": Operation<"/gists/{gist_id}/comments/{comment_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/gists#unstar-a-gist + */ + "DELETE /gists/{gist_id}/star": Operation<"/gists/{gist_id}/star", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#revoke-an-installation-access-token + */ + "DELETE /installation/token": Operation<"/installation/token", "delete">; + /** + * @see https://docs.github.com/rest/reference/activity#delete-a-thread-subscription + */ + "DELETE /notifications/threads/{thread_id}/subscription": Operation<"/notifications/threads/{thread_id}/subscription", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization + */ + "DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}": Operation<"/orgs/{org}/actions/permissions/repositories/{repository_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-group-from-an-organization + */ + "DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization + */ + "DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization + */ + "DELETE /orgs/{org}/actions/runners/{runner_id}": Operation<"/orgs/{org}/actions/runners/{runner_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-an-organization-secret + */ + "DELETE /orgs/{org}/actions/secrets/{secret_name}": Operation<"/orgs/{org}/actions/secrets/{secret_name}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret + */ + "DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": Operation<"/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/orgs#unblock-a-user-from-an-organization + */ + "DELETE /orgs/{org}/blocks/{username}": Operation<"/orgs/{org}/blocks/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/orgs#remove-a-saml-sso-authorization-for-an-organization + */ + "DELETE /orgs/{org}/credential-authorizations/{credential_id}": Operation<"/orgs/{org}/credential-authorizations/{credential_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/orgs#delete-an-organization-webhook + */ + "DELETE /orgs/{org}/hooks/{hook_id}": Operation<"/orgs/{org}/hooks/{hook_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-an-organization + */ + "DELETE /orgs/{org}/interaction-limits": Operation<"/orgs/{org}/interaction-limits", "delete">; + /** + * @see https://docs.github.com/rest/reference/orgs#cancel-an-organization-invitation + */ + "DELETE /orgs/{org}/invitations/{invitation_id}": Operation<"/orgs/{org}/invitations/{invitation_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/orgs#remove-an-organization-member + */ + "DELETE /orgs/{org}/members/{username}": Operation<"/orgs/{org}/members/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/orgs#remove-organization-membership-for-a-user + */ + "DELETE /orgs/{org}/memberships/{username}": Operation<"/orgs/{org}/memberships/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/migrations#delete-an-organization-migration-archive + */ + "DELETE /orgs/{org}/migrations/{migration_id}/archive": Operation<"/orgs/{org}/migrations/{migration_id}/archive", "delete", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#unlock-an-organization-repository + */ + "DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": Operation<"/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", "delete", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/orgs#remove-outside-collaborator-from-an-organization + */ + "DELETE /orgs/{org}/outside_collaborators/{username}": Operation<"/orgs/{org}/outside_collaborators/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/packages#delete-a-package-for-an-organization + */ + "DELETE /orgs/{org}/packages/{package_type}/{package_name}": Operation<"/orgs/{org}/packages/{package_type}/{package_name}", "delete">; + /** + * @see https://docs.github.com/rest/reference/packages#delete-a-package-version-for-an-organization + */ + "DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": Operation<"/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user + */ + "DELETE /orgs/{org}/public_members/{username}": Operation<"/orgs/{org}/public_members/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#delete-a-team + */ + "DELETE /orgs/{org}/teams/{team_slug}": Operation<"/orgs/{org}/teams/{team_slug}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#delete-a-discussion + */ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#delete-a-discussion-comment + */ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "delete">; + /** + * @see https://docs.github.com/rest/reference/reactions#delete-team-discussion-comment-reaction + */ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/reactions#delete-team-discussion-reaction + */ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user + */ + "DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}": Operation<"/orgs/{org}/teams/{team_slug}/memberships/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team + */ + "DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}": Operation<"/orgs/{org}/teams/{team_slug}/projects/{project_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams/#remove-a-repository-from-a-team + */ + "DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": Operation<"/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "delete">; + /** + * @see https://docs.github.com/rest/reference/projects#delete-a-project-card + */ + "DELETE /projects/columns/cards/{card_id}": Operation<"/projects/columns/cards/{card_id}", "delete", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#delete-a-project-column + */ + "DELETE /projects/columns/{column_id}": Operation<"/projects/columns/{column_id}", "delete", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#delete-a-project + */ + "DELETE /projects/{project_id}": Operation<"/projects/{project_id}", "delete", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#remove-project-collaborator + */ + "DELETE /projects/{project_id}/collaborators/{username}": Operation<"/projects/{project_id}/collaborators/{username}", "delete", "inertia">; + /** + * @see https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy + */ + "DELETE /reactions/{reaction_id}": Operation<"/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-repository + */ + "DELETE /repos/{owner}/{repo}": Operation<"/repos/{owner}/{repo}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-an-artifact + */ + "DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}": Operation<"/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository + */ + "DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}": Operation<"/repos/{owner}/{repo}/actions/runners/{runner_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-a-workflow-run + */ + "DELETE /repos/{owner}/{repo}/actions/runs/{run_id}": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-workflow-run-logs + */ + "DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/logs", "delete">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-a-repository-secret + */ + "DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}": Operation<"/repos/{owner}/{repo}/actions/secrets/{secret_name}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#disable-automated-security-fixes + */ + "DELETE /repos/{owner}/{repo}/automated-security-fixes": Operation<"/repos/{owner}/{repo}/automated-security-fixes", "delete", "london">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-branch-protection + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-admin-branch-protection + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-pull-request-review-protection + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-commit-signature-protection + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "delete", "zzzax">; + /** + * @see https://docs.github.com/rest/reference/repos#remove-status-check-protection + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#remove-status-check-contexts + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-access-restrictions + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#remove-app-access-restrictions + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#remove-team-access-restrictions + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#remove-user-access-restrictions + */ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "delete">; + /** + * @see https://docs.github.com/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository + */ + "DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}": Operation<"/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#remove-a-repository-collaborator + */ + "DELETE /repos/{owner}/{repo}/collaborators/{username}": Operation<"/repos/{owner}/{repo}/collaborators/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-commit-comment + */ + "DELETE /repos/{owner}/{repo}/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/comments/{comment_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/reactions#delete-a-commit-comment-reaction + */ + "DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": Operation<"/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-file + */ + "DELETE /repos/{owner}/{repo}/contents/{path}": Operation<"/repos/{owner}/{repo}/contents/{path}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-deployment + */ + "DELETE /repos/{owner}/{repo}/deployments/{deployment_id}": Operation<"/repos/{owner}/{repo}/deployments/{deployment_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-an-environment + */ + "DELETE /repos/{owner}/{repo}/environments/{environment_name}": Operation<"/repos/{owner}/{repo}/environments/{environment_name}", "delete">; + /** + * @see https://docs.github.com/rest/reference/git#delete-a-reference + */ + "DELETE /repos/{owner}/{repo}/git/refs/{ref}": Operation<"/repos/{owner}/{repo}/git/refs/{ref}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-repository-webhook + */ + "DELETE /repos/{owner}/{repo}/hooks/{hook_id}": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/migrations#cancel-an-import + */ + "DELETE /repos/{owner}/{repo}/import": Operation<"/repos/{owner}/{repo}/import", "delete">; + /** + * @see https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-a-repository + */ + "DELETE /repos/{owner}/{repo}/interaction-limits": Operation<"/repos/{owner}/{repo}/interaction-limits", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-repository-invitation + */ + "DELETE /repos/{owner}/{repo}/invitations/{invitation_id}": Operation<"/repos/{owner}/{repo}/invitations/{invitation_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/issues#delete-an-issue-comment + */ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/issues/comments/{comment_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/reactions#delete-an-issue-comment-reaction + */ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": Operation<"/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue + */ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/assignees", "delete">; + /** + * @see https://docs.github.com/rest/reference/issues#remove-all-labels-from-an-issue + */ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/labels", "delete">; + /** + * @see https://docs.github.com/rest/reference/issues#remove-a-label-from-an-issue + */ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", "delete">; + /** + * @see https://docs.github.com/rest/reference/issues#unlock-an-issue + */ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/lock", "delete">; + /** + * @see https://docs.github.com/rest/reference/reactions#delete-an-issue-reaction + */ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-deploy-key + */ + "DELETE /repos/{owner}/{repo}/keys/{key_id}": Operation<"/repos/{owner}/{repo}/keys/{key_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/issues#delete-a-label + */ + "DELETE /repos/{owner}/{repo}/labels/{name}": Operation<"/repos/{owner}/{repo}/labels/{name}", "delete">; + /** + * @see https://docs.github.com/rest/reference/issues#delete-a-milestone + */ + "DELETE /repos/{owner}/{repo}/milestones/{milestone_number}": Operation<"/repos/{owner}/{repo}/milestones/{milestone_number}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-github-pages-site + */ + "DELETE /repos/{owner}/{repo}/pages": Operation<"/repos/{owner}/{repo}/pages", "delete", "switcheroo">; + /** + * @see https://docs.github.com/rest/reference/pulls#delete-a-review-comment-for-a-pull-request + */ + "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/pulls/comments/{comment_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/reactions#delete-a-pull-request-comment-reaction + */ + "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": Operation<"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", "delete", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request + */ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "delete">; + /** + * @see https://docs.github.com/rest/reference/pulls#delete-a-pending-review-for-a-pull-request + */ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-release-asset + */ + "DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}": Operation<"/repos/{owner}/{repo}/releases/assets/{asset_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#delete-a-release + */ + "DELETE /repos/{owner}/{repo}/releases/{release_id}": Operation<"/repos/{owner}/{repo}/releases/{release_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/activity#delete-a-repository-subscription + */ + "DELETE /repos/{owner}/{repo}/subscription": Operation<"/repos/{owner}/{repo}/subscription", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#disable-vulnerability-alerts + */ + "DELETE /repos/{owner}/{repo}/vulnerability-alerts": Operation<"/repos/{owner}/{repo}/vulnerability-alerts", "delete", "dorian">; + /** + * @see https://docs.github.com/rest/reference/actions#delete-an-environment-secret + */ + "DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": Operation<"/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise + */ + "DELETE /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": Operation<"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#delete-a-scim-user-from-an-enterprise + */ + "DELETE /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": Operation<"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/scim#delete-a-scim-user-from-an-organization + */ + "DELETE /scim/v2/organizations/{org}/Users/{scim_user_id}": Operation<"/scim/v2/organizations/{org}/Users/{scim_user_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams/#delete-a-team-legacy + */ + "DELETE /teams/{team_id}": Operation<"/teams/{team_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#delete-a-discussion-legacy + */ + "DELETE /teams/{team_id}/discussions/{discussion_number}": Operation<"/teams/{team_id}/discussions/{discussion_number}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#delete-a-discussion-comment-legacy + */ + "DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#remove-team-member-legacy + */ + "DELETE /teams/{team_id}/members/{username}": Operation<"/teams/{team_id}/members/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user-legacy + */ + "DELETE /teams/{team_id}/memberships/{username}": Operation<"/teams/{team_id}/memberships/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams/#remove-a-project-from-a-team-legacy + */ + "DELETE /teams/{team_id}/projects/{project_id}": Operation<"/teams/{team_id}/projects/{project_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/teams/#remove-a-repository-from-a-team-legacy + */ + "DELETE /teams/{team_id}/repos/{owner}/{repo}": Operation<"/teams/{team_id}/repos/{owner}/{repo}", "delete">; + /** + * @see https://docs.github.com/rest/reference/users#unblock-a-user + */ + "DELETE /user/blocks/{username}": Operation<"/user/blocks/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user + */ + "DELETE /user/emails": Operation<"/user/emails", "delete">; + /** + * @see https://docs.github.com/rest/reference/users#unfollow-a-user + */ + "DELETE /user/following/{username}": Operation<"/user/following/{username}", "delete">; + /** + * @see https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user + */ + "DELETE /user/gpg_keys/{gpg_key_id}": Operation<"/user/gpg_keys/{gpg_key_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation + */ + "DELETE /user/installations/{installation_id}/repositories/{repository_id}": Operation<"/user/installations/{installation_id}/repositories/{repository_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories + */ + "DELETE /user/interaction-limits": Operation<"/user/interaction-limits", "delete">; + /** + * @see https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user + */ + "DELETE /user/keys/{key_id}": Operation<"/user/keys/{key_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/migrations#delete-a-user-migration-archive + */ + "DELETE /user/migrations/{migration_id}/archive": Operation<"/user/migrations/{migration_id}/archive", "delete", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#unlock-a-user-repository + */ + "DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock": Operation<"/user/migrations/{migration_id}/repos/{repo_name}/lock", "delete", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/packages#delete-a-package-for-the-authenticated-user + */ + "DELETE /user/packages/{package_type}/{package_name}": Operation<"/user/packages/{package_type}/{package_name}", "delete">; + /** + * @see https://docs.github.com/rest/reference/packages#delete-a-package-version-for-the-authenticated-user + */ + "DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}": Operation<"/user/packages/{package_type}/{package_name}/versions/{package_version_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/repos#decline-a-repository-invitation + */ + "DELETE /user/repository_invitations/{invitation_id}": Operation<"/user/repository_invitations/{invitation_id}", "delete">; + /** + * @see https://docs.github.com/rest/reference/activity#unstar-a-repository-for-the-authenticated-user + */ + "DELETE /user/starred/{owner}/{repo}": Operation<"/user/starred/{owner}/{repo}", "delete">; + /** + * @see https://docs.github.com/rest/overview/resources-in-the-rest-api#root-endpoint + */ + "GET /": Operation<"/", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#get-the-authenticated-app + */ + "GET /app": Operation<"/app", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#get-a-webhook-configuration-for-an-app + */ + "GET /app/hook/config": Operation<"/app/hook/config", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app + */ + "GET /app/installations": Operation<"/app/installations", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#get-an-installation-for-the-authenticated-app + */ + "GET /app/installations/{installation_id}": Operation<"/app/installations/{installation_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#list-your-grants + */ + "GET /applications/grants": Operation<"/applications/grants", "get">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#get-a-single-grant + */ + "GET /applications/grants/{grant_id}": Operation<"/applications/grants/{grant_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#check-an-authorization + */ + "GET /applications/{client_id}/tokens/{access_token}": Operation<"/applications/{client_id}/tokens/{access_token}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps/#get-an-app + */ + "GET /apps/{app_slug}": Operation<"/apps/{app_slug}", "get">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations + */ + "GET /authorizations": Operation<"/authorizations", "get">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#get-a-single-authorization + */ + "GET /authorizations/{authorization_id}": Operation<"/authorizations/{authorization_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/codes-of-conduct#get-all-codes-of-conduct + */ + "GET /codes_of_conduct": Operation<"/codes_of_conduct", "get", "scarlet-witch">; + /** + * @see https://docs.github.com/rest/reference/codes-of-conduct#get-a-code-of-conduct + */ + "GET /codes_of_conduct/{key}": Operation<"/codes_of_conduct/{key}", "get", "scarlet-witch">; + /** + * @see https://docs.github.com/rest/reference/emojis#get-emojis + */ + "GET /emojis": Operation<"/emojis", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/permissions": Operation<"/enterprises/{enterprise}/actions/permissions", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/permissions/organizations": Operation<"/enterprises/{enterprise}/actions/permissions/organizations", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/permissions/selected-actions": Operation<"/enterprises/{enterprise}/actions/permissions/selected-actions", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups": Operation<"/enterprises/{enterprise}/actions/runner-groups", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runners": Operation<"/enterprises/{enterprise}/actions/runners", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-runner-applications-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runners/downloads": Operation<"/enterprises/{enterprise}/actions/runners/downloads", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise + */ + "GET /enterprises/{enterprise}/actions/runners/{runner_id}": Operation<"/enterprises/{enterprise}/actions/runners/{runner_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-the-audit-log-for-an-enterprise + */ + "GET /enterprises/{enterprise}/audit-log": Operation<"/enterprises/{enterprise}/audit-log", "get">; + /** + * @see https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-an-enterprise + */ + "GET /enterprises/{enterprise}/settings/billing/actions": Operation<"/enterprises/{enterprise}/settings/billing/actions", "get">; + /** + * @see https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-an-enterprise + */ + "GET /enterprises/{enterprise}/settings/billing/packages": Operation<"/enterprises/{enterprise}/settings/billing/packages", "get">; + /** + * @see https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-an-enterprise + */ + "GET /enterprises/{enterprise}/settings/billing/shared-storage": Operation<"/enterprises/{enterprise}/settings/billing/shared-storage", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events + */ + "GET /events": Operation<"/events", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#get-feeds + */ + "GET /feeds": Operation<"/feeds", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#list-gists-for-the-authenticated-user + */ + "GET /gists": Operation<"/gists", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#list-public-gists + */ + "GET /gists/public": Operation<"/gists/public", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#list-starred-gists + */ + "GET /gists/starred": Operation<"/gists/starred", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#get-a-gist + */ + "GET /gists/{gist_id}": Operation<"/gists/{gist_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#list-gist-comments + */ + "GET /gists/{gist_id}/comments": Operation<"/gists/{gist_id}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#get-a-gist-comment + */ + "GET /gists/{gist_id}/comments/{comment_id}": Operation<"/gists/{gist_id}/comments/{comment_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#list-gist-commits + */ + "GET /gists/{gist_id}/commits": Operation<"/gists/{gist_id}/commits", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#list-gist-forks + */ + "GET /gists/{gist_id}/forks": Operation<"/gists/{gist_id}/forks", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#check-if-a-gist-is-starred + */ + "GET /gists/{gist_id}/star": Operation<"/gists/{gist_id}/star", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#get-a-gist-revision + */ + "GET /gists/{gist_id}/{sha}": Operation<"/gists/{gist_id}/{sha}", "get">; + /** + * @see https://docs.github.com/rest/reference/gitignore#get-all-gitignore-templates + */ + "GET /gitignore/templates": Operation<"/gitignore/templates", "get">; + /** + * @see https://docs.github.com/rest/reference/gitignore#get-a-gitignore-template + */ + "GET /gitignore/templates/{name}": Operation<"/gitignore/templates/{name}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-app-installation + */ + "GET /installation/repositories": Operation<"/installation/repositories", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-issues-assigned-to-the-authenticated-user + */ + "GET /issues": Operation<"/issues", "get">; + /** + * @see https://docs.github.com/rest/reference/licenses#get-all-commonly-used-licenses + */ + "GET /licenses": Operation<"/licenses", "get">; + /** + * @see https://docs.github.com/rest/reference/licenses#get-a-license + */ + "GET /licenses/{license}": Operation<"/licenses/{license}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account + */ + "GET /marketplace_listing/accounts/{account_id}": Operation<"/marketplace_listing/accounts/{account_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-plans + */ + "GET /marketplace_listing/plans": Operation<"/marketplace_listing/plans", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan + */ + "GET /marketplace_listing/plans/{plan_id}/accounts": Operation<"/marketplace_listing/plans/{plan_id}/accounts", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account-stubbed + */ + "GET /marketplace_listing/stubbed/accounts/{account_id}": Operation<"/marketplace_listing/stubbed/accounts/{account_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-plans-stubbed + */ + "GET /marketplace_listing/stubbed/plans": Operation<"/marketplace_listing/stubbed/plans", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan-stubbed + */ + "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts": Operation<"/marketplace_listing/stubbed/plans/{plan_id}/accounts", "get">; + /** + * @see https://docs.github.com/rest/reference/meta#get-github-meta-information + */ + "GET /meta": Operation<"/meta", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories + */ + "GET /networks/{owner}/{repo}/events": Operation<"/networks/{owner}/{repo}/events", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user + */ + "GET /notifications": Operation<"/notifications", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#get-a-thread + */ + "GET /notifications/threads/{thread_id}": Operation<"/notifications/threads/{thread_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user + */ + "GET /notifications/threads/{thread_id}/subscription": Operation<"/notifications/threads/{thread_id}/subscription", "get">; + /** + * @see https://docs.github.com/rest/reference/meta#get-octocat + */ + "GET /octocat": Operation<"/octocat", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organizations + */ + "GET /organizations": Operation<"/organizations", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#get-an-organization + */ + "GET /orgs/{org}": Operation<"/orgs/{org}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization + */ + "GET /orgs/{org}/actions/permissions": Operation<"/orgs/{org}/actions/permissions", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization + */ + "GET /orgs/{org}/actions/permissions/repositories": Operation<"/orgs/{org}/actions/permissions/repositories", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-organization + */ + "GET /orgs/{org}/actions/permissions/selected-actions": Operation<"/orgs/{org}/actions/permissions/selected-actions", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runner-groups-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups": Operation<"/orgs/{org}/actions/runner-groups", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-group-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-in-a-group-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization + */ + "GET /orgs/{org}/actions/runners": Operation<"/orgs/{org}/actions/runners", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization + */ + "GET /orgs/{org}/actions/runners/downloads": Operation<"/orgs/{org}/actions/runners/downloads", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-an-organization + */ + "GET /orgs/{org}/actions/runners/{runner_id}": Operation<"/orgs/{org}/actions/runners/{runner_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-organization-secrets + */ + "GET /orgs/{org}/actions/secrets": Operation<"/orgs/{org}/actions/secrets", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-an-organization-public-key + */ + "GET /orgs/{org}/actions/secrets/public-key": Operation<"/orgs/{org}/actions/secrets/public-key", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-an-organization-secret + */ + "GET /orgs/{org}/actions/secrets/{secret_name}": Operation<"/orgs/{org}/actions/secrets/{secret_name}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret + */ + "GET /orgs/{org}/actions/secrets/{secret_name}/repositories": Operation<"/orgs/{org}/actions/secrets/{secret_name}/repositories", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#get-audit-log + */ + "GET /orgs/{org}/audit-log": Operation<"/orgs/{org}/audit-log", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-users-blocked-by-an-organization + */ + "GET /orgs/{org}/blocks": Operation<"/orgs/{org}/blocks", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization + */ + "GET /orgs/{org}/blocks/{username}": Operation<"/orgs/{org}/blocks/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-saml-sso-authorizations-for-an-organization + */ + "GET /orgs/{org}/credential-authorizations": Operation<"/orgs/{org}/credential-authorizations", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-organization-events + */ + "GET /orgs/{org}/events": Operation<"/orgs/{org}/events", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-failed-organization-invitations + */ + "GET /orgs/{org}/failed_invitations": Operation<"/orgs/{org}/failed_invitations", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-webhooks + */ + "GET /orgs/{org}/hooks": Operation<"/orgs/{org}/hooks", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#get-an-organization-webhook + */ + "GET /orgs/{org}/hooks/{hook_id}": Operation<"/orgs/{org}/hooks/{hook_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#get-a-webhook-configuration-for-an-organization + */ + "GET /orgs/{org}/hooks/{hook_id}/config": Operation<"/orgs/{org}/hooks/{hook_id}/config", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app + */ + "GET /orgs/{org}/installation": Operation<"/orgs/{org}/installation", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-app-installations-for-an-organization + */ + "GET /orgs/{org}/installations": Operation<"/orgs/{org}/installations", "get">; + /** + * @see https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-an-organization + */ + "GET /orgs/{org}/interaction-limits": Operation<"/orgs/{org}/interaction-limits", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-pending-organization-invitations + */ + "GET /orgs/{org}/invitations": Operation<"/orgs/{org}/invitations", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-invitation-teams + */ + "GET /orgs/{org}/invitations/{invitation_id}/teams": Operation<"/orgs/{org}/invitations/{invitation_id}/teams", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-user + */ + "GET /orgs/{org}/issues": Operation<"/orgs/{org}/issues", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-members + */ + "GET /orgs/{org}/members": Operation<"/orgs/{org}/members", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#check-organization-membership-for-a-user + */ + "GET /orgs/{org}/members/{username}": Operation<"/orgs/{org}/members/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user + */ + "GET /orgs/{org}/memberships/{username}": Operation<"/orgs/{org}/memberships/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/migrations#list-organization-migrations + */ + "GET /orgs/{org}/migrations": Operation<"/orgs/{org}/migrations", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#get-an-organization-migration-status + */ + "GET /orgs/{org}/migrations/{migration_id}": Operation<"/orgs/{org}/migrations/{migration_id}", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#download-an-organization-migration-archive + */ + "GET /orgs/{org}/migrations/{migration_id}/archive": Operation<"/orgs/{org}/migrations/{migration_id}/archive", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#list-repositories-in-an-organization-migration + */ + "GET /orgs/{org}/migrations/{migration_id}/repositories": Operation<"/orgs/{org}/migrations/{migration_id}/repositories", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-outside-collaborators-for-an-organization + */ + "GET /orgs/{org}/outside_collaborators": Operation<"/orgs/{org}/outside_collaborators", "get">; + /** + * @see https://docs.github.com/rest/reference/packages#get-a-package-for-an-organization + */ + "GET /orgs/{org}/packages/{package_type}/{package_name}": Operation<"/orgs/{org}/packages/{package_type}/{package_name}", "get">; + /** + * @see https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization + */ + "GET /orgs/{org}/packages/{package_type}/{package_name}/versions": Operation<"/orgs/{org}/packages/{package_type}/{package_name}/versions", "get">; + /** + * @see https://docs.github.com/rest/reference/packages#get-a-package-version-for-an-organization + */ + "GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": Operation<"/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/projects#list-organization-projects + */ + "GET /orgs/{org}/projects": Operation<"/orgs/{org}/projects", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-public-organization-members + */ + "GET /orgs/{org}/public_members": Operation<"/orgs/{org}/public_members", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#check-public-organization-membership-for-a-user + */ + "GET /orgs/{org}/public_members/{username}": Operation<"/orgs/{org}/public_members/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-organization-repositories + */ + "GET /orgs/{org}/repos": Operation<"/orgs/{org}/repos", "get">; + /** + * @see https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-an-organization + */ + "GET /orgs/{org}/settings/billing/actions": Operation<"/orgs/{org}/settings/billing/actions", "get">; + /** + * @see https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-an-organization + */ + "GET /orgs/{org}/settings/billing/packages": Operation<"/orgs/{org}/settings/billing/packages", "get">; + /** + * @see https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-an-organization + */ + "GET /orgs/{org}/settings/billing/shared-storage": Operation<"/orgs/{org}/settings/billing/shared-storage", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-an-organization + */ + "GET /orgs/{org}/team-sync/groups": Operation<"/orgs/{org}/team-sync/groups", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-teams + */ + "GET /orgs/{org}/teams": Operation<"/orgs/{org}/teams", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-a-team-by-name + */ + "GET /orgs/{org}/teams/{team_slug}": Operation<"/orgs/{org}/teams/{team_slug}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussions + */ + "GET /orgs/{org}/teams/{team_slug}/discussions": Operation<"/orgs/{org}/teams/{team_slug}/discussions", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-a-discussion + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussion-comments + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-a-discussion-comment + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion + */ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/teams#list-pending-team-invitations + */ + "GET /orgs/{org}/teams/{team_slug}/invitations": Operation<"/orgs/{org}/teams/{team_slug}/invitations", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-team-members + */ + "GET /orgs/{org}/teams/{team_slug}/members": Operation<"/orgs/{org}/teams/{team_slug}/members", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user + */ + "GET /orgs/{org}/teams/{team_slug}/memberships/{username}": Operation<"/orgs/{org}/teams/{team_slug}/memberships/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-team-projects + */ + "GET /orgs/{org}/teams/{team_slug}/projects": Operation<"/orgs/{org}/teams/{team_slug}/projects", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project + */ + "GET /orgs/{org}/teams/{team_slug}/projects/{project_id}": Operation<"/orgs/{org}/teams/{team_slug}/projects/{project_id}", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/teams#list-team-repositories + */ + "GET /orgs/{org}/teams/{team_slug}/repos": Operation<"/orgs/{org}/teams/{team_slug}/repos", "get">; + /** + * @see https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-repository + */ + "GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": Operation<"/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team + */ + "GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings": Operation<"/orgs/{org}/teams/{team_slug}/team-sync/group-mappings", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-child-teams + */ + "GET /orgs/{org}/teams/{team_slug}/teams": Operation<"/orgs/{org}/teams/{team_slug}/teams", "get">; + /** + * @see https://docs.github.com/rest/reference/projects#get-a-project-card + */ + "GET /projects/columns/cards/{card_id}": Operation<"/projects/columns/cards/{card_id}", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#get-a-project-column + */ + "GET /projects/columns/{column_id}": Operation<"/projects/columns/{column_id}", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#list-project-cards + */ + "GET /projects/columns/{column_id}/cards": Operation<"/projects/columns/{column_id}/cards", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#get-a-project + */ + "GET /projects/{project_id}": Operation<"/projects/{project_id}", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#list-project-collaborators + */ + "GET /projects/{project_id}/collaborators": Operation<"/projects/{project_id}/collaborators", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#get-project-permission-for-a-user + */ + "GET /projects/{project_id}/collaborators/{username}/permission": Operation<"/projects/{project_id}/collaborators/{username}/permission", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#list-project-columns + */ + "GET /projects/{project_id}/columns": Operation<"/projects/{project_id}/columns", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user + */ + "GET /rate_limit": Operation<"/rate_limit", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-repository + */ + "GET /repos/{owner}/{repo}": Operation<"/repos/{owner}/{repo}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/artifacts": Operation<"/repos/{owner}/{repo}/actions/artifacts", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-an-artifact + */ + "GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}": Operation<"/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#download-an-artifact + */ + "GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": Operation<"/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-job-for-a-workflow-run + */ + "GET /repos/{owner}/{repo}/actions/jobs/{job_id}": Operation<"/repos/{owner}/{repo}/actions/jobs/{job_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#download-job-logs-for-a-workflow-run + */ + "GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs": Operation<"/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/permissions": Operation<"/repos/{owner}/{repo}/actions/permissions", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-allowed-actions-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/permissions/selected-actions": Operation<"/repos/{owner}/{repo}/actions/permissions/selected-actions", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runners": Operation<"/repos/{owner}/{repo}/actions/runners", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runners/downloads": Operation<"/repos/{owner}/{repo}/actions/runners/downloads", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runners/{runner_id}": Operation<"/repos/{owner}/{repo}/actions/runners/{runner_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-workflow-runs-for-a-repository + */ + "GET /repos/{owner}/{repo}/actions/runs": Operation<"/repos/{owner}/{repo}/actions/runs", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-workflow-run + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-the-review-history-for-a-workflow-run + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-workflow-run-artifacts + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#download-workflow-run-logs + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/logs", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-pending-deployments-for-a-workflow-run + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-workflow-run-usage + */ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/timing", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-repository-secrets + */ + "GET /repos/{owner}/{repo}/actions/secrets": Operation<"/repos/{owner}/{repo}/actions/secrets", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-repository-public-key + */ + "GET /repos/{owner}/{repo}/actions/secrets/public-key": Operation<"/repos/{owner}/{repo}/actions/secrets/public-key", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-repository-secret + */ + "GET /repos/{owner}/{repo}/actions/secrets/{secret_name}": Operation<"/repos/{owner}/{repo}/actions/secrets/{secret_name}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-repository-workflows + */ + "GET /repos/{owner}/{repo}/actions/workflows": Operation<"/repos/{owner}/{repo}/actions/workflows", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-a-workflow + */ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-workflow-runs + */ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-workflow-usage + */ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-assignees + */ + "GET /repos/{owner}/{repo}/assignees": Operation<"/repos/{owner}/{repo}/assignees", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#check-if-a-user-can-be-assigned + */ + "GET /repos/{owner}/{repo}/assignees/{assignee}": Operation<"/repos/{owner}/{repo}/assignees/{assignee}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-branches + */ + "GET /repos/{owner}/{repo}/branches": Operation<"/repos/{owner}/{repo}/branches", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-branch + */ + "GET /repos/{owner}/{repo}/branches/{branch}": Operation<"/repos/{owner}/{repo}/branches/{branch}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-branch-protection + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-admin-branch-protection + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-pull-request-review-protection + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-commit-signature-protection + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "get", "zzzax">; + /** + * @see https://docs.github.com/rest/reference/repos#get-status-checks-protection + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-all-status-check-contexts + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-access-restrictions + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-apps-with-access-to-the-protected-branch + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-teams-with-access-to-the-protected-branch + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-users-with-access-to-the-protected-branch + */ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "get">; + /** + * @see https://docs.github.com/rest/reference/checks#get-a-check-run + */ + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}": Operation<"/repos/{owner}/{repo}/check-runs/{check_run_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-run-annotations + */ + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": Operation<"/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", "get">; + /** + * @see https://docs.github.com/rest/reference/checks#get-a-check-suite + */ + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}": Operation<"/repos/{owner}/{repo}/check-suites/{check_suite_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite + */ + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": Operation<"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", "get">; + /** + * @see https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository + */ + "GET /repos/{owner}/{repo}/code-scanning/alerts": Operation<"/repos/{owner}/{repo}/code-scanning/alerts", "get">; + /** + * @see https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-alert + * @deprecated "alert_id" is now "alert_number" + */ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_id}": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-alert + */ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert + */ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", "get">; + /** + * @see https://docs.github.com/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository + */ + "GET /repos/{owner}/{repo}/code-scanning/analyses": Operation<"/repos/{owner}/{repo}/code-scanning/analyses", "get">; + /** + * @see https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository + */ + "GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": Operation<"/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/code-scanning#list-recent-code-scanning-analyses-for-a-repository + */ + "GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": Operation<"/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-collaborators + */ + "GET /repos/{owner}/{repo}/collaborators": Operation<"/repos/{owner}/{repo}/collaborators", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#check-if-a-user-is-a-repository-collaborator + */ + "GET /repos/{owner}/{repo}/collaborators/{username}": Operation<"/repos/{owner}/{repo}/collaborators/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-repository-permissions-for-a-user + */ + "GET /repos/{owner}/{repo}/collaborators/{username}/permission": Operation<"/repos/{owner}/{repo}/collaborators/{username}/permission", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-commit-comments-for-a-repository + */ + "GET /repos/{owner}/{repo}/comments": Operation<"/repos/{owner}/{repo}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-commit-comment + */ + "GET /repos/{owner}/{repo}/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/comments/{comment_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-a-commit-comment + */ + "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions": Operation<"/repos/{owner}/{repo}/comments/{comment_id}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/repos#list-commits + */ + "GET /repos/{owner}/{repo}/commits": Operation<"/repos/{owner}/{repo}/commits", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-branches-for-head-commit + */ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": Operation<"/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "get", "groot">; + /** + * @see https://docs.github.com/rest/reference/repos#list-commit-comments + */ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments": Operation<"/repos/{owner}/{repo}/commits/{commit_sha}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-pull-requests-associated-with-a-commit + */ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls": Operation<"/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "get", "groot">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-commit + */ + "GET /repos/{owner}/{repo}/commits/{ref}": Operation<"/repos/{owner}/{repo}/commits/{ref}", "get">; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/check-runs": Operation<"/repos/{owner}/{repo}/commits/{ref}/check-runs", "get">; + /** + * @see https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/check-suites": Operation<"/repos/{owner}/{repo}/commits/{ref}/check-suites", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-the-combined-status-for-a-specific-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/status": Operation<"/repos/{owner}/{repo}/commits/{ref}/status", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-commit-statuses-for-a-reference + */ + "GET /repos/{owner}/{repo}/commits/{ref}/statuses": Operation<"/repos/{owner}/{repo}/commits/{ref}/statuses", "get">; + /** + * @see https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository + */ + "GET /repos/{owner}/{repo}/community/code_of_conduct": Operation<"/repos/{owner}/{repo}/community/code_of_conduct", "get", "scarlet-witch">; + /** + * @see https://docs.github.com/rest/reference/repos#get-community-profile-metrics + */ + "GET /repos/{owner}/{repo}/community/profile": Operation<"/repos/{owner}/{repo}/community/profile", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#compare-two-commits + */ + "GET /repos/{owner}/{repo}/compare/{basehead}": Operation<"/repos/{owner}/{repo}/compare/{basehead}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#compare-two-commits + */ + "GET /repos/{owner}/{repo}/compare/{base}...{head}": Operation<"/repos/{owner}/{repo}/compare/{base}...{head}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-repository-content + */ + "GET /repos/{owner}/{repo}/contents/{path}": Operation<"/repos/{owner}/{repo}/contents/{path}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-contributors + */ + "GET /repos/{owner}/{repo}/contributors": Operation<"/repos/{owner}/{repo}/contributors", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-deployments + */ + "GET /repos/{owner}/{repo}/deployments": Operation<"/repos/{owner}/{repo}/deployments", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-deployment + */ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}": Operation<"/repos/{owner}/{repo}/deployments/{deployment_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-deployment-statuses + */ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses": Operation<"/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-deployment-status + */ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": Operation<"/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-all-environments + */ + "GET /repos/{owner}/{repo}/environments": Operation<"/repos/{owner}/{repo}/environments", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-an-environment + */ + "GET /repos/{owner}/{repo}/environments/{environment_name}": Operation<"/repos/{owner}/{repo}/environments/{environment_name}", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-repository-events + */ + "GET /repos/{owner}/{repo}/events": Operation<"/repos/{owner}/{repo}/events", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-forks + */ + "GET /repos/{owner}/{repo}/forks": Operation<"/repos/{owner}/{repo}/forks", "get">; + /** + * @see https://docs.github.com/rest/reference/git#get-a-blob + */ + "GET /repos/{owner}/{repo}/git/blobs/{file_sha}": Operation<"/repos/{owner}/{repo}/git/blobs/{file_sha}", "get">; + /** + * @see https://docs.github.com/rest/reference/git#get-a-commit + */ + "GET /repos/{owner}/{repo}/git/commits/{commit_sha}": Operation<"/repos/{owner}/{repo}/git/commits/{commit_sha}", "get">; + /** + * @see https://docs.github.com/rest/reference/git#list-matching-references + */ + "GET /repos/{owner}/{repo}/git/matching-refs/{ref}": Operation<"/repos/{owner}/{repo}/git/matching-refs/{ref}", "get">; + /** + * @see https://docs.github.com/rest/reference/git#get-a-reference + */ + "GET /repos/{owner}/{repo}/git/ref/{ref}": Operation<"/repos/{owner}/{repo}/git/ref/{ref}", "get">; + /** + * @see https://docs.github.com/rest/reference/git#get-a-tag + */ + "GET /repos/{owner}/{repo}/git/tags/{tag_sha}": Operation<"/repos/{owner}/{repo}/git/tags/{tag_sha}", "get">; + /** + * @see https://docs.github.com/rest/reference/git#get-a-tree + */ + "GET /repos/{owner}/{repo}/git/trees/{tree_sha}": Operation<"/repos/{owner}/{repo}/git/trees/{tree_sha}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-webhooks + */ + "GET /repos/{owner}/{repo}/hooks": Operation<"/repos/{owner}/{repo}/hooks", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-repository-webhook + */ + "GET /repos/{owner}/{repo}/hooks/{hook_id}": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-webhook-configuration-for-a-repository + */ + "GET /repos/{owner}/{repo}/hooks/{hook_id}/config": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}/config", "get">; + /** + * @see https://docs.github.com/rest/reference/migrations#get-an-import-status + */ + "GET /repos/{owner}/{repo}/import": Operation<"/repos/{owner}/{repo}/import", "get">; + /** + * @see https://docs.github.com/rest/reference/migrations#get-commit-authors + */ + "GET /repos/{owner}/{repo}/import/authors": Operation<"/repos/{owner}/{repo}/import/authors", "get">; + /** + * @see https://docs.github.com/rest/reference/migrations#get-large-files + */ + "GET /repos/{owner}/{repo}/import/large_files": Operation<"/repos/{owner}/{repo}/import/large_files", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app + */ + "GET /repos/{owner}/{repo}/installation": Operation<"/repos/{owner}/{repo}/installation", "get">; + /** + * @see https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-a-repository + */ + "GET /repos/{owner}/{repo}/interaction-limits": Operation<"/repos/{owner}/{repo}/interaction-limits", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-invitations + */ + "GET /repos/{owner}/{repo}/invitations": Operation<"/repos/{owner}/{repo}/invitations", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-repository-issues + */ + "GET /repos/{owner}/{repo}/issues": Operation<"/repos/{owner}/{repo}/issues", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-comments-for-a-repository + */ + "GET /repos/{owner}/{repo}/issues/comments": Operation<"/repos/{owner}/{repo}/issues/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#get-an-issue-comment + */ + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/issues/comments/{comment_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue-comment + */ + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": Operation<"/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-events-for-a-repository + */ + "GET /repos/{owner}/{repo}/issues/events": Operation<"/repos/{owner}/{repo}/issues/events", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#get-an-issue-event + */ + "GET /repos/{owner}/{repo}/issues/events/{event_id}": Operation<"/repos/{owner}/{repo}/issues/events/{event_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#get-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}": Operation<"/repos/{owner}/{repo}/issues/{issue_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-comments + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/comments": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-issue-events + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/events": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/events", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-labels-for-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/labels": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/labels", "get">; + /** + * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/issues#list-timeline-events-for-an-issue + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/timeline", "get", "mockingbird">; + /** + * @see https://docs.github.com/rest/reference/repos#list-deploy-keys + */ + "GET /repos/{owner}/{repo}/keys": Operation<"/repos/{owner}/{repo}/keys", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-deploy-key + */ + "GET /repos/{owner}/{repo}/keys/{key_id}": Operation<"/repos/{owner}/{repo}/keys/{key_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-labels-for-a-repository + */ + "GET /repos/{owner}/{repo}/labels": Operation<"/repos/{owner}/{repo}/labels", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#get-a-label + */ + "GET /repos/{owner}/{repo}/labels/{name}": Operation<"/repos/{owner}/{repo}/labels/{name}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-languages + */ + "GET /repos/{owner}/{repo}/languages": Operation<"/repos/{owner}/{repo}/languages", "get">; + /** + * @see https://docs.github.com/rest/reference/licenses/#get-the-license-for-a-repository + */ + "GET /repos/{owner}/{repo}/license": Operation<"/repos/{owner}/{repo}/license", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-milestones + */ + "GET /repos/{owner}/{repo}/milestones": Operation<"/repos/{owner}/{repo}/milestones", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#get-a-milestone + */ + "GET /repos/{owner}/{repo}/milestones/{milestone_number}": Operation<"/repos/{owner}/{repo}/milestones/{milestone_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-labels-for-issues-in-a-milestone + */ + "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels": Operation<"/repos/{owner}/{repo}/milestones/{milestone_number}/labels", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user + */ + "GET /repos/{owner}/{repo}/notifications": Operation<"/repos/{owner}/{repo}/notifications", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-github-pages-site + */ + "GET /repos/{owner}/{repo}/pages": Operation<"/repos/{owner}/{repo}/pages", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-github-pages-builds + */ + "GET /repos/{owner}/{repo}/pages/builds": Operation<"/repos/{owner}/{repo}/pages/builds", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-latest-pages-build + */ + "GET /repos/{owner}/{repo}/pages/builds/latest": Operation<"/repos/{owner}/{repo}/pages/builds/latest", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-github-pages-build + */ + "GET /repos/{owner}/{repo}/pages/builds/{build_id}": Operation<"/repos/{owner}/{repo}/pages/builds/{build_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-dns-health-check-for-github-pages + */ + "GET /repos/{owner}/{repo}/pages/health": Operation<"/repos/{owner}/{repo}/pages/health", "get">; + /** + * @see https://docs.github.com/rest/reference/projects#list-repository-projects + */ + "GET /repos/{owner}/{repo}/projects": Operation<"/repos/{owner}/{repo}/projects", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-pull-requests + */ + "GET /repos/{owner}/{repo}/pulls": Operation<"/repos/{owner}/{repo}/pulls", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-review-comments-in-a-repository + */ + "GET /repos/{owner}/{repo}/pulls/comments": Operation<"/repos/{owner}/{repo}/pulls/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#get-a-review-comment-for-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/pulls/comments/{comment_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment + */ + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": Operation<"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/pulls#get-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-review-comments-on-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-commits-on-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/commits": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/commits", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-pull-requests-files + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/files": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/files", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#check-if-a-pull-request-has-been-merged + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/merge": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/merge", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-reviews-for-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#get-a-review-for-a-pull-request + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/pulls#list-comments-for-a-pull-request-review + */ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-repository-readme + */ + "GET /repos/{owner}/{repo}/readme": Operation<"/repos/{owner}/{repo}/readme", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-repository-directory-readme + */ + "GET /repos/{owner}/{repo}/readme/{dir}": Operation<"/repos/{owner}/{repo}/readme/{dir}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-releases + */ + "GET /repos/{owner}/{repo}/releases": Operation<"/repos/{owner}/{repo}/releases", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-release-asset + */ + "GET /repos/{owner}/{repo}/releases/assets/{asset_id}": Operation<"/repos/{owner}/{repo}/releases/assets/{asset_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-the-latest-release + */ + "GET /repos/{owner}/{repo}/releases/latest": Operation<"/repos/{owner}/{repo}/releases/latest", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-release-by-tag-name + */ + "GET /repos/{owner}/{repo}/releases/tags/{tag}": Operation<"/repos/{owner}/{repo}/releases/tags/{tag}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-a-release + */ + "GET /repos/{owner}/{repo}/releases/{release_id}": Operation<"/repos/{owner}/{repo}/releases/{release_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-release-assets + */ + "GET /repos/{owner}/{repo}/releases/{release_id}/assets": Operation<"/repos/{owner}/{repo}/releases/{release_id}/assets", "get">; + /** + * @see https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository + */ + "GET /repos/{owner}/{repo}/secret-scanning/alerts": Operation<"/repos/{owner}/{repo}/secret-scanning/alerts", "get">; + /** + * @see https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert + */ + "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": Operation<"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-stargazers + */ + "GET /repos/{owner}/{repo}/stargazers": Operation<"/repos/{owner}/{repo}/stargazers", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-the-weekly-commit-activity + */ + "GET /repos/{owner}/{repo}/stats/code_frequency": Operation<"/repos/{owner}/{repo}/stats/code_frequency", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-the-last-year-of-commit-activity + */ + "GET /repos/{owner}/{repo}/stats/commit_activity": Operation<"/repos/{owner}/{repo}/stats/commit_activity", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-all-contributor-commit-activity + */ + "GET /repos/{owner}/{repo}/stats/contributors": Operation<"/repos/{owner}/{repo}/stats/contributors", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-the-weekly-commit-count + */ + "GET /repos/{owner}/{repo}/stats/participation": Operation<"/repos/{owner}/{repo}/stats/participation", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-the-hourly-commit-count-for-each-day + */ + "GET /repos/{owner}/{repo}/stats/punch_card": Operation<"/repos/{owner}/{repo}/stats/punch_card", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-watchers + */ + "GET /repos/{owner}/{repo}/subscribers": Operation<"/repos/{owner}/{repo}/subscribers", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#get-a-repository-subscription + */ + "GET /repos/{owner}/{repo}/subscription": Operation<"/repos/{owner}/{repo}/subscription", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-tags + */ + "GET /repos/{owner}/{repo}/tags": Operation<"/repos/{owner}/{repo}/tags", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#download-a-repository-archive + */ + "GET /repos/{owner}/{repo}/tarball/{ref}": Operation<"/repos/{owner}/{repo}/tarball/{ref}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-teams + */ + "GET /repos/{owner}/{repo}/teams": Operation<"/repos/{owner}/{repo}/teams", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-all-repository-topics + */ + "GET /repos/{owner}/{repo}/topics": Operation<"/repos/{owner}/{repo}/topics", "get", "mercy">; + /** + * @see https://docs.github.com/rest/reference/repos#get-repository-clones + */ + "GET /repos/{owner}/{repo}/traffic/clones": Operation<"/repos/{owner}/{repo}/traffic/clones", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-top-referral-paths + */ + "GET /repos/{owner}/{repo}/traffic/popular/paths": Operation<"/repos/{owner}/{repo}/traffic/popular/paths", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-top-referral-sources + */ + "GET /repos/{owner}/{repo}/traffic/popular/referrers": Operation<"/repos/{owner}/{repo}/traffic/popular/referrers", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#get-page-views + */ + "GET /repos/{owner}/{repo}/traffic/views": Operation<"/repos/{owner}/{repo}/traffic/views", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository + */ + "GET /repos/{owner}/{repo}/vulnerability-alerts": Operation<"/repos/{owner}/{repo}/vulnerability-alerts", "get", "dorian">; + /** + * @see https://docs.github.com/rest/reference/repos#download-a-repository-archive + */ + "GET /repos/{owner}/{repo}/zipball/{ref}": Operation<"/repos/{owner}/{repo}/zipball/{ref}", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-public-repositories + */ + "GET /repositories": Operation<"/repositories", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#list-environment-secrets + */ + "GET /repositories/{repository_id}/environments/{environment_name}/secrets": Operation<"/repositories/{repository_id}/environments/{environment_name}/secrets", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-an-environment-public-key + */ + "GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key": Operation<"/repositories/{repository_id}/environments/{environment_name}/secrets/public-key", "get">; + /** + * @see https://docs.github.com/rest/reference/actions#get-an-environment-secret + */ + "GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": Operation<"/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise + */ + "GET /scim/v2/enterprises/{enterprise}/Groups": Operation<"/scim/v2/enterprises/{enterprise}/Groups", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group + */ + "GET /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": Operation<"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#list-scim-provisioned-identities-for-an-enterprise + */ + "GET /scim/v2/enterprises/{enterprise}/Users": Operation<"/scim/v2/enterprises/{enterprise}/Users", "get">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-user + */ + "GET /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": Operation<"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/scim#list-scim-provisioned-identities + */ + "GET /scim/v2/organizations/{org}/Users": Operation<"/scim/v2/organizations/{org}/Users", "get">; + /** + * @see https://docs.github.com/rest/reference/scim#get-scim-provisioning-information-for-a-user + */ + "GET /scim/v2/organizations/{org}/Users/{scim_user_id}": Operation<"/scim/v2/organizations/{org}/Users/{scim_user_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/search#search-code + */ + "GET /search/code": Operation<"/search/code", "get">; + /** + * @see https://docs.github.com/rest/reference/search#search-commits + */ + "GET /search/commits": Operation<"/search/commits", "get", "cloak">; + /** + * @see https://docs.github.com/rest/reference/search#search-issues-and-pull-requests + */ + "GET /search/issues": Operation<"/search/issues", "get">; + /** + * @see https://docs.github.com/rest/reference/search#search-labels + */ + "GET /search/labels": Operation<"/search/labels", "get">; + /** + * @see https://docs.github.com/rest/reference/search#search-repositories + */ + "GET /search/repositories": Operation<"/search/repositories", "get">; + /** + * @see https://docs.github.com/rest/reference/search#search-topics + */ + "GET /search/topics": Operation<"/search/topics", "get", "mercy">; + /** + * @see https://docs.github.com/rest/reference/search#search-users + */ + "GET /search/users": Operation<"/search/users", "get">; + /** + * @see https://docs.github.com/rest/reference/teams/#get-a-team-legacy + */ + "GET /teams/{team_id}": Operation<"/teams/{team_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussions-legacy + */ + "GET /teams/{team_id}/discussions": Operation<"/teams/{team_id}/discussions", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-a-discussion-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}": Operation<"/teams/{team_id}/discussions/{discussion_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-discussion-comments-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/comments": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-a-discussion-comment-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "get">; + /** + * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-legacy + */ + "GET /teams/{team_id}/discussions/{discussion_number}/reactions": Operation<"/teams/{team_id}/discussions/{discussion_number}/reactions", "get", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/teams#list-pending-team-invitations-legacy + */ + "GET /teams/{team_id}/invitations": Operation<"/teams/{team_id}/invitations", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-team-members-legacy + */ + "GET /teams/{team_id}/members": Operation<"/teams/{team_id}/members", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-team-member-legacy + */ + "GET /teams/{team_id}/members/{username}": Operation<"/teams/{team_id}/members/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user-legacy + */ + "GET /teams/{team_id}/memberships/{username}": Operation<"/teams/{team_id}/memberships/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams/#list-team-projects-legacy + */ + "GET /teams/{team_id}/projects": Operation<"/teams/{team_id}/projects", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-project-legacy + */ + "GET /teams/{team_id}/projects/{project_id}": Operation<"/teams/{team_id}/projects/{project_id}", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/teams/#list-team-repositories-legacy + */ + "GET /teams/{team_id}/repos": Operation<"/teams/{team_id}/repos", "get">; + /** + * @see https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-repository-legacy + */ + "GET /teams/{team_id}/repos/{owner}/{repo}": Operation<"/teams/{team_id}/repos/{owner}/{repo}", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-idp-groups-for-a-team-legacy + */ + "GET /teams/{team_id}/team-sync/group-mappings": Operation<"/teams/{team_id}/team-sync/group-mappings", "get">; + /** + * @see https://docs.github.com/rest/reference/teams/#list-child-teams-legacy + */ + "GET /teams/{team_id}/teams": Operation<"/teams/{team_id}/teams", "get">; + /** + * @see https://docs.github.com/rest/reference/users#get-the-authenticated-user + */ + "GET /user": Operation<"/user", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user + */ + "GET /user/blocks": Operation<"/user/blocks", "get">; + /** + * @see https://docs.github.com/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user + */ + "GET /user/blocks/{username}": Operation<"/user/blocks/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user + */ + "GET /user/emails": Operation<"/user/emails", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-followers-of-the-authenticated-user + */ + "GET /user/followers": Operation<"/user/followers", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows + */ + "GET /user/following": Operation<"/user/following", "get">; + /** + * @see https://docs.github.com/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user + */ + "GET /user/following/{username}": Operation<"/user/following/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user + */ + "GET /user/gpg_keys": Operation<"/user/gpg_keys", "get">; + /** + * @see https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user + */ + "GET /user/gpg_keys/{gpg_key_id}": Operation<"/user/gpg_keys/{gpg_key_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token + */ + "GET /user/installations": Operation<"/user/installations", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-user-access-token + */ + "GET /user/installations/{installation_id}/repositories": Operation<"/user/installations/{installation_id}/repositories", "get">; + /** + * @see https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories + */ + "GET /user/interaction-limits": Operation<"/user/interaction-limits", "get">; + /** + * @see https://docs.github.com/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user + */ + "GET /user/issues": Operation<"/user/issues", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user + */ + "GET /user/keys": Operation<"/user/keys", "get">; + /** + * @see https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user + */ + "GET /user/keys/{key_id}": Operation<"/user/keys/{key_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user + */ + "GET /user/marketplace_purchases": Operation<"/user/marketplace_purchases", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user-stubbed + */ + "GET /user/marketplace_purchases/stubbed": Operation<"/user/marketplace_purchases/stubbed", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user + */ + "GET /user/memberships/orgs": Operation<"/user/memberships/orgs", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user + */ + "GET /user/memberships/orgs/{org}": Operation<"/user/memberships/orgs/{org}", "get">; + /** + * @see https://docs.github.com/rest/reference/migrations#list-user-migrations + */ + "GET /user/migrations": Operation<"/user/migrations", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#get-a-user-migration-status + */ + "GET /user/migrations/{migration_id}": Operation<"/user/migrations/{migration_id}", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive + */ + "GET /user/migrations/{migration_id}/archive": Operation<"/user/migrations/{migration_id}/archive", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration + */ + "GET /user/migrations/{migration_id}/repositories": Operation<"/user/migrations/{migration_id}/repositories", "get", "wyandotte">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user + */ + "GET /user/orgs": Operation<"/user/orgs", "get">; + /** + * @see https://docs.github.com/rest/reference/packages#get-a-package-for-the-authenticated-user + */ + "GET /user/packages/{package_type}/{package_name}": Operation<"/user/packages/{package_type}/{package_name}", "get">; + /** + * @see https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user + */ + "GET /user/packages/{package_type}/{package_name}/versions": Operation<"/user/packages/{package_type}/{package_name}/versions", "get">; + /** + * @see https://docs.github.com/rest/reference/packages#get-a-package-version-for-the-authenticated-user + */ + "GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}": Operation<"/user/packages/{package_type}/{package_name}/versions/{package_version_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user + */ + "GET /user/public_emails": Operation<"/user/public_emails", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repositories-for-the-authenticated-user + */ + "GET /user/repos": Operation<"/user/repos", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repository-invitations-for-the-authenticated-user + */ + "GET /user/repository_invitations": Operation<"/user/repository_invitations", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user + */ + "GET /user/starred": Operation<"/user/starred", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user + */ + "GET /user/starred/{owner}/{repo}": Operation<"/user/starred/{owner}/{repo}", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-watched-by-the-authenticated-user + */ + "GET /user/subscriptions": Operation<"/user/subscriptions", "get">; + /** + * @see https://docs.github.com/rest/reference/teams#list-teams-for-the-authenticated-user + */ + "GET /user/teams": Operation<"/user/teams", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-users + */ + "GET /users": Operation<"/users", "get">; + /** + * @see https://docs.github.com/rest/reference/users#get-a-user + */ + "GET /users/{username}": Operation<"/users/{username}", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-events-for-the-authenticated-user + */ + "GET /users/{username}/events": Operation<"/users/{username}/events", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-organization-events-for-the-authenticated-user + */ + "GET /users/{username}/events/orgs/{org}": Operation<"/users/{username}/events/orgs/{org}", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events-for-a-user + */ + "GET /users/{username}/events/public": Operation<"/users/{username}/events/public", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-followers-of-a-user + */ + "GET /users/{username}/followers": Operation<"/users/{username}/followers", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-the-people-a-user-follows + */ + "GET /users/{username}/following": Operation<"/users/{username}/following", "get">; + /** + * @see https://docs.github.com/rest/reference/users#check-if-a-user-follows-another-user + */ + "GET /users/{username}/following/{target_user}": Operation<"/users/{username}/following/{target_user}", "get">; + /** + * @see https://docs.github.com/rest/reference/gists#list-gists-for-a-user + */ + "GET /users/{username}/gists": Operation<"/users/{username}/gists", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-gpg-keys-for-a-user + */ + "GET /users/{username}/gpg_keys": Operation<"/users/{username}/gpg_keys", "get">; + /** + * @see https://docs.github.com/rest/reference/users#get-contextual-information-for-a-user + */ + "GET /users/{username}/hovercard": Operation<"/users/{username}/hovercard", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#get-a-user-installation-for-the-authenticated-app + */ + "GET /users/{username}/installation": Operation<"/users/{username}/installation", "get">; + /** + * @see https://docs.github.com/rest/reference/users#list-public-keys-for-a-user + */ + "GET /users/{username}/keys": Operation<"/users/{username}/keys", "get">; + /** + * @see https://docs.github.com/rest/reference/orgs#list-organizations-for-a-user + */ + "GET /users/{username}/orgs": Operation<"/users/{username}/orgs", "get">; + /** + * @see https://docs.github.com/rest/reference/packages#get-a-package-for-a-user + */ + "GET /users/{username}/packages/{package_type}/{package_name}": Operation<"/users/{username}/packages/{package_type}/{package_name}", "get">; + /** + * @see https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user + */ + "GET /users/{username}/packages/{package_type}/{package_name}/versions": Operation<"/users/{username}/packages/{package_type}/{package_name}/versions", "get">; + /** + * @see https://docs.github.com/rest/reference/packages#get-a-package-version-for-a-user + */ + "GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": Operation<"/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", "get">; + /** + * @see https://docs.github.com/rest/reference/projects#list-user-projects + */ + "GET /users/{username}/projects": Operation<"/users/{username}/projects", "get", "inertia">; + /** + * @see https://docs.github.com/rest/reference/activity#list-events-received-by-the-authenticated-user + */ + "GET /users/{username}/received_events": Operation<"/users/{username}/received_events", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user + */ + "GET /users/{username}/received_events/public": Operation<"/users/{username}/received_events/public", "get">; + /** + * @see https://docs.github.com/rest/reference/repos#list-repositories-for-a-user + */ + "GET /users/{username}/repos": Operation<"/users/{username}/repos", "get">; + /** + * @see https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-a-user + */ + "GET /users/{username}/settings/billing/actions": Operation<"/users/{username}/settings/billing/actions", "get">; + /** + * @see https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-a-user + */ + "GET /users/{username}/settings/billing/packages": Operation<"/users/{username}/settings/billing/packages", "get">; + /** + * @see https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-a-user + */ + "GET /users/{username}/settings/billing/shared-storage": Operation<"/users/{username}/settings/billing/shared-storage", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user + */ + "GET /users/{username}/starred": Operation<"/users/{username}/starred", "get">; + /** + * @see https://docs.github.com/rest/reference/activity#list-repositories-watched-by-a-user + */ + "GET /users/{username}/subscriptions": Operation<"/users/{username}/subscriptions", "get">; + /** + * @see + */ + "GET /zen": Operation<"/zen", "get">; + /** + * @see https://docs.github.com/rest/reference/apps#update-a-webhook-configuration-for-an-app + */ + "PATCH /app/hook/config": Operation<"/app/hook/config", "patch">; + /** + * @see https://docs.github.com/rest/reference/apps#reset-a-token + */ + "PATCH /applications/{client_id}/token": Operation<"/applications/{client_id}/token", "patch">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#update-an-existing-authorization + */ + "PATCH /authorizations/{authorization_id}": Operation<"/authorizations/{authorization_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise + */ + "PATCH /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/gists/#update-a-gist + */ + "PATCH /gists/{gist_id}": Operation<"/gists/{gist_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/gists#update-a-gist-comment + */ + "PATCH /gists/{gist_id}/comments/{comment_id}": Operation<"/gists/{gist_id}/comments/{comment_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/activity#mark-a-thread-as-read + */ + "PATCH /notifications/threads/{thread_id}": Operation<"/notifications/threads/{thread_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/orgs/#update-an-organization + */ + "PATCH /orgs/{org}": Operation<"/orgs/{org}", "patch">; + /** + * @see https://docs.github.com/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization + */ + "PATCH /orgs/{org}/actions/runner-groups/{runner_group_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/orgs#update-an-organization-webhook + */ + "PATCH /orgs/{org}/hooks/{hook_id}": Operation<"/orgs/{org}/hooks/{hook_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/orgs#update-a-webhook-configuration-for-an-organization + */ + "PATCH /orgs/{org}/hooks/{hook_id}/config": Operation<"/orgs/{org}/hooks/{hook_id}/config", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#update-a-team + */ + "PATCH /orgs/{org}/teams/{team_slug}": Operation<"/orgs/{org}/teams/{team_slug}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#update-a-discussion + */ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#update-a-discussion-comment + */ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections + */ + "PATCH /orgs/{org}/teams/{team_slug}/team-sync/group-mappings": Operation<"/orgs/{org}/teams/{team_slug}/team-sync/group-mappings", "patch">; + /** + * @see https://docs.github.com/rest/reference/projects#update-a-project-card + */ + "PATCH /projects/columns/cards/{card_id}": Operation<"/projects/columns/cards/{card_id}", "patch", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#update-a-project-column + */ + "PATCH /projects/columns/{column_id}": Operation<"/projects/columns/{column_id}", "patch", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#update-a-project + */ + "PATCH /projects/{project_id}": Operation<"/projects/{project_id}", "patch", "inertia">; + /** + * @see https://docs.github.com/rest/reference/repos/#update-a-repository + */ + "PATCH /repos/{owner}/{repo}": Operation<"/repos/{owner}/{repo}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-pull-request-review-protection + */ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-status-check-potection + */ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "patch">; + /** + * @see https://docs.github.com/rest/reference/checks#update-a-check-run + */ + "PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}": Operation<"/repos/{owner}/{repo}/check-runs/{check_run_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites + */ + "PATCH /repos/{owner}/{repo}/check-suites/preferences": Operation<"/repos/{owner}/{repo}/check-suites/preferences", "patch">; + /** + * @see https://docs.github.com/rest/reference/code-scanning#update-a-code-scanning-alert + */ + "PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-a-commit-comment + */ + "PATCH /repos/{owner}/{repo}/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/comments/{comment_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/git#update-a-reference + */ + "PATCH /repos/{owner}/{repo}/git/refs/{ref}": Operation<"/repos/{owner}/{repo}/git/refs/{ref}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-a-repository-webhook + */ + "PATCH /repos/{owner}/{repo}/hooks/{hook_id}": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-a-webhook-configuration-for-a-repository + */ + "PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}/config", "patch">; + /** + * @see https://docs.github.com/rest/reference/migrations#update-an-import + */ + "PATCH /repos/{owner}/{repo}/import": Operation<"/repos/{owner}/{repo}/import", "patch">; + /** + * @see https://docs.github.com/rest/reference/migrations#map-a-commit-author + */ + "PATCH /repos/{owner}/{repo}/import/authors/{author_id}": Operation<"/repos/{owner}/{repo}/import/authors/{author_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/migrations#update-git-lfs-preference + */ + "PATCH /repos/{owner}/{repo}/import/lfs": Operation<"/repos/{owner}/{repo}/import/lfs", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-a-repository-invitation + */ + "PATCH /repos/{owner}/{repo}/invitations/{invitation_id}": Operation<"/repos/{owner}/{repo}/invitations/{invitation_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/issues#update-an-issue-comment + */ + "PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/issues/comments/{comment_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/issues/#update-an-issue + */ + "PATCH /repos/{owner}/{repo}/issues/{issue_number}": Operation<"/repos/{owner}/{repo}/issues/{issue_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/issues#update-a-label + */ + "PATCH /repos/{owner}/{repo}/labels/{name}": Operation<"/repos/{owner}/{repo}/labels/{name}", "patch">; + /** + * @see https://docs.github.com/rest/reference/issues#update-a-milestone + */ + "PATCH /repos/{owner}/{repo}/milestones/{milestone_number}": Operation<"/repos/{owner}/{repo}/milestones/{milestone_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/pulls#update-a-review-comment-for-a-pull-request + */ + "PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}": Operation<"/repos/{owner}/{repo}/pulls/comments/{comment_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/pulls/#update-a-pull-request + */ + "PATCH /repos/{owner}/{repo}/pulls/{pull_number}": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-a-release-asset + */ + "PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}": Operation<"/repos/{owner}/{repo}/releases/assets/{asset_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#update-a-release + */ + "PATCH /repos/{owner}/{repo}/releases/{release_id}": Operation<"/repos/{owner}/{repo}/releases/{release_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert + */ + "PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": Operation<"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group + */ + "PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": Operation<"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-user + */ + "PATCH /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": Operation<"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/scim#update-an-attribute-for-a-scim-user + */ + "PATCH /scim/v2/organizations/{org}/Users/{scim_user_id}": Operation<"/scim/v2/organizations/{org}/Users/{scim_user_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams/#update-a-team-legacy + */ + "PATCH /teams/{team_id}": Operation<"/teams/{team_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#update-a-discussion-legacy + */ + "PATCH /teams/{team_id}/discussions/{discussion_number}": Operation<"/teams/{team_id}/discussions/{discussion_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#update-a-discussion-comment-legacy + */ + "PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "patch">; + /** + * @see https://docs.github.com/rest/reference/teams#create-or-update-idp-group-connections-legacy + */ + "PATCH /teams/{team_id}/team-sync/group-mappings": Operation<"/teams/{team_id}/team-sync/group-mappings", "patch">; + /** + * @see https://docs.github.com/rest/reference/users/#update-the-authenticated-user + */ + "PATCH /user": Operation<"/user", "patch">; + /** + * @see https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user + */ + "PATCH /user/email/visibility": Operation<"/user/email/visibility", "patch">; + /** + * @see https://docs.github.com/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user + */ + "PATCH /user/memberships/orgs/{org}": Operation<"/user/memberships/orgs/{org}", "patch">; + /** + * @see https://docs.github.com/rest/reference/repos#accept-a-repository-invitation + */ + "PATCH /user/repository_invitations/{invitation_id}": Operation<"/user/repository_invitations/{invitation_id}", "patch">; + /** + * @see https://docs.github.com/rest/reference/apps#create-a-github-app-from-a-manifest + */ + "POST /app-manifests/{code}/conversions": Operation<"/app-manifests/{code}/conversions", "post">; + /** + * @see https://docs.github.com/rest/reference/apps/#create-an-installation-access-token-for-an-app + */ + "POST /app/installations/{installation_id}/access_tokens": Operation<"/app/installations/{installation_id}/access_tokens", "post">; + /** + * @see https://docs.github.com/rest/reference/apps#check-a-token + */ + "POST /applications/{client_id}/token": Operation<"/applications/{client_id}/token", "post">; + /** + * @see https://docs.github.com/rest/reference/apps#create-a-scoped-access-token + */ + "POST /applications/{client_id}/token/scoped": Operation<"/applications/{client_id}/token/scoped", "post">; + /** + * @see https://docs.github.com/rest/reference/apps#reset-an-authorization + */ + "POST /applications/{client_id}/tokens/{access_token}": Operation<"/applications/{client_id}/tokens/{access_token}", "post">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization + */ + "POST /authorizations": Operation<"/authorizations", "post">; + /** + * @see https://docs.github.com/rest/reference/apps#create-a-content-attachment + */ + "POST /content_references/{content_reference_id}/attachments": Operation<"/content_references/{content_reference_id}/attachments", "post", "corsair">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise + */ + "POST /enterprises/{enterprise}/actions/runner-groups": Operation<"/enterprises/{enterprise}/actions/runner-groups", "post">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#create-a-registration-token-for-an-enterprise + */ + "POST /enterprises/{enterprise}/actions/runners/registration-token": Operation<"/enterprises/{enterprise}/actions/runners/registration-token", "post">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#create-a-remove-token-for-an-enterprise + */ + "POST /enterprises/{enterprise}/actions/runners/remove-token": Operation<"/enterprises/{enterprise}/actions/runners/remove-token", "post">; + /** + * @see https://docs.github.com/rest/reference/gists#create-a-gist + */ + "POST /gists": Operation<"/gists", "post">; + /** + * @see https://docs.github.com/rest/reference/gists#create-a-gist-comment + */ + "POST /gists/{gist_id}/comments": Operation<"/gists/{gist_id}/comments", "post">; + /** + * @see https://docs.github.com/rest/reference/gists#fork-a-gist + */ + "POST /gists/{gist_id}/forks": Operation<"/gists/{gist_id}/forks", "post">; + /** + * @see https://docs.github.com/rest/reference/markdown#render-a-markdown-document + */ + "POST /markdown": Operation<"/markdown", "post">; + /** + * @see https://docs.github.com/rest/reference/markdown#render-a-markdown-document-in-raw-mode + */ + "POST /markdown/raw": Operation<"/markdown/raw", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#create-a-self-hosted-runner-group-for-an-organization + */ + "POST /orgs/{org}/actions/runner-groups": Operation<"/orgs/{org}/actions/runner-groups", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#create-a-registration-token-for-an-organization + */ + "POST /orgs/{org}/actions/runners/registration-token": Operation<"/orgs/{org}/actions/runners/registration-token", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#create-a-remove-token-for-an-organization + */ + "POST /orgs/{org}/actions/runners/remove-token": Operation<"/orgs/{org}/actions/runners/remove-token", "post">; + /** + * @see https://docs.github.com/rest/reference/orgs#create-an-organization-webhook + */ + "POST /orgs/{org}/hooks": Operation<"/orgs/{org}/hooks", "post">; + /** + * @see https://docs.github.com/rest/reference/orgs#ping-an-organization-webhook + */ + "POST /orgs/{org}/hooks/{hook_id}/pings": Operation<"/orgs/{org}/hooks/{hook_id}/pings", "post">; + /** + * @see https://docs.github.com/rest/reference/orgs#create-an-organization-invitation + */ + "POST /orgs/{org}/invitations": Operation<"/orgs/{org}/invitations", "post">; + /** + * @see https://docs.github.com/rest/reference/migrations#start-an-organization-migration + */ + "POST /orgs/{org}/migrations": Operation<"/orgs/{org}/migrations", "post">; + /** + * @see https://docs.github.com/rest/reference/packages#restore-a-package-for-an-organization + */ + "POST /orgs/{org}/packages/{package_type}/{package_name}/restore{?token}": Operation<"/orgs/{org}/packages/{package_type}/{package_name}/restore", "post">; + /** + * @see https://docs.github.com/rest/reference/packages#restore-a-package-version-for-an-organization + */ + "POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": Operation<"/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "post">; + /** + * @see https://docs.github.com/rest/reference/projects#create-an-organization-project + */ + "POST /orgs/{org}/projects": Operation<"/orgs/{org}/projects", "post", "inertia">; + /** + * @see https://docs.github.com/rest/reference/repos#create-an-organization-repository + */ + "POST /orgs/{org}/repos": Operation<"/orgs/{org}/repos", "post">; + /** + * @see https://docs.github.com/rest/reference/teams#create-a-team + */ + "POST /orgs/{org}/teams": Operation<"/orgs/{org}/teams", "post">; + /** + * @see https://docs.github.com/rest/reference/teams#create-a-discussion + */ + "POST /orgs/{org}/teams/{team_slug}/discussions": Operation<"/orgs/{org}/teams/{team_slug}/discussions", "post">; + /** + * @see https://docs.github.com/rest/reference/teams#create-a-discussion-comment + */ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "post">; + /** + * @see https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment + */ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion + */ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": Operation<"/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/projects#move-a-project-card + */ + "POST /projects/columns/cards/{card_id}/moves": Operation<"/projects/columns/cards/{card_id}/moves", "post", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#create-a-project-card + */ + "POST /projects/columns/{column_id}/cards": Operation<"/projects/columns/{column_id}/cards", "post", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#move-a-project-column + */ + "POST /projects/columns/{column_id}/moves": Operation<"/projects/columns/{column_id}/moves", "post", "inertia">; + /** + * @see https://docs.github.com/rest/reference/projects#create-a-project-column + */ + "POST /projects/{project_id}/columns": Operation<"/projects/{project_id}/columns", "post", "inertia">; + /** + * @see https://docs.github.com/rest/reference/actions#create-a-registration-token-for-a-repository + */ + "POST /repos/{owner}/{repo}/actions/runners/registration-token": Operation<"/repos/{owner}/{repo}/actions/runners/registration-token", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#create-a-remove-token-for-a-repository + */ + "POST /repos/{owner}/{repo}/actions/runners/remove-token": Operation<"/repos/{owner}/{repo}/actions/runners/remove-token", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request + */ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/approve", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#cancel-a-workflow-run + */ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#review-pending-deployments-for-a-workflow-run + */ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#re-run-a-workflow + */ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun": Operation<"/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", "post">; + /** + * @see https://docs.github.com/rest/reference/actions#create-a-workflow-dispatch-event + */ + "POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#set-admin-branch-protection + */ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-commit-signature-protection + */ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "post", "zzzax">; + /** + * @see https://docs.github.com/rest/reference/repos#add-status-check-contexts + */ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#add-app-access-restrictions + */ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#add-team-access-restrictions + */ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#add-user-access-restrictions + */ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#rename-a-branch + */ + "POST /repos/{owner}/{repo}/branches/{branch}/rename": Operation<"/repos/{owner}/{repo}/branches/{branch}/rename", "post">; + /** + * @see https://docs.github.com/rest/reference/checks#create-a-check-run + */ + "POST /repos/{owner}/{repo}/check-runs": Operation<"/repos/{owner}/{repo}/check-runs", "post">; + /** + * @see https://docs.github.com/rest/reference/checks#create-a-check-suite + */ + "POST /repos/{owner}/{repo}/check-suites": Operation<"/repos/{owner}/{repo}/check-suites", "post">; + /** + * @see https://docs.github.com/rest/reference/checks#rerequest-a-check-suite + */ + "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": Operation<"/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", "post">; + /** + * @see https://docs.github.com/rest/reference/code-scanning#upload-a-sarif-file + */ + "POST /repos/{owner}/{repo}/code-scanning/sarifs": Operation<"/repos/{owner}/{repo}/code-scanning/sarifs", "post">; + /** + * @see https://docs.github.com/rest/reference/reactions#create-reaction-for-a-commit-comment + */ + "POST /repos/{owner}/{repo}/comments/{comment_id}/reactions": Operation<"/repos/{owner}/{repo}/comments/{comment_id}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-commit-comment + */ + "POST /repos/{owner}/{repo}/commits/{commit_sha}/comments": Operation<"/repos/{owner}/{repo}/commits/{commit_sha}/comments", "post">; + /** + * @see https://docs.github.com/rest/reference/apps#create-a-content-attachment + */ + "POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": Operation<"/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", "post", "corsair">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-deployment + */ + "POST /repos/{owner}/{repo}/deployments": Operation<"/repos/{owner}/{repo}/deployments", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-deployment-status + */ + "POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses": Operation<"/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-repository-dispatch-event + */ + "POST /repos/{owner}/{repo}/dispatches": Operation<"/repos/{owner}/{repo}/dispatches", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-fork + */ + "POST /repos/{owner}/{repo}/forks": Operation<"/repos/{owner}/{repo}/forks", "post">; + /** + * @see https://docs.github.com/rest/reference/git#create-a-blob + */ + "POST /repos/{owner}/{repo}/git/blobs": Operation<"/repos/{owner}/{repo}/git/blobs", "post">; + /** + * @see https://docs.github.com/rest/reference/git#create-a-commit + */ + "POST /repos/{owner}/{repo}/git/commits": Operation<"/repos/{owner}/{repo}/git/commits", "post">; + /** + * @see https://docs.github.com/rest/reference/git#create-a-reference + */ + "POST /repos/{owner}/{repo}/git/refs": Operation<"/repos/{owner}/{repo}/git/refs", "post">; + /** + * @see https://docs.github.com/rest/reference/git#create-a-tag-object + */ + "POST /repos/{owner}/{repo}/git/tags": Operation<"/repos/{owner}/{repo}/git/tags", "post">; + /** + * @see https://docs.github.com/rest/reference/git#create-a-tree + */ + "POST /repos/{owner}/{repo}/git/trees": Operation<"/repos/{owner}/{repo}/git/trees", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-repository-webhook + */ + "POST /repos/{owner}/{repo}/hooks": Operation<"/repos/{owner}/{repo}/hooks", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#ping-a-repository-webhook + */ + "POST /repos/{owner}/{repo}/hooks/{hook_id}/pings": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}/pings", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#test-the-push-repository-webhook + */ + "POST /repos/{owner}/{repo}/hooks/{hook_id}/tests": Operation<"/repos/{owner}/{repo}/hooks/{hook_id}/tests", "post">; + /** + * @see https://docs.github.com/rest/reference/issues#create-an-issue + */ + "POST /repos/{owner}/{repo}/issues": Operation<"/repos/{owner}/{repo}/issues", "post">; + /** + * @see https://docs.github.com/rest/reference/reactions#create-reaction-for-an-issue-comment + */ + "POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": Operation<"/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/issues#add-assignees-to-an-issue + */ + "POST /repos/{owner}/{repo}/issues/{issue_number}/assignees": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/assignees", "post">; + /** + * @see https://docs.github.com/rest/reference/issues#create-an-issue-comment + */ + "POST /repos/{owner}/{repo}/issues/{issue_number}/comments": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/comments", "post">; + /** + * @see https://docs.github.com/rest/reference/issues#add-labels-to-an-issue + */ + "POST /repos/{owner}/{repo}/issues/{issue_number}/labels": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/labels", "post">; + /** + * @see https://docs.github.com/rest/reference/reactions#create-reaction-for-an-issue + */ + "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-deploy-key + */ + "POST /repos/{owner}/{repo}/keys": Operation<"/repos/{owner}/{repo}/keys", "post">; + /** + * @see https://docs.github.com/rest/reference/issues#create-a-label + */ + "POST /repos/{owner}/{repo}/labels": Operation<"/repos/{owner}/{repo}/labels", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#merge-a-branch + */ + "POST /repos/{owner}/{repo}/merges": Operation<"/repos/{owner}/{repo}/merges", "post">; + /** + * @see https://docs.github.com/rest/reference/issues#create-a-milestone + */ + "POST /repos/{owner}/{repo}/milestones": Operation<"/repos/{owner}/{repo}/milestones", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-github-pages-site + */ + "POST /repos/{owner}/{repo}/pages": Operation<"/repos/{owner}/{repo}/pages", "post", "switcheroo">; + /** + * @see https://docs.github.com/rest/reference/repos#request-a-github-pages-build + */ + "POST /repos/{owner}/{repo}/pages/builds": Operation<"/repos/{owner}/{repo}/pages/builds", "post">; + /** + * @see https://docs.github.com/rest/reference/projects#create-a-repository-project + */ + "POST /repos/{owner}/{repo}/projects": Operation<"/repos/{owner}/{repo}/projects", "post", "inertia">; + /** + * @see https://docs.github.com/rest/reference/pulls#create-a-pull-request + */ + "POST /repos/{owner}/{repo}/pulls": Operation<"/repos/{owner}/{repo}/pulls", "post">; + /** + * @see https://docs.github.com/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment + */ + "POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": Operation<"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request + */ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/comments", "post">; + /** + * @see https://docs.github.com/rest/reference/pulls#create-a-reply-for-a-review-comment + */ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", "post">; + /** + * @see https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request + */ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "post">; + /** + * @see https://docs.github.com/rest/reference/pulls#create-a-review-for-a-pull-request + */ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "post">; + /** + * @see https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request + */ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-release + */ + "POST /repos/{owner}/{repo}/releases": Operation<"/repos/{owner}/{repo}/releases", "post">; + /** + * @see https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-release + */ + "POST /repos/{owner}/{repo}/releases/{release_id}/reactions": Operation<"/repos/{owner}/{repo}/releases/{release_id}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-commit-status + */ + "POST /repos/{owner}/{repo}/statuses/{sha}": Operation<"/repos/{owner}/{repo}/statuses/{sha}", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#transfer-a-repository + */ + "POST /repos/{owner}/{repo}/transfer": Operation<"/repos/{owner}/{repo}/transfer", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template + */ + "POST /repos/{template_owner}/{template_repo}/generate": Operation<"/repos/{template_owner}/{template_repo}/generate", "post", "baptiste">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users + */ + "POST /scim/v2/enterprises/{enterprise}/Groups": Operation<"/scim/v2/enterprises/{enterprise}/Groups", "post">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user + */ + "POST /scim/v2/enterprises/{enterprise}/Users": Operation<"/scim/v2/enterprises/{enterprise}/Users", "post">; + /** + * @see https://docs.github.com/rest/reference/scim#provision-and-invite-a-scim-user + */ + "POST /scim/v2/organizations/{org}/Users": Operation<"/scim/v2/organizations/{org}/Users", "post">; + /** + * @see https://docs.github.com/rest/reference/teams#create-a-discussion-legacy + */ + "POST /teams/{team_id}/discussions": Operation<"/teams/{team_id}/discussions", "post">; + /** + * @see https://docs.github.com/rest/reference/teams#create-a-discussion-comment-legacy + */ + "POST /teams/{team_id}/discussions/{discussion_number}/comments": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments", "post">; + /** + * @see https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment-legacy + */ + "POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": Operation<"/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-team-discussion-legacy + */ + "POST /teams/{team_id}/discussions/{discussion_number}/reactions": Operation<"/teams/{team_id}/discussions/{discussion_number}/reactions", "post", "squirrel-girl">; + /** + * @see https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user + */ + "POST /user/emails": Operation<"/user/emails", "post">; + /** + * @see https://docs.github.com/rest/reference/users#create-a-gpg-key-for-the-authenticated-user + */ + "POST /user/gpg_keys": Operation<"/user/gpg_keys", "post">; + /** + * @see https://docs.github.com/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user + */ + "POST /user/keys": Operation<"/user/keys", "post">; + /** + * @see https://docs.github.com/rest/reference/migrations#start-a-user-migration + */ + "POST /user/migrations": Operation<"/user/migrations", "post">; + /** + * @see https://docs.github.com/rest/reference/packages#restore-a-package-for-the-authenticated-user + */ + "POST /user/packages/{package_type}/{package_name}/restore{?token}": Operation<"/user/packages/{package_type}/{package_name}/restore", "post">; + /** + * @see https://docs.github.com/rest/reference/packages#restore-a-package-version-for-the-authenticated-user + */ + "POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": Operation<"/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "post">; + /** + * @see https://docs.github.com/rest/reference/projects#create-a-user-project + */ + "POST /user/projects": Operation<"/user/projects", "post", "inertia">; + /** + * @see https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user + */ + "POST /user/repos": Operation<"/user/repos", "post">; + /** + * @see https://docs.github.com/rest/reference/repos#upload-a-release-asset + */ + "POST {origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}": Operation<"/repos/{owner}/{repo}/releases/{release_id}/assets", "post">; + /** + * @see https://docs.github.com/rest/reference/apps#suspend-an-app-installation + */ + "PUT /app/installations/{installation_id}/suspended": Operation<"/app/installations/{installation_id}/suspended", "put">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app + */ + "PUT /authorizations/clients/{client_id}": Operation<"/authorizations/clients/{client_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint + */ + "PUT /authorizations/clients/{client_id}/{fingerprint}": Operation<"/authorizations/clients/{client_id}/{fingerprint}", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/permissions": Operation<"/enterprises/{enterprise}/actions/permissions", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/permissions/organizations": Operation<"/enterprises/{enterprise}/actions/permissions/organizations", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}": Operation<"/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/permissions/selected-actions": Operation<"/enterprises/{enterprise}/actions/permissions/selected-actions", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#add-a-self-hosted-runner-to-a-group-for-an-enterprise + */ + "PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": Operation<"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/gists#star-a-gist + */ + "PUT /gists/{gist_id}/star": Operation<"/gists/{gist_id}/star", "put">; + /** + * @see https://docs.github.com/rest/reference/activity#mark-notifications-as-read + */ + "PUT /notifications": Operation<"/notifications", "put">; + /** + * @see https://docs.github.com/rest/reference/activity#set-a-thread-subscription + */ + "PUT /notifications/threads/{thread_id}/subscription": Operation<"/notifications/threads/{thread_id}/subscription", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization + */ + "PUT /orgs/{org}/actions/permissions": Operation<"/orgs/{org}/actions/permissions", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization + */ + "PUT /orgs/{org}/actions/permissions/repositories": Operation<"/orgs/{org}/actions/permissions/repositories", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization + */ + "PUT /orgs/{org}/actions/permissions/repositories/{repository_id}": Operation<"/orgs/{org}/actions/permissions/repositories/{repository_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-organization + */ + "PUT /orgs/{org}/actions/permissions/selected-actions": Operation<"/orgs/{org}/actions/permissions/selected-actions", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#add-repository-acess-to-a-self-hosted-runner-group-in-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/runners": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#add-a-self-hosted-runner-to-a-group-for-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret + */ + "PUT /orgs/{org}/actions/secrets/{secret_name}": Operation<"/orgs/{org}/actions/secrets/{secret_name}", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret + */ + "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories": Operation<"/orgs/{org}/actions/secrets/{secret_name}/repositories", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#add-selected-repository-to-an-organization-secret + */ + "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": Operation<"/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/orgs#block-a-user-from-an-organization + */ + "PUT /orgs/{org}/blocks/{username}": Operation<"/orgs/{org}/blocks/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-an-organization + */ + "PUT /orgs/{org}/interaction-limits": Operation<"/orgs/{org}/interaction-limits", "put">; + /** + * @see https://docs.github.com/rest/reference/orgs#set-organization-membership-for-a-user + */ + "PUT /orgs/{org}/memberships/{username}": Operation<"/orgs/{org}/memberships/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator + */ + "PUT /orgs/{org}/outside_collaborators/{username}": Operation<"/orgs/{org}/outside_collaborators/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user + */ + "PUT /orgs/{org}/public_members/{username}": Operation<"/orgs/{org}/public_members/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user + */ + "PUT /orgs/{org}/teams/{team_slug}/memberships/{username}": Operation<"/orgs/{org}/teams/{team_slug}/memberships/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions + */ + "PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}": Operation<"/orgs/{org}/teams/{team_slug}/projects/{project_id}", "put", "inertia">; + /** + * @see https://docs.github.com/rest/reference/teams/#add-or-update-team-repository-permissions + */ + "PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": Operation<"/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "put">; + /** + * @see https://docs.github.com/rest/reference/projects#add-project-collaborator + */ + "PUT /projects/{project_id}/collaborators/{username}": Operation<"/projects/{project_id}/collaborators/{username}", "put", "inertia">; + /** + * @see https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository + */ + "PUT /repos/{owner}/{repo}/actions/permissions": Operation<"/repos/{owner}/{repo}/actions/permissions", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#set-allowed-actions-for-a-repository + */ + "PUT /repos/{owner}/{repo}/actions/permissions/selected-actions": Operation<"/repos/{owner}/{repo}/actions/permissions/selected-actions", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#create-or-update-a-repository-secret + */ + "PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}": Operation<"/repos/{owner}/{repo}/actions/secrets/{secret_name}", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#disable-a-workflow + */ + "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", "put">; + /** + * @see https://docs.github.com/rest/reference/actions#enable-a-workflow + */ + "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#enable-automated-security-fixes + */ + "PUT /repos/{owner}/{repo}/automated-security-fixes": Operation<"/repos/{owner}/{repo}/automated-security-fixes", "put", "london">; + /** + * @see https://docs.github.com/rest/reference/repos#update-branch-protection + */ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#set-status-check-contexts + */ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#set-app-access-restrictions + */ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#set-team-access-restrictions + */ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#set-user-access-restrictions + */ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": Operation<"/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#add-a-repository-collaborator + */ + "PUT /repos/{owner}/{repo}/collaborators/{username}": Operation<"/repos/{owner}/{repo}/collaborators/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#create-or-update-file-contents + */ + "PUT /repos/{owner}/{repo}/contents/{path}": Operation<"/repos/{owner}/{repo}/contents/{path}", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#create-or-update-an-environment + */ + "PUT /repos/{owner}/{repo}/environments/{environment_name}": Operation<"/repos/{owner}/{repo}/environments/{environment_name}", "put">; + /** + * @see https://docs.github.com/rest/reference/migrations#start-an-import + */ + "PUT /repos/{owner}/{repo}/import": Operation<"/repos/{owner}/{repo}/import", "put">; + /** + * @see https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-a-repository + */ + "PUT /repos/{owner}/{repo}/interaction-limits": Operation<"/repos/{owner}/{repo}/interaction-limits", "put">; + /** + * @see https://docs.github.com/rest/reference/issues#set-labels-for-an-issue + */ + "PUT /repos/{owner}/{repo}/issues/{issue_number}/labels": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/labels", "put">; + /** + * @see https://docs.github.com/rest/reference/issues#lock-an-issue + */ + "PUT /repos/{owner}/{repo}/issues/{issue_number}/lock": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/lock", "put">; + /** + * @see https://docs.github.com/rest/reference/activity#mark-repository-notifications-as-read + */ + "PUT /repos/{owner}/{repo}/notifications": Operation<"/repos/{owner}/{repo}/notifications", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#update-information-about-a-github-pages-site + */ + "PUT /repos/{owner}/{repo}/pages": Operation<"/repos/{owner}/{repo}/pages", "put">; + /** + * @see https://docs.github.com/rest/reference/pulls#merge-a-pull-request + */ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/merge", "put">; + /** + * @see https://docs.github.com/rest/reference/pulls#update-a-review-for-a-pull-request + */ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/pulls#dismiss-a-review-for-a-pull-request + */ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", "put">; + /** + * @see https://docs.github.com/rest/reference/pulls#update-a-pull-request-branch + */ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch": Operation<"/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", "put", "lydian">; + /** + * @see https://docs.github.com/rest/reference/activity#set-a-repository-subscription + */ + "PUT /repos/{owner}/{repo}/subscription": Operation<"/repos/{owner}/{repo}/subscription", "put">; + /** + * @see https://docs.github.com/rest/reference/repos#replace-all-repository-topics + */ + "PUT /repos/{owner}/{repo}/topics": Operation<"/repos/{owner}/{repo}/topics", "put", "mercy">; + /** + * @see https://docs.github.com/rest/reference/repos#enable-vulnerability-alerts + */ + "PUT /repos/{owner}/{repo}/vulnerability-alerts": Operation<"/repos/{owner}/{repo}/vulnerability-alerts", "put", "dorian">; + /** + * @see https://docs.github.com/rest/reference/actions#create-or-update-an-environment-secret + */ + "PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": Operation<"/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group + */ + "PUT /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": Operation<"/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-user + */ + "PUT /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": Operation<"/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/scim#set-scim-information-for-a-provisioned-user + */ + "PUT /scim/v2/organizations/{org}/Users/{scim_user_id}": Operation<"/scim/v2/organizations/{org}/Users/{scim_user_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/teams#add-team-member-legacy + */ + "PUT /teams/{team_id}/members/{username}": Operation<"/teams/{team_id}/members/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy + */ + "PUT /teams/{team_id}/memberships/{username}": Operation<"/teams/{team_id}/memberships/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/teams/#add-or-update-team-project-permissions-legacy + */ + "PUT /teams/{team_id}/projects/{project_id}": Operation<"/teams/{team_id}/projects/{project_id}", "put", "inertia">; + /** + * @see https://docs.github.com/rest/reference/teams/#add-or-update-team-repository-permissions-legacy + */ + "PUT /teams/{team_id}/repos/{owner}/{repo}": Operation<"/teams/{team_id}/repos/{owner}/{repo}", "put">; + /** + * @see https://docs.github.com/rest/reference/users#block-a-user + */ + "PUT /user/blocks/{username}": Operation<"/user/blocks/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/users#follow-a-user + */ + "PUT /user/following/{username}": Operation<"/user/following/{username}", "put">; + /** + * @see https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation + */ + "PUT /user/installations/{installation_id}/repositories/{repository_id}": Operation<"/user/installations/{installation_id}/repositories/{repository_id}", "put">; + /** + * @see https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories + */ + "PUT /user/interaction-limits": Operation<"/user/interaction-limits", "put">; + /** + * @see https://docs.github.com/rest/reference/activity#star-a-repository-for-the-authenticated-user + */ + "PUT /user/starred/{owner}/{repo}": Operation<"/user/starred/{owner}/{repo}", "put">; +} +export {}; diff --git a/node_modules/@octokit/types/dist-types/index.d.ts b/node_modules/@octokit/types/dist-types/index.d.ts new file mode 100644 index 00000000..004ae9b2 --- /dev/null +++ b/node_modules/@octokit/types/dist-types/index.d.ts @@ -0,0 +1,21 @@ +export * from "./AuthInterface"; +export * from "./EndpointDefaults"; +export * from "./EndpointInterface"; +export * from "./EndpointOptions"; +export * from "./Fetch"; +export * from "./OctokitResponse"; +export * from "./RequestError"; +export * from "./RequestHeaders"; +export * from "./RequestInterface"; +export * from "./RequestMethod"; +export * from "./RequestOptions"; +export * from "./RequestParameters"; +export * from "./RequestRequestOptions"; +export * from "./ResponseHeaders"; +export * from "./Route"; +export * from "./Signal"; +export * from "./StrategyInterface"; +export * from "./Url"; +export * from "./VERSION"; +export * from "./GetResponseTypeFromEndpointMethod"; +export * from "./generated/Endpoints"; diff --git a/node_modules/@octokit/types/dist-web/index.js b/node_modules/@octokit/types/dist-web/index.js new file mode 100644 index 00000000..8c996def --- /dev/null +++ b/node_modules/@octokit/types/dist-web/index.js @@ -0,0 +1,4 @@ +const VERSION = "6.16.0"; + +export { VERSION }; +//# sourceMappingURL=index.js.map diff --git a/node_modules/@octokit/types/dist-web/index.js.map b/node_modules/@octokit/types/dist-web/index.js.map new file mode 100644 index 00000000..cd0e254a --- /dev/null +++ b/node_modules/@octokit/types/dist-web/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../dist-src/VERSION.js"],"sourcesContent":["export const VERSION = \"0.0.0-development\";\n"],"names":[],"mappings":"AAAY,MAAC,OAAO,GAAG;;;;"} \ No newline at end of file diff --git a/node_modules/@octokit/types/package.json b/node_modules/@octokit/types/package.json new file mode 100644 index 00000000..07d71c68 --- /dev/null +++ b/node_modules/@octokit/types/package.json @@ -0,0 +1,54 @@ +{ + "name": "@octokit/types", + "description": "Shared TypeScript definitions for Octokit projects", + "version": "6.16.0", + "license": "MIT", + "files": [ + "dist-*/", + "bin/" + ], + "pika": true, + "sideEffects": false, + "keywords": [ + "github", + "api", + "sdk", + "toolkit", + "typescript" + ], + "repository": "github:octokit/types.ts", + "dependencies": { + "@octokit/openapi-types": "^7.2.0" + }, + "devDependencies": { + "@octokit/graphql": "^4.2.2", + "@pika/pack": "^0.5.0", + "@pika/plugin-build-node": "^0.9.0", + "@pika/plugin-build-web": "^0.9.0", + "@pika/plugin-ts-standard-pkg": "^0.9.0", + "@types/node": ">= 8", + "handlebars": "^4.7.6", + "json-schema-to-typescript": "^10.0.0", + "lodash.set": "^4.3.2", + "npm-run-all": "^4.1.5", + "pascal-case": "^3.1.1", + "pika-plugin-merge-properties": "^1.0.6", + "prettier": "^2.0.0", + "semantic-release": "^17.0.0", + "semantic-release-plugin-update-version-in-files": "^1.0.0", + "sort-keys": "^4.2.0", + "string-to-jsdoc-comment": "^1.0.0", + "typedoc": "^0.20.0", + "typescript": "^4.0.2" + }, + "publishConfig": { + "access": "public" + }, + "source": "dist-src/index.js", + "types": "dist-types/index.d.ts", + "octokit": { + "openapi-version": "2.21.0" + }, + "main": "dist-node/index.js", + "module": "dist-web/index.js" +} diff --git a/node_modules/@types/node/LICENSE b/node_modules/@types/node/LICENSE new file mode 100755 index 00000000..9e841e7a --- /dev/null +++ b/node_modules/@types/node/LICENSE @@ -0,0 +1,21 @@ + MIT License + + Copyright (c) Microsoft Corporation. + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE diff --git a/node_modules/@types/node/README.md b/node_modules/@types/node/README.md new file mode 100755 index 00000000..a6cab200 --- /dev/null +++ b/node_modules/@types/node/README.md @@ -0,0 +1,16 @@ +# Installation +> `npm install --save @types/node` + +# Summary +This package contains type definitions for Node.js (https://nodejs.org/). + +# Details +Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node. + +### Additional Details + * Last updated: Tue, 23 Nov 2021 19:31:07 GMT + * Dependencies: none + * Global values: `AbortController`, `AbortSignal`, `__dirname`, `__filename`, `console`, `exports`, `gc`, `global`, `module`, `process`, `require` + +# Credits +These definitions were written by [Microsoft TypeScript](https://github.com/Microsoft), [DefinitelyTyped](https://github.com/DefinitelyTyped), [Alberto Schiabel](https://github.com/jkomyno), [Alvis HT Tang](https://github.com/alvis), [Andrew Makarov](https://github.com/r3nya), [Benjamin Toueg](https://github.com/btoueg), [Chigozirim C.](https://github.com/smac89), [David Junger](https://github.com/touffy), [Deividas Bakanas](https://github.com/DeividasBakanas), [Eugene Y. Q. Shen](https://github.com/eyqs), [Hannes Magnusson](https://github.com/Hannes-Magnusson-CK), [Huw](https://github.com/hoo29), [Kelvin Jin](https://github.com/kjin), [Klaus Meinhardt](https://github.com/ajafff), [Lishude](https://github.com/islishude), [Mariusz Wiktorczyk](https://github.com/mwiktorczyk), [Mohsen Azimi](https://github.com/mohsen1), [Nicolas Even](https://github.com/n-e), [Nikita Galkin](https://github.com/galkin), [Parambir Singh](https://github.com/parambirs), [Sebastian Silbermann](https://github.com/eps1lon), [Seth Westphal](https://github.com/westy92), [Simon Schick](https://github.com/SimonSchick), [Thomas den Hollander](https://github.com/ThomasdenH), [Wilco Bakker](https://github.com/WilcoBakker), [wwwy3y3](https://github.com/wwwy3y3), [Samuel Ainsworth](https://github.com/samuela), [Kyle Uehlein](https://github.com/kuehlein), [Thanik Bhongbhibhat](https://github.com/bhongy), [Marcin Kopacz](https://github.com/chyzwar), [Trivikram Kamat](https://github.com/trivikr), [Junxiao Shi](https://github.com/yoursunny), [Ilia Baryshnikov](https://github.com/qwelias), [ExE Boss](https://github.com/ExE-Boss), [Surasak Chaisurin](https://github.com/Ryan-Willpower), [Piotr Błażejewicz](https://github.com/peterblazejewicz), [Anna Henningsen](https://github.com/addaleax), [Victor Perin](https://github.com/victorperin), [Yongsheng Zhang](https://github.com/ZYSzys), [NodeJS Contributors](https://github.com/NodeJS), [Linus Unnebäck](https://github.com/LinusU), and [wafuwafu13](https://github.com/wafuwafu13). diff --git a/node_modules/@types/node/assert.d.ts b/node_modules/@types/node/assert.d.ts new file mode 100755 index 00000000..9f916c16 --- /dev/null +++ b/node_modules/@types/node/assert.d.ts @@ -0,0 +1,912 @@ +/** + * The `assert` module provides a set of assertion functions for verifying + * invariants. + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/assert.js) + */ +declare module 'assert' { + /** + * An alias of {@link ok}. + * @since v0.5.9 + * @param value The input that is checked for being truthy. + */ + function assert(value: unknown, message?: string | Error): asserts value; + namespace assert { + /** + * Indicates the failure of an assertion. All errors thrown by the `assert` module + * will be instances of the `AssertionError` class. + */ + class AssertionError extends Error { + actual: unknown; + expected: unknown; + operator: string; + generatedMessage: boolean; + code: 'ERR_ASSERTION'; + constructor(options?: { + /** If provided, the error message is set to this value. */ + message?: string | undefined; + /** The `actual` property on the error instance. */ + actual?: unknown | undefined; + /** The `expected` property on the error instance. */ + expected?: unknown | undefined; + /** The `operator` property on the error instance. */ + operator?: string | undefined; + /** If provided, the generated stack trace omits frames before this function. */ + // tslint:disable-next-line:ban-types + stackStartFn?: Function | undefined; + }); + } + /** + * This feature is currently experimental and behavior might still change. + * @since v14.2.0, v12.19.0 + * @experimental + */ + class CallTracker { + /** + * The wrapper function is expected to be called exactly `exact` times. If the + * function has not been called exactly `exact` times when `tracker.verify()` is called, then `tracker.verify()` will throw an + * error. + * + * ```js + * import assert from 'assert'; + * + * // Creates call tracker. + * const tracker = new assert.CallTracker(); + * + * function func() {} + * + * // Returns a function that wraps func() that must be called exact times + * // before tracker.verify(). + * const callsfunc = tracker.calls(func); + * ``` + * @since v14.2.0, v12.19.0 + * @param [fn='A no-op function'] + * @param [exact=1] + * @return that wraps `fn`. + */ + calls(exact?: number): () => void; + calls any>(fn?: Func, exact?: number): Func; + /** + * The arrays contains information about the expected and actual number of calls of + * the functions that have not been called the expected number of times. + * + * ```js + * import assert from 'assert'; + * + * // Creates call tracker. + * const tracker = new assert.CallTracker(); + * + * function func() {} + * + * function foo() {} + * + * // Returns a function that wraps func() that must be called exact times + * // before tracker.verify(). + * const callsfunc = tracker.calls(func, 2); + * + * // Returns an array containing information on callsfunc() + * tracker.report(); + * // [ + * // { + * // message: 'Expected the func function to be executed 2 time(s) but was + * // executed 0 time(s).', + * // actual: 0, + * // expected: 2, + * // operator: 'func', + * // stack: stack trace + * // } + * // ] + * ``` + * @since v14.2.0, v12.19.0 + * @return of objects containing information about the wrapper functions returned by `calls`. + */ + report(): CallTrackerReportInformation[]; + /** + * Iterates through the list of functions passed to `tracker.calls()` and will throw an error for functions that + * have not been called the expected number of times. + * + * ```js + * import assert from 'assert'; + * + * // Creates call tracker. + * const tracker = new assert.CallTracker(); + * + * function func() {} + * + * // Returns a function that wraps func() that must be called exact times + * // before tracker.verify(). + * const callsfunc = tracker.calls(func, 2); + * + * callsfunc(); + * + * // Will throw an error since callsfunc() was only called once. + * tracker.verify(); + * ``` + * @since v14.2.0, v12.19.0 + */ + verify(): void; + } + interface CallTrackerReportInformation { + message: string; + /** The actual number of times the function was called. */ + actual: number; + /** The number of times the function was expected to be called. */ + expected: number; + /** The name of the function that is wrapped. */ + operator: string; + /** A stack trace of the function. */ + stack: object; + } + type AssertPredicate = RegExp | (new () => object) | ((thrown: unknown) => boolean) | object | Error; + /** + * Throws an `AssertionError` with the provided error message or a default + * error message. If the `message` parameter is an instance of an `Error` then + * it will be thrown instead of the `AssertionError`. + * + * ```js + * import assert from 'assert/strict'; + * + * assert.fail(); + * // AssertionError [ERR_ASSERTION]: Failed + * + * assert.fail('boom'); + * // AssertionError [ERR_ASSERTION]: boom + * + * assert.fail(new TypeError('need array')); + * // TypeError: need array + * ``` + * + * Using `assert.fail()` with more than two arguments is possible but deprecated. + * See below for further details. + * @since v0.1.21 + * @param [message='Failed'] + */ + function fail(message?: string | Error): never; + /** @deprecated since v10.0.0 - use fail([message]) or other assert functions instead. */ + function fail( + actual: unknown, + expected: unknown, + message?: string | Error, + operator?: string, + // tslint:disable-next-line:ban-types + stackStartFn?: Function + ): never; + /** + * Tests if `value` is truthy. It is equivalent to`assert.equal(!!value, true, message)`. + * + * If `value` is not truthy, an `AssertionError` is thrown with a `message`property set equal to the value of the `message` parameter. If the `message`parameter is `undefined`, a default + * error message is assigned. If the `message`parameter is an instance of an `Error` then it will be thrown instead of the`AssertionError`. + * If no arguments are passed in at all `message` will be set to the string:`` 'No value argument passed to `assert.ok()`' ``. + * + * Be aware that in the `repl` the error message will be different to the one + * thrown in a file! See below for further details. + * + * ```js + * import assert from 'assert/strict'; + * + * assert.ok(true); + * // OK + * assert.ok(1); + * // OK + * + * assert.ok(); + * // AssertionError: No value argument passed to `assert.ok()` + * + * assert.ok(false, 'it\'s false'); + * // AssertionError: it's false + * + * // In the repl: + * assert.ok(typeof 123 === 'string'); + * // AssertionError: false == true + * + * // In a file (e.g. test.js): + * assert.ok(typeof 123 === 'string'); + * // AssertionError: The expression evaluated to a falsy value: + * // + * // assert.ok(typeof 123 === 'string') + * + * assert.ok(false); + * // AssertionError: The expression evaluated to a falsy value: + * // + * // assert.ok(false) + * + * assert.ok(0); + * // AssertionError: The expression evaluated to a falsy value: + * // + * // assert.ok(0) + * ``` + * + * ```js + * import assert from 'assert/strict'; + * + * // Using `assert()` works the same: + * assert(0); + * // AssertionError: The expression evaluated to a falsy value: + * // + * // assert(0) + * ``` + * @since v0.1.21 + */ + function ok(value: unknown, message?: string | Error): asserts value; + /** + * **Strict assertion mode** + * + * An alias of {@link strictEqual}. + * + * **Legacy assertion mode** + * + * > Stability: 3 - Legacy: Use {@link strictEqual} instead. + * + * Tests shallow, coercive equality between the `actual` and `expected` parameters + * using the [Abstract Equality Comparison](https://tc39.github.io/ecma262/#sec-abstract-equality-comparison) ( `==` ). `NaN` is special handled + * and treated as being identical in case both sides are `NaN`. + * + * ```js + * import assert from 'assert'; + * + * assert.equal(1, 1); + * // OK, 1 == 1 + * assert.equal(1, '1'); + * // OK, 1 == '1' + * assert.equal(NaN, NaN); + * // OK + * + * assert.equal(1, 2); + * // AssertionError: 1 == 2 + * assert.equal({ a: { b: 1 } }, { a: { b: 1 } }); + * // AssertionError: { a: { b: 1 } } == { a: { b: 1 } } + * ``` + * + * If the values are not equal, an `AssertionError` is thrown with a `message`property set equal to the value of the `message` parameter. If the `message`parameter is undefined, a default + * error message is assigned. If the `message`parameter is an instance of an `Error` then it will be thrown instead of the`AssertionError`. + * @since v0.1.21 + */ + function equal(actual: unknown, expected: unknown, message?: string | Error): void; + /** + * **Strict assertion mode** + * + * An alias of {@link notStrictEqual}. + * + * **Legacy assertion mode** + * + * > Stability: 3 - Legacy: Use {@link notStrictEqual} instead. + * + * Tests shallow, coercive inequality with the [Abstract Equality Comparison](https://tc39.github.io/ecma262/#sec-abstract-equality-comparison)(`!=` ). `NaN` is special handled and treated as + * being identical in case both + * sides are `NaN`. + * + * ```js + * import assert from 'assert'; + * + * assert.notEqual(1, 2); + * // OK + * + * assert.notEqual(1, 1); + * // AssertionError: 1 != 1 + * + * assert.notEqual(1, '1'); + * // AssertionError: 1 != '1' + * ``` + * + * If the values are equal, an `AssertionError` is thrown with a `message`property set equal to the value of the `message` parameter. If the `message`parameter is undefined, a default error + * message is assigned. If the `message`parameter is an instance of an `Error` then it will be thrown instead of the`AssertionError`. + * @since v0.1.21 + */ + function notEqual(actual: unknown, expected: unknown, message?: string | Error): void; + /** + * **Strict assertion mode** + * + * An alias of {@link deepStrictEqual}. + * + * **Legacy assertion mode** + * + * > Stability: 3 - Legacy: Use {@link deepStrictEqual} instead. + * + * Tests for deep equality between the `actual` and `expected` parameters. Consider + * using {@link deepStrictEqual} instead. {@link deepEqual} can have + * surprising results. + * + * _Deep equality_ means that the enumerable "own" properties of child objects + * are also recursively evaluated by the following rules. + * @since v0.1.21 + */ + function deepEqual(actual: unknown, expected: unknown, message?: string | Error): void; + /** + * **Strict assertion mode** + * + * An alias of {@link notDeepStrictEqual}. + * + * **Legacy assertion mode** + * + * > Stability: 3 - Legacy: Use {@link notDeepStrictEqual} instead. + * + * Tests for any deep inequality. Opposite of {@link deepEqual}. + * + * ```js + * import assert from 'assert'; + * + * const obj1 = { + * a: { + * b: 1 + * } + * }; + * const obj2 = { + * a: { + * b: 2 + * } + * }; + * const obj3 = { + * a: { + * b: 1 + * } + * }; + * const obj4 = Object.create(obj1); + * + * assert.notDeepEqual(obj1, obj1); + * // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } } + * + * assert.notDeepEqual(obj1, obj2); + * // OK + * + * assert.notDeepEqual(obj1, obj3); + * // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } } + * + * assert.notDeepEqual(obj1, obj4); + * // OK + * ``` + * + * If the values are deeply equal, an `AssertionError` is thrown with a`message` property set equal to the value of the `message` parameter. If the`message` parameter is undefined, a default + * error message is assigned. If the`message` parameter is an instance of an `Error` then it will be thrown + * instead of the `AssertionError`. + * @since v0.1.21 + */ + function notDeepEqual(actual: unknown, expected: unknown, message?: string | Error): void; + /** + * Tests strict equality between the `actual` and `expected` parameters as + * determined by the [SameValue Comparison](https://tc39.github.io/ecma262/#sec-samevalue). + * + * ```js + * import assert from 'assert/strict'; + * + * assert.strictEqual(1, 2); + * // AssertionError [ERR_ASSERTION]: Expected inputs to be strictly equal: + * // + * // 1 !== 2 + * + * assert.strictEqual(1, 1); + * // OK + * + * assert.strictEqual('Hello foobar', 'Hello World!'); + * // AssertionError [ERR_ASSERTION]: Expected inputs to be strictly equal: + * // + actual - expected + * // + * // + 'Hello foobar' + * // - 'Hello World!' + * // ^ + * + * const apples = 1; + * const oranges = 2; + * assert.strictEqual(apples, oranges, `apples ${apples} !== oranges ${oranges}`); + * // AssertionError [ERR_ASSERTION]: apples 1 !== oranges 2 + * + * assert.strictEqual(1, '1', new TypeError('Inputs are not identical')); + * // TypeError: Inputs are not identical + * ``` + * + * If the values are not strictly equal, an `AssertionError` is thrown with a`message` property set equal to the value of the `message` parameter. If the`message` parameter is undefined, a + * default error message is assigned. If the`message` parameter is an instance of an `Error` then it will be thrown + * instead of the `AssertionError`. + * @since v0.1.21 + */ + function strictEqual(actual: unknown, expected: T, message?: string | Error): asserts actual is T; + /** + * Tests strict inequality between the `actual` and `expected` parameters as + * determined by the [SameValue Comparison](https://tc39.github.io/ecma262/#sec-samevalue). + * + * ```js + * import assert from 'assert/strict'; + * + * assert.notStrictEqual(1, 2); + * // OK + * + * assert.notStrictEqual(1, 1); + * // AssertionError [ERR_ASSERTION]: Expected "actual" to be strictly unequal to: + * // + * // 1 + * + * assert.notStrictEqual(1, '1'); + * // OK + * ``` + * + * If the values are strictly equal, an `AssertionError` is thrown with a`message` property set equal to the value of the `message` parameter. If the`message` parameter is undefined, a + * default error message is assigned. If the`message` parameter is an instance of an `Error` then it will be thrown + * instead of the `AssertionError`. + * @since v0.1.21 + */ + function notStrictEqual(actual: unknown, expected: unknown, message?: string | Error): void; + /** + * Tests for deep equality between the `actual` and `expected` parameters. + * "Deep" equality means that the enumerable "own" properties of child objects + * are recursively evaluated also by the following rules. + * @since v1.2.0 + */ + function deepStrictEqual(actual: unknown, expected: T, message?: string | Error): asserts actual is T; + /** + * Tests for deep strict inequality. Opposite of {@link deepStrictEqual}. + * + * ```js + * import assert from 'assert/strict'; + * + * assert.notDeepStrictEqual({ a: 1 }, { a: '1' }); + * // OK + * ``` + * + * If the values are deeply and strictly equal, an `AssertionError` is thrown + * with a `message` property set equal to the value of the `message` parameter. If + * the `message` parameter is undefined, a default error message is assigned. If + * the `message` parameter is an instance of an `Error` then it will be thrown + * instead of the `AssertionError`. + * @since v1.2.0 + */ + function notDeepStrictEqual(actual: unknown, expected: unknown, message?: string | Error): void; + /** + * Expects the function `fn` to throw an error. + * + * If specified, `error` can be a [`Class`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes), + * [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions), a validation function, + * a validation object where each property will be tested for strict deep equality, + * or an instance of error where each property will be tested for strict deep + * equality including the non-enumerable `message` and `name` properties. When + * using an object, it is also possible to use a regular expression, when + * validating against a string property. See below for examples. + * + * If specified, `message` will be appended to the message provided by the`AssertionError` if the `fn` call fails to throw or in case the error validation + * fails. + * + * Custom validation object/error instance: + * + * ```js + * import assert from 'assert/strict'; + * + * const err = new TypeError('Wrong value'); + * err.code = 404; + * err.foo = 'bar'; + * err.info = { + * nested: true, + * baz: 'text' + * }; + * err.reg = /abc/i; + * + * assert.throws( + * () => { + * throw err; + * }, + * { + * name: 'TypeError', + * message: 'Wrong value', + * info: { + * nested: true, + * baz: 'text' + * } + * // Only properties on the validation object will be tested for. + * // Using nested objects requires all properties to be present. Otherwise + * // the validation is going to fail. + * } + * ); + * + * // Using regular expressions to validate error properties: + * throws( + * () => { + * throw err; + * }, + * { + * // The `name` and `message` properties are strings and using regular + * // expressions on those will match against the string. If they fail, an + * // error is thrown. + * name: /^TypeError$/, + * message: /Wrong/, + * foo: 'bar', + * info: { + * nested: true, + * // It is not possible to use regular expressions for nested properties! + * baz: 'text' + * }, + * // The `reg` property contains a regular expression and only if the + * // validation object contains an identical regular expression, it is going + * // to pass. + * reg: /abc/i + * } + * ); + * + * // Fails due to the different `message` and `name` properties: + * throws( + * () => { + * const otherErr = new Error('Not found'); + * // Copy all enumerable properties from `err` to `otherErr`. + * for (const [key, value] of Object.entries(err)) { + * otherErr[key] = value; + * } + * throw otherErr; + * }, + * // The error's `message` and `name` properties will also be checked when using + * // an error as validation object. + * err + * ); + * ``` + * + * Validate instanceof using constructor: + * + * ```js + * import assert from 'assert/strict'; + * + * assert.throws( + * () => { + * throw new Error('Wrong value'); + * }, + * Error + * ); + * ``` + * + * Validate error message using [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions): + * + * Using a regular expression runs `.toString` on the error object, and will + * therefore also include the error name. + * + * ```js + * import assert from 'assert/strict'; + * + * assert.throws( + * () => { + * throw new Error('Wrong value'); + * }, + * /^Error: Wrong value$/ + * ); + * ``` + * + * Custom error validation: + * + * The function must return `true` to indicate all internal validations passed. + * It will otherwise fail with an `AssertionError`. + * + * ```js + * import assert from 'assert/strict'; + * + * assert.throws( + * () => { + * throw new Error('Wrong value'); + * }, + * (err) => { + * assert(err instanceof Error); + * assert(/value/.test(err)); + * // Avoid returning anything from validation functions besides `true`. + * // Otherwise, it's not clear what part of the validation failed. Instead, + * // throw an error about the specific validation that failed (as done in this + * // example) and add as much helpful debugging information to that error as + * // possible. + * return true; + * }, + * 'unexpected error' + * ); + * ``` + * + * `error` cannot be a string. If a string is provided as the second + * argument, then `error` is assumed to be omitted and the string will be used for`message` instead. This can lead to easy-to-miss mistakes. Using the same + * message as the thrown error message is going to result in an`ERR_AMBIGUOUS_ARGUMENT` error. Please read the example below carefully if using + * a string as the second argument gets considered: + * + * ```js + * import assert from 'assert/strict'; + * + * function throwingFirst() { + * throw new Error('First'); + * } + * + * function throwingSecond() { + * throw new Error('Second'); + * } + * + * function notThrowing() {} + * + * // The second argument is a string and the input function threw an Error. + * // The first case will not throw as it does not match for the error message + * // thrown by the input function! + * assert.throws(throwingFirst, 'Second'); + * // In the next example the message has no benefit over the message from the + * // error and since it is not clear if the user intended to actually match + * // against the error message, Node.js throws an `ERR_AMBIGUOUS_ARGUMENT` error. + * assert.throws(throwingSecond, 'Second'); + * // TypeError [ERR_AMBIGUOUS_ARGUMENT] + * + * // The string is only used (as message) in case the function does not throw: + * assert.throws(notThrowing, 'Second'); + * // AssertionError [ERR_ASSERTION]: Missing expected exception: Second + * + * // If it was intended to match for the error message do this instead: + * // It does not throw because the error messages match. + * assert.throws(throwingSecond, /Second$/); + * + * // If the error message does not match, an AssertionError is thrown. + * assert.throws(throwingFirst, /Second$/); + * // AssertionError [ERR_ASSERTION] + * ``` + * + * Due to the confusing error-prone notation, avoid a string as the second + * argument. + * @since v0.1.21 + */ + function throws(block: () => unknown, message?: string | Error): void; + function throws(block: () => unknown, error: AssertPredicate, message?: string | Error): void; + /** + * Asserts that the function `fn` does not throw an error. + * + * Using `assert.doesNotThrow()` is actually not useful because there + * is no benefit in catching an error and then rethrowing it. Instead, consider + * adding a comment next to the specific code path that should not throw and keep + * error messages as expressive as possible. + * + * When `assert.doesNotThrow()` is called, it will immediately call the `fn`function. + * + * If an error is thrown and it is the same type as that specified by the `error`parameter, then an `AssertionError` is thrown. If the error is of a + * different type, or if the `error` parameter is undefined, the error is + * propagated back to the caller. + * + * If specified, `error` can be a [`Class`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes), + * [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) or a validation + * function. See {@link throws} for more details. + * + * The following, for instance, will throw the `TypeError` because there is no + * matching error type in the assertion: + * + * ```js + * import assert from 'assert/strict'; + * + * assert.doesNotThrow( + * () => { + * throw new TypeError('Wrong value'); + * }, + * SyntaxError + * ); + * ``` + * + * However, the following will result in an `AssertionError` with the message + * 'Got unwanted exception...': + * + * ```js + * import assert from 'assert/strict'; + * + * assert.doesNotThrow( + * () => { + * throw new TypeError('Wrong value'); + * }, + * TypeError + * ); + * ``` + * + * If an `AssertionError` is thrown and a value is provided for the `message`parameter, the value of `message` will be appended to the `AssertionError` message: + * + * ```js + * import assert from 'assert/strict'; + * + * assert.doesNotThrow( + * () => { + * throw new TypeError('Wrong value'); + * }, + * /Wrong value/, + * 'Whoops' + * ); + * // Throws: AssertionError: Got unwanted exception: Whoops + * ``` + * @since v0.1.21 + */ + function doesNotThrow(block: () => unknown, message?: string | Error): void; + function doesNotThrow(block: () => unknown, error: AssertPredicate, message?: string | Error): void; + /** + * Throws `value` if `value` is not `undefined` or `null`. This is useful when + * testing the `error` argument in callbacks. The stack trace contains all frames + * from the error passed to `ifError()` including the potential new frames for`ifError()` itself. + * + * ```js + * import assert from 'assert/strict'; + * + * assert.ifError(null); + * // OK + * assert.ifError(0); + * // AssertionError [ERR_ASSERTION]: ifError got unwanted exception: 0 + * assert.ifError('error'); + * // AssertionError [ERR_ASSERTION]: ifError got unwanted exception: 'error' + * assert.ifError(new Error()); + * // AssertionError [ERR_ASSERTION]: ifError got unwanted exception: Error + * + * // Create some random error frames. + * let err; + * (function errorFrame() { + * err = new Error('test error'); + * })(); + * + * (function ifErrorFrame() { + * assert.ifError(err); + * })(); + * // AssertionError [ERR_ASSERTION]: ifError got unwanted exception: test error + * // at ifErrorFrame + * // at errorFrame + * ``` + * @since v0.1.97 + */ + function ifError(value: unknown): asserts value is null | undefined; + /** + * Awaits the `asyncFn` promise or, if `asyncFn` is a function, immediately + * calls the function and awaits the returned promise to complete. It will then + * check that the promise is rejected. + * + * If `asyncFn` is a function and it throws an error synchronously,`assert.rejects()` will return a rejected `Promise` with that error. If the + * function does not return a promise, `assert.rejects()` will return a rejected`Promise` with an `ERR_INVALID_RETURN_VALUE` error. In both cases the error + * handler is skipped. + * + * Besides the async nature to await the completion behaves identically to {@link throws}. + * + * If specified, `error` can be a [`Class`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes), + * [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions), a validation function, + * an object where each property will be tested for, or an instance of error where + * each property will be tested for including the non-enumerable `message` and`name` properties. + * + * If specified, `message` will be the message provided by the `AssertionError` if the `asyncFn` fails to reject. + * + * ```js + * import assert from 'assert/strict'; + * + * await assert.rejects( + * async () => { + * throw new TypeError('Wrong value'); + * }, + * { + * name: 'TypeError', + * message: 'Wrong value' + * } + * ); + * ``` + * + * ```js + * import assert from 'assert/strict'; + * + * await assert.rejects( + * async () => { + * throw new TypeError('Wrong value'); + * }, + * (err) => { + * assert.strictEqual(err.name, 'TypeError'); + * assert.strictEqual(err.message, 'Wrong value'); + * return true; + * } + * ); + * ``` + * + * ```js + * import assert from 'assert/strict'; + * + * assert.rejects( + * Promise.reject(new Error('Wrong value')), + * Error + * ).then(() => { + * // ... + * }); + * ``` + * + * `error` cannot be a string. If a string is provided as the second + * argument, then `error` is assumed to be omitted and the string will be used for`message` instead. This can lead to easy-to-miss mistakes. Please read the + * example in {@link throws} carefully if using a string as the second + * argument gets considered. + * @since v10.0.0 + */ + function rejects(block: (() => Promise) | Promise, message?: string | Error): Promise; + function rejects(block: (() => Promise) | Promise, error: AssertPredicate, message?: string | Error): Promise; + /** + * Awaits the `asyncFn` promise or, if `asyncFn` is a function, immediately + * calls the function and awaits the returned promise to complete. It will then + * check that the promise is not rejected. + * + * If `asyncFn` is a function and it throws an error synchronously,`assert.doesNotReject()` will return a rejected `Promise` with that error. If + * the function does not return a promise, `assert.doesNotReject()` will return a + * rejected `Promise` with an `ERR_INVALID_RETURN_VALUE` error. In both cases + * the error handler is skipped. + * + * Using `assert.doesNotReject()` is actually not useful because there is little + * benefit in catching a rejection and then rejecting it again. Instead, consider + * adding a comment next to the specific code path that should not reject and keep + * error messages as expressive as possible. + * + * If specified, `error` can be a [`Class`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes), + * [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) or a validation + * function. See {@link throws} for more details. + * + * Besides the async nature to await the completion behaves identically to {@link doesNotThrow}. + * + * ```js + * import assert from 'assert/strict'; + * + * await assert.doesNotReject( + * async () => { + * throw new TypeError('Wrong value'); + * }, + * SyntaxError + * ); + * ``` + * + * ```js + * import assert from 'assert/strict'; + * + * assert.doesNotReject(Promise.reject(new TypeError('Wrong value'))) + * .then(() => { + * // ... + * }); + * ``` + * @since v10.0.0 + */ + function doesNotReject(block: (() => Promise) | Promise, message?: string | Error): Promise; + function doesNotReject(block: (() => Promise) | Promise, error: AssertPredicate, message?: string | Error): Promise; + /** + * Expects the `string` input to match the regular expression. + * + * ```js + * import assert from 'assert/strict'; + * + * assert.match('I will fail', /pass/); + * // AssertionError [ERR_ASSERTION]: The input did not match the regular ... + * + * assert.match(123, /pass/); + * // AssertionError [ERR_ASSERTION]: The "string" argument must be of type string. + * + * assert.match('I will pass', /pass/); + * // OK + * ``` + * + * If the values do not match, or if the `string` argument is of another type than`string`, an `AssertionError` is thrown with a `message` property set equal + * to the value of the `message` parameter. If the `message` parameter is + * undefined, a default error message is assigned. If the `message` parameter is an + * instance of an `Error` then it will be thrown instead of the `AssertionError`. + * @since v13.6.0, v12.16.0 + */ + function match(value: string, regExp: RegExp, message?: string | Error): void; + /** + * Expects the `string` input not to match the regular expression. + * + * ```js + * import assert from 'assert/strict'; + * + * assert.doesNotMatch('I will fail', /fail/); + * // AssertionError [ERR_ASSERTION]: The input was expected to not match the ... + * + * assert.doesNotMatch(123, /pass/); + * // AssertionError [ERR_ASSERTION]: The "string" argument must be of type string. + * + * assert.doesNotMatch('I will pass', /different/); + * // OK + * ``` + * + * If the values do match, or if the `string` argument is of another type than`string`, an `AssertionError` is thrown with a `message` property set equal + * to the value of the `message` parameter. If the `message` parameter is + * undefined, a default error message is assigned. If the `message` parameter is an + * instance of an `Error` then it will be thrown instead of the `AssertionError`. + * @since v13.6.0, v12.16.0 + */ + function doesNotMatch(value: string, regExp: RegExp, message?: string | Error): void; + const strict: Omit & { + (value: unknown, message?: string | Error): asserts value; + equal: typeof strictEqual; + notEqual: typeof notStrictEqual; + deepEqual: typeof deepStrictEqual; + notDeepEqual: typeof notDeepStrictEqual; + // Mapped types and assertion functions are incompatible? + // TS2775: Assertions require every name in the call target + // to be declared with an explicit type annotation. + ok: typeof ok; + strictEqual: typeof strictEqual; + deepStrictEqual: typeof deepStrictEqual; + ifError: typeof ifError; + strict: typeof strict; + }; + } + export = assert; +} +declare module 'node:assert' { + import assert = require('assert'); + export = assert; +} diff --git a/node_modules/@types/node/assert/strict.d.ts b/node_modules/@types/node/assert/strict.d.ts new file mode 100755 index 00000000..b4319b97 --- /dev/null +++ b/node_modules/@types/node/assert/strict.d.ts @@ -0,0 +1,8 @@ +declare module 'assert/strict' { + import { strict } from 'node:assert'; + export = strict; +} +declare module 'node:assert/strict' { + import { strict } from 'node:assert'; + export = strict; +} diff --git a/node_modules/@types/node/async_hooks.d.ts b/node_modules/@types/node/async_hooks.d.ts new file mode 100755 index 00000000..35b9be2c --- /dev/null +++ b/node_modules/@types/node/async_hooks.d.ts @@ -0,0 +1,497 @@ +/** + * The `async_hooks` module provides an API to track asynchronous resources. It + * can be accessed using: + * + * ```js + * import async_hooks from 'async_hooks'; + * ``` + * @experimental + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/async_hooks.js) + */ +declare module 'async_hooks' { + /** + * ```js + * import { executionAsyncId } from 'async_hooks'; + * + * console.log(executionAsyncId()); // 1 - bootstrap + * fs.open(path, 'r', (err, fd) => { + * console.log(executionAsyncId()); // 6 - open() + * }); + * ``` + * + * The ID returned from `executionAsyncId()` is related to execution timing, not + * causality (which is covered by `triggerAsyncId()`): + * + * ```js + * const server = net.createServer((conn) => { + * // Returns the ID of the server, not of the new connection, because the + * // callback runs in the execution scope of the server's MakeCallback(). + * async_hooks.executionAsyncId(); + * + * }).listen(port, () => { + * // Returns the ID of a TickObject (process.nextTick()) because all + * // callbacks passed to .listen() are wrapped in a nextTick(). + * async_hooks.executionAsyncId(); + * }); + * ``` + * + * Promise contexts may not get precise `executionAsyncIds` by default. + * See the section on `promise execution tracking`. + * @since v8.1.0 + * @return The `asyncId` of the current execution context. Useful to track when something calls. + */ + function executionAsyncId(): number; + /** + * Resource objects returned by `executionAsyncResource()` are most often internal + * Node.js handle objects with undocumented APIs. Using any functions or properties + * on the object is likely to crash your application and should be avoided. + * + * Using `executionAsyncResource()` in the top-level execution context will + * return an empty object as there is no handle or request object to use, + * but having an object representing the top-level can be helpful. + * + * ```js + * import { open } from 'fs'; + * import { executionAsyncId, executionAsyncResource } from 'async_hooks'; + * + * console.log(executionAsyncId(), executionAsyncResource()); // 1 {} + * open(new URL(import.meta.url), 'r', (err, fd) => { + * console.log(executionAsyncId(), executionAsyncResource()); // 7 FSReqWrap + * }); + * ``` + * + * This can be used to implement continuation local storage without the + * use of a tracking `Map` to store the metadata: + * + * ```js + * import { createServer } from 'http'; + * import { + * executionAsyncId, + * executionAsyncResource, + * createHook + * } from 'async_hooks'; + * const sym = Symbol('state'); // Private symbol to avoid pollution + * + * createHook({ + * init(asyncId, type, triggerAsyncId, resource) { + * const cr = executionAsyncResource(); + * if (cr) { + * resource[sym] = cr[sym]; + * } + * } + * }).enable(); + * + * const server = createServer((req, res) => { + * executionAsyncResource()[sym] = { state: req.url }; + * setTimeout(function() { + * res.end(JSON.stringify(executionAsyncResource()[sym])); + * }, 100); + * }).listen(3000); + * ``` + * @since v13.9.0, v12.17.0 + * @return The resource representing the current execution. Useful to store data within the resource. + */ + function executionAsyncResource(): object; + /** + * ```js + * const server = net.createServer((conn) => { + * // The resource that caused (or triggered) this callback to be called + * // was that of the new connection. Thus the return value of triggerAsyncId() + * // is the asyncId of "conn". + * async_hooks.triggerAsyncId(); + * + * }).listen(port, () => { + * // Even though all callbacks passed to .listen() are wrapped in a nextTick() + * // the callback itself exists because the call to the server's .listen() + * // was made. So the return value would be the ID of the server. + * async_hooks.triggerAsyncId(); + * }); + * ``` + * + * Promise contexts may not get valid `triggerAsyncId`s by default. See + * the section on `promise execution tracking`. + * @return The ID of the resource responsible for calling the callback that is currently being executed. + */ + function triggerAsyncId(): number; + interface HookCallbacks { + /** + * Called when a class is constructed that has the possibility to emit an asynchronous event. + * @param asyncId a unique ID for the async resource + * @param type the type of the async resource + * @param triggerAsyncId the unique ID of the async resource in whose execution context this async resource was created + * @param resource reference to the resource representing the async operation, needs to be released during destroy + */ + init?(asyncId: number, type: string, triggerAsyncId: number, resource: object): void; + /** + * When an asynchronous operation is initiated or completes a callback is called to notify the user. + * The before callback is called just before said callback is executed. + * @param asyncId the unique identifier assigned to the resource about to execute the callback. + */ + before?(asyncId: number): void; + /** + * Called immediately after the callback specified in before is completed. + * @param asyncId the unique identifier assigned to the resource which has executed the callback. + */ + after?(asyncId: number): void; + /** + * Called when a promise has resolve() called. This may not be in the same execution id + * as the promise itself. + * @param asyncId the unique id for the promise that was resolve()d. + */ + promiseResolve?(asyncId: number): void; + /** + * Called after the resource corresponding to asyncId is destroyed + * @param asyncId a unique ID for the async resource + */ + destroy?(asyncId: number): void; + } + interface AsyncHook { + /** + * Enable the callbacks for a given AsyncHook instance. If no callbacks are provided enabling is a noop. + */ + enable(): this; + /** + * Disable the callbacks for a given AsyncHook instance from the global pool of AsyncHook callbacks to be executed. Once a hook has been disabled it will not be called again until enabled. + */ + disable(): this; + } + /** + * Registers functions to be called for different lifetime events of each async + * operation. + * + * The callbacks `init()`/`before()`/`after()`/`destroy()` are called for the + * respective asynchronous event during a resource's lifetime. + * + * All callbacks are optional. For example, if only resource cleanup needs to + * be tracked, then only the `destroy` callback needs to be passed. The + * specifics of all functions that can be passed to `callbacks` is in the `Hook Callbacks` section. + * + * ```js + * import { createHook } from 'async_hooks'; + * + * const asyncHook = createHook({ + * init(asyncId, type, triggerAsyncId, resource) { }, + * destroy(asyncId) { } + * }); + * ``` + * + * The callbacks will be inherited via the prototype chain: + * + * ```js + * class MyAsyncCallbacks { + * init(asyncId, type, triggerAsyncId, resource) { } + * destroy(asyncId) {} + * } + * + * class MyAddedCallbacks extends MyAsyncCallbacks { + * before(asyncId) { } + * after(asyncId) { } + * } + * + * const asyncHook = async_hooks.createHook(new MyAddedCallbacks()); + * ``` + * + * Because promises are asynchronous resources whose lifecycle is tracked + * via the async hooks mechanism, the `init()`, `before()`, `after()`, and`destroy()` callbacks _must not_ be async functions that return promises. + * @since v8.1.0 + * @param callbacks The `Hook Callbacks` to register + * @return Instance used for disabling and enabling hooks + */ + function createHook(callbacks: HookCallbacks): AsyncHook; + interface AsyncResourceOptions { + /** + * The ID of the execution context that created this async event. + * @default executionAsyncId() + */ + triggerAsyncId?: number | undefined; + /** + * Disables automatic `emitDestroy` when the object is garbage collected. + * This usually does not need to be set (even if `emitDestroy` is called + * manually), unless the resource's `asyncId` is retrieved and the + * sensitive API's `emitDestroy` is called with it. + * @default false + */ + requireManualDestroy?: boolean | undefined; + } + /** + * The class `AsyncResource` is designed to be extended by the embedder's async + * resources. Using this, users can easily trigger the lifetime events of their + * own resources. + * + * The `init` hook will trigger when an `AsyncResource` is instantiated. + * + * The following is an overview of the `AsyncResource` API. + * + * ```js + * import { AsyncResource, executionAsyncId } from 'async_hooks'; + * + * // AsyncResource() is meant to be extended. Instantiating a + * // new AsyncResource() also triggers init. If triggerAsyncId is omitted then + * // async_hook.executionAsyncId() is used. + * const asyncResource = new AsyncResource( + * type, { triggerAsyncId: executionAsyncId(), requireManualDestroy: false } + * ); + * + * // Run a function in the execution context of the resource. This will + * // * establish the context of the resource + * // * trigger the AsyncHooks before callbacks + * // * call the provided function `fn` with the supplied arguments + * // * trigger the AsyncHooks after callbacks + * // * restore the original execution context + * asyncResource.runInAsyncScope(fn, thisArg, ...args); + * + * // Call AsyncHooks destroy callbacks. + * asyncResource.emitDestroy(); + * + * // Return the unique ID assigned to the AsyncResource instance. + * asyncResource.asyncId(); + * + * // Return the trigger ID for the AsyncResource instance. + * asyncResource.triggerAsyncId(); + * ``` + */ + class AsyncResource { + /** + * AsyncResource() is meant to be extended. Instantiating a + * new AsyncResource() also triggers init. If triggerAsyncId is omitted then + * async_hook.executionAsyncId() is used. + * @param type The type of async event. + * @param triggerAsyncId The ID of the execution context that created + * this async event (default: `executionAsyncId()`), or an + * AsyncResourceOptions object (since 9.3) + */ + constructor(type: string, triggerAsyncId?: number | AsyncResourceOptions); + /** + * Binds the given function to the current execution context. + * + * The returned function will have an `asyncResource` property referencing + * the `AsyncResource` to which the function is bound. + * @since v14.8.0, v12.19.0 + * @param fn The function to bind to the current execution context. + * @param type An optional name to associate with the underlying `AsyncResource`. + */ + static bind any, ThisArg>( + fn: Func, + type?: string, + thisArg?: ThisArg + ): Func & { + asyncResource: AsyncResource; + }; + /** + * Binds the given function to execute to this `AsyncResource`'s scope. + * + * The returned function will have an `asyncResource` property referencing + * the `AsyncResource` to which the function is bound. + * @since v14.8.0, v12.19.0 + * @param fn The function to bind to the current `AsyncResource`. + */ + bind any>( + fn: Func + ): Func & { + asyncResource: AsyncResource; + }; + /** + * Call the provided function with the provided arguments in the execution context + * of the async resource. This will establish the context, trigger the AsyncHooks + * before callbacks, call the function, trigger the AsyncHooks after callbacks, and + * then restore the original execution context. + * @since v9.6.0 + * @param fn The function to call in the execution context of this async resource. + * @param thisArg The receiver to be used for the function call. + * @param args Optional arguments to pass to the function. + */ + runInAsyncScope(fn: (this: This, ...args: any[]) => Result, thisArg?: This, ...args: any[]): Result; + /** + * Call all `destroy` hooks. This should only ever be called once. An error will + * be thrown if it is called more than once. This **must** be manually called. If + * the resource is left to be collected by the GC then the `destroy` hooks will + * never be called. + * @return A reference to `asyncResource`. + */ + emitDestroy(): this; + /** + * @return The unique `asyncId` assigned to the resource. + */ + asyncId(): number; + /** + * + * @return The same `triggerAsyncId` that is passed to the `AsyncResource` constructor. + */ + triggerAsyncId(): number; + } + /** + * This class creates stores that stay coherent through asynchronous operations. + * + * While you can create your own implementation on top of the `async_hooks` module,`AsyncLocalStorage` should be preferred as it is a performant and memory safe + * implementation that involves significant optimizations that are non-obvious to + * implement. + * + * The following example uses `AsyncLocalStorage` to build a simple logger + * that assigns IDs to incoming HTTP requests and includes them in messages + * logged within each request. + * + * ```js + * import http from 'http'; + * import { AsyncLocalStorage } from 'async_hooks'; + * + * const asyncLocalStorage = new AsyncLocalStorage(); + * + * function logWithId(msg) { + * const id = asyncLocalStorage.getStore(); + * console.log(`${id !== undefined ? id : '-'}:`, msg); + * } + * + * let idSeq = 0; + * http.createServer((req, res) => { + * asyncLocalStorage.run(idSeq++, () => { + * logWithId('start'); + * // Imagine any chain of async operations here + * setImmediate(() => { + * logWithId('finish'); + * res.end(); + * }); + * }); + * }).listen(8080); + * + * http.get('http://localhost:8080'); + * http.get('http://localhost:8080'); + * // Prints: + * // 0: start + * // 1: start + * // 0: finish + * // 1: finish + * ``` + * + * Each instance of `AsyncLocalStorage` maintains an independent storage context. + * Multiple instances can safely exist simultaneously without risk of interfering + * with each other data. + * @since v13.10.0, v12.17.0 + */ + class AsyncLocalStorage { + /** + * Disables the instance of `AsyncLocalStorage`. All subsequent calls + * to `asyncLocalStorage.getStore()` will return `undefined` until`asyncLocalStorage.run()` or `asyncLocalStorage.enterWith()` is called again. + * + * When calling `asyncLocalStorage.disable()`, all current contexts linked to the + * instance will be exited. + * + * Calling `asyncLocalStorage.disable()` is required before the`asyncLocalStorage` can be garbage collected. This does not apply to stores + * provided by the `asyncLocalStorage`, as those objects are garbage collected + * along with the corresponding async resources. + * + * Use this method when the `asyncLocalStorage` is not in use anymore + * in the current process. + * @since v13.10.0, v12.17.0 + * @experimental + */ + disable(): void; + /** + * Returns the current store. + * If called outside of an asynchronous context initialized by + * calling `asyncLocalStorage.run()` or `asyncLocalStorage.enterWith()`, it + * returns `undefined`. + * @since v13.10.0, v12.17.0 + */ + getStore(): T | undefined; + /** + * Runs a function synchronously within a context and returns its + * return value. The store is not accessible outside of the callback function or + * the asynchronous operations created within the callback. + * + * The optional `args` are passed to the callback function. + * + * If the callback function throws an error, the error is thrown by `run()` too. + * The stacktrace is not impacted by this call and the context is exited. + * + * Example: + * + * ```js + * const store = { id: 2 }; + * try { + * asyncLocalStorage.run(store, () => { + * asyncLocalStorage.getStore(); // Returns the store object + * throw new Error(); + * }); + * } catch (e) { + * asyncLocalStorage.getStore(); // Returns undefined + * // The error will be caught here + * } + * ``` + * @since v13.10.0, v12.17.0 + */ + run(store: T, callback: (...args: TArgs) => R, ...args: TArgs): R; + /** + * Runs a function synchronously outside of a context and returns its + * return value. The store is not accessible within the callback function or + * the asynchronous operations created within the callback. Any `getStore()`call done within the callback function will always return `undefined`. + * + * The optional `args` are passed to the callback function. + * + * If the callback function throws an error, the error is thrown by `exit()` too. + * The stacktrace is not impacted by this call and the context is re-entered. + * + * Example: + * + * ```js + * // Within a call to run + * try { + * asyncLocalStorage.getStore(); // Returns the store object or value + * asyncLocalStorage.exit(() => { + * asyncLocalStorage.getStore(); // Returns undefined + * throw new Error(); + * }); + * } catch (e) { + * asyncLocalStorage.getStore(); // Returns the same object or value + * // The error will be caught here + * } + * ``` + * @since v13.10.0, v12.17.0 + * @experimental + */ + exit(callback: (...args: TArgs) => R, ...args: TArgs): R; + /** + * Transitions into the context for the remainder of the current + * synchronous execution and then persists the store through any following + * asynchronous calls. + * + * Example: + * + * ```js + * const store = { id: 1 }; + * // Replaces previous store with the given store object + * asyncLocalStorage.enterWith(store); + * asyncLocalStorage.getStore(); // Returns the store object + * someAsyncOperation(() => { + * asyncLocalStorage.getStore(); // Returns the same object + * }); + * ``` + * + * This transition will continue for the _entire_ synchronous execution. + * This means that if, for example, the context is entered within an event + * handler subsequent event handlers will also run within that context unless + * specifically bound to another context with an `AsyncResource`. That is why`run()` should be preferred over `enterWith()` unless there are strong reasons + * to use the latter method. + * + * ```js + * const store = { id: 1 }; + * + * emitter.on('my-event', () => { + * asyncLocalStorage.enterWith(store); + * }); + * emitter.on('my-event', () => { + * asyncLocalStorage.getStore(); // Returns the same object + * }); + * + * asyncLocalStorage.getStore(); // Returns undefined + * emitter.emit('my-event'); + * asyncLocalStorage.getStore(); // Returns the same object + * ``` + * @since v13.11.0, v12.17.0 + * @experimental + */ + enterWith(store: T): void; + } +} +declare module 'node:async_hooks' { + export * from 'async_hooks'; +} diff --git a/node_modules/@types/node/buffer.d.ts b/node_modules/@types/node/buffer.d.ts new file mode 100755 index 00000000..cfcd33e0 --- /dev/null +++ b/node_modules/@types/node/buffer.d.ts @@ -0,0 +1,2142 @@ +/** + * `Buffer` objects are used to represent a fixed-length sequence of bytes. Many + * Node.js APIs support `Buffer`s. + * + * The `Buffer` class is a subclass of JavaScript's [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) class and + * extends it with methods that cover additional use cases. Node.js APIs accept + * plain [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) s wherever `Buffer`s are supported as well. + * + * While the `Buffer` class is available within the global scope, it is still + * recommended to explicitly reference it via an import or require statement. + * + * ```js + * import { Buffer } from 'buffer'; + * + * // Creates a zero-filled Buffer of length 10. + * const buf1 = Buffer.alloc(10); + * + * // Creates a Buffer of length 10, + * // filled with bytes which all have the value `1`. + * const buf2 = Buffer.alloc(10, 1); + * + * // Creates an uninitialized buffer of length 10. + * // This is faster than calling Buffer.alloc() but the returned + * // Buffer instance might contain old data that needs to be + * // overwritten using fill(), write(), or other functions that fill the Buffer's + * // contents. + * const buf3 = Buffer.allocUnsafe(10); + * + * // Creates a Buffer containing the bytes [1, 2, 3]. + * const buf4 = Buffer.from([1, 2, 3]); + * + * // Creates a Buffer containing the bytes [1, 1, 1, 1] – the entries + * // are all truncated using `(value & 255)` to fit into the range 0–255. + * const buf5 = Buffer.from([257, 257.5, -255, '1']); + * + * // Creates a Buffer containing the UTF-8-encoded bytes for the string 'tést': + * // [0x74, 0xc3, 0xa9, 0x73, 0x74] (in hexadecimal notation) + * // [116, 195, 169, 115, 116] (in decimal notation) + * const buf6 = Buffer.from('tést'); + * + * // Creates a Buffer containing the Latin-1 bytes [0x74, 0xe9, 0x73, 0x74]. + * const buf7 = Buffer.from('tést', 'latin1'); + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/buffer.js) + */ +declare module 'buffer' { + import { BinaryLike } from 'node:crypto'; + export const INSPECT_MAX_BYTES: number; + export const kMaxLength: number; + export const kStringMaxLength: number; + export const constants: { + MAX_LENGTH: number; + MAX_STRING_LENGTH: number; + }; + export type TranscodeEncoding = 'ascii' | 'utf8' | 'utf16le' | 'ucs2' | 'latin1' | 'binary'; + /** + * Re-encodes the given `Buffer` or `Uint8Array` instance from one character + * encoding to another. Returns a new `Buffer` instance. + * + * Throws if the `fromEnc` or `toEnc` specify invalid character encodings or if + * conversion from `fromEnc` to `toEnc` is not permitted. + * + * Encodings supported by `buffer.transcode()` are: `'ascii'`, `'utf8'`,`'utf16le'`, `'ucs2'`, `'latin1'`, and `'binary'`. + * + * The transcoding process will use substitution characters if a given byte + * sequence cannot be adequately represented in the target encoding. For instance: + * + * ```js + * import { Buffer, transcode } from 'buffer'; + * + * const newBuf = transcode(Buffer.from('€'), 'utf8', 'ascii'); + * console.log(newBuf.toString('ascii')); + * // Prints: '?' + * ``` + * + * Because the Euro (`€`) sign is not representable in US-ASCII, it is replaced + * with `?` in the transcoded `Buffer`. + * @since v7.1.0 + * @param source A `Buffer` or `Uint8Array` instance. + * @param fromEnc The current encoding. + * @param toEnc To target encoding. + */ + export function transcode(source: Uint8Array, fromEnc: TranscodeEncoding, toEnc: TranscodeEncoding): Buffer; + export const SlowBuffer: { + /** @deprecated since v6.0.0, use `Buffer.allocUnsafeSlow()` */ + new (size: number): Buffer; + prototype: Buffer; + }; + /** + * Resolves a `'blob:nodedata:...'` an associated `Blob` object registered using + * a prior call to `URL.createObjectURL()`. + * @since v16.7.0 + * @experimental + * @param id A `'blob:nodedata:...` URL string returned by a prior call to `URL.createObjectURL()`. + */ + export function resolveObjectURL(id: string): Blob | undefined; + export { Buffer }; + /** + * @experimental + */ + export interface BlobOptions { + /** + * @default 'utf8' + */ + encoding?: BufferEncoding | undefined; + /** + * The Blob content-type. The intent is for `type` to convey + * the MIME media type of the data, however no validation of the type format + * is performed. + */ + type?: string | undefined; + } + /** + * A [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) encapsulates immutable, raw data that can be safely shared across + * multiple worker threads. + * @since v15.7.0 + * @experimental + */ + export class Blob { + /** + * The total size of the `Blob` in bytes. + * @since v15.7.0 + */ + readonly size: number; + /** + * The content-type of the `Blob`. + * @since v15.7.0 + */ + readonly type: string; + /** + * Creates a new `Blob` object containing a concatenation of the given sources. + * + * {ArrayBuffer}, {TypedArray}, {DataView}, and {Buffer} sources are copied into + * the 'Blob' and can therefore be safely modified after the 'Blob' is created. + * + * String sources are also copied into the `Blob`. + */ + constructor(sources: Array, options?: BlobOptions); + /** + * Returns a promise that fulfills with an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) containing a copy of + * the `Blob` data. + * @since v15.7.0 + */ + arrayBuffer(): Promise; + /** + * Creates and returns a new `Blob` containing a subset of this `Blob` objects + * data. The original `Blob` is not altered. + * @since v15.7.0 + * @param start The starting index. + * @param end The ending index. + * @param type The content-type for the new `Blob` + */ + slice(start?: number, end?: number, type?: string): Blob; + /** + * Returns a promise that fulfills with the contents of the `Blob` decoded as a + * UTF-8 string. + * @since v15.7.0 + */ + text(): Promise; + /** + * Returns a new `ReadableStream` that allows the content of the `Blob` to be read. + * @since v16.7.0 + */ + stream(): unknown; // pending web streams types + } + export import atob = globalThis.atob; + export import btoa = globalThis.btoa; + global { + // Buffer class + type BufferEncoding = 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex'; + type WithImplicitCoercion = + | T + | { + valueOf(): T; + }; + /** + * Raw data is stored in instances of the Buffer class. + * A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. + * Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex' + */ + interface BufferConstructor { + /** + * Allocates a new buffer containing the given {str}. + * + * @param str String to store in buffer. + * @param encoding encoding to use, optional. Default is 'utf8' + * @deprecated since v10.0.0 - Use `Buffer.from(string[, encoding])` instead. + */ + new (str: string, encoding?: BufferEncoding): Buffer; + /** + * Allocates a new buffer of {size} octets. + * + * @param size count of octets to allocate. + * @deprecated since v10.0.0 - Use `Buffer.alloc()` instead (also see `Buffer.allocUnsafe()`). + */ + new (size: number): Buffer; + /** + * Allocates a new buffer containing the given {array} of octets. + * + * @param array The octets to store. + * @deprecated since v10.0.0 - Use `Buffer.from(array)` instead. + */ + new (array: Uint8Array): Buffer; + /** + * Produces a Buffer backed by the same allocated memory as + * the given {ArrayBuffer}/{SharedArrayBuffer}. + * + * + * @param arrayBuffer The ArrayBuffer with which to share memory. + * @deprecated since v10.0.0 - Use `Buffer.from(arrayBuffer[, byteOffset[, length]])` instead. + */ + new (arrayBuffer: ArrayBuffer | SharedArrayBuffer): Buffer; + /** + * Allocates a new buffer containing the given {array} of octets. + * + * @param array The octets to store. + * @deprecated since v10.0.0 - Use `Buffer.from(array)` instead. + */ + new (array: ReadonlyArray): Buffer; + /** + * Copies the passed {buffer} data onto a new {Buffer} instance. + * + * @param buffer The buffer to copy. + * @deprecated since v10.0.0 - Use `Buffer.from(buffer)` instead. + */ + new (buffer: Buffer): Buffer; + /** + * Allocates a new `Buffer` using an `array` of bytes in the range `0` – `255`. + * Array entries outside that range will be truncated to fit into it. + * + * ```js + * import { Buffer } from 'buffer'; + * + * // Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'. + * const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]); + * ``` + * + * A `TypeError` will be thrown if `array` is not an `Array` or another type + * appropriate for `Buffer.from()` variants. + * + * `Buffer.from(array)` and `Buffer.from(string)` may also use the internal`Buffer` pool like `Buffer.allocUnsafe()` does. + * @since v5.10.0 + */ + from(arrayBuffer: WithImplicitCoercion, byteOffset?: number, length?: number): Buffer; + /** + * Creates a new Buffer using the passed {data} + * @param data data to create a new Buffer + */ + from(data: Uint8Array | ReadonlyArray): Buffer; + from(data: WithImplicitCoercion | string>): Buffer; + /** + * Creates a new Buffer containing the given JavaScript string {str}. + * If provided, the {encoding} parameter identifies the character encoding. + * If not provided, {encoding} defaults to 'utf8'. + */ + from( + str: + | WithImplicitCoercion + | { + [Symbol.toPrimitive](hint: 'string'): string; + }, + encoding?: BufferEncoding + ): Buffer; + /** + * Creates a new Buffer using the passed {data} + * @param values to create a new Buffer + */ + of(...items: number[]): Buffer; + /** + * Returns `true` if `obj` is a `Buffer`, `false` otherwise. + * + * ```js + * import { Buffer } from 'buffer'; + * + * Buffer.isBuffer(Buffer.alloc(10)); // true + * Buffer.isBuffer(Buffer.from('foo')); // true + * Buffer.isBuffer('a string'); // false + * Buffer.isBuffer([]); // false + * Buffer.isBuffer(new Uint8Array(1024)); // false + * ``` + * @since v0.1.101 + */ + isBuffer(obj: any): obj is Buffer; + /** + * Returns `true` if `encoding` is the name of a supported character encoding, + * or `false` otherwise. + * + * ```js + * import { Buffer } from 'buffer'; + * + * console.log(Buffer.isEncoding('utf8')); + * // Prints: true + * + * console.log(Buffer.isEncoding('hex')); + * // Prints: true + * + * console.log(Buffer.isEncoding('utf/8')); + * // Prints: false + * + * console.log(Buffer.isEncoding('')); + * // Prints: false + * ``` + * @since v0.9.1 + * @param encoding A character encoding name to check. + */ + isEncoding(encoding: string): encoding is BufferEncoding; + /** + * Returns the byte length of a string when encoded using `encoding`. + * This is not the same as [`String.prototype.length`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length), which does not account + * for the encoding that is used to convert the string into bytes. + * + * For `'base64'`, `'base64url'`, and `'hex'`, this function assumes valid input. + * For strings that contain non-base64/hex-encoded data (e.g. whitespace), the + * return value might be greater than the length of a `Buffer` created from the + * string. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const str = '\u00bd + \u00bc = \u00be'; + * + * console.log(`${str}: ${str.length} characters, ` + + * `${Buffer.byteLength(str, 'utf8')} bytes`); + * // Prints: ½ + ¼ = ¾: 9 characters, 12 bytes + * ``` + * + * When `string` is a + * `Buffer`/[`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView)/[`TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/- + * Reference/Global_Objects/TypedArray)/[`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)/[`SharedArrayBuffer`](https://develop- + * er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer), the byte length as reported by `.byteLength`is returned. + * @since v0.1.90 + * @param string A value to calculate the length of. + * @param [encoding='utf8'] If `string` is a string, this is its encoding. + * @return The number of bytes contained within `string`. + */ + byteLength(string: string | NodeJS.ArrayBufferView | ArrayBuffer | SharedArrayBuffer, encoding?: BufferEncoding): number; + /** + * Returns a new `Buffer` which is the result of concatenating all the `Buffer`instances in the `list` together. + * + * If the list has no items, or if the `totalLength` is 0, then a new zero-length`Buffer` is returned. + * + * If `totalLength` is not provided, it is calculated from the `Buffer` instances + * in `list` by adding their lengths. + * + * If `totalLength` is provided, it is coerced to an unsigned integer. If the + * combined length of the `Buffer`s in `list` exceeds `totalLength`, the result is + * truncated to `totalLength`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * // Create a single `Buffer` from a list of three `Buffer` instances. + * + * const buf1 = Buffer.alloc(10); + * const buf2 = Buffer.alloc(14); + * const buf3 = Buffer.alloc(18); + * const totalLength = buf1.length + buf2.length + buf3.length; + * + * console.log(totalLength); + * // Prints: 42 + * + * const bufA = Buffer.concat([buf1, buf2, buf3], totalLength); + * + * console.log(bufA); + * // Prints: + * console.log(bufA.length); + * // Prints: 42 + * ``` + * + * `Buffer.concat()` may also use the internal `Buffer` pool like `Buffer.allocUnsafe()` does. + * @since v0.7.11 + * @param list List of `Buffer` or {@link Uint8Array} instances to concatenate. + * @param totalLength Total length of the `Buffer` instances in `list` when concatenated. + */ + concat(list: ReadonlyArray, totalLength?: number): Buffer; + /** + * Compares `buf1` to `buf2`, typically for the purpose of sorting arrays of`Buffer` instances. This is equivalent to calling `buf1.compare(buf2)`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf1 = Buffer.from('1234'); + * const buf2 = Buffer.from('0123'); + * const arr = [buf1, buf2]; + * + * console.log(arr.sort(Buffer.compare)); + * // Prints: [ , ] + * // (This result is equal to: [buf2, buf1].) + * ``` + * @since v0.11.13 + * @return Either `-1`, `0`, or `1`, depending on the result of the comparison. See `compare` for details. + */ + compare(buf1: Uint8Array, buf2: Uint8Array): number; + /** + * Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the`Buffer` will be zero-filled. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.alloc(5); + * + * console.log(buf); + * // Prints: + * ``` + * + * If `size` is larger than {@link constants.MAX_LENGTH} or smaller than 0, `ERR_INVALID_ARG_VALUE` is thrown. + * + * If `fill` is specified, the allocated `Buffer` will be initialized by calling `buf.fill(fill)`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.alloc(5, 'a'); + * + * console.log(buf); + * // Prints: + * ``` + * + * If both `fill` and `encoding` are specified, the allocated `Buffer` will be + * initialized by calling `buf.fill(fill, encoding)`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64'); + * + * console.log(buf); + * // Prints: + * ``` + * + * Calling `Buffer.alloc()` can be measurably slower than the alternative `Buffer.allocUnsafe()` but ensures that the newly created `Buffer` instance + * contents will never contain sensitive data from previous allocations, including + * data that might not have been allocated for `Buffer`s. + * + * A `TypeError` will be thrown if `size` is not a number. + * @since v5.10.0 + * @param size The desired length of the new `Buffer`. + * @param [fill=0] A value to pre-fill the new `Buffer` with. + * @param [encoding='utf8'] If `fill` is a string, this is its encoding. + */ + alloc(size: number, fill?: string | Buffer | number, encoding?: BufferEncoding): Buffer; + /** + * Allocates a new `Buffer` of `size` bytes. If `size` is larger than {@link constants.MAX_LENGTH} or smaller than 0, `ERR_INVALID_ARG_VALUE` is thrown. + * + * The underlying memory for `Buffer` instances created in this way is _not_ + * _initialized_. The contents of the newly created `Buffer` are unknown and_may contain sensitive data_. Use `Buffer.alloc()` instead to initialize`Buffer` instances with zeroes. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(10); + * + * console.log(buf); + * // Prints (contents may vary): + * + * buf.fill(0); + * + * console.log(buf); + * // Prints: + * ``` + * + * A `TypeError` will be thrown if `size` is not a number. + * + * The `Buffer` module pre-allocates an internal `Buffer` instance of + * size `Buffer.poolSize` that is used as a pool for the fast allocation of new`Buffer` instances created using `Buffer.allocUnsafe()`,`Buffer.from(array)`, `Buffer.concat()`, and the + * deprecated`new Buffer(size)` constructor only when `size` is less than or equal + * to `Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two). + * + * Use of this pre-allocated internal memory pool is a key difference between + * calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`. + * Specifically, `Buffer.alloc(size, fill)` will _never_ use the internal `Buffer`pool, while `Buffer.allocUnsafe(size).fill(fill)`_will_ use the internal`Buffer` pool if `size` is less + * than or equal to half `Buffer.poolSize`. The + * difference is subtle but can be important when an application requires the + * additional performance that `Buffer.allocUnsafe()` provides. + * @since v5.10.0 + * @param size The desired length of the new `Buffer`. + */ + allocUnsafe(size: number): Buffer; + /** + * Allocates a new `Buffer` of `size` bytes. If `size` is larger than {@link constants.MAX_LENGTH} or smaller than 0, `ERR_INVALID_ARG_VALUE` is thrown. A zero-length `Buffer` is created + * if `size` is 0. + * + * The underlying memory for `Buffer` instances created in this way is _not_ + * _initialized_. The contents of the newly created `Buffer` are unknown and_may contain sensitive data_. Use `buf.fill(0)` to initialize + * such `Buffer` instances with zeroes. + * + * When using `Buffer.allocUnsafe()` to allocate new `Buffer` instances, + * allocations under 4 KB are sliced from a single pre-allocated `Buffer`. This + * allows applications to avoid the garbage collection overhead of creating many + * individually allocated `Buffer` instances. This approach improves both + * performance and memory usage by eliminating the need to track and clean up as + * many individual `ArrayBuffer` objects. + * + * However, in the case where a developer may need to retain a small chunk of + * memory from a pool for an indeterminate amount of time, it may be appropriate + * to create an un-pooled `Buffer` instance using `Buffer.allocUnsafeSlow()` and + * then copying out the relevant bits. + * + * ```js + * import { Buffer } from 'buffer'; + * + * // Need to keep around a few small chunks of memory. + * const store = []; + * + * socket.on('readable', () => { + * let data; + * while (null !== (data = readable.read())) { + * // Allocate for retained data. + * const sb = Buffer.allocUnsafeSlow(10); + * + * // Copy the data into the new allocation. + * data.copy(sb, 0, 0, 10); + * + * store.push(sb); + * } + * }); + * ``` + * + * A `TypeError` will be thrown if `size` is not a number. + * @since v5.12.0 + * @param size The desired length of the new `Buffer`. + */ + allocUnsafeSlow(size: number): Buffer; + /** + * This is the size (in bytes) of pre-allocated internal `Buffer` instances used + * for pooling. This value may be modified. + * @since v0.11.3 + */ + poolSize: number; + } + interface Buffer extends Uint8Array { + /** + * Writes `string` to `buf` at `offset` according to the character encoding in`encoding`. The `length` parameter is the number of bytes to write. If `buf` did + * not contain enough space to fit the entire string, only part of `string` will be + * written. However, partially encoded characters will not be written. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.alloc(256); + * + * const len = buf.write('\u00bd + \u00bc = \u00be', 0); + * + * console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`); + * // Prints: 12 bytes: ½ + ¼ = ¾ + * + * const buffer = Buffer.alloc(10); + * + * const length = buffer.write('abcd', 8); + * + * console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`); + * // Prints: 2 bytes : ab + * ``` + * @since v0.1.90 + * @param string String to write to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write `string`. + * @param [length=buf.length - offset] Maximum number of bytes to write (written bytes will not exceed `buf.length - offset`). + * @param [encoding='utf8'] The character encoding of `string`. + * @return Number of bytes written. + */ + write(string: string, encoding?: BufferEncoding): number; + write(string: string, offset: number, encoding?: BufferEncoding): number; + write(string: string, offset: number, length: number, encoding?: BufferEncoding): number; + /** + * Decodes `buf` to a string according to the specified character encoding in`encoding`. `start` and `end` may be passed to decode only a subset of `buf`. + * + * If `encoding` is `'utf8'` and a byte sequence in the input is not valid UTF-8, + * then each invalid byte is replaced with the replacement character `U+FFFD`. + * + * The maximum length of a string instance (in UTF-16 code units) is available + * as {@link constants.MAX_STRING_LENGTH}. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf1 = Buffer.allocUnsafe(26); + * + * for (let i = 0; i < 26; i++) { + * // 97 is the decimal ASCII value for 'a'. + * buf1[i] = i + 97; + * } + * + * console.log(buf1.toString('utf8')); + * // Prints: abcdefghijklmnopqrstuvwxyz + * console.log(buf1.toString('utf8', 0, 5)); + * // Prints: abcde + * + * const buf2 = Buffer.from('tést'); + * + * console.log(buf2.toString('hex')); + * // Prints: 74c3a97374 + * console.log(buf2.toString('utf8', 0, 3)); + * // Prints: té + * console.log(buf2.toString(undefined, 0, 3)); + * // Prints: té + * ``` + * @since v0.1.90 + * @param [encoding='utf8'] The character encoding to use. + * @param [start=0] The byte offset to start decoding at. + * @param [end=buf.length] The byte offset to stop decoding at (not inclusive). + */ + toString(encoding?: BufferEncoding, start?: number, end?: number): string; + /** + * Returns a JSON representation of `buf`. [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) implicitly calls + * this function when stringifying a `Buffer` instance. + * + * `Buffer.from()` accepts objects in the format returned from this method. + * In particular, `Buffer.from(buf.toJSON())` works like `Buffer.from(buf)`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]); + * const json = JSON.stringify(buf); + * + * console.log(json); + * // Prints: {"type":"Buffer","data":[1,2,3,4,5]} + * + * const copy = JSON.parse(json, (key, value) => { + * return value && value.type === 'Buffer' ? + * Buffer.from(value) : + * value; + * }); + * + * console.log(copy); + * // Prints: + * ``` + * @since v0.9.2 + */ + toJSON(): { + type: 'Buffer'; + data: number[]; + }; + /** + * Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes,`false` otherwise. Equivalent to `buf.compare(otherBuffer) === 0`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf1 = Buffer.from('ABC'); + * const buf2 = Buffer.from('414243', 'hex'); + * const buf3 = Buffer.from('ABCD'); + * + * console.log(buf1.equals(buf2)); + * // Prints: true + * console.log(buf1.equals(buf3)); + * // Prints: false + * ``` + * @since v0.11.13 + * @param otherBuffer A `Buffer` or {@link Uint8Array} with which to compare `buf`. + */ + equals(otherBuffer: Uint8Array): boolean; + /** + * Compares `buf` with `target` and returns a number indicating whether `buf`comes before, after, or is the same as `target` in sort order. + * Comparison is based on the actual sequence of bytes in each `Buffer`. + * + * * `0` is returned if `target` is the same as `buf` + * * `1` is returned if `target` should come _before_`buf` when sorted. + * * `-1` is returned if `target` should come _after_`buf` when sorted. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf1 = Buffer.from('ABC'); + * const buf2 = Buffer.from('BCD'); + * const buf3 = Buffer.from('ABCD'); + * + * console.log(buf1.compare(buf1)); + * // Prints: 0 + * console.log(buf1.compare(buf2)); + * // Prints: -1 + * console.log(buf1.compare(buf3)); + * // Prints: -1 + * console.log(buf2.compare(buf1)); + * // Prints: 1 + * console.log(buf2.compare(buf3)); + * // Prints: 1 + * console.log([buf1, buf2, buf3].sort(Buffer.compare)); + * // Prints: [ , , ] + * // (This result is equal to: [buf1, buf3, buf2].) + * ``` + * + * The optional `targetStart`, `targetEnd`, `sourceStart`, and `sourceEnd`arguments can be used to limit the comparison to specific ranges within `target`and `buf` respectively. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]); + * const buf2 = Buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]); + * + * console.log(buf1.compare(buf2, 5, 9, 0, 4)); + * // Prints: 0 + * console.log(buf1.compare(buf2, 0, 6, 4)); + * // Prints: -1 + * console.log(buf1.compare(buf2, 5, 6, 5)); + * // Prints: 1 + * ``` + * + * `ERR_OUT_OF_RANGE` is thrown if `targetStart < 0`, `sourceStart < 0`,`targetEnd > target.byteLength`, or `sourceEnd > source.byteLength`. + * @since v0.11.13 + * @param target A `Buffer` or {@link Uint8Array} with which to compare `buf`. + * @param [targetStart=0] The offset within `target` at which to begin comparison. + * @param [targetEnd=target.length] The offset within `target` at which to end comparison (not inclusive). + * @param [sourceStart=0] The offset within `buf` at which to begin comparison. + * @param [sourceEnd=buf.length] The offset within `buf` at which to end comparison (not inclusive). + */ + compare(target: Uint8Array, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number; + /** + * Copies data from a region of `buf` to a region in `target`, even if the `target`memory region overlaps with `buf`. + * + * [`TypedArray.prototype.set()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/set) performs the same operation, and is available + * for all TypedArrays, including Node.js `Buffer`s, although it takes + * different function arguments. + * + * ```js + * import { Buffer } from 'buffer'; + * + * // Create two `Buffer` instances. + * const buf1 = Buffer.allocUnsafe(26); + * const buf2 = Buffer.allocUnsafe(26).fill('!'); + * + * for (let i = 0; i < 26; i++) { + * // 97 is the decimal ASCII value for 'a'. + * buf1[i] = i + 97; + * } + * + * // Copy `buf1` bytes 16 through 19 into `buf2` starting at byte 8 of `buf2`. + * buf1.copy(buf2, 8, 16, 20); + * // This is equivalent to: + * // buf2.set(buf1.subarray(16, 20), 8); + * + * console.log(buf2.toString('ascii', 0, 25)); + * // Prints: !!!!!!!!qrst!!!!!!!!!!!!! + * ``` + * + * ```js + * import { Buffer } from 'buffer'; + * + * // Create a `Buffer` and copy data from one region to an overlapping region + * // within the same `Buffer`. + * + * const buf = Buffer.allocUnsafe(26); + * + * for (let i = 0; i < 26; i++) { + * // 97 is the decimal ASCII value for 'a'. + * buf[i] = i + 97; + * } + * + * buf.copy(buf, 0, 4, 10); + * + * console.log(buf.toString()); + * // Prints: efghijghijklmnopqrstuvwxyz + * ``` + * @since v0.1.90 + * @param target A `Buffer` or {@link Uint8Array} to copy into. + * @param [targetStart=0] The offset within `target` at which to begin writing. + * @param [sourceStart=0] The offset within `buf` from which to begin copying. + * @param [sourceEnd=buf.length] The offset within `buf` at which to stop copying (not inclusive). + * @return The number of bytes copied. + */ + copy(target: Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number; + /** + * Returns a new `Buffer` that references the same memory as the original, but + * offset and cropped by the `start` and `end` indices. + * + * This is the same behavior as `buf.subarray()`. + * + * This method is not compatible with the `Uint8Array.prototype.slice()`, + * which is a superclass of `Buffer`. To copy the slice, use`Uint8Array.prototype.slice()`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from('buffer'); + * + * const copiedBuf = Uint8Array.prototype.slice.call(buf); + * copiedBuf[0]++; + * console.log(copiedBuf.toString()); + * // Prints: cuffer + * + * console.log(buf.toString()); + * // Prints: buffer + * ``` + * @since v0.3.0 + * @param [start=0] Where the new `Buffer` will start. + * @param [end=buf.length] Where the new `Buffer` will end (not inclusive). + */ + slice(start?: number, end?: number): Buffer; + /** + * Returns a new `Buffer` that references the same memory as the original, but + * offset and cropped by the `start` and `end` indices. + * + * Specifying `end` greater than `buf.length` will return the same result as + * that of `end` equal to `buf.length`. + * + * This method is inherited from [`TypedArray.prototype.subarray()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/subarray). + * + * Modifying the new `Buffer` slice will modify the memory in the original `Buffer`because the allocated memory of the two objects overlap. + * + * ```js + * import { Buffer } from 'buffer'; + * + * // Create a `Buffer` with the ASCII alphabet, take a slice, and modify one byte + * // from the original `Buffer`. + * + * const buf1 = Buffer.allocUnsafe(26); + * + * for (let i = 0; i < 26; i++) { + * // 97 is the decimal ASCII value for 'a'. + * buf1[i] = i + 97; + * } + * + * const buf2 = buf1.subarray(0, 3); + * + * console.log(buf2.toString('ascii', 0, buf2.length)); + * // Prints: abc + * + * buf1[0] = 33; + * + * console.log(buf2.toString('ascii', 0, buf2.length)); + * // Prints: !bc + * ``` + * + * Specifying negative indexes causes the slice to be generated relative to the + * end of `buf` rather than the beginning. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from('buffer'); + * + * console.log(buf.subarray(-6, -1).toString()); + * // Prints: buffe + * // (Equivalent to buf.subarray(0, 5).) + * + * console.log(buf.subarray(-6, -2).toString()); + * // Prints: buff + * // (Equivalent to buf.subarray(0, 4).) + * + * console.log(buf.subarray(-5, -2).toString()); + * // Prints: uff + * // (Equivalent to buf.subarray(1, 4).) + * ``` + * @since v3.0.0 + * @param [start=0] Where the new `Buffer` will start. + * @param [end=buf.length] Where the new `Buffer` will end (not inclusive). + */ + subarray(start?: number, end?: number): Buffer; + /** + * Writes `value` to `buf` at the specified `offset` as big-endian. + * + * `value` is interpreted and written as a two's complement signed integer. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(8); + * + * buf.writeBigInt64BE(0x0102030405060708n, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v12.0.0, v10.20.0 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`. + * @return `offset` plus the number of bytes written. + */ + writeBigInt64BE(value: bigint, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as little-endian. + * + * `value` is interpreted and written as a two's complement signed integer. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(8); + * + * buf.writeBigInt64LE(0x0102030405060708n, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v12.0.0, v10.20.0 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`. + * @return `offset` plus the number of bytes written. + */ + writeBigInt64LE(value: bigint, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as big-endian. + * + * This function is also available under the `writeBigUint64BE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(8); + * + * buf.writeBigUInt64BE(0xdecafafecacefaden, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v12.0.0, v10.20.0 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`. + * @return `offset` plus the number of bytes written. + */ + writeBigUInt64BE(value: bigint, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as little-endian + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(8); + * + * buf.writeBigUInt64LE(0xdecafafecacefaden, 0); + * + * console.log(buf); + * // Prints: + * ``` + * + * This function is also available under the `writeBigUint64LE` alias. + * @since v12.0.0, v10.20.0 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`. + * @return `offset` plus the number of bytes written. + */ + writeBigUInt64LE(value: bigint, offset?: number): number; + /** + * Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined + * when `value` is anything other than an unsigned integer. + * + * This function is also available under the `writeUintLE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(6); + * + * buf.writeUIntLE(0x1234567890ab, 0, 6); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.5.5 + * @param value Number to be written to `buf`. + * @param offset Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - byteLength`. + * @param byteLength Number of bytes to write. Must satisfy `0 < byteLength <= 6`. + * @return `offset` plus the number of bytes written. + */ + writeUIntLE(value: number, offset: number, byteLength: number): number; + /** + * Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined + * when `value` is anything other than an unsigned integer. + * + * This function is also available under the `writeUintBE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(6); + * + * buf.writeUIntBE(0x1234567890ab, 0, 6); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.5.5 + * @param value Number to be written to `buf`. + * @param offset Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - byteLength`. + * @param byteLength Number of bytes to write. Must satisfy `0 < byteLength <= 6`. + * @return `offset` plus the number of bytes written. + */ + writeUIntBE(value: number, offset: number, byteLength: number): number; + /** + * Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined + * when `value` is anything other than a signed integer. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(6); + * + * buf.writeIntLE(0x1234567890ab, 0, 6); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.11.15 + * @param value Number to be written to `buf`. + * @param offset Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - byteLength`. + * @param byteLength Number of bytes to write. Must satisfy `0 < byteLength <= 6`. + * @return `offset` plus the number of bytes written. + */ + writeIntLE(value: number, offset: number, byteLength: number): number; + /** + * Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when`value` is anything other than a + * signed integer. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(6); + * + * buf.writeIntBE(0x1234567890ab, 0, 6); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.11.15 + * @param value Number to be written to `buf`. + * @param offset Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - byteLength`. + * @param byteLength Number of bytes to write. Must satisfy `0 < byteLength <= 6`. + * @return `offset` plus the number of bytes written. + */ + writeIntBE(value: number, offset: number, byteLength: number): number; + /** + * Reads an unsigned, big-endian 64-bit integer from `buf` at the specified`offset`. + * + * This function is also available under the `readBigUint64BE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]); + * + * console.log(buf.readBigUInt64BE(0)); + * // Prints: 4294967295n + * ``` + * @since v12.0.0, v10.20.0 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`. + */ + readBigUInt64BE(offset?: number): bigint; + /** + * Reads an unsigned, little-endian 64-bit integer from `buf` at the specified`offset`. + * + * This function is also available under the `readBigUint64LE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]); + * + * console.log(buf.readBigUInt64LE(0)); + * // Prints: 18446744069414584320n + * ``` + * @since v12.0.0, v10.20.0 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`. + */ + readBigUInt64LE(offset?: number): bigint; + /** + * Reads a signed, big-endian 64-bit integer from `buf` at the specified `offset`. + * + * Integers read from a `Buffer` are interpreted as two's complement signed + * values. + * @since v12.0.0, v10.20.0 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`. + */ + readBigInt64BE(offset?: number): bigint; + /** + * Reads a signed, little-endian 64-bit integer from `buf` at the specified`offset`. + * + * Integers read from a `Buffer` are interpreted as two's complement signed + * values. + * @since v12.0.0, v10.20.0 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`. + */ + readBigInt64LE(offset?: number): bigint; + /** + * Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as an unsigned, little-endian integer supporting + * up to 48 bits of accuracy. + * + * This function is also available under the `readUintLE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]); + * + * console.log(buf.readUIntLE(0, 6).toString(16)); + * // Prints: ab9078563412 + * ``` + * @since v0.11.15 + * @param offset Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - byteLength`. + * @param byteLength Number of bytes to read. Must satisfy `0 < byteLength <= 6`. + */ + readUIntLE(offset: number, byteLength: number): number; + /** + * Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as an unsigned big-endian integer supporting + * up to 48 bits of accuracy. + * + * This function is also available under the `readUintBE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]); + * + * console.log(buf.readUIntBE(0, 6).toString(16)); + * // Prints: 1234567890ab + * console.log(buf.readUIntBE(1, 6).toString(16)); + * // Throws ERR_OUT_OF_RANGE. + * ``` + * @since v0.11.15 + * @param offset Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - byteLength`. + * @param byteLength Number of bytes to read. Must satisfy `0 < byteLength <= 6`. + */ + readUIntBE(offset: number, byteLength: number): number; + /** + * Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as a little-endian, two's complement signed value + * supporting up to 48 bits of accuracy. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]); + * + * console.log(buf.readIntLE(0, 6).toString(16)); + * // Prints: -546f87a9cbee + * ``` + * @since v0.11.15 + * @param offset Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - byteLength`. + * @param byteLength Number of bytes to read. Must satisfy `0 < byteLength <= 6`. + */ + readIntLE(offset: number, byteLength: number): number; + /** + * Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as a big-endian, two's complement signed value + * supporting up to 48 bits of accuracy. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]); + * + * console.log(buf.readIntBE(0, 6).toString(16)); + * // Prints: 1234567890ab + * console.log(buf.readIntBE(1, 6).toString(16)); + * // Throws ERR_OUT_OF_RANGE. + * console.log(buf.readIntBE(1, 0).toString(16)); + * // Throws ERR_OUT_OF_RANGE. + * ``` + * @since v0.11.15 + * @param offset Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - byteLength`. + * @param byteLength Number of bytes to read. Must satisfy `0 < byteLength <= 6`. + */ + readIntBE(offset: number, byteLength: number): number; + /** + * Reads an unsigned 8-bit integer from `buf` at the specified `offset`. + * + * This function is also available under the `readUint8` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([1, -2]); + * + * console.log(buf.readUInt8(0)); + * // Prints: 1 + * console.log(buf.readUInt8(1)); + * // Prints: 254 + * console.log(buf.readUInt8(2)); + * // Throws ERR_OUT_OF_RANGE. + * ``` + * @since v0.5.0 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 1`. + */ + readUInt8(offset?: number): number; + /** + * Reads an unsigned, little-endian 16-bit integer from `buf` at the specified`offset`. + * + * This function is also available under the `readUint16LE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0x12, 0x34, 0x56]); + * + * console.log(buf.readUInt16LE(0).toString(16)); + * // Prints: 3412 + * console.log(buf.readUInt16LE(1).toString(16)); + * // Prints: 5634 + * console.log(buf.readUInt16LE(2).toString(16)); + * // Throws ERR_OUT_OF_RANGE. + * ``` + * @since v0.5.5 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 2`. + */ + readUInt16LE(offset?: number): number; + /** + * Reads an unsigned, big-endian 16-bit integer from `buf` at the specified`offset`. + * + * This function is also available under the `readUint16BE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0x12, 0x34, 0x56]); + * + * console.log(buf.readUInt16BE(0).toString(16)); + * // Prints: 1234 + * console.log(buf.readUInt16BE(1).toString(16)); + * // Prints: 3456 + * ``` + * @since v0.5.5 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 2`. + */ + readUInt16BE(offset?: number): number; + /** + * Reads an unsigned, little-endian 32-bit integer from `buf` at the specified`offset`. + * + * This function is also available under the `readUint32LE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]); + * + * console.log(buf.readUInt32LE(0).toString(16)); + * // Prints: 78563412 + * console.log(buf.readUInt32LE(1).toString(16)); + * // Throws ERR_OUT_OF_RANGE. + * ``` + * @since v0.5.5 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`. + */ + readUInt32LE(offset?: number): number; + /** + * Reads an unsigned, big-endian 32-bit integer from `buf` at the specified`offset`. + * + * This function is also available under the `readUint32BE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]); + * + * console.log(buf.readUInt32BE(0).toString(16)); + * // Prints: 12345678 + * ``` + * @since v0.5.5 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`. + */ + readUInt32BE(offset?: number): number; + /** + * Reads a signed 8-bit integer from `buf` at the specified `offset`. + * + * Integers read from a `Buffer` are interpreted as two's complement signed values. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([-1, 5]); + * + * console.log(buf.readInt8(0)); + * // Prints: -1 + * console.log(buf.readInt8(1)); + * // Prints: 5 + * console.log(buf.readInt8(2)); + * // Throws ERR_OUT_OF_RANGE. + * ``` + * @since v0.5.0 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 1`. + */ + readInt8(offset?: number): number; + /** + * Reads a signed, little-endian 16-bit integer from `buf` at the specified`offset`. + * + * Integers read from a `Buffer` are interpreted as two's complement signed values. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0, 5]); + * + * console.log(buf.readInt16LE(0)); + * // Prints: 1280 + * console.log(buf.readInt16LE(1)); + * // Throws ERR_OUT_OF_RANGE. + * ``` + * @since v0.5.5 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 2`. + */ + readInt16LE(offset?: number): number; + /** + * Reads a signed, big-endian 16-bit integer from `buf` at the specified `offset`. + * + * Integers read from a `Buffer` are interpreted as two's complement signed values. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0, 5]); + * + * console.log(buf.readInt16BE(0)); + * // Prints: 5 + * ``` + * @since v0.5.5 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 2`. + */ + readInt16BE(offset?: number): number; + /** + * Reads a signed, little-endian 32-bit integer from `buf` at the specified`offset`. + * + * Integers read from a `Buffer` are interpreted as two's complement signed values. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0, 0, 0, 5]); + * + * console.log(buf.readInt32LE(0)); + * // Prints: 83886080 + * console.log(buf.readInt32LE(1)); + * // Throws ERR_OUT_OF_RANGE. + * ``` + * @since v0.5.5 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`. + */ + readInt32LE(offset?: number): number; + /** + * Reads a signed, big-endian 32-bit integer from `buf` at the specified `offset`. + * + * Integers read from a `Buffer` are interpreted as two's complement signed values. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([0, 0, 0, 5]); + * + * console.log(buf.readInt32BE(0)); + * // Prints: 5 + * ``` + * @since v0.5.5 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`. + */ + readInt32BE(offset?: number): number; + /** + * Reads a 32-bit, little-endian float from `buf` at the specified `offset`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([1, 2, 3, 4]); + * + * console.log(buf.readFloatLE(0)); + * // Prints: 1.539989614439558e-36 + * console.log(buf.readFloatLE(1)); + * // Throws ERR_OUT_OF_RANGE. + * ``` + * @since v0.11.15 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`. + */ + readFloatLE(offset?: number): number; + /** + * Reads a 32-bit, big-endian float from `buf` at the specified `offset`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([1, 2, 3, 4]); + * + * console.log(buf.readFloatBE(0)); + * // Prints: 2.387939260590663e-38 + * ``` + * @since v0.11.15 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`. + */ + readFloatBE(offset?: number): number; + /** + * Reads a 64-bit, little-endian double from `buf` at the specified `offset`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]); + * + * console.log(buf.readDoubleLE(0)); + * // Prints: 5.447603722011605e-270 + * console.log(buf.readDoubleLE(1)); + * // Throws ERR_OUT_OF_RANGE. + * ``` + * @since v0.11.15 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 8`. + */ + readDoubleLE(offset?: number): number; + /** + * Reads a 64-bit, big-endian double from `buf` at the specified `offset`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]); + * + * console.log(buf.readDoubleBE(0)); + * // Prints: 8.20788039913184e-304 + * ``` + * @since v0.11.15 + * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 8`. + */ + readDoubleBE(offset?: number): number; + reverse(): this; + /** + * Interprets `buf` as an array of unsigned 16-bit integers and swaps the + * byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 2. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]); + * + * console.log(buf1); + * // Prints: + * + * buf1.swap16(); + * + * console.log(buf1); + * // Prints: + * + * const buf2 = Buffer.from([0x1, 0x2, 0x3]); + * + * buf2.swap16(); + * // Throws ERR_INVALID_BUFFER_SIZE. + * ``` + * + * One convenient use of `buf.swap16()` is to perform a fast in-place conversion + * between UTF-16 little-endian and UTF-16 big-endian: + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from('This is little-endian UTF-16', 'utf16le'); + * buf.swap16(); // Convert to big-endian UTF-16 text. + * ``` + * @since v5.10.0 + * @return A reference to `buf`. + */ + swap16(): Buffer; + /** + * Interprets `buf` as an array of unsigned 32-bit integers and swaps the + * byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 4. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]); + * + * console.log(buf1); + * // Prints: + * + * buf1.swap32(); + * + * console.log(buf1); + * // Prints: + * + * const buf2 = Buffer.from([0x1, 0x2, 0x3]); + * + * buf2.swap32(); + * // Throws ERR_INVALID_BUFFER_SIZE. + * ``` + * @since v5.10.0 + * @return A reference to `buf`. + */ + swap32(): Buffer; + /** + * Interprets `buf` as an array of 64-bit numbers and swaps byte order _in-place_. + * Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 8. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]); + * + * console.log(buf1); + * // Prints: + * + * buf1.swap64(); + * + * console.log(buf1); + * // Prints: + * + * const buf2 = Buffer.from([0x1, 0x2, 0x3]); + * + * buf2.swap64(); + * // Throws ERR_INVALID_BUFFER_SIZE. + * ``` + * @since v6.3.0 + * @return A reference to `buf`. + */ + swap64(): Buffer; + /** + * Writes `value` to `buf` at the specified `offset`. `value` must be a + * valid unsigned 8-bit integer. Behavior is undefined when `value` is anything + * other than an unsigned 8-bit integer. + * + * This function is also available under the `writeUint8` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(4); + * + * buf.writeUInt8(0x3, 0); + * buf.writeUInt8(0x4, 1); + * buf.writeUInt8(0x23, 2); + * buf.writeUInt8(0x42, 3); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.5.0 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 1`. + * @return `offset` plus the number of bytes written. + */ + writeUInt8(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid unsigned 16-bit integer. Behavior is undefined when `value` is + * anything other than an unsigned 16-bit integer. + * + * This function is also available under the `writeUint16LE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(4); + * + * buf.writeUInt16LE(0xdead, 0); + * buf.writeUInt16LE(0xbeef, 2); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.5.5 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 2`. + * @return `offset` plus the number of bytes written. + */ + writeUInt16LE(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid unsigned 16-bit integer. Behavior is undefined when `value`is anything other than an + * unsigned 16-bit integer. + * + * This function is also available under the `writeUint16BE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(4); + * + * buf.writeUInt16BE(0xdead, 0); + * buf.writeUInt16BE(0xbeef, 2); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.5.5 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 2`. + * @return `offset` plus the number of bytes written. + */ + writeUInt16BE(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid unsigned 32-bit integer. Behavior is undefined when `value` is + * anything other than an unsigned 32-bit integer. + * + * This function is also available under the `writeUint32LE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(4); + * + * buf.writeUInt32LE(0xfeedface, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.5.5 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`. + * @return `offset` plus the number of bytes written. + */ + writeUInt32LE(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid unsigned 32-bit integer. Behavior is undefined when `value`is anything other than an + * unsigned 32-bit integer. + * + * This function is also available under the `writeUint32BE` alias. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(4); + * + * buf.writeUInt32BE(0xfeedface, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.5.5 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`. + * @return `offset` plus the number of bytes written. + */ + writeUInt32BE(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset`. `value` must be a valid + * signed 8-bit integer. Behavior is undefined when `value` is anything other than + * a signed 8-bit integer. + * + * `value` is interpreted and written as a two's complement signed integer. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(2); + * + * buf.writeInt8(2, 0); + * buf.writeInt8(-2, 1); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.5.0 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 1`. + * @return `offset` plus the number of bytes written. + */ + writeInt8(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid signed 16-bit integer. Behavior is undefined when `value` is + * anything other than a signed 16-bit integer. + * + * The `value` is interpreted and written as a two's complement signed integer. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(2); + * + * buf.writeInt16LE(0x0304, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.5.5 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 2`. + * @return `offset` plus the number of bytes written. + */ + writeInt16LE(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid signed 16-bit integer. Behavior is undefined when `value` is + * anything other than a signed 16-bit integer. + * + * The `value` is interpreted and written as a two's complement signed integer. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(2); + * + * buf.writeInt16BE(0x0102, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.5.5 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 2`. + * @return `offset` plus the number of bytes written. + */ + writeInt16BE(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid signed 32-bit integer. Behavior is undefined when `value` is + * anything other than a signed 32-bit integer. + * + * The `value` is interpreted and written as a two's complement signed integer. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(4); + * + * buf.writeInt32LE(0x05060708, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.5.5 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`. + * @return `offset` plus the number of bytes written. + */ + writeInt32LE(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid signed 32-bit integer. Behavior is undefined when `value` is + * anything other than a signed 32-bit integer. + * + * The `value` is interpreted and written as a two's complement signed integer. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(4); + * + * buf.writeInt32BE(0x01020304, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.5.5 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`. + * @return `offset` plus the number of bytes written. + */ + writeInt32BE(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as little-endian. Behavior is + * undefined when `value` is anything other than a JavaScript number. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(4); + * + * buf.writeFloatLE(0xcafebabe, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.11.15 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`. + * @return `offset` plus the number of bytes written. + */ + writeFloatLE(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as big-endian. Behavior is + * undefined when `value` is anything other than a JavaScript number. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(4); + * + * buf.writeFloatBE(0xcafebabe, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.11.15 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`. + * @return `offset` plus the number of bytes written. + */ + writeFloatBE(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a JavaScript number. Behavior is undefined when `value` is anything + * other than a JavaScript number. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(8); + * + * buf.writeDoubleLE(123.456, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.11.15 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 8`. + * @return `offset` plus the number of bytes written. + */ + writeDoubleLE(value: number, offset?: number): number; + /** + * Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a JavaScript number. Behavior is undefined when `value` is anything + * other than a JavaScript number. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(8); + * + * buf.writeDoubleBE(123.456, 0); + * + * console.log(buf); + * // Prints: + * ``` + * @since v0.11.15 + * @param value Number to be written to `buf`. + * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 8`. + * @return `offset` plus the number of bytes written. + */ + writeDoubleBE(value: number, offset?: number): number; + /** + * Fills `buf` with the specified `value`. If the `offset` and `end` are not given, + * the entire `buf` will be filled: + * + * ```js + * import { Buffer } from 'buffer'; + * + * // Fill a `Buffer` with the ASCII character 'h'. + * + * const b = Buffer.allocUnsafe(50).fill('h'); + * + * console.log(b.toString()); + * // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh + * ``` + * + * `value` is coerced to a `uint32` value if it is not a string, `Buffer`, or + * integer. If the resulting integer is greater than `255` (decimal), `buf` will be + * filled with `value & 255`. + * + * If the final write of a `fill()` operation falls on a multi-byte character, + * then only the bytes of that character that fit into `buf` are written: + * + * ```js + * import { Buffer } from 'buffer'; + * + * // Fill a `Buffer` with character that takes up two bytes in UTF-8. + * + * console.log(Buffer.allocUnsafe(5).fill('\u0222')); + * // Prints: + * ``` + * + * If `value` contains invalid characters, it is truncated; if no valid + * fill data remains, an exception is thrown: + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.allocUnsafe(5); + * + * console.log(buf.fill('a')); + * // Prints: + * console.log(buf.fill('aazz', 'hex')); + * // Prints: + * console.log(buf.fill('zz', 'hex')); + * // Throws an exception. + * ``` + * @since v0.5.0 + * @param value The value with which to fill `buf`. + * @param [offset=0] Number of bytes to skip before starting to fill `buf`. + * @param [end=buf.length] Where to stop filling `buf` (not inclusive). + * @param [encoding='utf8'] The encoding for `value` if `value` is a string. + * @return A reference to `buf`. + */ + fill(value: string | Uint8Array | number, offset?: number, end?: number, encoding?: BufferEncoding): this; + /** + * If `value` is: + * + * * a string, `value` is interpreted according to the character encoding in`encoding`. + * * a `Buffer` or [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array), `value` will be used in its entirety. + * To compare a partial `Buffer`, use `buf.slice()`. + * * a number, `value` will be interpreted as an unsigned 8-bit integer + * value between `0` and `255`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from('this is a buffer'); + * + * console.log(buf.indexOf('this')); + * // Prints: 0 + * console.log(buf.indexOf('is')); + * // Prints: 2 + * console.log(buf.indexOf(Buffer.from('a buffer'))); + * // Prints: 8 + * console.log(buf.indexOf(97)); + * // Prints: 8 (97 is the decimal ASCII value for 'a') + * console.log(buf.indexOf(Buffer.from('a buffer example'))); + * // Prints: -1 + * console.log(buf.indexOf(Buffer.from('a buffer example').slice(0, 8))); + * // Prints: 8 + * + * const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le'); + * + * console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le')); + * // Prints: 4 + * console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le')); + * // Prints: 6 + * ``` + * + * If `value` is not a string, number, or `Buffer`, this method will throw a`TypeError`. If `value` is a number, it will be coerced to a valid byte value, + * an integer between 0 and 255. + * + * If `byteOffset` is not a number, it will be coerced to a number. If the result + * of coercion is `NaN` or `0`, then the entire buffer will be searched. This + * behavior matches [`String.prototype.indexOf()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf). + * + * ```js + * import { Buffer } from 'buffer'; + * + * const b = Buffer.from('abcdef'); + * + * // Passing a value that's a number, but not a valid byte. + * // Prints: 2, equivalent to searching for 99 or 'c'. + * console.log(b.indexOf(99.9)); + * console.log(b.indexOf(256 + 99)); + * + * // Passing a byteOffset that coerces to NaN or 0. + * // Prints: 1, searching the whole buffer. + * console.log(b.indexOf('b', undefined)); + * console.log(b.indexOf('b', {})); + * console.log(b.indexOf('b', null)); + * console.log(b.indexOf('b', [])); + * ``` + * + * If `value` is an empty string or empty `Buffer` and `byteOffset` is less + * than `buf.length`, `byteOffset` will be returned. If `value` is empty and`byteOffset` is at least `buf.length`, `buf.length` will be returned. + * @since v1.5.0 + * @param value What to search for. + * @param [byteOffset=0] Where to begin searching in `buf`. If negative, then offset is calculated from the end of `buf`. + * @param [encoding='utf8'] If `value` is a string, this is the encoding used to determine the binary representation of the string that will be searched for in `buf`. + * @return The index of the first occurrence of `value` in `buf`, or `-1` if `buf` does not contain `value`. + */ + indexOf(value: string | number | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number; + /** + * Identical to `buf.indexOf()`, except the last occurrence of `value` is found + * rather than the first occurrence. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from('this buffer is a buffer'); + * + * console.log(buf.lastIndexOf('this')); + * // Prints: 0 + * console.log(buf.lastIndexOf('buffer')); + * // Prints: 17 + * console.log(buf.lastIndexOf(Buffer.from('buffer'))); + * // Prints: 17 + * console.log(buf.lastIndexOf(97)); + * // Prints: 15 (97 is the decimal ASCII value for 'a') + * console.log(buf.lastIndexOf(Buffer.from('yolo'))); + * // Prints: -1 + * console.log(buf.lastIndexOf('buffer', 5)); + * // Prints: 5 + * console.log(buf.lastIndexOf('buffer', 4)); + * // Prints: -1 + * + * const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le'); + * + * console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le')); + * // Prints: 6 + * console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le')); + * // Prints: 4 + * ``` + * + * If `value` is not a string, number, or `Buffer`, this method will throw a`TypeError`. If `value` is a number, it will be coerced to a valid byte value, + * an integer between 0 and 255. + * + * If `byteOffset` is not a number, it will be coerced to a number. Any arguments + * that coerce to `NaN`, like `{}` or `undefined`, will search the whole buffer. + * This behavior matches [`String.prototype.lastIndexOf()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/lastIndexOf). + * + * ```js + * import { Buffer } from 'buffer'; + * + * const b = Buffer.from('abcdef'); + * + * // Passing a value that's a number, but not a valid byte. + * // Prints: 2, equivalent to searching for 99 or 'c'. + * console.log(b.lastIndexOf(99.9)); + * console.log(b.lastIndexOf(256 + 99)); + * + * // Passing a byteOffset that coerces to NaN. + * // Prints: 1, searching the whole buffer. + * console.log(b.lastIndexOf('b', undefined)); + * console.log(b.lastIndexOf('b', {})); + * + * // Passing a byteOffset that coerces to 0. + * // Prints: -1, equivalent to passing 0. + * console.log(b.lastIndexOf('b', null)); + * console.log(b.lastIndexOf('b', [])); + * ``` + * + * If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned. + * @since v6.0.0 + * @param value What to search for. + * @param [byteOffset=buf.length - 1] Where to begin searching in `buf`. If negative, then offset is calculated from the end of `buf`. + * @param [encoding='utf8'] If `value` is a string, this is the encoding used to determine the binary representation of the string that will be searched for in `buf`. + * @return The index of the last occurrence of `value` in `buf`, or `-1` if `buf` does not contain `value`. + */ + lastIndexOf(value: string | number | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number; + /** + * Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `[index, byte]` pairs from the contents + * of `buf`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * // Log the entire contents of a `Buffer`. + * + * const buf = Buffer.from('buffer'); + * + * for (const pair of buf.entries()) { + * console.log(pair); + * } + * // Prints: + * // [0, 98] + * // [1, 117] + * // [2, 102] + * // [3, 102] + * // [4, 101] + * // [5, 114] + * ``` + * @since v1.1.0 + */ + entries(): IterableIterator<[number, number]>; + /** + * Equivalent to `buf.indexOf() !== -1`. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from('this is a buffer'); + * + * console.log(buf.includes('this')); + * // Prints: true + * console.log(buf.includes('is')); + * // Prints: true + * console.log(buf.includes(Buffer.from('a buffer'))); + * // Prints: true + * console.log(buf.includes(97)); + * // Prints: true (97 is the decimal ASCII value for 'a') + * console.log(buf.includes(Buffer.from('a buffer example'))); + * // Prints: false + * console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8))); + * // Prints: true + * console.log(buf.includes('this', 4)); + * // Prints: false + * ``` + * @since v5.3.0 + * @param value What to search for. + * @param [byteOffset=0] Where to begin searching in `buf`. If negative, then offset is calculated from the end of `buf`. + * @param [encoding='utf8'] If `value` is a string, this is its encoding. + * @return `true` if `value` was found in `buf`, `false` otherwise. + */ + includes(value: string | number | Buffer, byteOffset?: number, encoding?: BufferEncoding): boolean; + /** + * Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `buf` keys (indices). + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from('buffer'); + * + * for (const key of buf.keys()) { + * console.log(key); + * } + * // Prints: + * // 0 + * // 1 + * // 2 + * // 3 + * // 4 + * // 5 + * ``` + * @since v1.1.0 + */ + keys(): IterableIterator; + /** + * Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) for `buf` values (bytes). This function is + * called automatically when a `Buffer` is used in a `for..of` statement. + * + * ```js + * import { Buffer } from 'buffer'; + * + * const buf = Buffer.from('buffer'); + * + * for (const value of buf.values()) { + * console.log(value); + * } + * // Prints: + * // 98 + * // 117 + * // 102 + * // 102 + * // 101 + * // 114 + * + * for (const value of buf) { + * console.log(value); + * } + * // Prints: + * // 98 + * // 117 + * // 102 + * // 102 + * // 101 + * // 114 + * ``` + * @since v1.1.0 + */ + values(): IterableIterator; + } + var Buffer: BufferConstructor; + /** + * Decodes a string of Base64-encoded data into bytes, and encodes those bytes + * into a string using Latin-1 (ISO-8859-1). + * + * The `data` may be any JavaScript-value that can be coerced into a string. + * + * **This function is only provided for compatibility with legacy web platform APIs** + * **and should never be used in new code, because they use strings to represent** + * **binary data and predate the introduction of typed arrays in JavaScript.** + * **For code running using Node.js APIs, converting between base64-encoded strings** + * **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.** + * @since v15.13.0 + * @deprecated Use `Buffer.from(data, 'base64')` instead. + * @param data The Base64-encoded input string. + */ + function atob(data: string): string; + /** + * Decodes a string into bytes using Latin-1 (ISO-8859), and encodes those bytes + * into a string using Base64. + * + * The `data` may be any JavaScript-value that can be coerced into a string. + * + * **This function is only provided for compatibility with legacy web platform APIs** + * **and should never be used in new code, because they use strings to represent** + * **binary data and predate the introduction of typed arrays in JavaScript.** + * **For code running using Node.js APIs, converting between base64-encoded strings** + * **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.** + * @since v15.13.0 + * @deprecated Use `buf.toString('base64')` instead. + * @param data An ASCII (Latin1) string. + */ + function btoa(data: string): string; + } +} +declare module 'node:buffer' { + export * from 'buffer'; +} diff --git a/node_modules/@types/node/child_process.d.ts b/node_modules/@types/node/child_process.d.ts new file mode 100755 index 00000000..d3831455 --- /dev/null +++ b/node_modules/@types/node/child_process.d.ts @@ -0,0 +1,1366 @@ +/** + * The `child_process` module provides the ability to spawn subprocesses in + * a manner that is similar, but not identical, to [`popen(3)`](http://man7.org/linux/man-pages/man3/popen.3.html). This capability + * is primarily provided by the {@link spawn} function: + * + * ```js + * const { spawn } = require('child_process'); + * const ls = spawn('ls', ['-lh', '/usr']); + * + * ls.stdout.on('data', (data) => { + * console.log(`stdout: ${data}`); + * }); + * + * ls.stderr.on('data', (data) => { + * console.error(`stderr: ${data}`); + * }); + * + * ls.on('close', (code) => { + * console.log(`child process exited with code ${code}`); + * }); + * ``` + * + * By default, pipes for `stdin`, `stdout`, and `stderr` are established between + * the parent Node.js process and the spawned subprocess. These pipes have + * limited (and platform-specific) capacity. If the subprocess writes to + * stdout in excess of that limit without the output being captured, the + * subprocess blocks waiting for the pipe buffer to accept more data. This is + * identical to the behavior of pipes in the shell. Use the `{ stdio: 'ignore' }`option if the output will not be consumed. + * + * The command lookup is performed using the `options.env.PATH` environment + * variable if it is in the `options` object. Otherwise, `process.env.PATH` is + * used. + * + * On Windows, environment variables are case-insensitive. Node.js + * lexicographically sorts the `env` keys and uses the first one that + * case-insensitively matches. Only first (in lexicographic order) entry will be + * passed to the subprocess. This might lead to issues on Windows when passing + * objects to the `env` option that have multiple variants of the same key, such as`PATH` and `Path`. + * + * The {@link spawn} method spawns the child process asynchronously, + * without blocking the Node.js event loop. The {@link spawnSync} function provides equivalent functionality in a synchronous manner that blocks + * the event loop until the spawned process either exits or is terminated. + * + * For convenience, the `child_process` module provides a handful of synchronous + * and asynchronous alternatives to {@link spawn} and {@link spawnSync}. Each of these alternatives are implemented on + * top of {@link spawn} or {@link spawnSync}. + * + * * {@link exec}: spawns a shell and runs a command within that + * shell, passing the `stdout` and `stderr` to a callback function when + * complete. + * * {@link execFile}: similar to {@link exec} except + * that it spawns the command directly without first spawning a shell by + * default. + * * {@link fork}: spawns a new Node.js process and invokes a + * specified module with an IPC communication channel established that allows + * sending messages between parent and child. + * * {@link execSync}: a synchronous version of {@link exec} that will block the Node.js event loop. + * * {@link execFileSync}: a synchronous version of {@link execFile} that will block the Node.js event loop. + * + * For certain use cases, such as automating shell scripts, the `synchronous counterparts` may be more convenient. In many cases, however, + * the synchronous methods can have significant impact on performance due to + * stalling the event loop while spawned processes complete. + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/child_process.js) + */ +declare module 'child_process' { + import { ObjectEncodingOptions } from 'node:fs'; + import { EventEmitter, Abortable } from 'node:events'; + import * as net from 'node:net'; + import { Writable, Readable, Stream, Pipe } from 'node:stream'; + import { URL } from 'node:url'; + type Serializable = string | object | number | boolean | bigint; + type SendHandle = net.Socket | net.Server; + /** + * Instances of the `ChildProcess` represent spawned child processes. + * + * Instances of `ChildProcess` are not intended to be created directly. Rather, + * use the {@link spawn}, {@link exec},{@link execFile}, or {@link fork} methods to create + * instances of `ChildProcess`. + * @since v2.2.0 + */ + class ChildProcess extends EventEmitter { + /** + * A `Writable Stream` that represents the child process's `stdin`. + * + * If a child process waits to read all of its input, the child will not continue + * until this stream has been closed via `end()`. + * + * If the child was spawned with `stdio[0]` set to anything other than `'pipe'`, + * then this will be `null`. + * + * `subprocess.stdin` is an alias for `subprocess.stdio[0]`. Both properties will + * refer to the same value. + * + * The `subprocess.stdin` property can be `undefined` if the child process could + * not be successfully spawned. + * @since v0.1.90 + */ + stdin: Writable | null; + /** + * A `Readable Stream` that represents the child process's `stdout`. + * + * If the child was spawned with `stdio[1]` set to anything other than `'pipe'`, + * then this will be `null`. + * + * `subprocess.stdout` is an alias for `subprocess.stdio[1]`. Both properties will + * refer to the same value. + * + * ```js + * const { spawn } = require('child_process'); + * + * const subprocess = spawn('ls'); + * + * subprocess.stdout.on('data', (data) => { + * console.log(`Received chunk ${data}`); + * }); + * ``` + * + * The `subprocess.stdout` property can be `null` if the child process could + * not be successfully spawned. + * @since v0.1.90 + */ + stdout: Readable | null; + /** + * A `Readable Stream` that represents the child process's `stderr`. + * + * If the child was spawned with `stdio[2]` set to anything other than `'pipe'`, + * then this will be `null`. + * + * `subprocess.stderr` is an alias for `subprocess.stdio[2]`. Both properties will + * refer to the same value. + * + * The `subprocess.stderr` property can be `null` if the child process could + * not be successfully spawned. + * @since v0.1.90 + */ + stderr: Readable | null; + /** + * The `subprocess.channel` property is a reference to the child's IPC channel. If + * no IPC channel currently exists, this property is `undefined`. + * @since v7.1.0 + */ + readonly channel?: Pipe | null | undefined; + /** + * A sparse array of pipes to the child process, corresponding with positions in + * the `stdio` option passed to {@link spawn} that have been set + * to the value `'pipe'`. `subprocess.stdio[0]`, `subprocess.stdio[1]`, and`subprocess.stdio[2]` are also available as `subprocess.stdin`,`subprocess.stdout`, and `subprocess.stderr`, + * respectively. + * + * In the following example, only the child's fd `1` (stdout) is configured as a + * pipe, so only the parent's `subprocess.stdio[1]` is a stream, all other values + * in the array are `null`. + * + * ```js + * const assert = require('assert'); + * const fs = require('fs'); + * const child_process = require('child_process'); + * + * const subprocess = child_process.spawn('ls', { + * stdio: [ + * 0, // Use parent's stdin for child. + * 'pipe', // Pipe child's stdout to parent. + * fs.openSync('err.out', 'w'), // Direct child's stderr to a file. + * ] + * }); + * + * assert.strictEqual(subprocess.stdio[0], null); + * assert.strictEqual(subprocess.stdio[0], subprocess.stdin); + * + * assert(subprocess.stdout); + * assert.strictEqual(subprocess.stdio[1], subprocess.stdout); + * + * assert.strictEqual(subprocess.stdio[2], null); + * assert.strictEqual(subprocess.stdio[2], subprocess.stderr); + * ``` + * + * The `subprocess.stdio` property can be `undefined` if the child process could + * not be successfully spawned. + * @since v0.7.10 + */ + readonly stdio: [ + Writable | null, + // stdin + Readable | null, + // stdout + Readable | null, + // stderr + Readable | Writable | null | undefined, + // extra + Readable | Writable | null | undefined // extra + ]; + /** + * The `subprocess.killed` property indicates whether the child process + * successfully received a signal from `subprocess.kill()`. The `killed` property + * does not indicate that the child process has been terminated. + * @since v0.5.10 + */ + readonly killed: boolean; + /** + * Returns the process identifier (PID) of the child process. If the child process + * fails to spawn due to errors, then the value is `undefined` and `error` is + * emitted. + * + * ```js + * const { spawn } = require('child_process'); + * const grep = spawn('grep', ['ssh']); + * + * console.log(`Spawned child pid: ${grep.pid}`); + * grep.stdin.end(); + * ``` + * @since v0.1.90 + */ + readonly pid?: number | undefined; + /** + * The `subprocess.connected` property indicates whether it is still possible to + * send and receive messages from a child process. When `subprocess.connected` is`false`, it is no longer possible to send or receive messages. + * @since v0.7.2 + */ + readonly connected: boolean; + /** + * The `subprocess.exitCode` property indicates the exit code of the child process. + * If the child process is still running, the field will be `null`. + */ + readonly exitCode: number | null; + /** + * The `subprocess.signalCode` property indicates the signal received by + * the child process if any, else `null`. + */ + readonly signalCode: NodeJS.Signals | null; + /** + * The `subprocess.spawnargs` property represents the full list of command-line + * arguments the child process was launched with. + */ + readonly spawnargs: string[]; + /** + * The `subprocess.spawnfile` property indicates the executable file name of + * the child process that is launched. + * + * For {@link fork}, its value will be equal to `process.execPath`. + * For {@link spawn}, its value will be the name of + * the executable file. + * For {@link exec}, its value will be the name of the shell + * in which the child process is launched. + */ + readonly spawnfile: string; + /** + * The `subprocess.kill()` method sends a signal to the child process. If no + * argument is given, the process will be sent the `'SIGTERM'` signal. See [`signal(7)`](http://man7.org/linux/man-pages/man7/signal.7.html) for a list of available signals. This function + * returns `true` if [`kill(2)`](http://man7.org/linux/man-pages/man2/kill.2.html) succeeds, and `false` otherwise. + * + * ```js + * const { spawn } = require('child_process'); + * const grep = spawn('grep', ['ssh']); + * + * grep.on('close', (code, signal) => { + * console.log( + * `child process terminated due to receipt of signal ${signal}`); + * }); + * + * // Send SIGHUP to process. + * grep.kill('SIGHUP'); + * ``` + * + * The `ChildProcess` object may emit an `'error'` event if the signal + * cannot be delivered. Sending a signal to a child process that has already exited + * is not an error but may have unforeseen consequences. Specifically, if the + * process identifier (PID) has been reassigned to another process, the signal will + * be delivered to that process instead which can have unexpected results. + * + * While the function is called `kill`, the signal delivered to the child process + * may not actually terminate the process. + * + * See [`kill(2)`](http://man7.org/linux/man-pages/man2/kill.2.html) for reference. + * + * On Windows, where POSIX signals do not exist, the `signal` argument will be + * ignored, and the process will be killed forcefully and abruptly (similar to`'SIGKILL'`). + * See `Signal Events` for more details. + * + * On Linux, child processes of child processes will not be terminated + * when attempting to kill their parent. This is likely to happen when running a + * new process in a shell or with the use of the `shell` option of `ChildProcess`: + * + * ```js + * 'use strict'; + * const { spawn } = require('child_process'); + * + * const subprocess = spawn( + * 'sh', + * [ + * '-c', + * `node -e "setInterval(() => { + * console.log(process.pid, 'is alive') + * }, 500);"`, + * ], { + * stdio: ['inherit', 'inherit', 'inherit'] + * } + * ); + * + * setTimeout(() => { + * subprocess.kill(); // Does not terminate the Node.js process in the shell. + * }, 2000); + * ``` + * @since v0.1.90 + */ + kill(signal?: NodeJS.Signals | number): boolean; + /** + * When an IPC channel has been established between the parent and child ( + * i.e. when using {@link fork}), the `subprocess.send()` method can + * be used to send messages to the child process. When the child process is a + * Node.js instance, these messages can be received via the `'message'` event. + * + * The message goes through serialization and parsing. The resulting + * message might not be the same as what is originally sent. + * + * For example, in the parent script: + * + * ```js + * const cp = require('child_process'); + * const n = cp.fork(`${__dirname}/sub.js`); + * + * n.on('message', (m) => { + * console.log('PARENT got message:', m); + * }); + * + * // Causes the child to print: CHILD got message: { hello: 'world' } + * n.send({ hello: 'world' }); + * ``` + * + * And then the child script, `'sub.js'` might look like this: + * + * ```js + * process.on('message', (m) => { + * console.log('CHILD got message:', m); + * }); + * + * // Causes the parent to print: PARENT got message: { foo: 'bar', baz: null } + * process.send({ foo: 'bar', baz: NaN }); + * ``` + * + * Child Node.js processes will have a `process.send()` method of their own + * that allows the child to send messages back to the parent. + * + * There is a special case when sending a `{cmd: 'NODE_foo'}` message. Messages + * containing a `NODE_` prefix in the `cmd` property are reserved for use within + * Node.js core and will not be emitted in the child's `'message'` event. Rather, such messages are emitted using the`'internalMessage'` event and are consumed internally by Node.js. + * Applications should avoid using such messages or listening for`'internalMessage'` events as it is subject to change without notice. + * + * The optional `sendHandle` argument that may be passed to `subprocess.send()` is + * for passing a TCP server or socket object to the child process. The child will + * receive the object as the second argument passed to the callback function + * registered on the `'message'` event. Any data that is received + * and buffered in the socket will not be sent to the child. + * + * The optional `callback` is a function that is invoked after the message is + * sent but before the child may have received it. The function is called with a + * single argument: `null` on success, or an `Error` object on failure. + * + * If no `callback` function is provided and the message cannot be sent, an`'error'` event will be emitted by the `ChildProcess` object. This can + * happen, for instance, when the child process has already exited. + * + * `subprocess.send()` will return `false` if the channel has closed or when the + * backlog of unsent messages exceeds a threshold that makes it unwise to send + * more. Otherwise, the method returns `true`. The `callback` function can be + * used to implement flow control. + * + * #### Example: sending a server object + * + * The `sendHandle` argument can be used, for instance, to pass the handle of + * a TCP server object to the child process as illustrated in the example below: + * + * ```js + * const subprocess = require('child_process').fork('subprocess.js'); + * + * // Open up the server object and send the handle. + * const server = require('net').createServer(); + * server.on('connection', (socket) => { + * socket.end('handled by parent'); + * }); + * server.listen(1337, () => { + * subprocess.send('server', server); + * }); + * ``` + * + * The child would then receive the server object as: + * + * ```js + * process.on('message', (m, server) => { + * if (m === 'server') { + * server.on('connection', (socket) => { + * socket.end('handled by child'); + * }); + * } + * }); + * ``` + * + * Once the server is now shared between the parent and child, some connections + * can be handled by the parent and some by the child. + * + * While the example above uses a server created using the `net` module, `dgram`module servers use exactly the same workflow with the exceptions of listening on + * a `'message'` event instead of `'connection'` and using `server.bind()` instead + * of `server.listen()`. This is, however, currently only supported on Unix + * platforms. + * + * #### Example: sending a socket object + * + * Similarly, the `sendHandler` argument can be used to pass the handle of a + * socket to the child process. The example below spawns two children that each + * handle connections with "normal" or "special" priority: + * + * ```js + * const { fork } = require('child_process'); + * const normal = fork('subprocess.js', ['normal']); + * const special = fork('subprocess.js', ['special']); + * + * // Open up the server and send sockets to child. Use pauseOnConnect to prevent + * // the sockets from being read before they are sent to the child process. + * const server = require('net').createServer({ pauseOnConnect: true }); + * server.on('connection', (socket) => { + * + * // If this is special priority... + * if (socket.remoteAddress === '74.125.127.100') { + * special.send('socket', socket); + * return; + * } + * // This is normal priority. + * normal.send('socket', socket); + * }); + * server.listen(1337); + * ``` + * + * The `subprocess.js` would receive the socket handle as the second argument + * passed to the event callback function: + * + * ```js + * process.on('message', (m, socket) => { + * if (m === 'socket') { + * if (socket) { + * // Check that the client socket exists. + * // It is possible for the socket to be closed between the time it is + * // sent and the time it is received in the child process. + * socket.end(`Request handled with ${process.argv[2]} priority`); + * } + * } + * }); + * ``` + * + * Do not use `.maxConnections` on a socket that has been passed to a subprocess. + * The parent cannot track when the socket is destroyed. + * + * Any `'message'` handlers in the subprocess should verify that `socket` exists, + * as the connection may have been closed during the time it takes to send the + * connection to the child. + * @since v0.5.9 + * @param options The `options` argument, if present, is an object used to parameterize the sending of certain types of handles. `options` supports the following properties: + */ + send(message: Serializable, callback?: (error: Error | null) => void): boolean; + send(message: Serializable, sendHandle?: SendHandle, callback?: (error: Error | null) => void): boolean; + send(message: Serializable, sendHandle?: SendHandle, options?: MessageOptions, callback?: (error: Error | null) => void): boolean; + /** + * Closes the IPC channel between parent and child, allowing the child to exit + * gracefully once there are no other connections keeping it alive. After calling + * this method the `subprocess.connected` and `process.connected` properties in + * both the parent and child (respectively) will be set to `false`, and it will be + * no longer possible to pass messages between the processes. + * + * The `'disconnect'` event will be emitted when there are no messages in the + * process of being received. This will most often be triggered immediately after + * calling `subprocess.disconnect()`. + * + * When the child process is a Node.js instance (e.g. spawned using {@link fork}), the `process.disconnect()` method can be invoked + * within the child process to close the IPC channel as well. + * @since v0.7.2 + */ + disconnect(): void; + /** + * By default, the parent will wait for the detached child to exit. To prevent the + * parent from waiting for a given `subprocess` to exit, use the`subprocess.unref()` method. Doing so will cause the parent's event loop to not + * include the child in its reference count, allowing the parent to exit + * independently of the child, unless there is an established IPC channel between + * the child and the parent. + * + * ```js + * const { spawn } = require('child_process'); + * + * const subprocess = spawn(process.argv[0], ['child_program.js'], { + * detached: true, + * stdio: 'ignore' + * }); + * + * subprocess.unref(); + * ``` + * @since v0.7.10 + */ + unref(): void; + /** + * Calling `subprocess.ref()` after making a call to `subprocess.unref()` will + * restore the removed reference count for the child process, forcing the parent + * to wait for the child to exit before exiting itself. + * + * ```js + * const { spawn } = require('child_process'); + * + * const subprocess = spawn(process.argv[0], ['child_program.js'], { + * detached: true, + * stdio: 'ignore' + * }); + * + * subprocess.unref(); + * subprocess.ref(); + * ``` + * @since v0.7.10 + */ + ref(): void; + /** + * events.EventEmitter + * 1. close + * 2. disconnect + * 3. error + * 4. exit + * 5. message + * 6. spawn + */ + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'close', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + addListener(event: 'disconnect', listener: () => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'exit', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + addListener(event: 'message', listener: (message: Serializable, sendHandle: SendHandle) => void): this; + addListener(event: 'spawn', listener: () => void): this; + emit(event: string | symbol, ...args: any[]): boolean; + emit(event: 'close', code: number | null, signal: NodeJS.Signals | null): boolean; + emit(event: 'disconnect'): boolean; + emit(event: 'error', err: Error): boolean; + emit(event: 'exit', code: number | null, signal: NodeJS.Signals | null): boolean; + emit(event: 'message', message: Serializable, sendHandle: SendHandle): boolean; + emit(event: 'spawn', listener: () => void): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'close', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + on(event: 'disconnect', listener: () => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'exit', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + on(event: 'message', listener: (message: Serializable, sendHandle: SendHandle) => void): this; + on(event: 'spawn', listener: () => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'close', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + once(event: 'disconnect', listener: () => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'exit', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + once(event: 'message', listener: (message: Serializable, sendHandle: SendHandle) => void): this; + once(event: 'spawn', listener: () => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + prependListener(event: 'disconnect', listener: () => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'exit', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + prependListener(event: 'message', listener: (message: Serializable, sendHandle: SendHandle) => void): this; + prependListener(event: 'spawn', listener: () => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + prependOnceListener(event: 'disconnect', listener: () => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'exit', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; + prependOnceListener(event: 'message', listener: (message: Serializable, sendHandle: SendHandle) => void): this; + prependOnceListener(event: 'spawn', listener: () => void): this; + } + // return this object when stdio option is undefined or not specified + interface ChildProcessWithoutNullStreams extends ChildProcess { + stdin: Writable; + stdout: Readable; + stderr: Readable; + readonly stdio: [ + Writable, + Readable, + Readable, + // stderr + Readable | Writable | null | undefined, + // extra, no modification + Readable | Writable | null | undefined // extra, no modification + ]; + } + // return this object when stdio option is a tuple of 3 + interface ChildProcessByStdio extends ChildProcess { + stdin: I; + stdout: O; + stderr: E; + readonly stdio: [ + I, + O, + E, + Readable | Writable | null | undefined, + // extra, no modification + Readable | Writable | null | undefined // extra, no modification + ]; + } + interface MessageOptions { + keepOpen?: boolean | undefined; + } + type IOType = 'overlapped' | 'pipe' | 'ignore' | 'inherit'; + type StdioOptions = IOType | Array; + type SerializationType = 'json' | 'advanced'; + interface MessagingOptions extends Abortable { + /** + * Specify the kind of serialization used for sending messages between processes. + * @default 'json' + */ + serialization?: SerializationType | undefined; + /** + * The signal value to be used when the spawned process will be killed by the abort signal. + * @default 'SIGTERM' + */ + killSignal?: NodeJS.Signals | number | undefined; + /** + * In milliseconds the maximum amount of time the process is allowed to run. + */ + timeout?: number | undefined; + } + interface ProcessEnvOptions { + uid?: number | undefined; + gid?: number | undefined; + cwd?: string | URL | undefined; + env?: NodeJS.ProcessEnv | undefined; + } + interface CommonOptions extends ProcessEnvOptions { + /** + * @default true + */ + windowsHide?: boolean | undefined; + /** + * @default 0 + */ + timeout?: number | undefined; + } + interface CommonSpawnOptions extends CommonOptions, MessagingOptions, Abortable { + argv0?: string | undefined; + stdio?: StdioOptions | undefined; + shell?: boolean | string | undefined; + windowsVerbatimArguments?: boolean | undefined; + } + interface SpawnOptions extends CommonSpawnOptions { + detached?: boolean | undefined; + } + interface SpawnOptionsWithoutStdio extends SpawnOptions { + stdio?: StdioPipeNamed | StdioPipe[] | undefined; + } + type StdioNull = 'inherit' | 'ignore' | Stream; + type StdioPipeNamed = 'pipe' | 'overlapped'; + type StdioPipe = undefined | null | StdioPipeNamed; + interface SpawnOptionsWithStdioTuple extends SpawnOptions { + stdio: [Stdin, Stdout, Stderr]; + } + /** + * The `child_process.spawn()` method spawns a new process using the given`command`, with command-line arguments in `args`. If omitted, `args` defaults + * to an empty array. + * + * **If the `shell` option is enabled, do not pass unsanitized user input to this** + * **function. Any input containing shell metacharacters may be used to trigger** + * **arbitrary command execution.** + * + * A third argument may be used to specify additional options, with these defaults: + * + * ```js + * const defaults = { + * cwd: undefined, + * env: process.env + * }; + * ``` + * + * Use `cwd` to specify the working directory from which the process is spawned. + * If not given, the default is to inherit the current working directory. If given, + * but the path does not exist, the child process emits an `ENOENT` error + * and exits immediately. `ENOENT` is also emitted when the command + * does not exist. + * + * Use `env` to specify environment variables that will be visible to the new + * process, the default is `process.env`. + * + * `undefined` values in `env` will be ignored. + * + * Example of running `ls -lh /usr`, capturing `stdout`, `stderr`, and the + * exit code: + * + * ```js + * const { spawn } = require('child_process'); + * const ls = spawn('ls', ['-lh', '/usr']); + * + * ls.stdout.on('data', (data) => { + * console.log(`stdout: ${data}`); + * }); + * + * ls.stderr.on('data', (data) => { + * console.error(`stderr: ${data}`); + * }); + * + * ls.on('close', (code) => { + * console.log(`child process exited with code ${code}`); + * }); + * ``` + * + * Example: A very elaborate way to run `ps ax | grep ssh` + * + * ```js + * const { spawn } = require('child_process'); + * const ps = spawn('ps', ['ax']); + * const grep = spawn('grep', ['ssh']); + * + * ps.stdout.on('data', (data) => { + * grep.stdin.write(data); + * }); + * + * ps.stderr.on('data', (data) => { + * console.error(`ps stderr: ${data}`); + * }); + * + * ps.on('close', (code) => { + * if (code !== 0) { + * console.log(`ps process exited with code ${code}`); + * } + * grep.stdin.end(); + * }); + * + * grep.stdout.on('data', (data) => { + * console.log(data.toString()); + * }); + * + * grep.stderr.on('data', (data) => { + * console.error(`grep stderr: ${data}`); + * }); + * + * grep.on('close', (code) => { + * if (code !== 0) { + * console.log(`grep process exited with code ${code}`); + * } + * }); + * ``` + * + * Example of checking for failed `spawn`: + * + * ```js + * const { spawn } = require('child_process'); + * const subprocess = spawn('bad_command'); + * + * subprocess.on('error', (err) => { + * console.error('Failed to start subprocess.'); + * }); + * ``` + * + * Certain platforms (macOS, Linux) will use the value of `argv[0]` for the process + * title while others (Windows, SunOS) will use `command`. + * + * Node.js currently overwrites `argv[0]` with `process.execPath` on startup, so`process.argv[0]` in a Node.js child process will not match the `argv0`parameter passed to `spawn` from the parent, + * retrieve it with the`process.argv0` property instead. + * + * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except + * the error passed to the callback will be an `AbortError`: + * + * ```js + * const { spawn } = require('child_process'); + * const controller = new AbortController(); + * const { signal } = controller; + * const grep = spawn('grep', ['ssh'], { signal }); + * grep.on('error', (err) => { + * // This will be called with err being an AbortError if the controller aborts + * }); + * controller.abort(); // Stops the child process + * ``` + * @since v0.1.90 + * @param command The command to run. + * @param args List of string arguments. + */ + function spawn(command: string, options?: SpawnOptionsWithoutStdio): ChildProcessWithoutNullStreams; + function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, options: SpawnOptions): ChildProcess; + // overloads of spawn with 'args' + function spawn(command: string, args?: ReadonlyArray, options?: SpawnOptionsWithoutStdio): ChildProcessWithoutNullStreams; + function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio; + function spawn(command: string, args: ReadonlyArray, options: SpawnOptions): ChildProcess; + interface ExecOptions extends CommonOptions { + shell?: string | undefined; + signal?: AbortSignal | undefined; + maxBuffer?: number | undefined; + killSignal?: NodeJS.Signals | number | undefined; + } + interface ExecOptionsWithStringEncoding extends ExecOptions { + encoding: BufferEncoding; + } + interface ExecOptionsWithBufferEncoding extends ExecOptions { + encoding: BufferEncoding | null; // specify `null`. + } + interface ExecException extends Error { + cmd?: string | undefined; + killed?: boolean | undefined; + code?: number | undefined; + signal?: NodeJS.Signals | undefined; + } + /** + * Spawns a shell then executes the `command` within that shell, buffering any + * generated output. The `command` string passed to the exec function is processed + * directly by the shell and special characters (vary based on [shell](https://en.wikipedia.org/wiki/List_of_command-line_interpreters)) + * need to be dealt with accordingly: + * + * ```js + * const { exec } = require('child_process'); + * + * exec('"/path/to/test file/test.sh" arg1 arg2'); + * // Double quotes are used so that the space in the path is not interpreted as + * // a delimiter of multiple arguments. + * + * exec('echo "The \\$HOME variable is $HOME"'); + * // The $HOME variable is escaped in the first instance, but not in the second. + * ``` + * + * **Never pass unsanitized user input to this function. Any input containing shell** + * **metacharacters may be used to trigger arbitrary command execution.** + * + * If a `callback` function is provided, it is called with the arguments`(error, stdout, stderr)`. On success, `error` will be `null`. On error,`error` will be an instance of `Error`. The + * `error.code` property will be + * the exit code of the process. By convention, any exit code other than `0`indicates an error. `error.signal` will be the signal that terminated the + * process. + * + * The `stdout` and `stderr` arguments passed to the callback will contain the + * stdout and stderr output of the child process. By default, Node.js will decode + * the output as UTF-8 and pass strings to the callback. The `encoding` option + * can be used to specify the character encoding used to decode the stdout and + * stderr output. If `encoding` is `'buffer'`, or an unrecognized character + * encoding, `Buffer` objects will be passed to the callback instead. + * + * ```js + * const { exec } = require('child_process'); + * exec('cat *.js missing_file | wc -l', (error, stdout, stderr) => { + * if (error) { + * console.error(`exec error: ${error}`); + * return; + * } + * console.log(`stdout: ${stdout}`); + * console.error(`stderr: ${stderr}`); + * }); + * ``` + * + * If `timeout` is greater than `0`, the parent will send the signal + * identified by the `killSignal` property (the default is `'SIGTERM'`) if the + * child runs longer than `timeout` milliseconds. + * + * Unlike the [`exec(3)`](http://man7.org/linux/man-pages/man3/exec.3.html) POSIX system call, `child_process.exec()` does not replace + * the existing process and uses a shell to execute the command. + * + * If this method is invoked as its `util.promisify()` ed version, it returns + * a `Promise` for an `Object` with `stdout` and `stderr` properties. The returned`ChildProcess` instance is attached to the `Promise` as a `child` property. In + * case of an error (including any error resulting in an exit code other than 0), a + * rejected promise is returned, with the same `error` object given in the + * callback, but with two additional properties `stdout` and `stderr`. + * + * ```js + * const util = require('util'); + * const exec = util.promisify(require('child_process').exec); + * + * async function lsExample() { + * const { stdout, stderr } = await exec('ls'); + * console.log('stdout:', stdout); + * console.error('stderr:', stderr); + * } + * lsExample(); + * ``` + * + * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except + * the error passed to the callback will be an `AbortError`: + * + * ```js + * const { exec } = require('child_process'); + * const controller = new AbortController(); + * const { signal } = controller; + * const child = exec('grep ssh', { signal }, (error) => { + * console.log(error); // an AbortError + * }); + * controller.abort(); + * ``` + * @since v0.1.90 + * @param command The command to run, with space-separated arguments. + * @param callback called with the output when process terminates. + */ + function exec(command: string, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; + // `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`. + function exec( + command: string, + options: { + encoding: 'buffer' | null; + } & ExecOptions, + callback?: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void + ): ChildProcess; + // `options` with well known `encoding` means stdout/stderr are definitely `string`. + function exec( + command: string, + options: { + encoding: BufferEncoding; + } & ExecOptions, + callback?: (error: ExecException | null, stdout: string, stderr: string) => void + ): ChildProcess; + // `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`. + // There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`. + function exec( + command: string, + options: { + encoding: BufferEncoding; + } & ExecOptions, + callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void + ): ChildProcess; + // `options` without an `encoding` means stdout/stderr are definitely `string`. + function exec(command: string, options: ExecOptions, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; + // fallback if nothing else matches. Worst case is always `string | Buffer`. + function exec( + command: string, + options: (ObjectEncodingOptions & ExecOptions) | undefined | null, + callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void + ): ChildProcess; + interface PromiseWithChild extends Promise { + child: ChildProcess; + } + namespace exec { + function __promisify__(command: string): PromiseWithChild<{ + stdout: string; + stderr: string; + }>; + function __promisify__( + command: string, + options: { + encoding: 'buffer' | null; + } & ExecOptions + ): PromiseWithChild<{ + stdout: Buffer; + stderr: Buffer; + }>; + function __promisify__( + command: string, + options: { + encoding: BufferEncoding; + } & ExecOptions + ): PromiseWithChild<{ + stdout: string; + stderr: string; + }>; + function __promisify__( + command: string, + options: ExecOptions + ): PromiseWithChild<{ + stdout: string; + stderr: string; + }>; + function __promisify__( + command: string, + options?: (ObjectEncodingOptions & ExecOptions) | null + ): PromiseWithChild<{ + stdout: string | Buffer; + stderr: string | Buffer; + }>; + } + interface ExecFileOptions extends CommonOptions, Abortable { + maxBuffer?: number | undefined; + killSignal?: NodeJS.Signals | number | undefined; + windowsVerbatimArguments?: boolean | undefined; + shell?: boolean | string | undefined; + signal?: AbortSignal | undefined; + } + interface ExecFileOptionsWithStringEncoding extends ExecFileOptions { + encoding: BufferEncoding; + } + interface ExecFileOptionsWithBufferEncoding extends ExecFileOptions { + encoding: 'buffer' | null; + } + interface ExecFileOptionsWithOtherEncoding extends ExecFileOptions { + encoding: BufferEncoding; + } + type ExecFileException = ExecException & NodeJS.ErrnoException; + /** + * The `child_process.execFile()` function is similar to {@link exec} except that it does not spawn a shell by default. Rather, the specified + * executable `file` is spawned directly as a new process making it slightly more + * efficient than {@link exec}. + * + * The same options as {@link exec} are supported. Since a shell is + * not spawned, behaviors such as I/O redirection and file globbing are not + * supported. + * + * ```js + * const { execFile } = require('child_process'); + * const child = execFile('node', ['--version'], (error, stdout, stderr) => { + * if (error) { + * throw error; + * } + * console.log(stdout); + * }); + * ``` + * + * The `stdout` and `stderr` arguments passed to the callback will contain the + * stdout and stderr output of the child process. By default, Node.js will decode + * the output as UTF-8 and pass strings to the callback. The `encoding` option + * can be used to specify the character encoding used to decode the stdout and + * stderr output. If `encoding` is `'buffer'`, or an unrecognized character + * encoding, `Buffer` objects will be passed to the callback instead. + * + * If this method is invoked as its `util.promisify()` ed version, it returns + * a `Promise` for an `Object` with `stdout` and `stderr` properties. The returned`ChildProcess` instance is attached to the `Promise` as a `child` property. In + * case of an error (including any error resulting in an exit code other than 0), a + * rejected promise is returned, with the same `error` object given in the + * callback, but with two additional properties `stdout` and `stderr`. + * + * ```js + * const util = require('util'); + * const execFile = util.promisify(require('child_process').execFile); + * async function getVersion() { + * const { stdout } = await execFile('node', ['--version']); + * console.log(stdout); + * } + * getVersion(); + * ``` + * + * **If the `shell` option is enabled, do not pass unsanitized user input to this** + * **function. Any input containing shell metacharacters may be used to trigger** + * **arbitrary command execution.** + * + * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except + * the error passed to the callback will be an `AbortError`: + * + * ```js + * const { execFile } = require('child_process'); + * const controller = new AbortController(); + * const { signal } = controller; + * const child = execFile('node', ['--version'], { signal }, (error) => { + * console.log(error); // an AbortError + * }); + * controller.abort(); + * ``` + * @since v0.1.91 + * @param file The name or path of the executable file to run. + * @param args List of string arguments. + * @param callback Called with the output when process terminates. + */ + function execFile(file: string): ChildProcess; + function execFile(file: string, options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess; + function execFile(file: string, args?: ReadonlyArray | null): ChildProcess; + function execFile(file: string, args: ReadonlyArray | undefined | null, options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess; + // no `options` definitely means stdout/stderr are `string`. + function execFile(file: string, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile(file: string, args: ReadonlyArray | undefined | null, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void): ChildProcess; + // `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`. + function execFile(file: string, options: ExecFileOptionsWithBufferEncoding, callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void): ChildProcess; + function execFile( + file: string, + args: ReadonlyArray | undefined | null, + options: ExecFileOptionsWithBufferEncoding, + callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void + ): ChildProcess; + // `options` with well known `encoding` means stdout/stderr are definitely `string`. + function execFile(file: string, options: ExecFileOptionsWithStringEncoding, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile( + file: string, + args: ReadonlyArray | undefined | null, + options: ExecFileOptionsWithStringEncoding, + callback: (error: ExecFileException | null, stdout: string, stderr: string) => void + ): ChildProcess; + // `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`. + // There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`. + function execFile(file: string, options: ExecFileOptionsWithOtherEncoding, callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void): ChildProcess; + function execFile( + file: string, + args: ReadonlyArray | undefined | null, + options: ExecFileOptionsWithOtherEncoding, + callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void + ): ChildProcess; + // `options` without an `encoding` means stdout/stderr are definitely `string`. + function execFile(file: string, options: ExecFileOptions, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void): ChildProcess; + function execFile( + file: string, + args: ReadonlyArray | undefined | null, + options: ExecFileOptions, + callback: (error: ExecFileException | null, stdout: string, stderr: string) => void + ): ChildProcess; + // fallback if nothing else matches. Worst case is always `string | Buffer`. + function execFile( + file: string, + options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null, + callback: ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null + ): ChildProcess; + function execFile( + file: string, + args: ReadonlyArray | undefined | null, + options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null, + callback: ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null + ): ChildProcess; + namespace execFile { + function __promisify__(file: string): PromiseWithChild<{ + stdout: string; + stderr: string; + }>; + function __promisify__( + file: string, + args: ReadonlyArray | undefined | null + ): PromiseWithChild<{ + stdout: string; + stderr: string; + }>; + function __promisify__( + file: string, + options: ExecFileOptionsWithBufferEncoding + ): PromiseWithChild<{ + stdout: Buffer; + stderr: Buffer; + }>; + function __promisify__( + file: string, + args: ReadonlyArray | undefined | null, + options: ExecFileOptionsWithBufferEncoding + ): PromiseWithChild<{ + stdout: Buffer; + stderr: Buffer; + }>; + function __promisify__( + file: string, + options: ExecFileOptionsWithStringEncoding + ): PromiseWithChild<{ + stdout: string; + stderr: string; + }>; + function __promisify__( + file: string, + args: ReadonlyArray | undefined | null, + options: ExecFileOptionsWithStringEncoding + ): PromiseWithChild<{ + stdout: string; + stderr: string; + }>; + function __promisify__( + file: string, + options: ExecFileOptionsWithOtherEncoding + ): PromiseWithChild<{ + stdout: string | Buffer; + stderr: string | Buffer; + }>; + function __promisify__( + file: string, + args: ReadonlyArray | undefined | null, + options: ExecFileOptionsWithOtherEncoding + ): PromiseWithChild<{ + stdout: string | Buffer; + stderr: string | Buffer; + }>; + function __promisify__( + file: string, + options: ExecFileOptions + ): PromiseWithChild<{ + stdout: string; + stderr: string; + }>; + function __promisify__( + file: string, + args: ReadonlyArray | undefined | null, + options: ExecFileOptions + ): PromiseWithChild<{ + stdout: string; + stderr: string; + }>; + function __promisify__( + file: string, + options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null + ): PromiseWithChild<{ + stdout: string | Buffer; + stderr: string | Buffer; + }>; + function __promisify__( + file: string, + args: ReadonlyArray | undefined | null, + options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null + ): PromiseWithChild<{ + stdout: string | Buffer; + stderr: string | Buffer; + }>; + } + interface ForkOptions extends ProcessEnvOptions, MessagingOptions, Abortable { + execPath?: string | undefined; + execArgv?: string[] | undefined; + silent?: boolean | undefined; + stdio?: StdioOptions | undefined; + detached?: boolean | undefined; + windowsVerbatimArguments?: boolean | undefined; + } + /** + * The `child_process.fork()` method is a special case of {@link spawn} used specifically to spawn new Node.js processes. + * Like {@link spawn}, a `ChildProcess` object is returned. The + * returned `ChildProcess` will have an additional communication channel + * built-in that allows messages to be passed back and forth between the parent and + * child. See `subprocess.send()` for details. + * + * Keep in mind that spawned Node.js child processes are + * independent of the parent with exception of the IPC communication channel + * that is established between the two. Each process has its own memory, with + * their own V8 instances. Because of the additional resource allocations + * required, spawning a large number of child Node.js processes is not + * recommended. + * + * By default, `child_process.fork()` will spawn new Node.js instances using the `process.execPath` of the parent process. The `execPath` property in the`options` object allows for an alternative + * execution path to be used. + * + * Node.js processes launched with a custom `execPath` will communicate with the + * parent process using the file descriptor (fd) identified using the + * environment variable `NODE_CHANNEL_FD` on the child process. + * + * Unlike the [`fork(2)`](http://man7.org/linux/man-pages/man2/fork.2.html) POSIX system call, `child_process.fork()` does not clone the + * current process. + * + * The `shell` option available in {@link spawn} is not supported by`child_process.fork()` and will be ignored if set. + * + * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except + * the error passed to the callback will be an `AbortError`: + * + * ```js + * if (process.argv[2] === 'child') { + * setTimeout(() => { + * console.log(`Hello from ${process.argv[2]}!`); + * }, 1_000); + * } else { + * const { fork } = require('child_process'); + * const controller = new AbortController(); + * const { signal } = controller; + * const child = fork(__filename, ['child'], { signal }); + * child.on('error', (err) => { + * // This will be called with err being an AbortError if the controller aborts + * }); + * controller.abort(); // Stops the child process + * } + * ``` + * @since v0.5.0 + * @param modulePath The module to run in the child. + * @param args List of string arguments. + */ + function fork(modulePath: string, options?: ForkOptions): ChildProcess; + function fork(modulePath: string, args?: ReadonlyArray, options?: ForkOptions): ChildProcess; + interface SpawnSyncOptions extends CommonSpawnOptions { + input?: string | NodeJS.ArrayBufferView | undefined; + maxBuffer?: number | undefined; + encoding?: BufferEncoding | 'buffer' | null | undefined; + } + interface SpawnSyncOptionsWithStringEncoding extends SpawnSyncOptions { + encoding: BufferEncoding; + } + interface SpawnSyncOptionsWithBufferEncoding extends SpawnSyncOptions { + encoding?: 'buffer' | null | undefined; + } + interface SpawnSyncReturns { + pid: number; + output: Array; + stdout: T; + stderr: T; + status: number | null; + signal: NodeJS.Signals | null; + error?: Error | undefined; + } + /** + * The `child_process.spawnSync()` method is generally identical to {@link spawn} with the exception that the function will not return + * until the child process has fully closed. When a timeout has been encountered + * and `killSignal` is sent, the method won't return until the process has + * completely exited. If the process intercepts and handles the `SIGTERM` signal + * and doesn't exit, the parent process will wait until the child process has + * exited. + * + * **If the `shell` option is enabled, do not pass unsanitized user input to this** + * **function. Any input containing shell metacharacters may be used to trigger** + * **arbitrary command execution.** + * @since v0.11.12 + * @param command The command to run. + * @param args List of string arguments. + */ + function spawnSync(command: string): SpawnSyncReturns; + function spawnSync(command: string, options: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns; + function spawnSync(command: string, options: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns; + function spawnSync(command: string, options?: SpawnSyncOptions): SpawnSyncReturns; + function spawnSync(command: string, args: ReadonlyArray): SpawnSyncReturns; + function spawnSync(command: string, args: ReadonlyArray, options: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns; + function spawnSync(command: string, args: ReadonlyArray, options: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns; + function spawnSync(command: string, args?: ReadonlyArray, options?: SpawnSyncOptions): SpawnSyncReturns; + interface CommonExecOptions extends CommonOptions { + input?: string | NodeJS.ArrayBufferView | undefined; + stdio?: StdioOptions | undefined; + killSignal?: NodeJS.Signals | number | undefined; + maxBuffer?: number | undefined; + encoding?: BufferEncoding | 'buffer' | null | undefined; + } + interface ExecSyncOptions extends CommonExecOptions { + shell?: string | undefined; + } + interface ExecSyncOptionsWithStringEncoding extends ExecSyncOptions { + encoding: BufferEncoding; + } + interface ExecSyncOptionsWithBufferEncoding extends ExecSyncOptions { + encoding?: 'buffer' | null | undefined; + } + /** + * The `child_process.execSync()` method is generally identical to {@link exec} with the exception that the method will not return + * until the child process has fully closed. When a timeout has been encountered + * and `killSignal` is sent, the method won't return until the process has + * completely exited. If the child process intercepts and handles the `SIGTERM`signal and doesn't exit, the parent process will wait until the child process + * has exited. + * + * If the process times out or has a non-zero exit code, this method will throw. + * The `Error` object will contain the entire result from {@link spawnSync}. + * + * **Never pass unsanitized user input to this function. Any input containing shell** + * **metacharacters may be used to trigger arbitrary command execution.** + * @since v0.11.12 + * @param command The command to run. + * @return The stdout from the command. + */ + function execSync(command: string): Buffer; + function execSync(command: string, options: ExecSyncOptionsWithStringEncoding): string; + function execSync(command: string, options: ExecSyncOptionsWithBufferEncoding): Buffer; + function execSync(command: string, options?: ExecSyncOptions): string | Buffer; + interface ExecFileSyncOptions extends CommonExecOptions { + shell?: boolean | string | undefined; + } + interface ExecFileSyncOptionsWithStringEncoding extends ExecFileSyncOptions { + encoding: BufferEncoding; + } + interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions { + encoding?: 'buffer' | null; // specify `null`. + } + /** + * The `child_process.execFileSync()` method is generally identical to {@link execFile} with the exception that the method will not + * return until the child process has fully closed. When a timeout has been + * encountered and `killSignal` is sent, the method won't return until the process + * has completely exited. + * + * If the child process intercepts and handles the `SIGTERM` signal and + * does not exit, the parent process will still wait until the child process has + * exited. + * + * If the process times out or has a non-zero exit code, this method will throw an `Error` that will include the full result of the underlying {@link spawnSync}. + * + * **If the `shell` option is enabled, do not pass unsanitized user input to this** + * **function. Any input containing shell metacharacters may be used to trigger** + * **arbitrary command execution.** + * @since v0.11.12 + * @param file The name or path of the executable file to run. + * @param args List of string arguments. + * @return The stdout from the command. + */ + function execFileSync(file: string): Buffer; + function execFileSync(file: string, options: ExecFileSyncOptionsWithStringEncoding): string; + function execFileSync(file: string, options: ExecFileSyncOptionsWithBufferEncoding): Buffer; + function execFileSync(file: string, options?: ExecFileSyncOptions): string | Buffer; + function execFileSync(file: string, args: ReadonlyArray): Buffer; + function execFileSync(file: string, args: ReadonlyArray, options: ExecFileSyncOptionsWithStringEncoding): string; + function execFileSync(file: string, args: ReadonlyArray, options: ExecFileSyncOptionsWithBufferEncoding): Buffer; + function execFileSync(file: string, args?: ReadonlyArray, options?: ExecFileSyncOptions): string | Buffer; +} +declare module 'node:child_process' { + export * from 'child_process'; +} diff --git a/node_modules/@types/node/cluster.d.ts b/node_modules/@types/node/cluster.d.ts new file mode 100755 index 00000000..7f161410 --- /dev/null +++ b/node_modules/@types/node/cluster.d.ts @@ -0,0 +1,414 @@ +/** + * A single instance of Node.js runs in a single thread. To take advantage of + * multi-core systems, the user will sometimes want to launch a cluster of Node.js + * processes to handle the load. + * + * The cluster module allows easy creation of child processes that all share + * server ports. + * + * ```js + * import cluster from 'cluster'; + * import http from 'http'; + * import { cpus } from 'os'; + * import process from 'process'; + * + * const numCPUs = cpus().length; + * + * if (cluster.isPrimary) { + * console.log(`Primary ${process.pid} is running`); + * + * // Fork workers. + * for (let i = 0; i < numCPUs; i++) { + * cluster.fork(); + * } + * + * cluster.on('exit', (worker, code, signal) => { + * console.log(`worker ${worker.process.pid} died`); + * }); + * } else { + * // Workers can share any TCP connection + * // In this case it is an HTTP server + * http.createServer((req, res) => { + * res.writeHead(200); + * res.end('hello world\n'); + * }).listen(8000); + * + * console.log(`Worker ${process.pid} started`); + * } + * ``` + * + * Running Node.js will now share port 8000 between the workers: + * + * ```console + * $ node server.js + * Primary 3596 is running + * Worker 4324 started + * Worker 4520 started + * Worker 6056 started + * Worker 5644 started + * ``` + * + * On Windows, it is not yet possible to set up a named pipe server in a worker. + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/cluster.js) + */ +declare module 'cluster' { + import * as child from 'node:child_process'; + import EventEmitter = require('node:events'); + import * as net from 'node:net'; + export interface ClusterSettings { + execArgv?: string[] | undefined; // default: process.execArgv + exec?: string | undefined; + args?: string[] | undefined; + silent?: boolean | undefined; + stdio?: any[] | undefined; + uid?: number | undefined; + gid?: number | undefined; + inspectPort?: number | (() => number) | undefined; + } + export interface Address { + address: string; + port: number; + addressType: number | 'udp4' | 'udp6'; // 4, 6, -1, "udp4", "udp6" + } + /** + * A `Worker` object contains all public information and method about a worker. + * In the primary it can be obtained using `cluster.workers`. In a worker + * it can be obtained using `cluster.worker`. + * @since v0.7.0 + */ + export class Worker extends EventEmitter { + /** + * Each new worker is given its own unique id, this id is stored in the`id`. + * + * While a worker is alive, this is the key that indexes it in`cluster.workers`. + * @since v0.8.0 + */ + id: number; + /** + * All workers are created using `child_process.fork()`, the returned object + * from this function is stored as `.process`. In a worker, the global `process`is stored. + * + * See: `Child Process module`. + * + * Workers will call `process.exit(0)` if the `'disconnect'` event occurs + * on `process` and `.exitedAfterDisconnect` is not `true`. This protects against + * accidental disconnection. + * @since v0.7.0 + */ + process: child.ChildProcess; + /** + * Send a message to a worker or primary, optionally with a handle. + * + * In the primary this sends a message to a specific worker. It is identical to `ChildProcess.send()`. + * + * In a worker this sends a message to the primary. It is identical to`process.send()`. + * + * This example will echo back all messages from the primary: + * + * ```js + * if (cluster.isPrimary) { + * const worker = cluster.fork(); + * worker.send('hi there'); + * + * } else if (cluster.isWorker) { + * process.on('message', (msg) => { + * process.send(msg); + * }); + * } + * ``` + * @since v0.7.0 + * @param options The `options` argument, if present, is an object used to parameterize the sending of certain types of handles. `options` supports the following properties: + */ + send(message: child.Serializable, callback?: (error: Error | null) => void): boolean; + send(message: child.Serializable, sendHandle: child.SendHandle, callback?: (error: Error | null) => void): boolean; + send(message: child.Serializable, sendHandle: child.SendHandle, options?: child.MessageOptions, callback?: (error: Error | null) => void): boolean; + /** + * This function will kill the worker. In the primary, it does this + * by disconnecting the `worker.process`, and once disconnected, killing + * with `signal`. In the worker, it does it by disconnecting the channel, + * and then exiting with code `0`. + * + * Because `kill()` attempts to gracefully disconnect the worker process, it is + * susceptible to waiting indefinitely for the disconnect to complete. For example, + * if the worker enters an infinite loop, a graceful disconnect will never occur. + * If the graceful disconnect behavior is not needed, use `worker.process.kill()`. + * + * Causes `.exitedAfterDisconnect` to be set. + * + * This method is aliased as `worker.destroy()` for backward compatibility. + * + * In a worker, `process.kill()` exists, but it is not this function; + * it is `kill()`. + * @since v0.9.12 + * @param [signal='SIGTERM'] Name of the kill signal to send to the worker process. + */ + kill(signal?: string): void; + destroy(signal?: string): void; + /** + * In a worker, this function will close all servers, wait for the `'close'` event + * on those servers, and then disconnect the IPC channel. + * + * In the primary, an internal message is sent to the worker causing it to call`.disconnect()` on itself. + * + * Causes `.exitedAfterDisconnect` to be set. + * + * After a server is closed, it will no longer accept new connections, + * but connections may be accepted by any other listening worker. Existing + * connections will be allowed to close as usual. When no more connections exist, + * see `server.close()`, the IPC channel to the worker will close allowing it + * to die gracefully. + * + * The above applies _only_ to server connections, client connections are not + * automatically closed by workers, and disconnect does not wait for them to close + * before exiting. + * + * In a worker, `process.disconnect` exists, but it is not this function; + * it is `disconnect()`. + * + * Because long living server connections may block workers from disconnecting, it + * may be useful to send a message, so application specific actions may be taken to + * close them. It also may be useful to implement a timeout, killing a worker if + * the `'disconnect'` event has not been emitted after some time. + * + * ```js + * if (cluster.isPrimary) { + * const worker = cluster.fork(); + * let timeout; + * + * worker.on('listening', (address) => { + * worker.send('shutdown'); + * worker.disconnect(); + * timeout = setTimeout(() => { + * worker.kill(); + * }, 2000); + * }); + * + * worker.on('disconnect', () => { + * clearTimeout(timeout); + * }); + * + * } else if (cluster.isWorker) { + * const net = require('net'); + * const server = net.createServer((socket) => { + * // Connections never end + * }); + * + * server.listen(8000); + * + * process.on('message', (msg) => { + * if (msg === 'shutdown') { + * // Initiate graceful close of any connections to server + * } + * }); + * } + * ``` + * @since v0.7.7 + * @return A reference to `worker`. + */ + disconnect(): void; + /** + * This function returns `true` if the worker is connected to its primary via its + * IPC channel, `false` otherwise. A worker is connected to its primary after it + * has been created. It is disconnected after the `'disconnect'` event is emitted. + * @since v0.11.14 + */ + isConnected(): boolean; + /** + * This function returns `true` if the worker's process has terminated (either + * because of exiting or being signaled). Otherwise, it returns `false`. + * + * ```js + * import cluster from 'cluster'; + * import http from 'http'; + * import { cpus } from 'os'; + * import process from 'process'; + * + * const numCPUs = cpus().length; + * + * if (cluster.isPrimary) { + * console.log(`Primary ${process.pid} is running`); + * + * // Fork workers. + * for (let i = 0; i < numCPUs; i++) { + * cluster.fork(); + * } + * + * cluster.on('fork', (worker) => { + * console.log('worker is dead:', worker.isDead()); + * }); + * + * cluster.on('exit', (worker, code, signal) => { + * console.log('worker is dead:', worker.isDead()); + * }); + * } else { + * // Workers can share any TCP connection. In this case, it is an HTTP server. + * http.createServer((req, res) => { + * res.writeHead(200); + * res.end(`Current process\n ${process.pid}`); + * process.kill(process.pid); + * }).listen(8000); + * } + * ``` + * @since v0.11.14 + */ + isDead(): boolean; + /** + * This property is `true` if the worker exited due to `.kill()` or`.disconnect()`. If the worker exited any other way, it is `false`. If the + * worker has not exited, it is `undefined`. + * + * The boolean `worker.exitedAfterDisconnect` allows distinguishing between + * voluntary and accidental exit, the primary may choose not to respawn a worker + * based on this value. + * + * ```js + * cluster.on('exit', (worker, code, signal) => { + * if (worker.exitedAfterDisconnect === true) { + * console.log('Oh, it was just voluntary – no need to worry'); + * } + * }); + * + * // kill worker + * worker.kill(); + * ``` + * @since v6.0.0 + */ + exitedAfterDisconnect: boolean; + /** + * events.EventEmitter + * 1. disconnect + * 2. error + * 3. exit + * 4. listening + * 5. message + * 6. online + */ + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'disconnect', listener: () => void): this; + addListener(event: 'error', listener: (error: Error) => void): this; + addListener(event: 'exit', listener: (code: number, signal: string) => void): this; + addListener(event: 'listening', listener: (address: Address) => void): this; + addListener(event: 'message', listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + addListener(event: 'online', listener: () => void): this; + emit(event: string | symbol, ...args: any[]): boolean; + emit(event: 'disconnect'): boolean; + emit(event: 'error', error: Error): boolean; + emit(event: 'exit', code: number, signal: string): boolean; + emit(event: 'listening', address: Address): boolean; + emit(event: 'message', message: any, handle: net.Socket | net.Server): boolean; + emit(event: 'online'): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'disconnect', listener: () => void): this; + on(event: 'error', listener: (error: Error) => void): this; + on(event: 'exit', listener: (code: number, signal: string) => void): this; + on(event: 'listening', listener: (address: Address) => void): this; + on(event: 'message', listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + on(event: 'online', listener: () => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'disconnect', listener: () => void): this; + once(event: 'error', listener: (error: Error) => void): this; + once(event: 'exit', listener: (code: number, signal: string) => void): this; + once(event: 'listening', listener: (address: Address) => void): this; + once(event: 'message', listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + once(event: 'online', listener: () => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'disconnect', listener: () => void): this; + prependListener(event: 'error', listener: (error: Error) => void): this; + prependListener(event: 'exit', listener: (code: number, signal: string) => void): this; + prependListener(event: 'listening', listener: (address: Address) => void): this; + prependListener(event: 'message', listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + prependListener(event: 'online', listener: () => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'disconnect', listener: () => void): this; + prependOnceListener(event: 'error', listener: (error: Error) => void): this; + prependOnceListener(event: 'exit', listener: (code: number, signal: string) => void): this; + prependOnceListener(event: 'listening', listener: (address: Address) => void): this; + prependOnceListener(event: 'message', listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + prependOnceListener(event: 'online', listener: () => void): this; + } + export interface Cluster extends EventEmitter { + disconnect(callback?: () => void): void; + fork(env?: any): Worker; + /** @deprecated since v16.0.0 - use isPrimary. */ + readonly isMaster: boolean; + readonly isPrimary: boolean; + readonly isWorker: boolean; + schedulingPolicy: number; + readonly settings: ClusterSettings; + /** @deprecated since v16.0.0 - use setupPrimary. */ + setupMaster(settings?: ClusterSettings): void; + /** + * `setupPrimary` is used to change the default 'fork' behavior. Once called, the settings will be present in cluster.settings. + */ + setupPrimary(settings?: ClusterSettings): void; + readonly worker?: Worker | undefined; + readonly workers?: NodeJS.Dict | undefined; + readonly SCHED_NONE: number; + readonly SCHED_RR: number; + /** + * events.EventEmitter + * 1. disconnect + * 2. exit + * 3. fork + * 4. listening + * 5. message + * 6. online + * 7. setup + */ + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'disconnect', listener: (worker: Worker) => void): this; + addListener(event: 'exit', listener: (worker: Worker, code: number, signal: string) => void): this; + addListener(event: 'fork', listener: (worker: Worker) => void): this; + addListener(event: 'listening', listener: (worker: Worker, address: Address) => void): this; + addListener(event: 'message', listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + addListener(event: 'online', listener: (worker: Worker) => void): this; + addListener(event: 'setup', listener: (settings: ClusterSettings) => void): this; + emit(event: string | symbol, ...args: any[]): boolean; + emit(event: 'disconnect', worker: Worker): boolean; + emit(event: 'exit', worker: Worker, code: number, signal: string): boolean; + emit(event: 'fork', worker: Worker): boolean; + emit(event: 'listening', worker: Worker, address: Address): boolean; + emit(event: 'message', worker: Worker, message: any, handle: net.Socket | net.Server): boolean; + emit(event: 'online', worker: Worker): boolean; + emit(event: 'setup', settings: ClusterSettings): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'disconnect', listener: (worker: Worker) => void): this; + on(event: 'exit', listener: (worker: Worker, code: number, signal: string) => void): this; + on(event: 'fork', listener: (worker: Worker) => void): this; + on(event: 'listening', listener: (worker: Worker, address: Address) => void): this; + on(event: 'message', listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + on(event: 'online', listener: (worker: Worker) => void): this; + on(event: 'setup', listener: (settings: ClusterSettings) => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'disconnect', listener: (worker: Worker) => void): this; + once(event: 'exit', listener: (worker: Worker, code: number, signal: string) => void): this; + once(event: 'fork', listener: (worker: Worker) => void): this; + once(event: 'listening', listener: (worker: Worker, address: Address) => void): this; + once(event: 'message', listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. + once(event: 'online', listener: (worker: Worker) => void): this; + once(event: 'setup', listener: (settings: ClusterSettings) => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'disconnect', listener: (worker: Worker) => void): this; + prependListener(event: 'exit', listener: (worker: Worker, code: number, signal: string) => void): this; + prependListener(event: 'fork', listener: (worker: Worker) => void): this; + prependListener(event: 'listening', listener: (worker: Worker, address: Address) => void): this; + // the handle is a net.Socket or net.Server object, or undefined. + prependListener(event: 'message', listener: (worker: Worker, message: any, handle?: net.Socket | net.Server) => void): this; + prependListener(event: 'online', listener: (worker: Worker) => void): this; + prependListener(event: 'setup', listener: (settings: ClusterSettings) => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'disconnect', listener: (worker: Worker) => void): this; + prependOnceListener(event: 'exit', listener: (worker: Worker, code: number, signal: string) => void): this; + prependOnceListener(event: 'fork', listener: (worker: Worker) => void): this; + prependOnceListener(event: 'listening', listener: (worker: Worker, address: Address) => void): this; + // the handle is a net.Socket or net.Server object, or undefined. + prependOnceListener(event: 'message', listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; + prependOnceListener(event: 'online', listener: (worker: Worker) => void): this; + prependOnceListener(event: 'setup', listener: (settings: ClusterSettings) => void): this; + } + const cluster: Cluster; + export default cluster; +} +declare module 'node:cluster' { + export * from 'cluster'; + export { default as default } from 'cluster'; +} diff --git a/node_modules/@types/node/console.d.ts b/node_modules/@types/node/console.d.ts new file mode 100755 index 00000000..ede7a53f --- /dev/null +++ b/node_modules/@types/node/console.d.ts @@ -0,0 +1,412 @@ +/** + * The `console` module provides a simple debugging console that is similar to the + * JavaScript console mechanism provided by web browsers. + * + * The module exports two specific components: + * + * * A `Console` class with methods such as `console.log()`, `console.error()` and`console.warn()` that can be used to write to any Node.js stream. + * * A global `console` instance configured to write to `process.stdout` and `process.stderr`. The global `console` can be used without calling`require('console')`. + * + * _**Warning**_: The global console object's methods are neither consistently + * synchronous like the browser APIs they resemble, nor are they consistently + * asynchronous like all other Node.js streams. See the `note on process I/O` for + * more information. + * + * Example using the global `console`: + * + * ```js + * console.log('hello world'); + * // Prints: hello world, to stdout + * console.log('hello %s', 'world'); + * // Prints: hello world, to stdout + * console.error(new Error('Whoops, something bad happened')); + * // Prints error message and stack trace to stderr: + * // Error: Whoops, something bad happened + * // at [eval]:5:15 + * // at Script.runInThisContext (node:vm:132:18) + * // at Object.runInThisContext (node:vm:309:38) + * // at node:internal/process/execution:77:19 + * // at [eval]-wrapper:6:22 + * // at evalScript (node:internal/process/execution:76:60) + * // at node:internal/main/eval_string:23:3 + * + * const name = 'Will Robinson'; + * console.warn(`Danger ${name}! Danger!`); + * // Prints: Danger Will Robinson! Danger!, to stderr + * ``` + * + * Example using the `Console` class: + * + * ```js + * const out = getStreamSomehow(); + * const err = getStreamSomehow(); + * const myConsole = new console.Console(out, err); + * + * myConsole.log('hello world'); + * // Prints: hello world, to out + * myConsole.log('hello %s', 'world'); + * // Prints: hello world, to out + * myConsole.error(new Error('Whoops, something bad happened')); + * // Prints: [Error: Whoops, something bad happened], to err + * + * const name = 'Will Robinson'; + * myConsole.warn(`Danger ${name}! Danger!`); + * // Prints: Danger Will Robinson! Danger!, to err + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/console.js) + */ +declare module 'console' { + import console = require('node:console'); + export = console; +} +declare module 'node:console' { + import { InspectOptions } from 'node:util'; + global { + // This needs to be global to avoid TS2403 in case lib.dom.d.ts is present in the same build + interface Console { + Console: console.ConsoleConstructor; + /** + * `console.assert()` writes a message if `value` is [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy) or omitted. It only + * writes a message and does not otherwise affect execution. The output always + * starts with `"Assertion failed"`. If provided, `message` is formatted using `util.format()`. + * + * If `value` is [truthy](https://developer.mozilla.org/en-US/docs/Glossary/Truthy), nothing happens. + * + * ```js + * console.assert(true, 'does nothing'); + * + * console.assert(false, 'Whoops %s work', 'didn\'t'); + * // Assertion failed: Whoops didn't work + * + * console.assert(); + * // Assertion failed + * ``` + * @since v0.1.101 + * @param value The value tested for being truthy. + * @param message All arguments besides `value` are used as error message. + */ + assert(value: any, message?: string, ...optionalParams: any[]): void; + /** + * When `stdout` is a TTY, calling `console.clear()` will attempt to clear the + * TTY. When `stdout` is not a TTY, this method does nothing. + * + * The specific operation of `console.clear()` can vary across operating systems + * and terminal types. For most Linux operating systems, `console.clear()`operates similarly to the `clear` shell command. On Windows, `console.clear()`will clear only the output in the + * current terminal viewport for the Node.js + * binary. + * @since v8.3.0 + */ + clear(): void; + /** + * Maintains an internal counter specific to `label` and outputs to `stdout` the + * number of times `console.count()` has been called with the given `label`. + * + * ```js + * > console.count() + * default: 1 + * undefined + * > console.count('default') + * default: 2 + * undefined + * > console.count('abc') + * abc: 1 + * undefined + * > console.count('xyz') + * xyz: 1 + * undefined + * > console.count('abc') + * abc: 2 + * undefined + * > console.count() + * default: 3 + * undefined + * > + * ``` + * @since v8.3.0 + * @param label The display label for the counter. + */ + count(label?: string): void; + /** + * Resets the internal counter specific to `label`. + * + * ```js + * > console.count('abc'); + * abc: 1 + * undefined + * > console.countReset('abc'); + * undefined + * > console.count('abc'); + * abc: 1 + * undefined + * > + * ``` + * @since v8.3.0 + * @param label The display label for the counter. + */ + countReset(label?: string): void; + /** + * The `console.debug()` function is an alias for {@link log}. + * @since v8.0.0 + */ + debug(message?: any, ...optionalParams: any[]): void; + /** + * Uses `util.inspect()` on `obj` and prints the resulting string to `stdout`. + * This function bypasses any custom `inspect()` function defined on `obj`. + * @since v0.1.101 + */ + dir(obj: any, options?: InspectOptions): void; + /** + * This method calls `console.log()` passing it the arguments received. + * This method does not produce any XML formatting. + * @since v8.0.0 + */ + dirxml(...data: any[]): void; + /** + * Prints to `stderr` with newline. Multiple arguments can be passed, with the + * first used as the primary message and all additional used as substitution + * values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html) (the arguments are all passed to `util.format()`). + * + * ```js + * const code = 5; + * console.error('error #%d', code); + * // Prints: error #5, to stderr + * console.error('error', code); + * // Prints: error 5, to stderr + * ``` + * + * If formatting elements (e.g. `%d`) are not found in the first string then `util.inspect()` is called on each argument and the resulting string + * values are concatenated. See `util.format()` for more information. + * @since v0.1.100 + */ + error(message?: any, ...optionalParams: any[]): void; + /** + * Increases indentation of subsequent lines by spaces for `groupIndentation`length. + * + * If one or more `label`s are provided, those are printed first without the + * additional indentation. + * @since v8.5.0 + */ + group(...label: any[]): void; + /** + * An alias for {@link group}. + * @since v8.5.0 + */ + groupCollapsed(...label: any[]): void; + /** + * Decreases indentation of subsequent lines by spaces for `groupIndentation`length. + * @since v8.5.0 + */ + groupEnd(): void; + /** + * The `console.info()` function is an alias for {@link log}. + * @since v0.1.100 + */ + info(message?: any, ...optionalParams: any[]): void; + /** + * Prints to `stdout` with newline. Multiple arguments can be passed, with the + * first used as the primary message and all additional used as substitution + * values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html) (the arguments are all passed to `util.format()`). + * + * ```js + * const count = 5; + * console.log('count: %d', count); + * // Prints: count: 5, to stdout + * console.log('count:', count); + * // Prints: count: 5, to stdout + * ``` + * + * See `util.format()` for more information. + * @since v0.1.100 + */ + log(message?: any, ...optionalParams: any[]): void; + /** + * Try to construct a table with the columns of the properties of `tabularData`(or use `properties`) and rows of `tabularData` and log it. Falls back to just + * logging the argument if it can’t be parsed as tabular. + * + * ```js + * // These can't be parsed as tabular data + * console.table(Symbol()); + * // Symbol() + * + * console.table(undefined); + * // undefined + * + * console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }]); + * // ┌─────────┬─────┬─────┐ + * // │ (index) │ a │ b │ + * // ├─────────┼─────┼─────┤ + * // │ 0 │ 1 │ 'Y' │ + * // │ 1 │ 'Z' │ 2 │ + * // └─────────┴─────┴─────┘ + * + * console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }], ['a']); + * // ┌─────────┬─────┐ + * // │ (index) │ a │ + * // ├─────────┼─────┤ + * // │ 0 │ 1 │ + * // │ 1 │ 'Z' │ + * // └─────────┴─────┘ + * ``` + * @since v10.0.0 + * @param properties Alternate properties for constructing the table. + */ + table(tabularData: any, properties?: ReadonlyArray): void; + /** + * Starts a timer that can be used to compute the duration of an operation. Timers + * are identified by a unique `label`. Use the same `label` when calling {@link timeEnd} to stop the timer and output the elapsed time in + * suitable time units to `stdout`. For example, if the elapsed + * time is 3869ms, `console.timeEnd()` displays "3.869s". + * @since v0.1.104 + */ + time(label?: string): void; + /** + * Stops a timer that was previously started by calling {@link time} and + * prints the result to `stdout`: + * + * ```js + * console.time('100-elements'); + * for (let i = 0; i < 100; i++) {} + * console.timeEnd('100-elements'); + * // prints 100-elements: 225.438ms + * ``` + * @since v0.1.104 + */ + timeEnd(label?: string): void; + /** + * For a timer that was previously started by calling {@link time}, prints + * the elapsed time and other `data` arguments to `stdout`: + * + * ```js + * console.time('process'); + * const value = expensiveProcess1(); // Returns 42 + * console.timeLog('process', value); + * // Prints "process: 365.227ms 42". + * doExpensiveProcess2(value); + * console.timeEnd('process'); + * ``` + * @since v10.7.0 + */ + timeLog(label?: string, ...data: any[]): void; + /** + * Prints to `stderr` the string `'Trace: '`, followed by the `util.format()` formatted message and stack trace to the current position in the code. + * + * ```js + * console.trace('Show me'); + * // Prints: (stack trace will vary based on where trace is called) + * // Trace: Show me + * // at repl:2:9 + * // at REPLServer.defaultEval (repl.js:248:27) + * // at bound (domain.js:287:14) + * // at REPLServer.runBound [as eval] (domain.js:300:12) + * // at REPLServer. (repl.js:412:12) + * // at emitOne (events.js:82:20) + * // at REPLServer.emit (events.js:169:7) + * // at REPLServer.Interface._onLine (readline.js:210:10) + * // at REPLServer.Interface._line (readline.js:549:8) + * // at REPLServer.Interface._ttyWrite (readline.js:826:14) + * ``` + * @since v0.1.104 + */ + trace(message?: any, ...optionalParams: any[]): void; + /** + * The `console.warn()` function is an alias for {@link error}. + * @since v0.1.100 + */ + warn(message?: any, ...optionalParams: any[]): void; + // --- Inspector mode only --- + /** + * This method does not display anything unless used in the inspector. + * Starts a JavaScript CPU profile with an optional label. + */ + profile(label?: string): void; + /** + * This method does not display anything unless used in the inspector. + * Stops the current JavaScript CPU profiling session if one has been started and prints the report to the Profiles panel of the inspector. + */ + profileEnd(label?: string): void; + /** + * This method does not display anything unless used in the inspector. + * Adds an event with the label `label` to the Timeline panel of the inspector. + */ + timeStamp(label?: string): void; + } + /** + * The `console` module provides a simple debugging console that is similar to the + * JavaScript console mechanism provided by web browsers. + * + * The module exports two specific components: + * + * * A `Console` class with methods such as `console.log()`, `console.error()` and`console.warn()` that can be used to write to any Node.js stream. + * * A global `console` instance configured to write to `process.stdout` and `process.stderr`. The global `console` can be used without calling`require('console')`. + * + * _**Warning**_: The global console object's methods are neither consistently + * synchronous like the browser APIs they resemble, nor are they consistently + * asynchronous like all other Node.js streams. See the `note on process I/O` for + * more information. + * + * Example using the global `console`: + * + * ```js + * console.log('hello world'); + * // Prints: hello world, to stdout + * console.log('hello %s', 'world'); + * // Prints: hello world, to stdout + * console.error(new Error('Whoops, something bad happened')); + * // Prints error message and stack trace to stderr: + * // Error: Whoops, something bad happened + * // at [eval]:5:15 + * // at Script.runInThisContext (node:vm:132:18) + * // at Object.runInThisContext (node:vm:309:38) + * // at node:internal/process/execution:77:19 + * // at [eval]-wrapper:6:22 + * // at evalScript (node:internal/process/execution:76:60) + * // at node:internal/main/eval_string:23:3 + * + * const name = 'Will Robinson'; + * console.warn(`Danger ${name}! Danger!`); + * // Prints: Danger Will Robinson! Danger!, to stderr + * ``` + * + * Example using the `Console` class: + * + * ```js + * const out = getStreamSomehow(); + * const err = getStreamSomehow(); + * const myConsole = new console.Console(out, err); + * + * myConsole.log('hello world'); + * // Prints: hello world, to out + * myConsole.log('hello %s', 'world'); + * // Prints: hello world, to out + * myConsole.error(new Error('Whoops, something bad happened')); + * // Prints: [Error: Whoops, something bad happened], to err + * + * const name = 'Will Robinson'; + * myConsole.warn(`Danger ${name}! Danger!`); + * // Prints: Danger Will Robinson! Danger!, to err + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/console.js) + */ + namespace console { + interface ConsoleConstructorOptions { + stdout: NodeJS.WritableStream; + stderr?: NodeJS.WritableStream | undefined; + ignoreErrors?: boolean | undefined; + colorMode?: boolean | 'auto' | undefined; + inspectOptions?: InspectOptions | undefined; + /** + * Set group indentation + * @default 2 + */ + groupIndentation?: number | undefined; + } + interface ConsoleConstructor { + prototype: Console; + new (stdout: NodeJS.WritableStream, stderr?: NodeJS.WritableStream, ignoreErrors?: boolean): Console; + new (options: ConsoleConstructorOptions): Console; + } + } + var console: Console; + } + export = globalThis.console; +} diff --git a/node_modules/@types/node/constants.d.ts b/node_modules/@types/node/constants.d.ts new file mode 100755 index 00000000..208020dc --- /dev/null +++ b/node_modules/@types/node/constants.d.ts @@ -0,0 +1,18 @@ +/** @deprecated since v6.3.0 - use constants property exposed by the relevant module instead. */ +declare module 'constants' { + import { constants as osConstants, SignalConstants } from 'node:os'; + import { constants as cryptoConstants } from 'node:crypto'; + import { constants as fsConstants } from 'node:fs'; + + const exp: typeof osConstants.errno & + typeof osConstants.priority & + SignalConstants & + typeof cryptoConstants & + typeof fsConstants; + export = exp; +} + +declare module 'node:constants' { + import constants = require('constants'); + export = constants; +} diff --git a/node_modules/@types/node/crypto.d.ts b/node_modules/@types/node/crypto.d.ts new file mode 100755 index 00000000..a896ae71 --- /dev/null +++ b/node_modules/@types/node/crypto.d.ts @@ -0,0 +1,3307 @@ +/** + * The `crypto` module provides cryptographic functionality that includes a set of + * wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign, and verify functions. + * + * ```js + * const { createHmac } = await import('crypto'); + * + * const secret = 'abcdefg'; + * const hash = createHmac('sha256', secret) + * .update('I love cupcakes') + * .digest('hex'); + * console.log(hash); + * // Prints: + * // c0fa1bc00531bd78ef38c628449c5102aeabd49b5dc3a2a516ea6ea959d6658e + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/crypto.js) + */ +declare module 'crypto' { + import * as stream from 'node:stream'; + import { PeerCertificate } from 'node:tls'; + interface Certificate { + /** + * @deprecated + * @param spkac + * @returns The challenge component of the `spkac` data structure, + * which includes a public key and a challenge. + */ + exportChallenge(spkac: BinaryLike): Buffer; + /** + * @deprecated + * @param spkac + * @param encoding The encoding of the spkac string. + * @returns The public key component of the `spkac` data structure, + * which includes a public key and a challenge. + */ + exportPublicKey(spkac: BinaryLike, encoding?: string): Buffer; + /** + * @deprecated + * @param spkac + * @returns `true` if the given `spkac` data structure is valid, + * `false` otherwise. + */ + verifySpkac(spkac: NodeJS.ArrayBufferView): boolean; + } + const Certificate: Certificate & { + /** @deprecated since v14.9.0 - Use static methods of `crypto.Certificate` instead. */ + new (): Certificate; + /** @deprecated since v14.9.0 - Use static methods of `crypto.Certificate` instead. */ + (): Certificate; + /** + * @param spkac + * @returns The challenge component of the `spkac` data structure, + * which includes a public key and a challenge. + */ + exportChallenge(spkac: BinaryLike): Buffer; + /** + * @param spkac + * @param encoding The encoding of the spkac string. + * @returns The public key component of the `spkac` data structure, + * which includes a public key and a challenge. + */ + exportPublicKey(spkac: BinaryLike, encoding?: string): Buffer; + /** + * @param spkac + * @returns `true` if the given `spkac` data structure is valid, + * `false` otherwise. + */ + verifySpkac(spkac: NodeJS.ArrayBufferView): boolean; + }; + namespace constants { + // https://nodejs.org/dist/latest-v10.x/docs/api/crypto.html#crypto_crypto_constants + const OPENSSL_VERSION_NUMBER: number; + /** Applies multiple bug workarounds within OpenSSL. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html for detail. */ + const SSL_OP_ALL: number; + /** Allows legacy insecure renegotiation between OpenSSL and unpatched clients or servers. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html. */ + const SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number; + /** Attempts to use the server's preferences instead of the client's when selecting a cipher. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html. */ + const SSL_OP_CIPHER_SERVER_PREFERENCE: number; + /** Instructs OpenSSL to use Cisco's "speshul" version of DTLS_BAD_VER. */ + const SSL_OP_CISCO_ANYCONNECT: number; + /** Instructs OpenSSL to turn on cookie exchange. */ + const SSL_OP_COOKIE_EXCHANGE: number; + /** Instructs OpenSSL to add server-hello extension from an early version of the cryptopro draft. */ + const SSL_OP_CRYPTOPRO_TLSEXT_BUG: number; + /** Instructs OpenSSL to disable a SSL 3.0/TLS 1.0 vulnerability workaround added in OpenSSL 0.9.6d. */ + const SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number; + /** Instructs OpenSSL to always use the tmp_rsa key when performing RSA operations. */ + const SSL_OP_EPHEMERAL_RSA: number; + /** Allows initial connection to servers that do not support RI. */ + const SSL_OP_LEGACY_SERVER_CONNECT: number; + const SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number; + const SSL_OP_MICROSOFT_SESS_ID_BUG: number; + /** Instructs OpenSSL to disable the workaround for a man-in-the-middle protocol-version vulnerability in the SSL 2.0 server implementation. */ + const SSL_OP_MSIE_SSLV2_RSA_PADDING: number; + const SSL_OP_NETSCAPE_CA_DN_BUG: number; + const SSL_OP_NETSCAPE_CHALLENGE_BUG: number; + const SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number; + const SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number; + /** Instructs OpenSSL to disable support for SSL/TLS compression. */ + const SSL_OP_NO_COMPRESSION: number; + const SSL_OP_NO_QUERY_MTU: number; + /** Instructs OpenSSL to always start a new session when performing renegotiation. */ + const SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number; + const SSL_OP_NO_SSLv2: number; + const SSL_OP_NO_SSLv3: number; + const SSL_OP_NO_TICKET: number; + const SSL_OP_NO_TLSv1: number; + const SSL_OP_NO_TLSv1_1: number; + const SSL_OP_NO_TLSv1_2: number; + const SSL_OP_PKCS1_CHECK_1: number; + const SSL_OP_PKCS1_CHECK_2: number; + /** Instructs OpenSSL to always create a new key when using temporary/ephemeral DH parameters. */ + const SSL_OP_SINGLE_DH_USE: number; + /** Instructs OpenSSL to always create a new key when using temporary/ephemeral ECDH parameters. */ + const SSL_OP_SINGLE_ECDH_USE: number; + const SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number; + const SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number; + const SSL_OP_TLS_BLOCK_PADDING_BUG: number; + const SSL_OP_TLS_D5_BUG: number; + /** Instructs OpenSSL to disable version rollback attack detection. */ + const SSL_OP_TLS_ROLLBACK_BUG: number; + const ENGINE_METHOD_RSA: number; + const ENGINE_METHOD_DSA: number; + const ENGINE_METHOD_DH: number; + const ENGINE_METHOD_RAND: number; + const ENGINE_METHOD_EC: number; + const ENGINE_METHOD_CIPHERS: number; + const ENGINE_METHOD_DIGESTS: number; + const ENGINE_METHOD_PKEY_METHS: number; + const ENGINE_METHOD_PKEY_ASN1_METHS: number; + const ENGINE_METHOD_ALL: number; + const ENGINE_METHOD_NONE: number; + const DH_CHECK_P_NOT_SAFE_PRIME: number; + const DH_CHECK_P_NOT_PRIME: number; + const DH_UNABLE_TO_CHECK_GENERATOR: number; + const DH_NOT_SUITABLE_GENERATOR: number; + const ALPN_ENABLED: number; + const RSA_PKCS1_PADDING: number; + const RSA_SSLV23_PADDING: number; + const RSA_NO_PADDING: number; + const RSA_PKCS1_OAEP_PADDING: number; + const RSA_X931_PADDING: number; + const RSA_PKCS1_PSS_PADDING: number; + /** Sets the salt length for RSA_PKCS1_PSS_PADDING to the digest size when signing or verifying. */ + const RSA_PSS_SALTLEN_DIGEST: number; + /** Sets the salt length for RSA_PKCS1_PSS_PADDING to the maximum permissible value when signing data. */ + const RSA_PSS_SALTLEN_MAX_SIGN: number; + /** Causes the salt length for RSA_PKCS1_PSS_PADDING to be determined automatically when verifying a signature. */ + const RSA_PSS_SALTLEN_AUTO: number; + const POINT_CONVERSION_COMPRESSED: number; + const POINT_CONVERSION_UNCOMPRESSED: number; + const POINT_CONVERSION_HYBRID: number; + /** Specifies the built-in default cipher list used by Node.js (colon-separated values). */ + const defaultCoreCipherList: string; + /** Specifies the active default cipher list used by the current Node.js process (colon-separated values). */ + const defaultCipherList: string; + } + interface HashOptions extends stream.TransformOptions { + /** + * For XOF hash functions such as `shake256`, the + * outputLength option can be used to specify the desired output length in bytes. + */ + outputLength?: number | undefined; + } + /** @deprecated since v10.0.0 */ + const fips: boolean; + /** + * Creates and returns a `Hash` object that can be used to generate hash digests + * using the given `algorithm`. Optional `options` argument controls stream + * behavior. For XOF hash functions such as `'shake256'`, the `outputLength` option + * can be used to specify the desired output length in bytes. + * + * The `algorithm` is dependent on the available algorithms supported by the + * version of OpenSSL on the platform. Examples are `'sha256'`, `'sha512'`, etc. + * On recent releases of OpenSSL, `openssl list -digest-algorithms`(`openssl list-message-digest-algorithms` for older versions of OpenSSL) will + * display the available digest algorithms. + * + * Example: generating the sha256 sum of a file + * + * ```js + * import { + * createReadStream + * } from 'fs'; + * import { argv } from 'process'; + * const { + * createHash + * } = await import('crypto'); + * + * const filename = argv[2]; + * + * const hash = createHash('sha256'); + * + * const input = createReadStream(filename); + * input.on('readable', () => { + * // Only one element is going to be produced by the + * // hash stream. + * const data = input.read(); + * if (data) + * hash.update(data); + * else { + * console.log(`${hash.digest('hex')} ${filename}`); + * } + * }); + * ``` + * @since v0.1.92 + * @param options `stream.transform` options + */ + function createHash(algorithm: string, options?: HashOptions): Hash; + /** + * Creates and returns an `Hmac` object that uses the given `algorithm` and `key`. + * Optional `options` argument controls stream behavior. + * + * The `algorithm` is dependent on the available algorithms supported by the + * version of OpenSSL on the platform. Examples are `'sha256'`, `'sha512'`, etc. + * On recent releases of OpenSSL, `openssl list -digest-algorithms`(`openssl list-message-digest-algorithms` for older versions of OpenSSL) will + * display the available digest algorithms. + * + * The `key` is the HMAC key used to generate the cryptographic HMAC hash. If it is + * a `KeyObject`, its type must be `secret`. + * + * Example: generating the sha256 HMAC of a file + * + * ```js + * import { + * createReadStream + * } from 'fs'; + * import { argv } from 'process'; + * const { + * createHmac + * } = await import('crypto'); + * + * const filename = argv[2]; + * + * const hmac = createHmac('sha256', 'a secret'); + * + * const input = createReadStream(filename); + * input.on('readable', () => { + * // Only one element is going to be produced by the + * // hash stream. + * const data = input.read(); + * if (data) + * hmac.update(data); + * else { + * console.log(`${hmac.digest('hex')} ${filename}`); + * } + * }); + * ``` + * @since v0.1.94 + * @param options `stream.transform` options + */ + function createHmac(algorithm: string, key: BinaryLike | KeyObject, options?: stream.TransformOptions): Hmac; + // https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings + type BinaryToTextEncoding = 'base64' | 'base64url' | 'hex'; + type CharacterEncoding = 'utf8' | 'utf-8' | 'utf16le' | 'latin1'; + type LegacyCharacterEncoding = 'ascii' | 'binary' | 'ucs2' | 'ucs-2'; + type Encoding = BinaryToTextEncoding | CharacterEncoding | LegacyCharacterEncoding; + type ECDHKeyFormat = 'compressed' | 'uncompressed' | 'hybrid'; + /** + * The `Hash` class is a utility for creating hash digests of data. It can be + * used in one of two ways: + * + * * As a `stream` that is both readable and writable, where data is written + * to produce a computed hash digest on the readable side, or + * * Using the `hash.update()` and `hash.digest()` methods to produce the + * computed hash. + * + * The {@link createHash} method is used to create `Hash` instances. `Hash`objects are not to be created directly using the `new` keyword. + * + * Example: Using `Hash` objects as streams: + * + * ```js + * const { + * createHash + * } = await import('crypto'); + * + * const hash = createHash('sha256'); + * + * hash.on('readable', () => { + * // Only one element is going to be produced by the + * // hash stream. + * const data = hash.read(); + * if (data) { + * console.log(data.toString('hex')); + * // Prints: + * // 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50 + * } + * }); + * + * hash.write('some data to hash'); + * hash.end(); + * ``` + * + * Example: Using `Hash` and piped streams: + * + * ```js + * import { createReadStream } from 'fs'; + * import { stdout } from 'process'; + * const { createHash } = await import('crypto'); + * + * const hash = createHash('sha256'); + * + * const input = createReadStream('test.js'); + * input.pipe(hash).setEncoding('hex').pipe(stdout); + * ``` + * + * Example: Using the `hash.update()` and `hash.digest()` methods: + * + * ```js + * const { + * createHash + * } = await import('crypto'); + * + * const hash = createHash('sha256'); + * + * hash.update('some data to hash'); + * console.log(hash.digest('hex')); + * // Prints: + * // 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50 + * ``` + * @since v0.1.92 + */ + class Hash extends stream.Transform { + private constructor(); + /** + * Creates a new `Hash` object that contains a deep copy of the internal state + * of the current `Hash` object. + * + * The optional `options` argument controls stream behavior. For XOF hash + * functions such as `'shake256'`, the `outputLength` option can be used to + * specify the desired output length in bytes. + * + * An error is thrown when an attempt is made to copy the `Hash` object after + * its `hash.digest()` method has been called. + * + * ```js + * // Calculate a rolling hash. + * const { + * createHash + * } = await import('crypto'); + * + * const hash = createHash('sha256'); + * + * hash.update('one'); + * console.log(hash.copy().digest('hex')); + * + * hash.update('two'); + * console.log(hash.copy().digest('hex')); + * + * hash.update('three'); + * console.log(hash.copy().digest('hex')); + * + * // Etc. + * ``` + * @since v13.1.0 + * @param options `stream.transform` options + */ + copy(options?: stream.TransformOptions): Hash; + /** + * Updates the hash content with the given `data`, the encoding of which + * is given in `inputEncoding`. + * If `encoding` is not provided, and the `data` is a string, an + * encoding of `'utf8'` is enforced. If `data` is a `Buffer`, `TypedArray`, or`DataView`, then `inputEncoding` is ignored. + * + * This can be called many times with new data as it is streamed. + * @since v0.1.92 + * @param inputEncoding The `encoding` of the `data` string. + */ + update(data: BinaryLike): Hash; + update(data: string, inputEncoding: Encoding): Hash; + /** + * Calculates the digest of all of the data passed to be hashed (using the `hash.update()` method). + * If `encoding` is provided a string will be returned; otherwise + * a `Buffer` is returned. + * + * The `Hash` object can not be used again after `hash.digest()` method has been + * called. Multiple calls will cause an error to be thrown. + * @since v0.1.92 + * @param encoding The `encoding` of the return value. + */ + digest(): Buffer; + digest(encoding: BinaryToTextEncoding): string; + } + /** + * The `Hmac` class is a utility for creating cryptographic HMAC digests. It can + * be used in one of two ways: + * + * * As a `stream` that is both readable and writable, where data is written + * to produce a computed HMAC digest on the readable side, or + * * Using the `hmac.update()` and `hmac.digest()` methods to produce the + * computed HMAC digest. + * + * The {@link createHmac} method is used to create `Hmac` instances. `Hmac`objects are not to be created directly using the `new` keyword. + * + * Example: Using `Hmac` objects as streams: + * + * ```js + * const { + * createHmac + * } = await import('crypto'); + * + * const hmac = createHmac('sha256', 'a secret'); + * + * hmac.on('readable', () => { + * // Only one element is going to be produced by the + * // hash stream. + * const data = hmac.read(); + * if (data) { + * console.log(data.toString('hex')); + * // Prints: + * // 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e + * } + * }); + * + * hmac.write('some data to hash'); + * hmac.end(); + * ``` + * + * Example: Using `Hmac` and piped streams: + * + * ```js + * import { createReadStream } from 'fs'; + * import { stdout } from 'process'; + * const { + * createHmac + * } = await import('crypto'); + * + * const hmac = createHmac('sha256', 'a secret'); + * + * const input = createReadStream('test.js'); + * input.pipe(hmac).pipe(stdout); + * ``` + * + * Example: Using the `hmac.update()` and `hmac.digest()` methods: + * + * ```js + * const { + * createHmac + * } = await import('crypto'); + * + * const hmac = createHmac('sha256', 'a secret'); + * + * hmac.update('some data to hash'); + * console.log(hmac.digest('hex')); + * // Prints: + * // 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e + * ``` + * @since v0.1.94 + */ + class Hmac extends stream.Transform { + private constructor(); + /** + * Updates the `Hmac` content with the given `data`, the encoding of which + * is given in `inputEncoding`. + * If `encoding` is not provided, and the `data` is a string, an + * encoding of `'utf8'` is enforced. If `data` is a `Buffer`, `TypedArray`, or`DataView`, then `inputEncoding` is ignored. + * + * This can be called many times with new data as it is streamed. + * @since v0.1.94 + * @param inputEncoding The `encoding` of the `data` string. + */ + update(data: BinaryLike): Hmac; + update(data: string, inputEncoding: Encoding): Hmac; + /** + * Calculates the HMAC digest of all of the data passed using `hmac.update()`. + * If `encoding` is + * provided a string is returned; otherwise a `Buffer` is returned; + * + * The `Hmac` object can not be used again after `hmac.digest()` has been + * called. Multiple calls to `hmac.digest()` will result in an error being thrown. + * @since v0.1.94 + * @param encoding The `encoding` of the return value. + */ + digest(): Buffer; + digest(encoding: BinaryToTextEncoding): string; + } + type KeyObjectType = 'secret' | 'public' | 'private'; + interface KeyExportOptions { + type: 'pkcs1' | 'spki' | 'pkcs8' | 'sec1'; + format: T; + cipher?: string | undefined; + passphrase?: string | Buffer | undefined; + } + interface JwkKeyExportOptions { + format: 'jwk'; + } + interface JsonWebKey { + crv?: string | undefined; + d?: string | undefined; + dp?: string | undefined; + dq?: string | undefined; + e?: string | undefined; + k?: string | undefined; + kty?: string | undefined; + n?: string | undefined; + p?: string | undefined; + q?: string | undefined; + qi?: string | undefined; + x?: string | undefined; + y?: string | undefined; + [key: string]: unknown; + } + interface AsymmetricKeyDetails { + /** + * Key size in bits (RSA, DSA). + */ + modulusLength?: number | undefined; + /** + * Public exponent (RSA). + */ + publicExponent?: bigint | undefined; + /** + * Name of the message digest (RSA-PSS). + */ + hashAlgorithm?: string | undefined; + /** + * Name of the message digest used by MGF1 (RSA-PSS). + */ + mgf1HashAlgorithm?: string | undefined; + /** + * Minimal salt length in bytes (RSA-PSS). + */ + saltLength?: number | undefined; + /** + * Size of q in bits (DSA). + */ + divisorLength?: number | undefined; + /** + * Name of the curve (EC). + */ + namedCurve?: string | undefined; + } + interface JwkKeyExportOptions { + format: 'jwk'; + } + /** + * Node.js uses a `KeyObject` class to represent a symmetric or asymmetric key, + * and each kind of key exposes different functions. The {@link createSecretKey}, {@link createPublicKey} and {@link createPrivateKey} methods are used to create `KeyObject`instances. `KeyObject` + * objects are not to be created directly using the `new`keyword. + * + * Most applications should consider using the new `KeyObject` API instead of + * passing keys as strings or `Buffer`s due to improved security features. + * + * `KeyObject` instances can be passed to other threads via `postMessage()`. + * The receiver obtains a cloned `KeyObject`, and the `KeyObject` does not need to + * be listed in the `transferList` argument. + * @since v11.6.0 + */ + class KeyObject { + private constructor(); + /** + * Example: Converting a `CryptoKey` instance to a `KeyObject`: + * + * ```js + * const { webcrypto, KeyObject } = await import('crypto'); + * const { subtle } = webcrypto; + * + * const key = await subtle.generateKey({ + * name: 'HMAC', + * hash: 'SHA-256', + * length: 256 + * }, true, ['sign', 'verify']); + * + * const keyObject = KeyObject.from(key); + * console.log(keyObject.symmetricKeySize); + * // Prints: 32 (symmetric key size in bytes) + * ``` + * @since v15.0.0 + */ + static from(key: webcrypto.CryptoKey): KeyObject; + /** + * For asymmetric keys, this property represents the type of the key. Supported key + * types are: + * + * * `'rsa'` (OID 1.2.840.113549.1.1.1) + * * `'rsa-pss'` (OID 1.2.840.113549.1.1.10) + * * `'dsa'` (OID 1.2.840.10040.4.1) + * * `'ec'` (OID 1.2.840.10045.2.1) + * * `'x25519'` (OID 1.3.101.110) + * * `'x448'` (OID 1.3.101.111) + * * `'ed25519'` (OID 1.3.101.112) + * * `'ed448'` (OID 1.3.101.113) + * * `'dh'` (OID 1.2.840.113549.1.3.1) + * + * This property is `undefined` for unrecognized `KeyObject` types and symmetric + * keys. + * @since v11.6.0 + */ + asymmetricKeyType?: KeyType | undefined; + /** + * For asymmetric keys, this property represents the size of the embedded key in + * bytes. This property is `undefined` for symmetric keys. + */ + asymmetricKeySize?: number | undefined; + /** + * This property exists only on asymmetric keys. Depending on the type of the key, + * this object contains information about the key. None of the information obtained + * through this property can be used to uniquely identify a key or to compromise + * the security of the key. + * + * For RSA-PSS keys, if the key material contains a `RSASSA-PSS-params` sequence, + * the `hashAlgorithm`, `mgf1HashAlgorithm`, and `saltLength` properties will be + * set. + * + * Other key details might be exposed via this API using additional attributes. + * @since v15.7.0 + */ + asymmetricKeyDetails?: AsymmetricKeyDetails | undefined; + /** + * For symmetric keys, the following encoding options can be used: + * + * For public keys, the following encoding options can be used: + * + * For private keys, the following encoding options can be used: + * + * The result type depends on the selected encoding format, when PEM the + * result is a string, when DER it will be a buffer containing the data + * encoded as DER, when [JWK](https://tools.ietf.org/html/rfc7517) it will be an object. + * + * When [JWK](https://tools.ietf.org/html/rfc7517) encoding format was selected, all other encoding options are + * ignored. + * + * PKCS#1, SEC1, and PKCS#8 type keys can be encrypted by using a combination of + * the `cipher` and `format` options. The PKCS#8 `type` can be used with any`format` to encrypt any key algorithm (RSA, EC, or DH) by specifying a`cipher`. PKCS#1 and SEC1 can only be + * encrypted by specifying a `cipher`when the PEM `format` is used. For maximum compatibility, use PKCS#8 for + * encrypted private keys. Since PKCS#8 defines its own + * encryption mechanism, PEM-level encryption is not supported when encrypting + * a PKCS#8 key. See [RFC 5208](https://www.rfc-editor.org/rfc/rfc5208.txt) for PKCS#8 encryption and [RFC 1421](https://www.rfc-editor.org/rfc/rfc1421.txt) for + * PKCS#1 and SEC1 encryption. + * @since v11.6.0 + */ + export(options: KeyExportOptions<'pem'>): string | Buffer; + export(options?: KeyExportOptions<'der'>): Buffer; + export(options?: JwkKeyExportOptions): JsonWebKey; + /** + * For secret keys, this property represents the size of the key in bytes. This + * property is `undefined` for asymmetric keys. + * @since v11.6.0 + */ + symmetricKeySize?: number | undefined; + /** + * Depending on the type of this `KeyObject`, this property is either`'secret'` for secret (symmetric) keys, `'public'` for public (asymmetric) keys + * or `'private'` for private (asymmetric) keys. + * @since v11.6.0 + */ + type: KeyObjectType; + } + type CipherCCMTypes = 'aes-128-ccm' | 'aes-192-ccm' | 'aes-256-ccm' | 'chacha20-poly1305'; + type CipherGCMTypes = 'aes-128-gcm' | 'aes-192-gcm' | 'aes-256-gcm'; + type BinaryLike = string | NodeJS.ArrayBufferView; + type CipherKey = BinaryLike | KeyObject; + interface CipherCCMOptions extends stream.TransformOptions { + authTagLength: number; + } + interface CipherGCMOptions extends stream.TransformOptions { + authTagLength?: number | undefined; + } + /** + * Creates and returns a `Cipher` object that uses the given `algorithm` and`password`. + * + * The `options` argument controls stream behavior and is optional except when a + * cipher in CCM or OCB mode is used (e.g. `'aes-128-ccm'`). In that case, the`authTagLength` option is required and specifies the length of the + * authentication tag in bytes, see `CCM mode`. In GCM mode, the `authTagLength`option is not required but can be used to set the length of the authentication + * tag that will be returned by `getAuthTag()` and defaults to 16 bytes. + * + * The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On + * recent OpenSSL releases, `openssl list -cipher-algorithms`(`openssl list-cipher-algorithms` for older versions of OpenSSL) will + * display the available cipher algorithms. + * + * The `password` is used to derive the cipher key and initialization vector (IV). + * The value must be either a `'latin1'` encoded string, a `Buffer`, a`TypedArray`, or a `DataView`. + * + * The implementation of `crypto.createCipher()` derives keys using the OpenSSL + * function [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) with the digest algorithm set to MD5, one + * iteration, and no salt. The lack of salt allows dictionary attacks as the same + * password always creates the same key. The low iteration count and + * non-cryptographically secure hash algorithm allow passwords to be tested very + * rapidly. + * + * In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) it is recommended that + * developers derive a key and IV on + * their own using {@link scrypt} and to use {@link createCipheriv} to create the `Cipher` object. Users should not use ciphers with counter mode + * (e.g. CTR, GCM, or CCM) in `crypto.createCipher()`. A warning is emitted when + * they are used in order to avoid the risk of IV reuse that causes + * vulnerabilities. For the case when IV is reused in GCM, see [Nonce-Disrespecting Adversaries](https://github.com/nonce-disrespect/nonce-disrespect) for details. + * @since v0.1.94 + * @deprecated Since v10.0.0 - Use {@link createCipheriv} instead. + * @param options `stream.transform` options + */ + function createCipher(algorithm: CipherCCMTypes, password: BinaryLike, options: CipherCCMOptions): CipherCCM; + /** @deprecated since v10.0.0 use `createCipheriv()` */ + function createCipher(algorithm: CipherGCMTypes, password: BinaryLike, options?: CipherGCMOptions): CipherGCM; + /** @deprecated since v10.0.0 use `createCipheriv()` */ + function createCipher(algorithm: string, password: BinaryLike, options?: stream.TransformOptions): Cipher; + /** + * Creates and returns a `Cipher` object, with the given `algorithm`, `key` and + * initialization vector (`iv`). + * + * The `options` argument controls stream behavior and is optional except when a + * cipher in CCM or OCB mode is used (e.g. `'aes-128-ccm'`). In that case, the`authTagLength` option is required and specifies the length of the + * authentication tag in bytes, see `CCM mode`. In GCM mode, the `authTagLength`option is not required but can be used to set the length of the authentication + * tag that will be returned by `getAuthTag()` and defaults to 16 bytes. + * + * The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On + * recent OpenSSL releases, `openssl list -cipher-algorithms`(`openssl list-cipher-algorithms` for older versions of OpenSSL) will + * display the available cipher algorithms. + * + * The `key` is the raw key used by the `algorithm` and `iv` is an [initialization vector](https://en.wikipedia.org/wiki/Initialization_vector). Both arguments must be `'utf8'` encoded + * strings,`Buffers`, `TypedArray`, or `DataView`s. The `key` may optionally be + * a `KeyObject` of type `secret`. If the cipher does not need + * an initialization vector, `iv` may be `null`. + * + * When passing strings for `key` or `iv`, please consider `caveats when using strings as inputs to cryptographic APIs`. + * + * Initialization vectors should be unpredictable and unique; ideally, they will be + * cryptographically random. They do not have to be secret: IVs are typically just + * added to ciphertext messages unencrypted. It may sound contradictory that + * something has to be unpredictable and unique, but does not have to be secret; + * remember that an attacker must not be able to predict ahead of time what a + * given IV will be. + * @since v0.1.94 + * @param options `stream.transform` options + */ + function createCipheriv(algorithm: CipherCCMTypes, key: CipherKey, iv: BinaryLike | null, options: CipherCCMOptions): CipherCCM; + function createCipheriv(algorithm: CipherGCMTypes, key: CipherKey, iv: BinaryLike | null, options?: CipherGCMOptions): CipherGCM; + function createCipheriv(algorithm: string, key: CipherKey, iv: BinaryLike | null, options?: stream.TransformOptions): Cipher; + /** + * Instances of the `Cipher` class are used to encrypt data. The class can be + * used in one of two ways: + * + * * As a `stream` that is both readable and writable, where plain unencrypted + * data is written to produce encrypted data on the readable side, or + * * Using the `cipher.update()` and `cipher.final()` methods to produce + * the encrypted data. + * + * The {@link createCipher} or {@link createCipheriv} methods are + * used to create `Cipher` instances. `Cipher` objects are not to be created + * directly using the `new` keyword. + * + * Example: Using `Cipher` objects as streams: + * + * ```js + * const { + * scrypt, + * randomFill, + * createCipheriv + * } = await import('crypto'); + * + * const algorithm = 'aes-192-cbc'; + * const password = 'Password used to generate key'; + * + * // First, we'll generate the key. The key length is dependent on the algorithm. + * // In this case for aes192, it is 24 bytes (192 bits). + * scrypt(password, 'salt', 24, (err, key) => { + * if (err) throw err; + * // Then, we'll generate a random initialization vector + * randomFill(new Uint8Array(16), (err, iv) => { + * if (err) throw err; + * + * // Once we have the key and iv, we can create and use the cipher... + * const cipher = createCipheriv(algorithm, key, iv); + * + * let encrypted = ''; + * cipher.setEncoding('hex'); + * + * cipher.on('data', (chunk) => encrypted += chunk); + * cipher.on('end', () => console.log(encrypted)); + * + * cipher.write('some clear text data'); + * cipher.end(); + * }); + * }); + * ``` + * + * Example: Using `Cipher` and piped streams: + * + * ```js + * import { + * createReadStream, + * createWriteStream, + * } from 'fs'; + * + * import { + * pipeline + * } from 'stream'; + * + * const { + * scrypt, + * randomFill, + * createCipheriv + * } = await import('crypto'); + * + * const algorithm = 'aes-192-cbc'; + * const password = 'Password used to generate key'; + * + * // First, we'll generate the key. The key length is dependent on the algorithm. + * // In this case for aes192, it is 24 bytes (192 bits). + * scrypt(password, 'salt', 24, (err, key) => { + * if (err) throw err; + * // Then, we'll generate a random initialization vector + * randomFill(new Uint8Array(16), (err, iv) => { + * if (err) throw err; + * + * const cipher = createCipheriv(algorithm, key, iv); + * + * const input = createReadStream('test.js'); + * const output = createWriteStream('test.enc'); + * + * pipeline(input, cipher, output, (err) => { + * if (err) throw err; + * }); + * }); + * }); + * ``` + * + * Example: Using the `cipher.update()` and `cipher.final()` methods: + * + * ```js + * const { + * scrypt, + * randomFill, + * createCipheriv + * } = await import('crypto'); + * + * const algorithm = 'aes-192-cbc'; + * const password = 'Password used to generate key'; + * + * // First, we'll generate the key. The key length is dependent on the algorithm. + * // In this case for aes192, it is 24 bytes (192 bits). + * scrypt(password, 'salt', 24, (err, key) => { + * if (err) throw err; + * // Then, we'll generate a random initialization vector + * randomFill(new Uint8Array(16), (err, iv) => { + * if (err) throw err; + * + * const cipher = createCipheriv(algorithm, key, iv); + * + * let encrypted = cipher.update('some clear text data', 'utf8', 'hex'); + * encrypted += cipher.final('hex'); + * console.log(encrypted); + * }); + * }); + * ``` + * @since v0.1.94 + */ + class Cipher extends stream.Transform { + private constructor(); + /** + * Updates the cipher with `data`. If the `inputEncoding` argument is given, + * the `data`argument is a string using the specified encoding. If the `inputEncoding`argument is not given, `data` must be a `Buffer`, `TypedArray`, or`DataView`. If `data` is a `Buffer`, + * `TypedArray`, or `DataView`, then`inputEncoding` is ignored. + * + * The `outputEncoding` specifies the output format of the enciphered + * data. If the `outputEncoding`is specified, a string using the specified encoding is returned. If no`outputEncoding` is provided, a `Buffer` is returned. + * + * The `cipher.update()` method can be called multiple times with new data until `cipher.final()` is called. Calling `cipher.update()` after `cipher.final()` will result in an error being + * thrown. + * @since v0.1.94 + * @param inputEncoding The `encoding` of the data. + * @param outputEncoding The `encoding` of the return value. + */ + update(data: BinaryLike): Buffer; + update(data: string, inputEncoding: Encoding): Buffer; + update(data: NodeJS.ArrayBufferView, inputEncoding: undefined, outputEncoding: Encoding): string; + update(data: string, inputEncoding: Encoding | undefined, outputEncoding: Encoding): string; + /** + * Once the `cipher.final()` method has been called, the `Cipher` object can no + * longer be used to encrypt data. Attempts to call `cipher.final()` more than + * once will result in an error being thrown. + * @since v0.1.94 + * @param outputEncoding The `encoding` of the return value. + * @return Any remaining enciphered contents. If `outputEncoding` is specified, a string is returned. If an `outputEncoding` is not provided, a {@link Buffer} is returned. + */ + final(): Buffer; + final(outputEncoding: BufferEncoding): string; + /** + * When using block encryption algorithms, the `Cipher` class will automatically + * add padding to the input data to the appropriate block size. To disable the + * default padding call `cipher.setAutoPadding(false)`. + * + * When `autoPadding` is `false`, the length of the entire input data must be a + * multiple of the cipher's block size or `cipher.final()` will throw an error. + * Disabling automatic padding is useful for non-standard padding, for instance + * using `0x0` instead of PKCS padding. + * + * The `cipher.setAutoPadding()` method must be called before `cipher.final()`. + * @since v0.7.1 + * @param [autoPadding=true] + * @return for method chaining. + */ + setAutoPadding(autoPadding?: boolean): this; + } + interface CipherCCM extends Cipher { + setAAD( + buffer: NodeJS.ArrayBufferView, + options: { + plaintextLength: number; + } + ): this; + getAuthTag(): Buffer; + } + interface CipherGCM extends Cipher { + setAAD( + buffer: NodeJS.ArrayBufferView, + options?: { + plaintextLength: number; + } + ): this; + getAuthTag(): Buffer; + } + /** + * Creates and returns a `Decipher` object that uses the given `algorithm` and`password` (key). + * + * The `options` argument controls stream behavior and is optional except when a + * cipher in CCM or OCB mode is used (e.g. `'aes-128-ccm'`). In that case, the`authTagLength` option is required and specifies the length of the + * authentication tag in bytes, see `CCM mode`. + * + * The implementation of `crypto.createDecipher()` derives keys using the OpenSSL + * function [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) with the digest algorithm set to MD5, one + * iteration, and no salt. The lack of salt allows dictionary attacks as the same + * password always creates the same key. The low iteration count and + * non-cryptographically secure hash algorithm allow passwords to be tested very + * rapidly. + * + * In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) it is recommended that + * developers derive a key and IV on + * their own using {@link scrypt} and to use {@link createDecipheriv} to create the `Decipher` object. + * @since v0.1.94 + * @deprecated Since v10.0.0 - Use {@link createDecipheriv} instead. + * @param options `stream.transform` options + */ + function createDecipher(algorithm: CipherCCMTypes, password: BinaryLike, options: CipherCCMOptions): DecipherCCM; + /** @deprecated since v10.0.0 use `createDecipheriv()` */ + function createDecipher(algorithm: CipherGCMTypes, password: BinaryLike, options?: CipherGCMOptions): DecipherGCM; + /** @deprecated since v10.0.0 use `createDecipheriv()` */ + function createDecipher(algorithm: string, password: BinaryLike, options?: stream.TransformOptions): Decipher; + /** + * Creates and returns a `Decipher` object that uses the given `algorithm`, `key`and initialization vector (`iv`). + * + * The `options` argument controls stream behavior and is optional except when a + * cipher in CCM or OCB mode is used (e.g. `'aes-128-ccm'`). In that case, the`authTagLength` option is required and specifies the length of the + * authentication tag in bytes, see `CCM mode`. In GCM mode, the `authTagLength`option is not required but can be used to restrict accepted authentication tags + * to those with the specified length. + * + * The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On + * recent OpenSSL releases, `openssl list -cipher-algorithms`(`openssl list-cipher-algorithms` for older versions of OpenSSL) will + * display the available cipher algorithms. + * + * The `key` is the raw key used by the `algorithm` and `iv` is an [initialization vector](https://en.wikipedia.org/wiki/Initialization_vector). Both arguments must be `'utf8'` encoded + * strings,`Buffers`, `TypedArray`, or `DataView`s. The `key` may optionally be + * a `KeyObject` of type `secret`. If the cipher does not need + * an initialization vector, `iv` may be `null`. + * + * When passing strings for `key` or `iv`, please consider `caveats when using strings as inputs to cryptographic APIs`. + * + * Initialization vectors should be unpredictable and unique; ideally, they will be + * cryptographically random. They do not have to be secret: IVs are typically just + * added to ciphertext messages unencrypted. It may sound contradictory that + * something has to be unpredictable and unique, but does not have to be secret; + * remember that an attacker must not be able to predict ahead of time what a given + * IV will be. + * @since v0.1.94 + * @param options `stream.transform` options + */ + function createDecipheriv(algorithm: CipherCCMTypes, key: CipherKey, iv: BinaryLike | null, options: CipherCCMOptions): DecipherCCM; + function createDecipheriv(algorithm: CipherGCMTypes, key: CipherKey, iv: BinaryLike | null, options?: CipherGCMOptions): DecipherGCM; + function createDecipheriv(algorithm: string, key: CipherKey, iv: BinaryLike | null, options?: stream.TransformOptions): Decipher; + /** + * Instances of the `Decipher` class are used to decrypt data. The class can be + * used in one of two ways: + * + * * As a `stream` that is both readable and writable, where plain encrypted + * data is written to produce unencrypted data on the readable side, or + * * Using the `decipher.update()` and `decipher.final()` methods to + * produce the unencrypted data. + * + * The {@link createDecipher} or {@link createDecipheriv} methods are + * used to create `Decipher` instances. `Decipher` objects are not to be created + * directly using the `new` keyword. + * + * Example: Using `Decipher` objects as streams: + * + * ```js + * import { Buffer } from 'buffer'; + * const { + * scryptSync, + * createDecipheriv + * } = await import('crypto'); + * + * const algorithm = 'aes-192-cbc'; + * const password = 'Password used to generate key'; + * // Key length is dependent on the algorithm. In this case for aes192, it is + * // 24 bytes (192 bits). + * // Use the async `crypto.scrypt()` instead. + * const key = scryptSync(password, 'salt', 24); + * // The IV is usually passed along with the ciphertext. + * const iv = Buffer.alloc(16, 0); // Initialization vector. + * + * const decipher = createDecipheriv(algorithm, key, iv); + * + * let decrypted = ''; + * decipher.on('readable', () => { + * while (null !== (chunk = decipher.read())) { + * decrypted += chunk.toString('utf8'); + * } + * }); + * decipher.on('end', () => { + * console.log(decrypted); + * // Prints: some clear text data + * }); + * + * // Encrypted with same algorithm, key and iv. + * const encrypted = + * 'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa'; + * decipher.write(encrypted, 'hex'); + * decipher.end(); + * ``` + * + * Example: Using `Decipher` and piped streams: + * + * ```js + * import { + * createReadStream, + * createWriteStream, + * } from 'fs'; + * import { Buffer } from 'buffer'; + * const { + * scryptSync, + * createDecipheriv + * } = await import('crypto'); + * + * const algorithm = 'aes-192-cbc'; + * const password = 'Password used to generate key'; + * // Use the async `crypto.scrypt()` instead. + * const key = scryptSync(password, 'salt', 24); + * // The IV is usually passed along with the ciphertext. + * const iv = Buffer.alloc(16, 0); // Initialization vector. + * + * const decipher = createDecipheriv(algorithm, key, iv); + * + * const input = createReadStream('test.enc'); + * const output = createWriteStream('test.js'); + * + * input.pipe(decipher).pipe(output); + * ``` + * + * Example: Using the `decipher.update()` and `decipher.final()` methods: + * + * ```js + * import { Buffer } from 'buffer'; + * const { + * scryptSync, + * createDecipheriv + * } = await import('crypto'); + * + * const algorithm = 'aes-192-cbc'; + * const password = 'Password used to generate key'; + * // Use the async `crypto.scrypt()` instead. + * const key = scryptSync(password, 'salt', 24); + * // The IV is usually passed along with the ciphertext. + * const iv = Buffer.alloc(16, 0); // Initialization vector. + * + * const decipher = createDecipheriv(algorithm, key, iv); + * + * // Encrypted using same algorithm, key and iv. + * const encrypted = + * 'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa'; + * let decrypted = decipher.update(encrypted, 'hex', 'utf8'); + * decrypted += decipher.final('utf8'); + * console.log(decrypted); + * // Prints: some clear text data + * ``` + * @since v0.1.94 + */ + class Decipher extends stream.Transform { + private constructor(); + /** + * Updates the decipher with `data`. If the `inputEncoding` argument is given, + * the `data`argument is a string using the specified encoding. If the `inputEncoding`argument is not given, `data` must be a `Buffer`. If `data` is a `Buffer` then `inputEncoding` is + * ignored. + * + * The `outputEncoding` specifies the output format of the enciphered + * data. If the `outputEncoding`is specified, a string using the specified encoding is returned. If no`outputEncoding` is provided, a `Buffer` is returned. + * + * The `decipher.update()` method can be called multiple times with new data until `decipher.final()` is called. Calling `decipher.update()` after `decipher.final()` will result in an error + * being thrown. + * @since v0.1.94 + * @param inputEncoding The `encoding` of the `data` string. + * @param outputEncoding The `encoding` of the return value. + */ + update(data: NodeJS.ArrayBufferView): Buffer; + update(data: string, inputEncoding: Encoding): Buffer; + update(data: NodeJS.ArrayBufferView, inputEncoding: undefined, outputEncoding: Encoding): string; + update(data: string, inputEncoding: Encoding | undefined, outputEncoding: Encoding): string; + /** + * Once the `decipher.final()` method has been called, the `Decipher` object can + * no longer be used to decrypt data. Attempts to call `decipher.final()` more + * than once will result in an error being thrown. + * @since v0.1.94 + * @param outputEncoding The `encoding` of the return value. + * @return Any remaining deciphered contents. If `outputEncoding` is specified, a string is returned. If an `outputEncoding` is not provided, a {@link Buffer} is returned. + */ + final(): Buffer; + final(outputEncoding: BufferEncoding): string; + /** + * When data has been encrypted without standard block padding, calling`decipher.setAutoPadding(false)` will disable automatic padding to prevent `decipher.final()` from checking for and + * removing padding. + * + * Turning auto padding off will only work if the input data's length is a + * multiple of the ciphers block size. + * + * The `decipher.setAutoPadding()` method must be called before `decipher.final()`. + * @since v0.7.1 + * @param [autoPadding=true] + * @return for method chaining. + */ + setAutoPadding(auto_padding?: boolean): this; + } + interface DecipherCCM extends Decipher { + setAuthTag(buffer: NodeJS.ArrayBufferView): this; + setAAD( + buffer: NodeJS.ArrayBufferView, + options: { + plaintextLength: number; + } + ): this; + } + interface DecipherGCM extends Decipher { + setAuthTag(buffer: NodeJS.ArrayBufferView): this; + setAAD( + buffer: NodeJS.ArrayBufferView, + options?: { + plaintextLength: number; + } + ): this; + } + interface PrivateKeyInput { + key: string | Buffer; + format?: KeyFormat | undefined; + type?: 'pkcs1' | 'pkcs8' | 'sec1' | undefined; + passphrase?: string | Buffer | undefined; + } + interface PublicKeyInput { + key: string | Buffer; + format?: KeyFormat | undefined; + type?: 'pkcs1' | 'spki' | undefined; + } + /** + * Asynchronously generates a new random secret key of the given `length`. The`type` will determine which validations will be performed on the `length`. + * + * ```js + * const { + * generateKey + * } = await import('crypto'); + * + * generateKey('hmac', { length: 64 }, (err, key) => { + * if (err) throw err; + * console.log(key.export().toString('hex')); // 46e..........620 + * }); + * ``` + * @since v15.0.0 + * @param type The intended use of the generated secret key. Currently accepted values are `'hmac'` and `'aes'`. + */ + function generateKey( + type: 'hmac' | 'aes', + options: { + length: number; + }, + callback: (err: Error | null, key: KeyObject) => void + ): void; + /** + * Synchronously generates a new random secret key of the given `length`. The`type` will determine which validations will be performed on the `length`. + * + * ```js + * const { + * generateKeySync + * } = await import('crypto'); + * + * const key = generateKeySync('hmac', { length: 64 }); + * console.log(key.export().toString('hex')); // e89..........41e + * ``` + * @since v15.0.0 + * @param type The intended use of the generated secret key. Currently accepted values are `'hmac'` and `'aes'`. + */ + function generateKeySync( + type: 'hmac' | 'aes', + options: { + length: number; + } + ): KeyObject; + interface JsonWebKeyInput { + key: JsonWebKey; + format: 'jwk'; + } + /** + * Creates and returns a new key object containing a private key. If `key` is a + * string or `Buffer`, `format` is assumed to be `'pem'`; otherwise, `key`must be an object with the properties described above. + * + * If the private key is encrypted, a `passphrase` must be specified. The length + * of the passphrase is limited to 1024 bytes. + * @since v11.6.0 + */ + function createPrivateKey(key: PrivateKeyInput | string | Buffer | JsonWebKeyInput): KeyObject; + /** + * Creates and returns a new key object containing a public key. If `key` is a + * string or `Buffer`, `format` is assumed to be `'pem'`; if `key` is a `KeyObject`with type `'private'`, the public key is derived from the given private key; + * otherwise, `key` must be an object with the properties described above. + * + * If the format is `'pem'`, the `'key'` may also be an X.509 certificate. + * + * Because public keys can be derived from private keys, a private key may be + * passed instead of a public key. In that case, this function behaves as if {@link createPrivateKey} had been called, except that the type of the + * returned `KeyObject` will be `'public'` and that the private key cannot be + * extracted from the returned `KeyObject`. Similarly, if a `KeyObject` with type`'private'` is given, a new `KeyObject` with type `'public'` will be returned + * and it will be impossible to extract the private key from the returned object. + * @since v11.6.0 + */ + function createPublicKey(key: PublicKeyInput | string | Buffer | KeyObject | JsonWebKeyInput): KeyObject; + /** + * Creates and returns a new key object containing a secret key for symmetric + * encryption or `Hmac`. + * @since v11.6.0 + * @param encoding The string encoding when `key` is a string. + */ + function createSecretKey(key: NodeJS.ArrayBufferView): KeyObject; + function createSecretKey(key: string, encoding: BufferEncoding): KeyObject; + /** + * Creates and returns a `Sign` object that uses the given `algorithm`. Use {@link getHashes} to obtain the names of the available digest algorithms. + * Optional `options` argument controls the `stream.Writable` behavior. + * + * In some cases, a `Sign` instance can be created using the name of a signature + * algorithm, such as `'RSA-SHA256'`, instead of a digest algorithm. This will use + * the corresponding digest algorithm. This does not work for all signature + * algorithms, such as `'ecdsa-with-SHA256'`, so it is best to always use digest + * algorithm names. + * @since v0.1.92 + * @param options `stream.Writable` options + */ + function createSign(algorithm: string, options?: stream.WritableOptions): Sign; + type DSAEncoding = 'der' | 'ieee-p1363'; + interface SigningOptions { + /** + * @See crypto.constants.RSA_PKCS1_PADDING + */ + padding?: number | undefined; + saltLength?: number | undefined; + dsaEncoding?: DSAEncoding | undefined; + } + interface SignPrivateKeyInput extends PrivateKeyInput, SigningOptions {} + interface SignKeyObjectInput extends SigningOptions { + key: KeyObject; + } + interface VerifyPublicKeyInput extends PublicKeyInput, SigningOptions {} + interface VerifyKeyObjectInput extends SigningOptions { + key: KeyObject; + } + type KeyLike = string | Buffer | KeyObject; + /** + * The `Sign` class is a utility for generating signatures. It can be used in one + * of two ways: + * + * * As a writable `stream`, where data to be signed is written and the `sign.sign()` method is used to generate and return the signature, or + * * Using the `sign.update()` and `sign.sign()` methods to produce the + * signature. + * + * The {@link createSign} method is used to create `Sign` instances. The + * argument is the string name of the hash function to use. `Sign` objects are not + * to be created directly using the `new` keyword. + * + * Example: Using `Sign` and `Verify` objects as streams: + * + * ```js + * const { + * generateKeyPairSync, + * createSign, + * createVerify + * } = await import('crypto'); + * + * const { privateKey, publicKey } = generateKeyPairSync('ec', { + * namedCurve: 'sect239k1' + * }); + * + * const sign = createSign('SHA256'); + * sign.write('some data to sign'); + * sign.end(); + * const signature = sign.sign(privateKey, 'hex'); + * + * const verify = createVerify('SHA256'); + * verify.write('some data to sign'); + * verify.end(); + * console.log(verify.verify(publicKey, signature, 'hex')); + * // Prints: true + * ``` + * + * Example: Using the `sign.update()` and `verify.update()` methods: + * + * ```js + * const { + * generateKeyPairSync, + * createSign, + * createVerify + * } = await import('crypto'); + * + * const { privateKey, publicKey } = generateKeyPairSync('rsa', { + * modulusLength: 2048, + * }); + * + * const sign = createSign('SHA256'); + * sign.update('some data to sign'); + * sign.end(); + * const signature = sign.sign(privateKey); + * + * const verify = createVerify('SHA256'); + * verify.update('some data to sign'); + * verify.end(); + * console.log(verify.verify(publicKey, signature)); + * // Prints: true + * ``` + * @since v0.1.92 + */ + class Sign extends stream.Writable { + private constructor(); + /** + * Updates the `Sign` content with the given `data`, the encoding of which + * is given in `inputEncoding`. + * If `encoding` is not provided, and the `data` is a string, an + * encoding of `'utf8'` is enforced. If `data` is a `Buffer`, `TypedArray`, or`DataView`, then `inputEncoding` is ignored. + * + * This can be called many times with new data as it is streamed. + * @since v0.1.92 + * @param inputEncoding The `encoding` of the `data` string. + */ + update(data: BinaryLike): this; + update(data: string, inputEncoding: Encoding): this; + /** + * Calculates the signature on all the data passed through using either `sign.update()` or `sign.write()`. + * + * If `privateKey` is not a `KeyObject`, this function behaves as if`privateKey` had been passed to {@link createPrivateKey}. If it is an + * object, the following additional properties can be passed: + * + * If `outputEncoding` is provided a string is returned; otherwise a `Buffer` is returned. + * + * The `Sign` object can not be again used after `sign.sign()` method has been + * called. Multiple calls to `sign.sign()` will result in an error being thrown. + * @since v0.1.92 + */ + sign(privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput): Buffer; + sign(privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput, outputFormat: BinaryToTextEncoding): string; + } + /** + * Creates and returns a `Verify` object that uses the given algorithm. + * Use {@link getHashes} to obtain an array of names of the available + * signing algorithms. Optional `options` argument controls the`stream.Writable` behavior. + * + * In some cases, a `Verify` instance can be created using the name of a signature + * algorithm, such as `'RSA-SHA256'`, instead of a digest algorithm. This will use + * the corresponding digest algorithm. This does not work for all signature + * algorithms, such as `'ecdsa-with-SHA256'`, so it is best to always use digest + * algorithm names. + * @since v0.1.92 + * @param options `stream.Writable` options + */ + function createVerify(algorithm: string, options?: stream.WritableOptions): Verify; + /** + * The `Verify` class is a utility for verifying signatures. It can be used in one + * of two ways: + * + * * As a writable `stream` where written data is used to validate against the + * supplied signature, or + * * Using the `verify.update()` and `verify.verify()` methods to verify + * the signature. + * + * The {@link createVerify} method is used to create `Verify` instances.`Verify` objects are not to be created directly using the `new` keyword. + * + * See `Sign` for examples. + * @since v0.1.92 + */ + class Verify extends stream.Writable { + private constructor(); + /** + * Updates the `Verify` content with the given `data`, the encoding of which + * is given in `inputEncoding`. + * If `inputEncoding` is not provided, and the `data` is a string, an + * encoding of `'utf8'` is enforced. If `data` is a `Buffer`, `TypedArray`, or`DataView`, then `inputEncoding` is ignored. + * + * This can be called many times with new data as it is streamed. + * @since v0.1.92 + * @param inputEncoding The `encoding` of the `data` string. + */ + update(data: BinaryLike): Verify; + update(data: string, inputEncoding: Encoding): Verify; + /** + * Verifies the provided data using the given `object` and `signature`. + * + * If `object` is not a `KeyObject`, this function behaves as if`object` had been passed to {@link createPublicKey}. If it is an + * object, the following additional properties can be passed: + * + * The `signature` argument is the previously calculated signature for the data, in + * the `signatureEncoding`. + * If a `signatureEncoding` is specified, the `signature` is expected to be a + * string; otherwise `signature` is expected to be a `Buffer`,`TypedArray`, or `DataView`. + * + * The `verify` object can not be used again after `verify.verify()` has been + * called. Multiple calls to `verify.verify()` will result in an error being + * thrown. + * + * Because public keys can be derived from private keys, a private key may + * be passed instead of a public key. + * @since v0.1.92 + */ + verify(object: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput, signature: NodeJS.ArrayBufferView): boolean; + verify(object: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput, signature: string, signature_format?: BinaryToTextEncoding): boolean; + } + /** + * Creates a `DiffieHellman` key exchange object using the supplied `prime` and an + * optional specific `generator`. + * + * The `generator` argument can be a number, string, or `Buffer`. If`generator` is not specified, the value `2` is used. + * + * If `primeEncoding` is specified, `prime` is expected to be a string; otherwise + * a `Buffer`, `TypedArray`, or `DataView` is expected. + * + * If `generatorEncoding` is specified, `generator` is expected to be a string; + * otherwise a number, `Buffer`, `TypedArray`, or `DataView` is expected. + * @since v0.11.12 + * @param primeEncoding The `encoding` of the `prime` string. + * @param [generator=2] + * @param generatorEncoding The `encoding` of the `generator` string. + */ + function createDiffieHellman(primeLength: number, generator?: number | NodeJS.ArrayBufferView): DiffieHellman; + function createDiffieHellman(prime: NodeJS.ArrayBufferView): DiffieHellman; + function createDiffieHellman(prime: string, primeEncoding: BinaryToTextEncoding): DiffieHellman; + function createDiffieHellman(prime: string, primeEncoding: BinaryToTextEncoding, generator: number | NodeJS.ArrayBufferView): DiffieHellman; + function createDiffieHellman(prime: string, primeEncoding: BinaryToTextEncoding, generator: string, generatorEncoding: BinaryToTextEncoding): DiffieHellman; + /** + * The `DiffieHellman` class is a utility for creating Diffie-Hellman key + * exchanges. + * + * Instances of the `DiffieHellman` class can be created using the {@link createDiffieHellman} function. + * + * ```js + * import assert from 'assert'; + * + * const { + * createDiffieHellman + * } = await import('crypto'); + * + * // Generate Alice's keys... + * const alice = createDiffieHellman(2048); + * const aliceKey = alice.generateKeys(); + * + * // Generate Bob's keys... + * const bob = createDiffieHellman(alice.getPrime(), alice.getGenerator()); + * const bobKey = bob.generateKeys(); + * + * // Exchange and generate the secret... + * const aliceSecret = alice.computeSecret(bobKey); + * const bobSecret = bob.computeSecret(aliceKey); + * + * // OK + * assert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex')); + * ``` + * @since v0.5.0 + */ + class DiffieHellman { + private constructor(); + /** + * Generates private and public Diffie-Hellman key values, and returns + * the public key in the specified `encoding`. This key should be + * transferred to the other party. + * If `encoding` is provided a string is returned; otherwise a `Buffer` is returned. + * @since v0.5.0 + * @param encoding The `encoding` of the return value. + */ + generateKeys(): Buffer; + generateKeys(encoding: BinaryToTextEncoding): string; + /** + * Computes the shared secret using `otherPublicKey` as the other + * party's public key and returns the computed shared secret. The supplied + * key is interpreted using the specified `inputEncoding`, and secret is + * encoded using specified `outputEncoding`. + * If the `inputEncoding` is not + * provided, `otherPublicKey` is expected to be a `Buffer`,`TypedArray`, or `DataView`. + * + * If `outputEncoding` is given a string is returned; otherwise, a `Buffer` is returned. + * @since v0.5.0 + * @param inputEncoding The `encoding` of an `otherPublicKey` string. + * @param outputEncoding The `encoding` of the return value. + */ + computeSecret(otherPublicKey: NodeJS.ArrayBufferView): Buffer; + computeSecret(otherPublicKey: string, inputEncoding: BinaryToTextEncoding): Buffer; + computeSecret(otherPublicKey: NodeJS.ArrayBufferView, outputEncoding: BinaryToTextEncoding): string; + computeSecret(otherPublicKey: string, inputEncoding: BinaryToTextEncoding, outputEncoding: BinaryToTextEncoding): string; + /** + * Returns the Diffie-Hellman prime in the specified `encoding`. + * If `encoding` is provided a string is + * returned; otherwise a `Buffer` is returned. + * @since v0.5.0 + * @param encoding The `encoding` of the return value. + */ + getPrime(): Buffer; + getPrime(encoding: BinaryToTextEncoding): string; + /** + * Returns the Diffie-Hellman generator in the specified `encoding`. + * If `encoding` is provided a string is + * returned; otherwise a `Buffer` is returned. + * @since v0.5.0 + * @param encoding The `encoding` of the return value. + */ + getGenerator(): Buffer; + getGenerator(encoding: BinaryToTextEncoding): string; + /** + * Returns the Diffie-Hellman public key in the specified `encoding`. + * If `encoding` is provided a + * string is returned; otherwise a `Buffer` is returned. + * @since v0.5.0 + * @param encoding The `encoding` of the return value. + */ + getPublicKey(): Buffer; + getPublicKey(encoding: BinaryToTextEncoding): string; + /** + * Returns the Diffie-Hellman private key in the specified `encoding`. + * If `encoding` is provided a + * string is returned; otherwise a `Buffer` is returned. + * @since v0.5.0 + * @param encoding The `encoding` of the return value. + */ + getPrivateKey(): Buffer; + getPrivateKey(encoding: BinaryToTextEncoding): string; + /** + * Sets the Diffie-Hellman public key. If the `encoding` argument is provided,`publicKey` is expected + * to be a string. If no `encoding` is provided, `publicKey` is expected + * to be a `Buffer`, `TypedArray`, or `DataView`. + * @since v0.5.0 + * @param encoding The `encoding` of the `publicKey` string. + */ + setPublicKey(publicKey: NodeJS.ArrayBufferView): void; + setPublicKey(publicKey: string, encoding: BufferEncoding): void; + /** + * Sets the Diffie-Hellman private key. If the `encoding` argument is provided,`privateKey` is expected + * to be a string. If no `encoding` is provided, `privateKey` is expected + * to be a `Buffer`, `TypedArray`, or `DataView`. + * @since v0.5.0 + * @param encoding The `encoding` of the `privateKey` string. + */ + setPrivateKey(privateKey: NodeJS.ArrayBufferView): void; + setPrivateKey(privateKey: string, encoding: BufferEncoding): void; + /** + * A bit field containing any warnings and/or errors resulting from a check + * performed during initialization of the `DiffieHellman` object. + * + * The following values are valid for this property (as defined in `constants`module): + * + * * `DH_CHECK_P_NOT_SAFE_PRIME` + * * `DH_CHECK_P_NOT_PRIME` + * * `DH_UNABLE_TO_CHECK_GENERATOR` + * * `DH_NOT_SUITABLE_GENERATOR` + * @since v0.11.12 + */ + verifyError: number; + } + /** + * Creates a predefined `DiffieHellmanGroup` key exchange object. The + * supported groups are: `'modp1'`, `'modp2'`, `'modp5'` (defined in [RFC 2412](https://www.rfc-editor.org/rfc/rfc2412.txt), but see `Caveats`) and `'modp14'`, `'modp15'`,`'modp16'`, `'modp17'`, + * `'modp18'` (defined in [RFC 3526](https://www.rfc-editor.org/rfc/rfc3526.txt)). The + * returned object mimics the interface of objects created by {@link createDiffieHellman}, but will not allow changing + * the keys (with `diffieHellman.setPublicKey()`, for example). The + * advantage of using this method is that the parties do not have to + * generate nor exchange a group modulus beforehand, saving both processor + * and communication time. + * + * Example (obtaining a shared secret): + * + * ```js + * const { + * getDiffieHellman + * } = await import('crypto'); + * const alice = getDiffieHellman('modp14'); + * const bob = getDiffieHellman('modp14'); + * + * alice.generateKeys(); + * bob.generateKeys(); + * + * const aliceSecret = alice.computeSecret(bob.getPublicKey(), null, 'hex'); + * const bobSecret = bob.computeSecret(alice.getPublicKey(), null, 'hex'); + * + * // aliceSecret and bobSecret should be the same + * console.log(aliceSecret === bobSecret); + * ``` + * @since v0.7.5 + */ + function getDiffieHellman(groupName: string): DiffieHellman; + /** + * Provides an asynchronous Password-Based Key Derivation Function 2 (PBKDF2) + * implementation. A selected HMAC digest algorithm specified by `digest` is + * applied to derive a key of the requested byte length (`keylen`) from the`password`, `salt` and `iterations`. + * + * The supplied `callback` function is called with two arguments: `err` and`derivedKey`. If an error occurs while deriving the key, `err` will be set; + * otherwise `err` will be `null`. By default, the successfully generated`derivedKey` will be passed to the callback as a `Buffer`. An error will be + * thrown if any of the input arguments specify invalid values or types. + * + * If `digest` is `null`, `'sha1'` will be used. This behavior is deprecated, + * please specify a `digest` explicitly. + * + * The `iterations` argument must be a number set as high as possible. The + * higher the number of iterations, the more secure the derived key will be, + * but will take a longer amount of time to complete. + * + * The `salt` should be as unique as possible. It is recommended that a salt is + * random and at least 16 bytes long. See [NIST SP 800-132](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf) for details. + * + * When passing strings for `password` or `salt`, please consider `caveats when using strings as inputs to cryptographic APIs`. + * + * ```js + * const { + * pbkdf2 + * } = await import('crypto'); + * + * pbkdf2('secret', 'salt', 100000, 64, 'sha512', (err, derivedKey) => { + * if (err) throw err; + * console.log(derivedKey.toString('hex')); // '3745e48...08d59ae' + * }); + * ``` + * + * The `crypto.DEFAULT_ENCODING` property can be used to change the way the`derivedKey` is passed to the callback. This property, however, has been + * deprecated and use should be avoided. + * + * ```js + * import crypto from 'crypto'; + * crypto.DEFAULT_ENCODING = 'hex'; + * crypto.pbkdf2('secret', 'salt', 100000, 512, 'sha512', (err, derivedKey) => { + * if (err) throw err; + * console.log(derivedKey); // '3745e48...aa39b34' + * }); + * ``` + * + * An array of supported digest functions can be retrieved using {@link getHashes}. + * + * This API uses libuv's threadpool, which can have surprising and + * negative performance implications for some applications; see the `UV_THREADPOOL_SIZE` documentation for more information. + * @since v0.5.5 + */ + function pbkdf2(password: BinaryLike, salt: BinaryLike, iterations: number, keylen: number, digest: string, callback: (err: Error | null, derivedKey: Buffer) => void): void; + /** + * Provides a synchronous Password-Based Key Derivation Function 2 (PBKDF2) + * implementation. A selected HMAC digest algorithm specified by `digest` is + * applied to derive a key of the requested byte length (`keylen`) from the`password`, `salt` and `iterations`. + * + * If an error occurs an `Error` will be thrown, otherwise the derived key will be + * returned as a `Buffer`. + * + * If `digest` is `null`, `'sha1'` will be used. This behavior is deprecated, + * please specify a `digest` explicitly. + * + * The `iterations` argument must be a number set as high as possible. The + * higher the number of iterations, the more secure the derived key will be, + * but will take a longer amount of time to complete. + * + * The `salt` should be as unique as possible. It is recommended that a salt is + * random and at least 16 bytes long. See [NIST SP 800-132](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf) for details. + * + * When passing strings for `password` or `salt`, please consider `caveats when using strings as inputs to cryptographic APIs`. + * + * ```js + * const { + * pbkdf2Sync + * } = await import('crypto'); + * + * const key = pbkdf2Sync('secret', 'salt', 100000, 64, 'sha512'); + * console.log(key.toString('hex')); // '3745e48...08d59ae' + * ``` + * + * The `crypto.DEFAULT_ENCODING` property may be used to change the way the`derivedKey` is returned. This property, however, is deprecated and use + * should be avoided. + * + * ```js + * import crypto from 'crypto'; + * crypto.DEFAULT_ENCODING = 'hex'; + * const key = crypto.pbkdf2Sync('secret', 'salt', 100000, 512, 'sha512'); + * console.log(key); // '3745e48...aa39b34' + * ``` + * + * An array of supported digest functions can be retrieved using {@link getHashes}. + * @since v0.9.3 + */ + function pbkdf2Sync(password: BinaryLike, salt: BinaryLike, iterations: number, keylen: number, digest: string): Buffer; + /** + * Generates cryptographically strong pseudorandom data. The `size` argument + * is a number indicating the number of bytes to generate. + * + * If a `callback` function is provided, the bytes are generated asynchronously + * and the `callback` function is invoked with two arguments: `err` and `buf`. + * If an error occurs, `err` will be an `Error` object; otherwise it is `null`. The`buf` argument is a `Buffer` containing the generated bytes. + * + * ```js + * // Asynchronous + * const { + * randomBytes + * } = await import('crypto'); + * + * randomBytes(256, (err, buf) => { + * if (err) throw err; + * console.log(`${buf.length} bytes of random data: ${buf.toString('hex')}`); + * }); + * ``` + * + * If the `callback` function is not provided, the random bytes are generated + * synchronously and returned as a `Buffer`. An error will be thrown if + * there is a problem generating the bytes. + * + * ```js + * // Synchronous + * const { + * randomBytes + * } = await import('crypto'); + * + * const buf = randomBytes(256); + * console.log( + * `${buf.length} bytes of random data: ${buf.toString('hex')}`); + * ``` + * + * The `crypto.randomBytes()` method will not complete until there is + * sufficient entropy available. + * This should normally never take longer than a few milliseconds. The only time + * when generating the random bytes may conceivably block for a longer period of + * time is right after boot, when the whole system is still low on entropy. + * + * This API uses libuv's threadpool, which can have surprising and + * negative performance implications for some applications; see the `UV_THREADPOOL_SIZE` documentation for more information. + * + * The asynchronous version of `crypto.randomBytes()` is carried out in a single + * threadpool request. To minimize threadpool task length variation, partition + * large `randomBytes` requests when doing so as part of fulfilling a client + * request. + * @since v0.5.8 + * @param size The number of bytes to generate. The `size` must not be larger than `2**31 - 1`. + * @return if the `callback` function is not provided. + */ + function randomBytes(size: number): Buffer; + function randomBytes(size: number, callback: (err: Error | null, buf: Buffer) => void): void; + function pseudoRandomBytes(size: number): Buffer; + function pseudoRandomBytes(size: number, callback: (err: Error | null, buf: Buffer) => void): void; + /** + * Return a random integer `n` such that `min <= n < max`. This + * implementation avoids [modulo bias](https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle#Modulo_bias). + * + * The range (`max - min`) must be less than 248. `min` and `max` must + * be [safe integers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isSafeInteger). + * + * If the `callback` function is not provided, the random integer is + * generated synchronously. + * + * ```js + * // Asynchronous + * const { + * randomInt + * } = await import('crypto'); + * + * randomInt(3, (err, n) => { + * if (err) throw err; + * console.log(`Random number chosen from (0, 1, 2): ${n}`); + * }); + * ``` + * + * ```js + * // Synchronous + * const { + * randomInt + * } = await import('crypto'); + * + * const n = randomInt(3); + * console.log(`Random number chosen from (0, 1, 2): ${n}`); + * ``` + * + * ```js + * // With `min` argument + * const { + * randomInt + * } = await import('crypto'); + * + * const n = randomInt(1, 7); + * console.log(`The dice rolled: ${n}`); + * ``` + * @since v14.10.0, v12.19.0 + * @param [min=0] Start of random range (inclusive). + * @param max End of random range (exclusive). + * @param callback `function(err, n) {}`. + */ + function randomInt(max: number): number; + function randomInt(min: number, max: number): number; + function randomInt(max: number, callback: (err: Error | null, value: number) => void): void; + function randomInt(min: number, max: number, callback: (err: Error | null, value: number) => void): void; + /** + * Synchronous version of {@link randomFill}. + * + * ```js + * import { Buffer } from 'buffer'; + * const { randomFillSync } = await import('crypto'); + * + * const buf = Buffer.alloc(10); + * console.log(randomFillSync(buf).toString('hex')); + * + * randomFillSync(buf, 5); + * console.log(buf.toString('hex')); + * + * // The above is equivalent to the following: + * randomFillSync(buf, 5, 5); + * console.log(buf.toString('hex')); + * ``` + * + * Any `ArrayBuffer`, `TypedArray` or `DataView` instance may be passed as`buffer`. + * + * ```js + * import { Buffer } from 'buffer'; + * const { randomFillSync } = await import('crypto'); + * + * const a = new Uint32Array(10); + * console.log(Buffer.from(randomFillSync(a).buffer, + * a.byteOffset, a.byteLength).toString('hex')); + * + * const b = new DataView(new ArrayBuffer(10)); + * console.log(Buffer.from(randomFillSync(b).buffer, + * b.byteOffset, b.byteLength).toString('hex')); + * + * const c = new ArrayBuffer(10); + * console.log(Buffer.from(randomFillSync(c)).toString('hex')); + * ``` + * @since v7.10.0, v6.13.0 + * @param buffer Must be supplied. The size of the provided `buffer` must not be larger than `2**31 - 1`. + * @param [offset=0] + * @param [size=buffer.length - offset] + * @return The object passed as `buffer` argument. + */ + function randomFillSync(buffer: T, offset?: number, size?: number): T; + /** + * This function is similar to {@link randomBytes} but requires the first + * argument to be a `Buffer` that will be filled. It also + * requires that a callback is passed in. + * + * If the `callback` function is not provided, an error will be thrown. + * + * ```js + * import { Buffer } from 'buffer'; + * const { randomFill } = await import('crypto'); + * + * const buf = Buffer.alloc(10); + * randomFill(buf, (err, buf) => { + * if (err) throw err; + * console.log(buf.toString('hex')); + * }); + * + * randomFill(buf, 5, (err, buf) => { + * if (err) throw err; + * console.log(buf.toString('hex')); + * }); + * + * // The above is equivalent to the following: + * randomFill(buf, 5, 5, (err, buf) => { + * if (err) throw err; + * console.log(buf.toString('hex')); + * }); + * ``` + * + * Any `ArrayBuffer`, `TypedArray`, or `DataView` instance may be passed as`buffer`. + * + * While this includes instances of `Float32Array` and `Float64Array`, this + * function should not be used to generate random floating-point numbers. The + * result may contain `+Infinity`, `-Infinity`, and `NaN`, and even if the array + * contains finite numbers only, they are not drawn from a uniform random + * distribution and have no meaningful lower or upper bounds. + * + * ```js + * import { Buffer } from 'buffer'; + * const { randomFill } = await import('crypto'); + * + * const a = new Uint32Array(10); + * randomFill(a, (err, buf) => { + * if (err) throw err; + * console.log(Buffer.from(buf.buffer, buf.byteOffset, buf.byteLength) + * .toString('hex')); + * }); + * + * const b = new DataView(new ArrayBuffer(10)); + * randomFill(b, (err, buf) => { + * if (err) throw err; + * console.log(Buffer.from(buf.buffer, buf.byteOffset, buf.byteLength) + * .toString('hex')); + * }); + * + * const c = new ArrayBuffer(10); + * randomFill(c, (err, buf) => { + * if (err) throw err; + * console.log(Buffer.from(buf).toString('hex')); + * }); + * ``` + * + * This API uses libuv's threadpool, which can have surprising and + * negative performance implications for some applications; see the `UV_THREADPOOL_SIZE` documentation for more information. + * + * The asynchronous version of `crypto.randomFill()` is carried out in a single + * threadpool request. To minimize threadpool task length variation, partition + * large `randomFill` requests when doing so as part of fulfilling a client + * request. + * @since v7.10.0, v6.13.0 + * @param buffer Must be supplied. The size of the provided `buffer` must not be larger than `2**31 - 1`. + * @param [offset=0] + * @param [size=buffer.length - offset] + * @param callback `function(err, buf) {}`. + */ + function randomFill(buffer: T, callback: (err: Error | null, buf: T) => void): void; + function randomFill(buffer: T, offset: number, callback: (err: Error | null, buf: T) => void): void; + function randomFill(buffer: T, offset: number, size: number, callback: (err: Error | null, buf: T) => void): void; + interface ScryptOptions { + cost?: number | undefined; + blockSize?: number | undefined; + parallelization?: number | undefined; + N?: number | undefined; + r?: number | undefined; + p?: number | undefined; + maxmem?: number | undefined; + } + /** + * Provides an asynchronous [scrypt](https://en.wikipedia.org/wiki/Scrypt) implementation. Scrypt is a password-based + * key derivation function that is designed to be expensive computationally and + * memory-wise in order to make brute-force attacks unrewarding. + * + * The `salt` should be as unique as possible. It is recommended that a salt is + * random and at least 16 bytes long. See [NIST SP 800-132](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf) for details. + * + * When passing strings for `password` or `salt`, please consider `caveats when using strings as inputs to cryptographic APIs`. + * + * The `callback` function is called with two arguments: `err` and `derivedKey`.`err` is an exception object when key derivation fails, otherwise `err` is`null`. `derivedKey` is passed to the + * callback as a `Buffer`. + * + * An exception is thrown when any of the input arguments specify invalid values + * or types. + * + * ```js + * const { + * scrypt + * } = await import('crypto'); + * + * // Using the factory defaults. + * scrypt('password', 'salt', 64, (err, derivedKey) => { + * if (err) throw err; + * console.log(derivedKey.toString('hex')); // '3745e48...08d59ae' + * }); + * // Using a custom N parameter. Must be a power of two. + * scrypt('password', 'salt', 64, { N: 1024 }, (err, derivedKey) => { + * if (err) throw err; + * console.log(derivedKey.toString('hex')); // '3745e48...aa39b34' + * }); + * ``` + * @since v10.5.0 + */ + function scrypt(password: BinaryLike, salt: BinaryLike, keylen: number, callback: (err: Error | null, derivedKey: Buffer) => void): void; + function scrypt(password: BinaryLike, salt: BinaryLike, keylen: number, options: ScryptOptions, callback: (err: Error | null, derivedKey: Buffer) => void): void; + /** + * Provides a synchronous [scrypt](https://en.wikipedia.org/wiki/Scrypt) implementation. Scrypt is a password-based + * key derivation function that is designed to be expensive computationally and + * memory-wise in order to make brute-force attacks unrewarding. + * + * The `salt` should be as unique as possible. It is recommended that a salt is + * random and at least 16 bytes long. See [NIST SP 800-132](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf) for details. + * + * When passing strings for `password` or `salt`, please consider `caveats when using strings as inputs to cryptographic APIs`. + * + * An exception is thrown when key derivation fails, otherwise the derived key is + * returned as a `Buffer`. + * + * An exception is thrown when any of the input arguments specify invalid values + * or types. + * + * ```js + * const { + * scryptSync + * } = await import('crypto'); + * // Using the factory defaults. + * + * const key1 = scryptSync('password', 'salt', 64); + * console.log(key1.toString('hex')); // '3745e48...08d59ae' + * // Using a custom N parameter. Must be a power of two. + * const key2 = scryptSync('password', 'salt', 64, { N: 1024 }); + * console.log(key2.toString('hex')); // '3745e48...aa39b34' + * ``` + * @since v10.5.0 + */ + function scryptSync(password: BinaryLike, salt: BinaryLike, keylen: number, options?: ScryptOptions): Buffer; + interface RsaPublicKey { + key: KeyLike; + padding?: number | undefined; + } + interface RsaPrivateKey { + key: KeyLike; + passphrase?: string | undefined; + /** + * @default 'sha1' + */ + oaepHash?: string | undefined; + oaepLabel?: NodeJS.TypedArray | undefined; + padding?: number | undefined; + } + /** + * Encrypts the content of `buffer` with `key` and returns a new `Buffer` with encrypted content. The returned data can be decrypted using + * the corresponding private key, for example using {@link privateDecrypt}. + * + * If `key` is not a `KeyObject`, this function behaves as if`key` had been passed to {@link createPublicKey}. If it is an + * object, the `padding` property can be passed. Otherwise, this function uses`RSA_PKCS1_OAEP_PADDING`. + * + * Because RSA public keys can be derived from private keys, a private key may + * be passed instead of a public key. + * @since v0.11.14 + */ + function publicEncrypt(key: RsaPublicKey | RsaPrivateKey | KeyLike, buffer: NodeJS.ArrayBufferView): Buffer; + /** + * Decrypts `buffer` with `key`.`buffer` was previously encrypted using + * the corresponding private key, for example using {@link privateEncrypt}. + * + * If `key` is not a `KeyObject`, this function behaves as if`key` had been passed to {@link createPublicKey}. If it is an + * object, the `padding` property can be passed. Otherwise, this function uses`RSA_PKCS1_PADDING`. + * + * Because RSA public keys can be derived from private keys, a private key may + * be passed instead of a public key. + * @since v1.1.0 + */ + function publicDecrypt(key: RsaPublicKey | RsaPrivateKey | KeyLike, buffer: NodeJS.ArrayBufferView): Buffer; + /** + * Decrypts `buffer` with `privateKey`. `buffer` was previously encrypted using + * the corresponding public key, for example using {@link publicEncrypt}. + * + * If `privateKey` is not a `KeyObject`, this function behaves as if`privateKey` had been passed to {@link createPrivateKey}. If it is an + * object, the `padding` property can be passed. Otherwise, this function uses`RSA_PKCS1_OAEP_PADDING`. + * @since v0.11.14 + */ + function privateDecrypt(privateKey: RsaPrivateKey | KeyLike, buffer: NodeJS.ArrayBufferView): Buffer; + /** + * Encrypts `buffer` with `privateKey`. The returned data can be decrypted using + * the corresponding public key, for example using {@link publicDecrypt}. + * + * If `privateKey` is not a `KeyObject`, this function behaves as if`privateKey` had been passed to {@link createPrivateKey}. If it is an + * object, the `padding` property can be passed. Otherwise, this function uses`RSA_PKCS1_PADDING`. + * @since v1.1.0 + */ + function privateEncrypt(privateKey: RsaPrivateKey | KeyLike, buffer: NodeJS.ArrayBufferView): Buffer; + /** + * ```js + * const { + * getCiphers + * } = await import('crypto'); + * + * console.log(getCiphers()); // ['aes-128-cbc', 'aes-128-ccm', ...] + * ``` + * @since v0.9.3 + * @return An array with the names of the supported cipher algorithms. + */ + function getCiphers(): string[]; + /** + * ```js + * const { + * getCurves + * } = await import('crypto'); + * + * console.log(getCurves()); // ['Oakley-EC2N-3', 'Oakley-EC2N-4', ...] + * ``` + * @since v2.3.0 + * @return An array with the names of the supported elliptic curves. + */ + function getCurves(): string[]; + /** + * @since v10.0.0 + * @return `1` if and only if a FIPS compliant crypto provider is currently in use, `0` otherwise. A future semver-major release may change the return type of this API to a {boolean}. + */ + function getFips(): 1 | 0; + /** + * ```js + * const { + * getHashes + * } = await import('crypto'); + * + * console.log(getHashes()); // ['DSA', 'DSA-SHA', 'DSA-SHA1', ...] + * ``` + * @since v0.9.3 + * @return An array of the names of the supported hash algorithms, such as `'RSA-SHA256'`. Hash algorithms are also called "digest" algorithms. + */ + function getHashes(): string[]; + /** + * The `ECDH` class is a utility for creating Elliptic Curve Diffie-Hellman (ECDH) + * key exchanges. + * + * Instances of the `ECDH` class can be created using the {@link createECDH} function. + * + * ```js + * import assert from 'assert'; + * + * const { + * createECDH + * } = await import('crypto'); + * + * // Generate Alice's keys... + * const alice = createECDH('secp521r1'); + * const aliceKey = alice.generateKeys(); + * + * // Generate Bob's keys... + * const bob = createECDH('secp521r1'); + * const bobKey = bob.generateKeys(); + * + * // Exchange and generate the secret... + * const aliceSecret = alice.computeSecret(bobKey); + * const bobSecret = bob.computeSecret(aliceKey); + * + * assert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex')); + * // OK + * ``` + * @since v0.11.14 + */ + class ECDH { + private constructor(); + /** + * Converts the EC Diffie-Hellman public key specified by `key` and `curve` to the + * format specified by `format`. The `format` argument specifies point encoding + * and can be `'compressed'`, `'uncompressed'` or `'hybrid'`. The supplied key is + * interpreted using the specified `inputEncoding`, and the returned key is encoded + * using the specified `outputEncoding`. + * + * Use {@link getCurves} to obtain a list of available curve names. + * On recent OpenSSL releases, `openssl ecparam -list_curves` will also display + * the name and description of each available elliptic curve. + * + * If `format` is not specified the point will be returned in `'uncompressed'`format. + * + * If the `inputEncoding` is not provided, `key` is expected to be a `Buffer`,`TypedArray`, or `DataView`. + * + * Example (uncompressing a key): + * + * ```js + * const { + * createECDH, + * ECDH + * } = await import('crypto'); + * + * const ecdh = createECDH('secp256k1'); + * ecdh.generateKeys(); + * + * const compressedKey = ecdh.getPublicKey('hex', 'compressed'); + * + * const uncompressedKey = ECDH.convertKey(compressedKey, + * 'secp256k1', + * 'hex', + * 'hex', + * 'uncompressed'); + * + * // The converted key and the uncompressed public key should be the same + * console.log(uncompressedKey === ecdh.getPublicKey('hex')); + * ``` + * @since v10.0.0 + * @param inputEncoding The `encoding` of the `key` string. + * @param outputEncoding The `encoding` of the return value. + * @param [format='uncompressed'] + */ + static convertKey( + key: BinaryLike, + curve: string, + inputEncoding?: BinaryToTextEncoding, + outputEncoding?: 'latin1' | 'hex' | 'base64' | 'base64url', + format?: 'uncompressed' | 'compressed' | 'hybrid' + ): Buffer | string; + /** + * Generates private and public EC Diffie-Hellman key values, and returns + * the public key in the specified `format` and `encoding`. This key should be + * transferred to the other party. + * + * The `format` argument specifies point encoding and can be `'compressed'` or`'uncompressed'`. If `format` is not specified, the point will be returned in`'uncompressed'` format. + * + * If `encoding` is provided a string is returned; otherwise a `Buffer` is returned. + * @since v0.11.14 + * @param encoding The `encoding` of the return value. + * @param [format='uncompressed'] + */ + generateKeys(): Buffer; + generateKeys(encoding: BinaryToTextEncoding, format?: ECDHKeyFormat): string; + /** + * Computes the shared secret using `otherPublicKey` as the other + * party's public key and returns the computed shared secret. The supplied + * key is interpreted using specified `inputEncoding`, and the returned secret + * is encoded using the specified `outputEncoding`. + * If the `inputEncoding` is not + * provided, `otherPublicKey` is expected to be a `Buffer`, `TypedArray`, or`DataView`. + * + * If `outputEncoding` is given a string will be returned; otherwise a `Buffer` is returned. + * + * `ecdh.computeSecret` will throw an`ERR_CRYPTO_ECDH_INVALID_PUBLIC_KEY` error when `otherPublicKey`lies outside of the elliptic curve. Since `otherPublicKey` is + * usually supplied from a remote user over an insecure network, + * be sure to handle this exception accordingly. + * @since v0.11.14 + * @param inputEncoding The `encoding` of the `otherPublicKey` string. + * @param outputEncoding The `encoding` of the return value. + */ + computeSecret(otherPublicKey: NodeJS.ArrayBufferView): Buffer; + computeSecret(otherPublicKey: string, inputEncoding: BinaryToTextEncoding): Buffer; + computeSecret(otherPublicKey: NodeJS.ArrayBufferView, outputEncoding: BinaryToTextEncoding): string; + computeSecret(otherPublicKey: string, inputEncoding: BinaryToTextEncoding, outputEncoding: BinaryToTextEncoding): string; + /** + * If `encoding` is specified, a string is returned; otherwise a `Buffer` is + * returned. + * @since v0.11.14 + * @param encoding The `encoding` of the return value. + * @return The EC Diffie-Hellman in the specified `encoding`. + */ + getPrivateKey(): Buffer; + getPrivateKey(encoding: BinaryToTextEncoding): string; + /** + * The `format` argument specifies point encoding and can be `'compressed'` or`'uncompressed'`. If `format` is not specified the point will be returned in`'uncompressed'` format. + * + * If `encoding` is specified, a string is returned; otherwise a `Buffer` is + * returned. + * @since v0.11.14 + * @param encoding The `encoding` of the return value. + * @param [format='uncompressed'] + * @return The EC Diffie-Hellman public key in the specified `encoding` and `format`. + */ + getPublicKey(): Buffer; + getPublicKey(encoding: BinaryToTextEncoding, format?: ECDHKeyFormat): string; + /** + * Sets the EC Diffie-Hellman private key. + * If `encoding` is provided, `privateKey` is expected + * to be a string; otherwise `privateKey` is expected to be a `Buffer`,`TypedArray`, or `DataView`. + * + * If `privateKey` is not valid for the curve specified when the `ECDH` object was + * created, an error is thrown. Upon setting the private key, the associated + * public point (key) is also generated and set in the `ECDH` object. + * @since v0.11.14 + * @param encoding The `encoding` of the `privateKey` string. + */ + setPrivateKey(privateKey: NodeJS.ArrayBufferView): void; + setPrivateKey(privateKey: string, encoding: BinaryToTextEncoding): void; + } + /** + * Creates an Elliptic Curve Diffie-Hellman (`ECDH`) key exchange object using a + * predefined curve specified by the `curveName` string. Use {@link getCurves} to obtain a list of available curve names. On recent + * OpenSSL releases, `openssl ecparam -list_curves` will also display the name + * and description of each available elliptic curve. + * @since v0.11.14 + */ + function createECDH(curveName: string): ECDH; + /** + * This function is based on a constant-time algorithm. + * Returns true if `a` is equal to `b`, without leaking timing information that + * would allow an attacker to guess one of the values. This is suitable for + * comparing HMAC digests or secret values like authentication cookies or [capability urls](https://www.w3.org/TR/capability-urls/). + * + * `a` and `b` must both be `Buffer`s, `TypedArray`s, or `DataView`s, and they + * must have the same byte length. + * + * If at least one of `a` and `b` is a `TypedArray` with more than one byte per + * entry, such as `Uint16Array`, the result will be computed using the platform + * byte order. + * + * Use of `crypto.timingSafeEqual` does not guarantee that the _surrounding_ code + * is timing-safe. Care should be taken to ensure that the surrounding code does + * not introduce timing vulnerabilities. + * @since v6.6.0 + */ + function timingSafeEqual(a: NodeJS.ArrayBufferView, b: NodeJS.ArrayBufferView): boolean; + /** @deprecated since v10.0.0 */ + const DEFAULT_ENCODING: BufferEncoding; + type KeyType = 'rsa' | 'rsa-pss' | 'dsa' | 'ec' | 'ed25519' | 'ed448' | 'x25519' | 'x448'; + type KeyFormat = 'pem' | 'der'; + interface BasePrivateKeyEncodingOptions { + format: T; + cipher?: string | undefined; + passphrase?: string | undefined; + } + interface KeyPairKeyObjectResult { + publicKey: KeyObject; + privateKey: KeyObject; + } + interface ED25519KeyPairKeyObjectOptions {} + interface ED448KeyPairKeyObjectOptions {} + interface X25519KeyPairKeyObjectOptions {} + interface X448KeyPairKeyObjectOptions {} + interface ECKeyPairKeyObjectOptions { + /** + * Name of the curve to use + */ + namedCurve: string; + } + interface RSAKeyPairKeyObjectOptions { + /** + * Key size in bits + */ + modulusLength: number; + /** + * Public exponent + * @default 0x10001 + */ + publicExponent?: number | undefined; + } + interface RSAPSSKeyPairKeyObjectOptions { + /** + * Key size in bits + */ + modulusLength: number; + /** + * Public exponent + * @default 0x10001 + */ + publicExponent?: number | undefined; + /** + * Name of the message digest + */ + hashAlgorithm?: string; + /** + * Name of the message digest used by MGF1 + */ + mgf1HashAlgorithm?: string; + /** + * Minimal salt length in bytes + */ + saltLength?: string; + } + interface DSAKeyPairKeyObjectOptions { + /** + * Key size in bits + */ + modulusLength: number; + /** + * Size of q in bits + */ + divisorLength: number; + } + interface RSAKeyPairOptions { + /** + * Key size in bits + */ + modulusLength: number; + /** + * Public exponent + * @default 0x10001 + */ + publicExponent?: number | undefined; + publicKeyEncoding: { + type: 'pkcs1' | 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs1' | 'pkcs8'; + }; + } + interface RSAPSSKeyPairOptions { + /** + * Key size in bits + */ + modulusLength: number; + /** + * Public exponent + * @default 0x10001 + */ + publicExponent?: number | undefined; + /** + * Name of the message digest + */ + hashAlgorithm?: string; + /** + * Name of the message digest used by MGF1 + */ + mgf1HashAlgorithm?: string; + /** + * Minimal salt length in bytes + */ + saltLength?: string; + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + interface DSAKeyPairOptions { + /** + * Key size in bits + */ + modulusLength: number; + /** + * Size of q in bits + */ + divisorLength: number; + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + interface ECKeyPairOptions { + /** + * Name of the curve to use. + */ + namedCurve: string; + publicKeyEncoding: { + type: 'pkcs1' | 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'sec1' | 'pkcs8'; + }; + } + interface ED25519KeyPairOptions { + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + interface ED448KeyPairOptions { + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + interface X25519KeyPairOptions { + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + interface X448KeyPairOptions { + publicKeyEncoding: { + type: 'spki'; + format: PubF; + }; + privateKeyEncoding: BasePrivateKeyEncodingOptions & { + type: 'pkcs8'; + }; + } + interface KeyPairSyncResult { + publicKey: T1; + privateKey: T2; + } + /** + * Generates a new asymmetric key pair of the given `type`. RSA, RSA-PSS, DSA, EC, + * Ed25519, Ed448, X25519, X448, and DH are currently supported. + * + * If a `publicKeyEncoding` or `privateKeyEncoding` was specified, this function + * behaves as if `keyObject.export()` had been called on its result. Otherwise, + * the respective part of the key is returned as a `KeyObject`. + * + * When encoding public keys, it is recommended to use `'spki'`. When encoding + * private keys, it is recommended to use `'pkcs8'` with a strong passphrase, + * and to keep the passphrase confidential. + * + * ```js + * const { + * generateKeyPairSync + * } = await import('crypto'); + * + * const { + * publicKey, + * privateKey, + * } = generateKeyPairSync('rsa', { + * modulusLength: 4096, + * publicKeyEncoding: { + * type: 'spki', + * format: 'pem' + * }, + * privateKeyEncoding: { + * type: 'pkcs8', + * format: 'pem', + * cipher: 'aes-256-cbc', + * passphrase: 'top secret' + * } + * }); + * ``` + * + * The return value `{ publicKey, privateKey }` represents the generated key pair. + * When PEM encoding was selected, the respective key will be a string, otherwise + * it will be a buffer containing the data encoded as DER. + * @since v10.12.0 + * @param type Must be `'rsa'`, `'rsa-pss'`, `'dsa'`, `'ec'`, `'ed25519'`, `'ed448'`, `'x25519'`, `'x448'`, or `'dh'`. + */ + function generateKeyPairSync(type: 'rsa', options: RSAKeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'rsa', options: RSAKeyPairOptions<'pem', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'rsa', options: RSAKeyPairOptions<'der', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'rsa', options: RSAKeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'rsa', options: RSAKeyPairKeyObjectOptions): KeyPairKeyObjectResult; + function generateKeyPairSync(type: 'rsa-pss', options: RSAPSSKeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'rsa-pss', options: RSAPSSKeyPairOptions<'pem', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'rsa-pss', options: RSAPSSKeyPairOptions<'der', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'rsa-pss', options: RSAPSSKeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'rsa-pss', options: RSAPSSKeyPairKeyObjectOptions): KeyPairKeyObjectResult; + function generateKeyPairSync(type: 'dsa', options: DSAKeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'dsa', options: DSAKeyPairOptions<'pem', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'dsa', options: DSAKeyPairOptions<'der', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'dsa', options: DSAKeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'dsa', options: DSAKeyPairKeyObjectOptions): KeyPairKeyObjectResult; + function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'pem', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'der', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ec', options: ECKeyPairKeyObjectOptions): KeyPairKeyObjectResult; + function generateKeyPairSync(type: 'ed25519', options: ED25519KeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed25519', options: ED25519KeyPairOptions<'pem', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed25519', options: ED25519KeyPairOptions<'der', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed25519', options: ED25519KeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed25519', options?: ED25519KeyPairKeyObjectOptions): KeyPairKeyObjectResult; + function generateKeyPairSync(type: 'ed448', options: ED448KeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed448', options: ED448KeyPairOptions<'pem', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed448', options: ED448KeyPairOptions<'der', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed448', options: ED448KeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'ed448', options?: ED448KeyPairKeyObjectOptions): KeyPairKeyObjectResult; + function generateKeyPairSync(type: 'x25519', options: X25519KeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x25519', options: X25519KeyPairOptions<'pem', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x25519', options: X25519KeyPairOptions<'der', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x25519', options: X25519KeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x25519', options?: X25519KeyPairKeyObjectOptions): KeyPairKeyObjectResult; + function generateKeyPairSync(type: 'x448', options: X448KeyPairOptions<'pem', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x448', options: X448KeyPairOptions<'pem', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x448', options: X448KeyPairOptions<'der', 'pem'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x448', options: X448KeyPairOptions<'der', 'der'>): KeyPairSyncResult; + function generateKeyPairSync(type: 'x448', options?: X448KeyPairKeyObjectOptions): KeyPairKeyObjectResult; + /** + * Generates a new asymmetric key pair of the given `type`. RSA, RSA-PSS, DSA, EC, + * Ed25519, Ed448, X25519, X448, and DH are currently supported. + * + * If a `publicKeyEncoding` or `privateKeyEncoding` was specified, this function + * behaves as if `keyObject.export()` had been called on its result. Otherwise, + * the respective part of the key is returned as a `KeyObject`. + * + * It is recommended to encode public keys as `'spki'` and private keys as`'pkcs8'` with encryption for long-term storage: + * + * ```js + * const { + * generateKeyPair + * } = await import('crypto'); + * + * generateKeyPair('rsa', { + * modulusLength: 4096, + * publicKeyEncoding: { + * type: 'spki', + * format: 'pem' + * }, + * privateKeyEncoding: { + * type: 'pkcs8', + * format: 'pem', + * cipher: 'aes-256-cbc', + * passphrase: 'top secret' + * } + * }, (err, publicKey, privateKey) => { + * // Handle errors and use the generated key pair. + * }); + * ``` + * + * On completion, `callback` will be called with `err` set to `undefined` and`publicKey` / `privateKey` representing the generated key pair. + * + * If this method is invoked as its `util.promisify()` ed version, it returns + * a `Promise` for an `Object` with `publicKey` and `privateKey` properties. + * @since v10.12.0 + * @param type Must be `'rsa'`, `'rsa-pss'`, `'dsa'`, `'ec'`, `'ed25519'`, `'ed448'`, `'x25519'`, `'x448'`, or `'dh'`. + */ + function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; + function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; + function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'rsa', options: RSAKeyPairKeyObjectOptions, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + function generateKeyPair(type: 'rsa-pss', options: RSAPSSKeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; + function generateKeyPair(type: 'rsa-pss', options: RSAPSSKeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'rsa-pss', options: RSAPSSKeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; + function generateKeyPair(type: 'rsa-pss', options: RSAPSSKeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'rsa-pss', options: RSAPSSKeyPairKeyObjectOptions, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + function generateKeyPair(type: 'dsa', options: DSAKeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; + function generateKeyPair(type: 'dsa', options: DSAKeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'dsa', options: DSAKeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; + function generateKeyPair(type: 'dsa', options: DSAKeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'dsa', options: DSAKeyPairKeyObjectOptions, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; + function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; + function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'ec', options: ECKeyPairKeyObjectOptions, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + function generateKeyPair(type: 'ed25519', options: ED25519KeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; + function generateKeyPair(type: 'ed25519', options: ED25519KeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'ed25519', options: ED25519KeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; + function generateKeyPair(type: 'ed25519', options: ED25519KeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'ed25519', options: ED25519KeyPairKeyObjectOptions | undefined, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + function generateKeyPair(type: 'ed448', options: ED448KeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; + function generateKeyPair(type: 'ed448', options: ED448KeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'ed448', options: ED448KeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; + function generateKeyPair(type: 'ed448', options: ED448KeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'ed448', options: ED448KeyPairKeyObjectOptions | undefined, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + function generateKeyPair(type: 'x25519', options: X25519KeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; + function generateKeyPair(type: 'x25519', options: X25519KeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'x25519', options: X25519KeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; + function generateKeyPair(type: 'x25519', options: X25519KeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'x25519', options: X25519KeyPairKeyObjectOptions | undefined, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + function generateKeyPair(type: 'x448', options: X448KeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; + function generateKeyPair(type: 'x448', options: X448KeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'x448', options: X448KeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; + function generateKeyPair(type: 'x448', options: X448KeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; + function generateKeyPair(type: 'x448', options: X448KeyPairKeyObjectOptions | undefined, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; + namespace generateKeyPair { + function __promisify__( + type: 'rsa', + options: RSAKeyPairOptions<'pem', 'pem'> + ): Promise<{ + publicKey: string; + privateKey: string; + }>; + function __promisify__( + type: 'rsa', + options: RSAKeyPairOptions<'pem', 'der'> + ): Promise<{ + publicKey: string; + privateKey: Buffer; + }>; + function __promisify__( + type: 'rsa', + options: RSAKeyPairOptions<'der', 'pem'> + ): Promise<{ + publicKey: Buffer; + privateKey: string; + }>; + function __promisify__( + type: 'rsa', + options: RSAKeyPairOptions<'der', 'der'> + ): Promise<{ + publicKey: Buffer; + privateKey: Buffer; + }>; + function __promisify__(type: 'rsa', options: RSAKeyPairKeyObjectOptions): Promise; + function __promisify__( + type: 'rsa-pss', + options: RSAPSSKeyPairOptions<'pem', 'pem'> + ): Promise<{ + publicKey: string; + privateKey: string; + }>; + function __promisify__( + type: 'rsa-pss', + options: RSAPSSKeyPairOptions<'pem', 'der'> + ): Promise<{ + publicKey: string; + privateKey: Buffer; + }>; + function __promisify__( + type: 'rsa-pss', + options: RSAPSSKeyPairOptions<'der', 'pem'> + ): Promise<{ + publicKey: Buffer; + privateKey: string; + }>; + function __promisify__( + type: 'rsa-pss', + options: RSAPSSKeyPairOptions<'der', 'der'> + ): Promise<{ + publicKey: Buffer; + privateKey: Buffer; + }>; + function __promisify__(type: 'rsa-pss', options: RSAPSSKeyPairKeyObjectOptions): Promise; + function __promisify__( + type: 'dsa', + options: DSAKeyPairOptions<'pem', 'pem'> + ): Promise<{ + publicKey: string; + privateKey: string; + }>; + function __promisify__( + type: 'dsa', + options: DSAKeyPairOptions<'pem', 'der'> + ): Promise<{ + publicKey: string; + privateKey: Buffer; + }>; + function __promisify__( + type: 'dsa', + options: DSAKeyPairOptions<'der', 'pem'> + ): Promise<{ + publicKey: Buffer; + privateKey: string; + }>; + function __promisify__( + type: 'dsa', + options: DSAKeyPairOptions<'der', 'der'> + ): Promise<{ + publicKey: Buffer; + privateKey: Buffer; + }>; + function __promisify__(type: 'dsa', options: DSAKeyPairKeyObjectOptions): Promise; + function __promisify__( + type: 'ec', + options: ECKeyPairOptions<'pem', 'pem'> + ): Promise<{ + publicKey: string; + privateKey: string; + }>; + function __promisify__( + type: 'ec', + options: ECKeyPairOptions<'pem', 'der'> + ): Promise<{ + publicKey: string; + privateKey: Buffer; + }>; + function __promisify__( + type: 'ec', + options: ECKeyPairOptions<'der', 'pem'> + ): Promise<{ + publicKey: Buffer; + privateKey: string; + }>; + function __promisify__( + type: 'ec', + options: ECKeyPairOptions<'der', 'der'> + ): Promise<{ + publicKey: Buffer; + privateKey: Buffer; + }>; + function __promisify__(type: 'ec', options: ECKeyPairKeyObjectOptions): Promise; + function __promisify__( + type: 'ed25519', + options: ED25519KeyPairOptions<'pem', 'pem'> + ): Promise<{ + publicKey: string; + privateKey: string; + }>; + function __promisify__( + type: 'ed25519', + options: ED25519KeyPairOptions<'pem', 'der'> + ): Promise<{ + publicKey: string; + privateKey: Buffer; + }>; + function __promisify__( + type: 'ed25519', + options: ED25519KeyPairOptions<'der', 'pem'> + ): Promise<{ + publicKey: Buffer; + privateKey: string; + }>; + function __promisify__( + type: 'ed25519', + options: ED25519KeyPairOptions<'der', 'der'> + ): Promise<{ + publicKey: Buffer; + privateKey: Buffer; + }>; + function __promisify__(type: 'ed25519', options?: ED25519KeyPairKeyObjectOptions): Promise; + function __promisify__( + type: 'ed448', + options: ED448KeyPairOptions<'pem', 'pem'> + ): Promise<{ + publicKey: string; + privateKey: string; + }>; + function __promisify__( + type: 'ed448', + options: ED448KeyPairOptions<'pem', 'der'> + ): Promise<{ + publicKey: string; + privateKey: Buffer; + }>; + function __promisify__( + type: 'ed448', + options: ED448KeyPairOptions<'der', 'pem'> + ): Promise<{ + publicKey: Buffer; + privateKey: string; + }>; + function __promisify__( + type: 'ed448', + options: ED448KeyPairOptions<'der', 'der'> + ): Promise<{ + publicKey: Buffer; + privateKey: Buffer; + }>; + function __promisify__(type: 'ed448', options?: ED448KeyPairKeyObjectOptions): Promise; + function __promisify__( + type: 'x25519', + options: X25519KeyPairOptions<'pem', 'pem'> + ): Promise<{ + publicKey: string; + privateKey: string; + }>; + function __promisify__( + type: 'x25519', + options: X25519KeyPairOptions<'pem', 'der'> + ): Promise<{ + publicKey: string; + privateKey: Buffer; + }>; + function __promisify__( + type: 'x25519', + options: X25519KeyPairOptions<'der', 'pem'> + ): Promise<{ + publicKey: Buffer; + privateKey: string; + }>; + function __promisify__( + type: 'x25519', + options: X25519KeyPairOptions<'der', 'der'> + ): Promise<{ + publicKey: Buffer; + privateKey: Buffer; + }>; + function __promisify__(type: 'x25519', options?: X25519KeyPairKeyObjectOptions): Promise; + function __promisify__( + type: 'x448', + options: X448KeyPairOptions<'pem', 'pem'> + ): Promise<{ + publicKey: string; + privateKey: string; + }>; + function __promisify__( + type: 'x448', + options: X448KeyPairOptions<'pem', 'der'> + ): Promise<{ + publicKey: string; + privateKey: Buffer; + }>; + function __promisify__( + type: 'x448', + options: X448KeyPairOptions<'der', 'pem'> + ): Promise<{ + publicKey: Buffer; + privateKey: string; + }>; + function __promisify__( + type: 'x448', + options: X448KeyPairOptions<'der', 'der'> + ): Promise<{ + publicKey: Buffer; + privateKey: Buffer; + }>; + function __promisify__(type: 'x448', options?: X448KeyPairKeyObjectOptions): Promise; + } + /** + * Calculates and returns the signature for `data` using the given private key and + * algorithm. If `algorithm` is `null` or `undefined`, then the algorithm is + * dependent upon the key type (especially Ed25519 and Ed448). + * + * If `key` is not a `KeyObject`, this function behaves as if `key` had been + * passed to {@link createPrivateKey}. If it is an object, the following + * additional properties can be passed: + * + * If the `callback` function is provided this function uses libuv's threadpool. + * @since v12.0.0 + */ + function sign(algorithm: string | null | undefined, data: NodeJS.ArrayBufferView, key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput): Buffer; + function sign( + algorithm: string | null | undefined, + data: NodeJS.ArrayBufferView, + key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput, + callback: (error: Error | null, data: Buffer) => void + ): void; + /** + * Verifies the given signature for `data` using the given key and algorithm. If`algorithm` is `null` or `undefined`, then the algorithm is dependent upon the + * key type (especially Ed25519 and Ed448). + * + * If `key` is not a `KeyObject`, this function behaves as if `key` had been + * passed to {@link createPublicKey}. If it is an object, the following + * additional properties can be passed: + * + * The `signature` argument is the previously calculated signature for the `data`. + * + * Because public keys can be derived from private keys, a private key or a public + * key may be passed for `key`. + * + * If the `callback` function is provided this function uses libuv's threadpool. + * @since v12.0.0 + */ + function verify(algorithm: string | null | undefined, data: NodeJS.ArrayBufferView, key: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput, signature: NodeJS.ArrayBufferView): boolean; + function verify( + algorithm: string | null | undefined, + data: NodeJS.ArrayBufferView, + key: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput, + signature: NodeJS.ArrayBufferView, + callback: (error: Error | null, result: boolean) => void + ): void; + /** + * Computes the Diffie-Hellman secret based on a `privateKey` and a `publicKey`. + * Both keys must have the same `asymmetricKeyType`, which must be one of `'dh'`(for Diffie-Hellman), `'ec'` (for ECDH), `'x448'`, or `'x25519'` (for ECDH-ES). + * @since v13.9.0, v12.17.0 + */ + function diffieHellman(options: { privateKey: KeyObject; publicKey: KeyObject }): Buffer; + type CipherMode = 'cbc' | 'ccm' | 'cfb' | 'ctr' | 'ecb' | 'gcm' | 'ocb' | 'ofb' | 'stream' | 'wrap' | 'xts'; + interface CipherInfoOptions { + /** + * A test key length. + */ + keyLength?: number | undefined; + /** + * A test IV length. + */ + ivLength?: number | undefined; + } + interface CipherInfo { + /** + * The name of the cipher. + */ + name: string; + /** + * The nid of the cipher. + */ + nid: number; + /** + * The block size of the cipher in bytes. + * This property is omitted when mode is 'stream'. + */ + blockSize?: number | undefined; + /** + * The expected or default initialization vector length in bytes. + * This property is omitted if the cipher does not use an initialization vector. + */ + ivLength?: number | undefined; + /** + * The expected or default key length in bytes. + */ + keyLength: number; + /** + * The cipher mode. + */ + mode: CipherMode; + } + /** + * Returns information about a given cipher. + * + * Some ciphers accept variable length keys and initialization vectors. By default, + * the `crypto.getCipherInfo()` method will return the default values for these + * ciphers. To test if a given key length or iv length is acceptable for given + * cipher, use the `keyLength` and `ivLength` options. If the given values are + * unacceptable, `undefined` will be returned. + * @since v15.0.0 + * @param nameOrNid The name or nid of the cipher to query. + */ + function getCipherInfo(nameOrNid: string | number, options?: CipherInfoOptions): CipherInfo | undefined; + /** + * HKDF is a simple key derivation function defined in RFC 5869\. The given `ikm`,`salt` and `info` are used with the `digest` to derive a key of `keylen` bytes. + * + * The supplied `callback` function is called with two arguments: `err` and`derivedKey`. If an errors occurs while deriving the key, `err` will be set; + * otherwise `err` will be `null`. The successfully generated `derivedKey` will + * be passed to the callback as an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer). An error will be thrown if any + * of the input arguments specify invalid values or types. + * + * ```js + * import { Buffer } from 'buffer'; + * const { + * hkdf + * } = await import('crypto'); + * + * hkdf('sha512', 'key', 'salt', 'info', 64, (err, derivedKey) => { + * if (err) throw err; + * console.log(Buffer.from(derivedKey).toString('hex')); // '24156e2...5391653' + * }); + * ``` + * @since v15.0.0 + * @param digest The digest algorithm to use. + * @param ikm The input keying material. It must be at least one byte in length. + * @param salt The salt value. Must be provided but can be zero-length. + * @param info Additional info value. Must be provided but can be zero-length, and cannot be more than 1024 bytes. + * @param keylen The length of the key to generate. Must be greater than 0. The maximum allowable value is `255` times the number of bytes produced by the selected digest function (e.g. `sha512` + * generates 64-byte hashes, making the maximum HKDF output 16320 bytes). + */ + function hkdf(digest: string, irm: BinaryLike | KeyObject, salt: BinaryLike, info: BinaryLike, keylen: number, callback: (err: Error | null, derivedKey: ArrayBuffer) => void): void; + /** + * Provides a synchronous HKDF key derivation function as defined in RFC 5869\. The + * given `ikm`, `salt` and `info` are used with the `digest` to derive a key of`keylen` bytes. + * + * The successfully generated `derivedKey` will be returned as an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer). + * + * An error will be thrown if any of the input arguments specify invalid values or + * types, or if the derived key cannot be generated. + * + * ```js + * import { Buffer } from 'buffer'; + * const { + * hkdfSync + * } = await import('crypto'); + * + * const derivedKey = hkdfSync('sha512', 'key', 'salt', 'info', 64); + * console.log(Buffer.from(derivedKey).toString('hex')); // '24156e2...5391653' + * ``` + * @since v15.0.0 + * @param digest The digest algorithm to use. + * @param ikm The input keying material. It must be at least one byte in length. + * @param salt The salt value. Must be provided but can be zero-length. + * @param info Additional info value. Must be provided but can be zero-length, and cannot be more than 1024 bytes. + * @param keylen The length of the key to generate. Must be greater than 0. The maximum allowable value is `255` times the number of bytes produced by the selected digest function (e.g. `sha512` + * generates 64-byte hashes, making the maximum HKDF output 16320 bytes). + */ + function hkdfSync(digest: string, ikm: BinaryLike | KeyObject, salt: BinaryLike, info: BinaryLike, keylen: number): ArrayBuffer; + interface SecureHeapUsage { + /** + * The total allocated secure heap size as specified using the `--secure-heap=n` command-line flag. + */ + total: number; + /** + * The minimum allocation from the secure heap as specified using the `--secure-heap-min` command-line flag. + */ + min: number; + /** + * The total number of bytes currently allocated from the secure heap. + */ + used: number; + /** + * The calculated ratio of `used` to `total` allocated bytes. + */ + utilization: number; + } + /** + * @since v15.6.0 + */ + function secureHeapUsed(): SecureHeapUsage; + interface RandomUUIDOptions { + /** + * By default, to improve performance, + * Node.js will pre-emptively generate and persistently cache enough + * random data to generate up to 128 random UUIDs. To generate a UUID + * without using the cache, set `disableEntropyCache` to `true`. + * + * @default `false` + */ + disableEntropyCache?: boolean | undefined; + } + /** + * Generates a random [RFC 4122](https://www.rfc-editor.org/rfc/rfc4122.txt) version 4 UUID. The UUID is generated using a + * cryptographic pseudorandom number generator. + * @since v15.6.0 + */ + function randomUUID(options?: RandomUUIDOptions): string; + interface X509CheckOptions { + /** + * @default 'always' + */ + subject: 'always' | 'never'; + /** + * @default true + */ + wildcards: boolean; + /** + * @default true + */ + partialWildcards: boolean; + /** + * @default false + */ + multiLabelWildcards: boolean; + /** + * @default false + */ + singleLabelSubdomains: boolean; + } + /** + * Encapsulates an X509 certificate and provides read-only access to + * its information. + * + * ```js + * const { X509Certificate } = await import('crypto'); + * + * const x509 = new X509Certificate('{... pem encoded cert ...}'); + * + * console.log(x509.subject); + * ``` + * @since v15.6.0 + */ + class X509Certificate { + /** + * Will be \`true\` if this is a Certificate Authority (ca) certificate. + * @since v15.6.0 + */ + readonly ca: boolean; + /** + * The SHA-1 fingerprint of this certificate. + * @since v15.6.0 + */ + readonly fingerprint: string; + /** + * The SHA-256 fingerprint of this certificate. + * @since v15.6.0 + */ + readonly fingerprint256: string; + /** + * The complete subject of this certificate. + * @since v15.6.0 + */ + readonly subject: string; + /** + * The subject alternative name specified for this certificate. + * @since v15.6.0 + */ + readonly subjectAltName: string; + /** + * The information access content of this certificate. + * @since v15.6.0 + */ + readonly infoAccess: string; + /** + * An array detailing the key usages for this certificate. + * @since v15.6.0 + */ + readonly keyUsage: string[]; + /** + * The issuer identification included in this certificate. + * @since v15.6.0 + */ + readonly issuer: string; + /** + * The issuer certificate or `undefined` if the issuer certificate is not + * available. + * @since v15.9.0 + */ + readonly issuerCertificate?: X509Certificate | undefined; + /** + * The public key `KeyObject` for this certificate. + * @since v15.6.0 + */ + readonly publicKey: KeyObject; + /** + * A `Buffer` containing the DER encoding of this certificate. + * @since v15.6.0 + */ + readonly raw: Buffer; + /** + * The serial number of this certificate. + * @since v15.6.0 + */ + readonly serialNumber: string; + /** + * The date/time from which this certificate is considered valid. + * @since v15.6.0 + */ + readonly validFrom: string; + /** + * The date/time until which this certificate is considered valid. + * @since v15.6.0 + */ + readonly validTo: string; + constructor(buffer: BinaryLike); + /** + * Checks whether the certificate matches the given email address. + * @since v15.6.0 + * @return Returns `email` if the certificate matches, `undefined` if it does not. + */ + checkEmail(email: string, options?: X509CheckOptions): string | undefined; + /** + * Checks whether the certificate matches the given host name. + * @since v15.6.0 + * @return Returns `name` if the certificate matches, `undefined` if it does not. + */ + checkHost(name: string, options?: X509CheckOptions): string | undefined; + /** + * Checks whether the certificate matches the given IP address (IPv4 or IPv6). + * @since v15.6.0 + * @return Returns `ip` if the certificate matches, `undefined` if it does not. + */ + checkIP(ip: string, options?: X509CheckOptions): string | undefined; + /** + * Checks whether this certificate was issued by the given `otherCert`. + * @since v15.6.0 + */ + checkIssued(otherCert: X509Certificate): boolean; + /** + * Checks whether the public key for this certificate is consistent with + * the given private key. + * @since v15.6.0 + * @param privateKey A private key. + */ + checkPrivateKey(privateKey: KeyObject): boolean; + /** + * There is no standard JSON encoding for X509 certificates. The`toJSON()` method returns a string containing the PEM encoded + * certificate. + * @since v15.6.0 + */ + toJSON(): string; + /** + * Returns information about this certificate using the legacy `certificate object` encoding. + * @since v15.6.0 + */ + toLegacyObject(): PeerCertificate; + /** + * Returns the PEM-encoded certificate. + * @since v15.6.0 + */ + toString(): string; + /** + * Verifies that this certificate was signed by the given public key. + * Does not perform any other validation checks on the certificate. + * @since v15.6.0 + * @param publicKey A public key. + */ + verify(publicKey: KeyObject): boolean; + } + type LargeNumberLike = NodeJS.ArrayBufferView | SharedArrayBuffer | ArrayBuffer | bigint; + interface GeneratePrimeOptions { + add?: LargeNumberLike | undefined; + rem?: LargeNumberLike | undefined; + /** + * @default false + */ + safe?: boolean | undefined; + bigint?: boolean | undefined; + } + interface GeneratePrimeOptionsBigInt extends GeneratePrimeOptions { + bigint: true; + } + interface GeneratePrimeOptionsArrayBuffer extends GeneratePrimeOptions { + bigint?: false | undefined; + } + /** + * Generates a pseudorandom prime of `size` bits. + * + * If `options.safe` is `true`, the prime will be a safe prime -- that is,`(prime - 1) / 2` will also be a prime. + * + * The `options.add` and `options.rem` parameters can be used to enforce additional + * requirements, e.g., for Diffie-Hellman: + * + * * If `options.add` and `options.rem` are both set, the prime will satisfy the + * condition that `prime % add = rem`. + * * If only `options.add` is set and `options.safe` is not `true`, the prime will + * satisfy the condition that `prime % add = 1`. + * * If only `options.add` is set and `options.safe` is set to `true`, the prime + * will instead satisfy the condition that `prime % add = 3`. This is necessary + * because `prime % add = 1` for `options.add > 2` would contradict the condition + * enforced by `options.safe`. + * * `options.rem` is ignored if `options.add` is not given. + * + * Both `options.add` and `options.rem` must be encoded as big-endian sequences + * if given as an `ArrayBuffer`, `SharedArrayBuffer`, `TypedArray`, `Buffer`, or`DataView`. + * + * By default, the prime is encoded as a big-endian sequence of octets + * in an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer). If the `bigint` option is `true`, then a + * [bigint](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) is provided. + * @since v15.8.0 + * @param size The size (in bits) of the prime to generate. + */ + function generatePrime(size: number, callback: (err: Error | null, prime: ArrayBuffer) => void): void; + function generatePrime(size: number, options: GeneratePrimeOptionsBigInt, callback: (err: Error | null, prime: bigint) => void): void; + function generatePrime(size: number, options: GeneratePrimeOptionsArrayBuffer, callback: (err: Error | null, prime: ArrayBuffer) => void): void; + function generatePrime(size: number, options: GeneratePrimeOptions, callback: (err: Error | null, prime: ArrayBuffer | bigint) => void): void; + /** + * Generates a pseudorandom prime of `size` bits. + * + * If `options.safe` is `true`, the prime will be a safe prime -- that is,`(prime - 1) / 2` will also be a prime. + * + * The `options.add` and `options.rem` parameters can be used to enforce additional + * requirements, e.g., for Diffie-Hellman: + * + * * If `options.add` and `options.rem` are both set, the prime will satisfy the + * condition that `prime % add = rem`. + * * If only `options.add` is set and `options.safe` is not `true`, the prime will + * satisfy the condition that `prime % add = 1`. + * * If only `options.add` is set and `options.safe` is set to `true`, the prime + * will instead satisfy the condition that `prime % add = 3`. This is necessary + * because `prime % add = 1` for `options.add > 2` would contradict the condition + * enforced by `options.safe`. + * * `options.rem` is ignored if `options.add` is not given. + * + * Both `options.add` and `options.rem` must be encoded as big-endian sequences + * if given as an `ArrayBuffer`, `SharedArrayBuffer`, `TypedArray`, `Buffer`, or`DataView`. + * + * By default, the prime is encoded as a big-endian sequence of octets + * in an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer). If the `bigint` option is `true`, then a + * [bigint](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) is provided. + * @since v15.8.0 + * @param size The size (in bits) of the prime to generate. + */ + function generatePrimeSync(size: number): ArrayBuffer; + function generatePrimeSync(size: number, options: GeneratePrimeOptionsBigInt): bigint; + function generatePrimeSync(size: number, options: GeneratePrimeOptionsArrayBuffer): ArrayBuffer; + function generatePrimeSync(size: number, options: GeneratePrimeOptions): ArrayBuffer | bigint; + interface CheckPrimeOptions { + /** + * The number of Miller-Rabin probabilistic primality iterations to perform. + * When the value is 0 (zero), a number of checks is used that yields a false positive rate of at most 2-64 for random input. + * Care must be used when selecting a number of checks. + * Refer to the OpenSSL documentation for the BN_is_prime_ex function nchecks options for more details. + * + * @default 0 + */ + checks?: number | undefined; + } + /** + * Checks the primality of the `candidate`. + * @since v15.8.0 + * @param candidate A possible prime encoded as a sequence of big endian octets of arbitrary length. + */ + function checkPrime(value: LargeNumberLike, callback: (err: Error | null, result: boolean) => void): void; + function checkPrime(value: LargeNumberLike, options: CheckPrimeOptions, callback: (err: Error | null, result: boolean) => void): void; + /** + * Checks the primality of the `candidate`. + * @since v15.8.0 + * @param candidate A possible prime encoded as a sequence of big endian octets of arbitrary length. + * @return `true` if the candidate is a prime with an error probability less than `0.25 ** options.checks`. + */ + function checkPrimeSync(candidate: LargeNumberLike, options?: CheckPrimeOptions): boolean; + namespace webcrypto { + class CryptoKey {} // placeholder + } +} +declare module 'node:crypto' { + export * from 'crypto'; +} diff --git a/node_modules/@types/node/dgram.d.ts b/node_modules/@types/node/dgram.d.ts new file mode 100755 index 00000000..d7b9ee2d --- /dev/null +++ b/node_modules/@types/node/dgram.d.ts @@ -0,0 +1,545 @@ +/** + * The `dgram` module provides an implementation of UDP datagram sockets. + * + * ```js + * import dgram from 'dgram'; + * + * const server = dgram.createSocket('udp4'); + * + * server.on('error', (err) => { + * console.log(`server error:\n${err.stack}`); + * server.close(); + * }); + * + * server.on('message', (msg, rinfo) => { + * console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`); + * }); + * + * server.on('listening', () => { + * const address = server.address(); + * console.log(`server listening ${address.address}:${address.port}`); + * }); + * + * server.bind(41234); + * // Prints: server listening 0.0.0.0:41234 + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/dgram.js) + */ +declare module 'dgram' { + import { AddressInfo } from 'node:net'; + import * as dns from 'node:dns'; + import { EventEmitter, Abortable } from 'node:events'; + interface RemoteInfo { + address: string; + family: 'IPv4' | 'IPv6'; + port: number; + size: number; + } + interface BindOptions { + port?: number | undefined; + address?: string | undefined; + exclusive?: boolean | undefined; + fd?: number | undefined; + } + type SocketType = 'udp4' | 'udp6'; + interface SocketOptions extends Abortable { + type: SocketType; + reuseAddr?: boolean | undefined; + /** + * @default false + */ + ipv6Only?: boolean | undefined; + recvBufferSize?: number | undefined; + sendBufferSize?: number | undefined; + lookup?: ((hostname: string, options: dns.LookupOneOptions, callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void) => void) | undefined; + } + /** + * Creates a `dgram.Socket` object. Once the socket is created, calling `socket.bind()` will instruct the socket to begin listening for datagram + * messages. When `address` and `port` are not passed to `socket.bind()` the + * method will bind the socket to the "all interfaces" address on a random port + * (it does the right thing for both `udp4` and `udp6` sockets). The bound address + * and port can be retrieved using `socket.address().address` and `socket.address().port`. + * + * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.close()` on the socket: + * + * ```js + * const controller = new AbortController(); + * const { signal } = controller; + * const server = dgram.createSocket({ type: 'udp4', signal }); + * server.on('message', (msg, rinfo) => { + * console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`); + * }); + * // Later, when you want to close the server. + * controller.abort(); + * ``` + * @since v0.11.13 + * @param options Available options are: + * @param callback Attached as a listener for `'message'` events. Optional. + */ + function createSocket(type: SocketType, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; + function createSocket(options: SocketOptions, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; + /** + * Encapsulates the datagram functionality. + * + * New instances of `dgram.Socket` are created using {@link createSocket}. + * The `new` keyword is not to be used to create `dgram.Socket` instances. + * @since v0.1.99 + */ + class Socket extends EventEmitter { + /** + * Tells the kernel to join a multicast group at the given `multicastAddress` and`multicastInterface` using the `IP_ADD_MEMBERSHIP` socket option. If the`multicastInterface` argument is not + * specified, the operating system will choose + * one interface and will add membership to it. To add membership to every + * available interface, call `addMembership` multiple times, once per interface. + * + * When called on an unbound socket, this method will implicitly bind to a random + * port, listening on all interfaces. + * + * When sharing a UDP socket across multiple `cluster` workers, the`socket.addMembership()` function must be called only once or an`EADDRINUSE` error will occur: + * + * ```js + * import cluster from 'cluster'; + * import dgram from 'dgram'; + * + * if (cluster.isPrimary) { + * cluster.fork(); // Works ok. + * cluster.fork(); // Fails with EADDRINUSE. + * } else { + * const s = dgram.createSocket('udp4'); + * s.bind(1234, () => { + * s.addMembership('224.0.0.114'); + * }); + * } + * ``` + * @since v0.6.9 + */ + addMembership(multicastAddress: string, multicastInterface?: string): void; + /** + * Returns an object containing the address information for a socket. + * For UDP sockets, this object will contain `address`, `family` and `port`properties. + * + * This method throws `EBADF` if called on an unbound socket. + * @since v0.1.99 + */ + address(): AddressInfo; + /** + * For UDP sockets, causes the `dgram.Socket` to listen for datagram + * messages on a named `port` and optional `address`. If `port` is not + * specified or is `0`, the operating system will attempt to bind to a + * random port. If `address` is not specified, the operating system will + * attempt to listen on all addresses. Once binding is complete, a`'listening'` event is emitted and the optional `callback` function is + * called. + * + * Specifying both a `'listening'` event listener and passing a`callback` to the `socket.bind()` method is not harmful but not very + * useful. + * + * A bound datagram socket keeps the Node.js process running to receive + * datagram messages. + * + * If binding fails, an `'error'` event is generated. In rare case (e.g. + * attempting to bind with a closed socket), an `Error` may be thrown. + * + * Example of a UDP server listening on port 41234: + * + * ```js + * import dgram from 'dgram'; + * + * const server = dgram.createSocket('udp4'); + * + * server.on('error', (err) => { + * console.log(`server error:\n${err.stack}`); + * server.close(); + * }); + * + * server.on('message', (msg, rinfo) => { + * console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`); + * }); + * + * server.on('listening', () => { + * const address = server.address(); + * console.log(`server listening ${address.address}:${address.port}`); + * }); + * + * server.bind(41234); + * // Prints: server listening 0.0.0.0:41234 + * ``` + * @since v0.1.99 + * @param callback with no parameters. Called when binding is complete. + */ + bind(port?: number, address?: string, callback?: () => void): this; + bind(port?: number, callback?: () => void): this; + bind(callback?: () => void): this; + bind(options: BindOptions, callback?: () => void): this; + /** + * Close the underlying socket and stop listening for data on it. If a callback is + * provided, it is added as a listener for the `'close'` event. + * @since v0.1.99 + * @param callback Called when the socket has been closed. + */ + close(callback?: () => void): this; + /** + * Associates the `dgram.Socket` to a remote address and port. Every + * message sent by this handle is automatically sent to that destination. Also, + * the socket will only receive messages from that remote peer. + * Trying to call `connect()` on an already connected socket will result + * in an `ERR_SOCKET_DGRAM_IS_CONNECTED` exception. If `address` is not + * provided, `'127.0.0.1'` (for `udp4` sockets) or `'::1'` (for `udp6` sockets) + * will be used by default. Once the connection is complete, a `'connect'` event + * is emitted and the optional `callback` function is called. In case of failure, + * the `callback` is called or, failing this, an `'error'` event is emitted. + * @since v12.0.0 + * @param callback Called when the connection is completed or on error. + */ + connect(port: number, address?: string, callback?: () => void): void; + connect(port: number, callback: () => void): void; + /** + * A synchronous function that disassociates a connected `dgram.Socket` from + * its remote address. Trying to call `disconnect()` on an unbound or already + * disconnected socket will result in an `ERR_SOCKET_DGRAM_NOT_CONNECTED` exception. + * @since v12.0.0 + */ + disconnect(): void; + /** + * Instructs the kernel to leave a multicast group at `multicastAddress` using the`IP_DROP_MEMBERSHIP` socket option. This method is automatically called by the + * kernel when the socket is closed or the process terminates, so most apps will + * never have reason to call this. + * + * If `multicastInterface` is not specified, the operating system will attempt to + * drop membership on all valid interfaces. + * @since v0.6.9 + */ + dropMembership(multicastAddress: string, multicastInterface?: string): void; + /** + * This method throws `ERR_SOCKET_BUFFER_SIZE` if called on an unbound socket. + * @since v8.7.0 + * @return the `SO_RCVBUF` socket receive buffer size in bytes. + */ + getRecvBufferSize(): number; + /** + * This method throws `ERR_SOCKET_BUFFER_SIZE` if called on an unbound socket. + * @since v8.7.0 + * @return the `SO_SNDBUF` socket send buffer size in bytes. + */ + getSendBufferSize(): number; + /** + * By default, binding a socket will cause it to block the Node.js process from + * exiting as long as the socket is open. The `socket.unref()` method can be used + * to exclude the socket from the reference counting that keeps the Node.js + * process active. The `socket.ref()` method adds the socket back to the reference + * counting and restores the default behavior. + * + * Calling `socket.ref()` multiples times will have no additional effect. + * + * The `socket.ref()` method returns a reference to the socket so calls can be + * chained. + * @since v0.9.1 + */ + ref(): this; + /** + * Returns an object containing the `address`, `family`, and `port` of the remote + * endpoint. This method throws an `ERR_SOCKET_DGRAM_NOT_CONNECTED` exception + * if the socket is not connected. + * @since v12.0.0 + */ + remoteAddress(): AddressInfo; + /** + * Broadcasts a datagram on the socket. + * For connectionless sockets, the destination `port` and `address` must be + * specified. Connected sockets, on the other hand, will use their associated + * remote endpoint, so the `port` and `address` arguments must not be set. + * + * The `msg` argument contains the message to be sent. + * Depending on its type, different behavior can apply. If `msg` is a `Buffer`, + * any `TypedArray` or a `DataView`, + * the `offset` and `length` specify the offset within the `Buffer` where the + * message begins and the number of bytes in the message, respectively. + * If `msg` is a `String`, then it is automatically converted to a `Buffer`with `'utf8'` encoding. With messages that + * contain multi-byte characters, `offset` and `length` will be calculated with + * respect to `byte length` and not the character position. + * If `msg` is an array, `offset` and `length` must not be specified. + * + * The `address` argument is a string. If the value of `address` is a host name, + * DNS will be used to resolve the address of the host. If `address` is not + * provided or otherwise falsy, `'127.0.0.1'` (for `udp4` sockets) or `'::1'`(for `udp6` sockets) will be used by default. + * + * If the socket has not been previously bound with a call to `bind`, the socket + * is assigned a random port number and is bound to the "all interfaces" address + * (`'0.0.0.0'` for `udp4` sockets, `'::0'` for `udp6` sockets.) + * + * An optional `callback` function may be specified to as a way of reporting + * DNS errors or for determining when it is safe to reuse the `buf` object. + * DNS lookups delay the time to send for at least one tick of the + * Node.js event loop. + * + * The only way to know for sure that the datagram has been sent is by using a`callback`. If an error occurs and a `callback` is given, the error will be + * passed as the first argument to the `callback`. If a `callback` is not given, + * the error is emitted as an `'error'` event on the `socket` object. + * + * Offset and length are optional but both _must_ be set if either are used. + * They are supported only when the first argument is a `Buffer`, a `TypedArray`, + * or a `DataView`. + * + * This method throws `ERR_SOCKET_BAD_PORT` if called on an unbound socket. + * + * Example of sending a UDP packet to a port on `localhost`; + * + * ```js + * import dgram from 'dgram'; + * import { Buffer } from 'buffer'; + * + * const message = Buffer.from('Some bytes'); + * const client = dgram.createSocket('udp4'); + * client.send(message, 41234, 'localhost', (err) => { + * client.close(); + * }); + * ``` + * + * Example of sending a UDP packet composed of multiple buffers to a port on`127.0.0.1`; + * + * ```js + * import dgram from 'dgram'; + * import { Buffer } from 'buffer'; + * + * const buf1 = Buffer.from('Some '); + * const buf2 = Buffer.from('bytes'); + * const client = dgram.createSocket('udp4'); + * client.send([buf1, buf2], 41234, (err) => { + * client.close(); + * }); + * ``` + * + * Sending multiple buffers might be faster or slower depending on the + * application and operating system. Run benchmarks to + * determine the optimal strategy on a case-by-case basis. Generally speaking, + * however, sending multiple buffers is faster. + * + * Example of sending a UDP packet using a socket connected to a port on`localhost`: + * + * ```js + * import dgram from 'dgram'; + * import { Buffer } from 'buffer'; + * + * const message = Buffer.from('Some bytes'); + * const client = dgram.createSocket('udp4'); + * client.connect(41234, 'localhost', (err) => { + * client.send(message, (err) => { + * client.close(); + * }); + * }); + * ``` + * @since v0.1.99 + * @param msg Message to be sent. + * @param offset Offset in the buffer where the message starts. + * @param length Number of bytes in the message. + * @param port Destination port. + * @param address Destination host name or IP address. + * @param callback Called when the message has been sent. + */ + send(msg: string | Uint8Array | ReadonlyArray, port?: number, address?: string, callback?: (error: Error | null, bytes: number) => void): void; + send(msg: string | Uint8Array | ReadonlyArray, port?: number, callback?: (error: Error | null, bytes: number) => void): void; + send(msg: string | Uint8Array | ReadonlyArray, callback?: (error: Error | null, bytes: number) => void): void; + send(msg: string | Uint8Array, offset: number, length: number, port?: number, address?: string, callback?: (error: Error | null, bytes: number) => void): void; + send(msg: string | Uint8Array, offset: number, length: number, port?: number, callback?: (error: Error | null, bytes: number) => void): void; + send(msg: string | Uint8Array, offset: number, length: number, callback?: (error: Error | null, bytes: number) => void): void; + /** + * Sets or clears the `SO_BROADCAST` socket option. When set to `true`, UDP + * packets may be sent to a local interface's broadcast address. + * + * This method throws `EBADF` if called on an unbound socket. + * @since v0.6.9 + */ + setBroadcast(flag: boolean): void; + /** + * _All references to scope in this section are referring to [IPv6 Zone Indices](https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses), which are defined by [RFC + * 4007](https://tools.ietf.org/html/rfc4007). In string form, an IP_ + * _with a scope index is written as `'IP%scope'` where scope is an interface name_ + * _or interface number._ + * + * Sets the default outgoing multicast interface of the socket to a chosen + * interface or back to system interface selection. The `multicastInterface` must + * be a valid string representation of an IP from the socket's family. + * + * For IPv4 sockets, this should be the IP configured for the desired physical + * interface. All packets sent to multicast on the socket will be sent on the + * interface determined by the most recent successful use of this call. + * + * For IPv6 sockets, `multicastInterface` should include a scope to indicate the + * interface as in the examples that follow. In IPv6, individual `send` calls can + * also use explicit scope in addresses, so only packets sent to a multicast + * address without specifying an explicit scope are affected by the most recent + * successful use of this call. + * + * This method throws `EBADF` if called on an unbound socket. + * + * #### Example: IPv6 outgoing multicast interface + * + * On most systems, where scope format uses the interface name: + * + * ```js + * const socket = dgram.createSocket('udp6'); + * + * socket.bind(1234, () => { + * socket.setMulticastInterface('::%eth1'); + * }); + * ``` + * + * On Windows, where scope format uses an interface number: + * + * ```js + * const socket = dgram.createSocket('udp6'); + * + * socket.bind(1234, () => { + * socket.setMulticastInterface('::%2'); + * }); + * ``` + * + * #### Example: IPv4 outgoing multicast interface + * + * All systems use an IP of the host on the desired physical interface: + * + * ```js + * const socket = dgram.createSocket('udp4'); + * + * socket.bind(1234, () => { + * socket.setMulticastInterface('10.0.0.2'); + * }); + * ``` + * @since v8.6.0 + */ + setMulticastInterface(multicastInterface: string): void; + /** + * Sets or clears the `IP_MULTICAST_LOOP` socket option. When set to `true`, + * multicast packets will also be received on the local interface. + * + * This method throws `EBADF` if called on an unbound socket. + * @since v0.3.8 + */ + setMulticastLoopback(flag: boolean): boolean; + /** + * Sets the `IP_MULTICAST_TTL` socket option. While TTL generally stands for + * "Time to Live", in this context it specifies the number of IP hops that a + * packet is allowed to travel through, specifically for multicast traffic. Each + * router or gateway that forwards a packet decrements the TTL. If the TTL is + * decremented to 0 by a router, it will not be forwarded. + * + * The `ttl` argument may be between 0 and 255\. The default on most systems is `1`. + * + * This method throws `EBADF` if called on an unbound socket. + * @since v0.3.8 + */ + setMulticastTTL(ttl: number): number; + /** + * Sets the `SO_RCVBUF` socket option. Sets the maximum socket receive buffer + * in bytes. + * + * This method throws `ERR_SOCKET_BUFFER_SIZE` if called on an unbound socket. + * @since v8.7.0 + */ + setRecvBufferSize(size: number): void; + /** + * Sets the `SO_SNDBUF` socket option. Sets the maximum socket send buffer + * in bytes. + * + * This method throws `ERR_SOCKET_BUFFER_SIZE` if called on an unbound socket. + * @since v8.7.0 + */ + setSendBufferSize(size: number): void; + /** + * Sets the `IP_TTL` socket option. While TTL generally stands for "Time to Live", + * in this context it specifies the number of IP hops that a packet is allowed to + * travel through. Each router or gateway that forwards a packet decrements the + * TTL. If the TTL is decremented to 0 by a router, it will not be forwarded. + * Changing TTL values is typically done for network probes or when multicasting. + * + * The `ttl` argument may be between between 1 and 255\. The default on most systems + * is 64. + * + * This method throws `EBADF` if called on an unbound socket. + * @since v0.1.101 + */ + setTTL(ttl: number): number; + /** + * By default, binding a socket will cause it to block the Node.js process from + * exiting as long as the socket is open. The `socket.unref()` method can be used + * to exclude the socket from the reference counting that keeps the Node.js + * process active, allowing the process to exit even if the socket is still + * listening. + * + * Calling `socket.unref()` multiple times will have no addition effect. + * + * The `socket.unref()` method returns a reference to the socket so calls can be + * chained. + * @since v0.9.1 + */ + unref(): this; + /** + * Tells the kernel to join a source-specific multicast channel at the given`sourceAddress` and `groupAddress`, using the `multicastInterface` with the`IP_ADD_SOURCE_MEMBERSHIP` socket + * option. If the `multicastInterface` argument + * is not specified, the operating system will choose one interface and will add + * membership to it. To add membership to every available interface, call`socket.addSourceSpecificMembership()` multiple times, once per interface. + * + * When called on an unbound socket, this method will implicitly bind to a random + * port, listening on all interfaces. + * @since v13.1.0, v12.16.0 + */ + addSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string): void; + /** + * Instructs the kernel to leave a source-specific multicast channel at the given`sourceAddress` and `groupAddress` using the `IP_DROP_SOURCE_MEMBERSHIP`socket option. This method is + * automatically called by the kernel when the + * socket is closed or the process terminates, so most apps will never have + * reason to call this. + * + * If `multicastInterface` is not specified, the operating system will attempt to + * drop membership on all valid interfaces. + * @since v13.1.0, v12.16.0 + */ + dropSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string): void; + /** + * events.EventEmitter + * 1. close + * 2. connect + * 3. error + * 4. listening + * 5. message + */ + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'close', listener: () => void): this; + addListener(event: 'connect', listener: () => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'listening', listener: () => void): this; + addListener(event: 'message', listener: (msg: Buffer, rinfo: RemoteInfo) => void): this; + emit(event: string | symbol, ...args: any[]): boolean; + emit(event: 'close'): boolean; + emit(event: 'connect'): boolean; + emit(event: 'error', err: Error): boolean; + emit(event: 'listening'): boolean; + emit(event: 'message', msg: Buffer, rinfo: RemoteInfo): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'close', listener: () => void): this; + on(event: 'connect', listener: () => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'listening', listener: () => void): this; + on(event: 'message', listener: (msg: Buffer, rinfo: RemoteInfo) => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'connect', listener: () => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'listening', listener: () => void): this; + once(event: 'message', listener: (msg: Buffer, rinfo: RemoteInfo) => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'connect', listener: () => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'listening', listener: () => void): this; + prependListener(event: 'message', listener: (msg: Buffer, rinfo: RemoteInfo) => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'connect', listener: () => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'listening', listener: () => void): this; + prependOnceListener(event: 'message', listener: (msg: Buffer, rinfo: RemoteInfo) => void): this; + } +} +declare module 'node:dgram' { + export * from 'dgram'; +} diff --git a/node_modules/@types/node/diagnostics_channel.d.ts b/node_modules/@types/node/diagnostics_channel.d.ts new file mode 100755 index 00000000..d6747dad --- /dev/null +++ b/node_modules/@types/node/diagnostics_channel.d.ts @@ -0,0 +1,134 @@ +/** + * The `diagnostics_channel` module provides an API to create named channels + * to report arbitrary message data for diagnostics purposes. + * + * It can be accessed using: + * + * ```js + * import diagnostics_channel from 'diagnostics_channel'; + * ``` + * + * It is intended that a module writer wanting to report diagnostics messages + * will create one or many top-level channels to report messages through. + * Channels may also be acquired at runtime but it is not encouraged + * due to the additional overhead of doing so. Channels may be exported for + * convenience, but as long as the name is known it can be acquired anywhere. + * + * If you intend for your module to produce diagnostics data for others to + * consume it is recommended that you include documentation of what named + * channels are used along with the shape of the message data. Channel names + * should generally include the module name to avoid collisions with data from + * other modules. + * @experimental + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/diagnostics_channel.js) + */ +declare module 'diagnostics_channel' { + /** + * Check if there are active subscribers to the named channel. This is helpful if + * the message you want to send might be expensive to prepare. + * + * This API is optional but helpful when trying to publish messages from very + * performance-sensitive code. + * + * ```js + * import diagnostics_channel from 'diagnostics_channel'; + * + * if (diagnostics_channel.hasSubscribers('my-channel')) { + * // There are subscribers, prepare and publish message + * } + * ``` + * @since v15.1.0, v14.17.0 + * @param name The channel name + * @return If there are active subscribers + */ + function hasSubscribers(name: string): boolean; + /** + * This is the primary entry-point for anyone wanting to interact with a named + * channel. It produces a channel object which is optimized to reduce overhead at + * publish time as much as possible. + * + * ```js + * import diagnostics_channel from 'diagnostics_channel'; + * + * const channel = diagnostics_channel.channel('my-channel'); + * ``` + * @since v15.1.0, v14.17.0 + * @param name The channel name + * @return The named channel object + */ + function channel(name: string): Channel; + type ChannelListener = (name: string, message: unknown) => void; + /** + * The class `Channel` represents an individual named channel within the data + * pipeline. It is use to track subscribers and to publish messages when there + * are subscribers present. It exists as a separate object to avoid channel + * lookups at publish time, enabling very fast publish speeds and allowing + * for heavy use while incurring very minimal cost. Channels are created with {@link channel}, constructing a channel directly + * with `new Channel(name)` is not supported. + * @since v15.1.0, v14.17.0 + */ + class Channel { + readonly name: string; + /** + * Check if there are active subscribers to this channel. This is helpful if + * the message you want to send might be expensive to prepare. + * + * This API is optional but helpful when trying to publish messages from very + * performance-sensitive code. + * + * ```js + * import diagnostics_channel from 'diagnostics_channel'; + * + * const channel = diagnostics_channel.channel('my-channel'); + * + * if (channel.hasSubscribers) { + * // There are subscribers, prepare and publish message + * } + * ``` + * @since v15.1.0, v14.17.0 + */ + readonly hasSubscribers: boolean; + private constructor(name: string); + /** + * Register a message handler to subscribe to this channel. This message handler + * will be run synchronously whenever a message is published to the channel. Any + * errors thrown in the message handler will trigger an `'uncaughtException'`. + * + * ```js + * import diagnostics_channel from 'diagnostics_channel'; + * + * const channel = diagnostics_channel.channel('my-channel'); + * + * channel.subscribe((message, name) => { + * // Received data + * }); + * ``` + * @since v15.1.0, v14.17.0 + * @param onMessage The handler to receive channel messages + */ + subscribe(onMessage: ChannelListener): void; + /** + * Remove a message handler previously registered to this channel with `channel.subscribe(onMessage)`. + * + * ```js + * import diagnostics_channel from 'diagnostics_channel'; + * + * const channel = diagnostics_channel.channel('my-channel'); + * + * function onMessage(message, name) { + * // Received data + * } + * + * channel.subscribe(onMessage); + * + * channel.unsubscribe(onMessage); + * ``` + * @since v15.1.0, v14.17.0 + * @param onMessage The previous subscribed handler to remove + */ + unsubscribe(onMessage: ChannelListener): void; + } +} +declare module 'node:diagnostics_channel' { + export * from 'diagnostics_channel'; +} diff --git a/node_modules/@types/node/dns.d.ts b/node_modules/@types/node/dns.d.ts new file mode 100755 index 00000000..78776f41 --- /dev/null +++ b/node_modules/@types/node/dns.d.ts @@ -0,0 +1,654 @@ +/** + * The `dns` module enables name resolution. For example, use it to look up IP + * addresses of host names. + * + * Although named for the [Domain Name System (DNS)](https://en.wikipedia.org/wiki/Domain_Name_System), it does not always use the + * DNS protocol for lookups. {@link lookup} uses the operating system + * facilities to perform name resolution. It may not need to perform any network + * communication. To perform name resolution the way other applications on the same + * system do, use {@link lookup}. + * + * ```js + * const dns = require('dns'); + * + * dns.lookup('example.org', (err, address, family) => { + * console.log('address: %j family: IPv%s', address, family); + * }); + * // address: "93.184.216.34" family: IPv4 + * ``` + * + * All other functions in the `dns` module connect to an actual DNS server to + * perform name resolution. They will always use the network to perform DNS + * queries. These functions do not use the same set of configuration files used by {@link lookup} (e.g. `/etc/hosts`). Use these functions to always perform + * DNS queries, bypassing other name-resolution facilities. + * + * ```js + * const dns = require('dns'); + * + * dns.resolve4('archive.org', (err, addresses) => { + * if (err) throw err; + * + * console.log(`addresses: ${JSON.stringify(addresses)}`); + * + * addresses.forEach((a) => { + * dns.reverse(a, (err, hostnames) => { + * if (err) { + * throw err; + * } + * console.log(`reverse for ${a}: ${JSON.stringify(hostnames)}`); + * }); + * }); + * }); + * ``` + * + * See the `Implementation considerations section` for more information. + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/dns.js) + */ +declare module 'dns' { + import * as dnsPromises from 'node:dns/promises'; + // Supported getaddrinfo flags. + export const ADDRCONFIG: number; + export const V4MAPPED: number; + /** + * If `dns.V4MAPPED` is specified, return resolved IPv6 addresses as + * well as IPv4 mapped IPv6 addresses. + */ + export const ALL: number; + export interface LookupOptions { + family?: number | undefined; + hints?: number | undefined; + all?: boolean | undefined; + verbatim?: boolean | undefined; + } + export interface LookupOneOptions extends LookupOptions { + all?: false | undefined; + } + export interface LookupAllOptions extends LookupOptions { + all: true; + } + export interface LookupAddress { + address: string; + family: number; + } + /** + * Resolves a host name (e.g. `'nodejs.org'`) into the first found A (IPv4) or + * AAAA (IPv6) record. All `option` properties are optional. If `options` is an + * integer, then it must be `4` or `6` – if `options` is not provided, then IPv4 + * and IPv6 addresses are both returned if found. + * + * With the `all` option set to `true`, the arguments for `callback` change to`(err, addresses)`, with `addresses` being an array of objects with the + * properties `address` and `family`. + * + * On error, `err` is an `Error` object, where `err.code` is the error code. + * Keep in mind that `err.code` will be set to `'ENOTFOUND'` not only when + * the host name does not exist but also when the lookup fails in other ways + * such as no available file descriptors. + * + * `dns.lookup()` does not necessarily have anything to do with the DNS protocol. + * The implementation uses an operating system facility that can associate names + * with addresses, and vice versa. This implementation can have subtle but + * important consequences on the behavior of any Node.js program. Please take some + * time to consult the `Implementation considerations section` before using`dns.lookup()`. + * + * Example usage: + * + * ```js + * const dns = require('dns'); + * const options = { + * family: 6, + * hints: dns.ADDRCONFIG | dns.V4MAPPED, + * }; + * dns.lookup('example.com', options, (err, address, family) => + * console.log('address: %j family: IPv%s', address, family)); + * // address: "2606:2800:220:1:248:1893:25c8:1946" family: IPv6 + * + * // When options.all is true, the result will be an Array. + * options.all = true; + * dns.lookup('example.com', options, (err, addresses) => + * console.log('addresses: %j', addresses)); + * // addresses: [{"address":"2606:2800:220:1:248:1893:25c8:1946","family":6}] + * ``` + * + * If this method is invoked as its `util.promisify()` ed version, and `all`is not set to `true`, it returns a `Promise` for an `Object` with `address` and`family` properties. + * @since v0.1.90 + */ + export function lookup(hostname: string, family: number, callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void): void; + export function lookup(hostname: string, options: LookupOneOptions, callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void): void; + export function lookup(hostname: string, options: LookupAllOptions, callback: (err: NodeJS.ErrnoException | null, addresses: LookupAddress[]) => void): void; + export function lookup(hostname: string, options: LookupOptions, callback: (err: NodeJS.ErrnoException | null, address: string | LookupAddress[], family: number) => void): void; + export function lookup(hostname: string, callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void): void; + export namespace lookup { + function __promisify__(hostname: string, options: LookupAllOptions): Promise; + function __promisify__(hostname: string, options?: LookupOneOptions | number): Promise; + function __promisify__(hostname: string, options: LookupOptions): Promise; + } + /** + * Resolves the given `address` and `port` into a host name and service using + * the operating system's underlying `getnameinfo` implementation. + * + * If `address` is not a valid IP address, a `TypeError` will be thrown. + * The `port` will be coerced to a number. If it is not a legal port, a `TypeError`will be thrown. + * + * On an error, `err` is an `Error` object, where `err.code` is the error code. + * + * ```js + * const dns = require('dns'); + * dns.lookupService('127.0.0.1', 22, (err, hostname, service) => { + * console.log(hostname, service); + * // Prints: localhost ssh + * }); + * ``` + * + * If this method is invoked as its `util.promisify()` ed version, it returns a`Promise` for an `Object` with `hostname` and `service` properties. + * @since v0.11.14 + */ + export function lookupService(address: string, port: number, callback: (err: NodeJS.ErrnoException | null, hostname: string, service: string) => void): void; + export namespace lookupService { + function __promisify__( + address: string, + port: number + ): Promise<{ + hostname: string; + service: string; + }>; + } + export interface ResolveOptions { + ttl: boolean; + } + export interface ResolveWithTtlOptions extends ResolveOptions { + ttl: true; + } + export interface RecordWithTtl { + address: string; + ttl: number; + } + /** @deprecated Use `AnyARecord` or `AnyAaaaRecord` instead. */ + export type AnyRecordWithTtl = AnyARecord | AnyAaaaRecord; + export interface AnyARecord extends RecordWithTtl { + type: 'A'; + } + export interface AnyAaaaRecord extends RecordWithTtl { + type: 'AAAA'; + } + export interface CaaRecord { + critial: number; + issue?: string | undefined; + issuewild?: string | undefined; + iodef?: string | undefined; + contactemail?: string | undefined; + contactphone?: string | undefined; + } + export interface MxRecord { + priority: number; + exchange: string; + } + export interface AnyMxRecord extends MxRecord { + type: 'MX'; + } + export interface NaptrRecord { + flags: string; + service: string; + regexp: string; + replacement: string; + order: number; + preference: number; + } + export interface AnyNaptrRecord extends NaptrRecord { + type: 'NAPTR'; + } + export interface SoaRecord { + nsname: string; + hostmaster: string; + serial: number; + refresh: number; + retry: number; + expire: number; + minttl: number; + } + export interface AnySoaRecord extends SoaRecord { + type: 'SOA'; + } + export interface SrvRecord { + priority: number; + weight: number; + port: number; + name: string; + } + export interface AnySrvRecord extends SrvRecord { + type: 'SRV'; + } + export interface AnyTxtRecord { + type: 'TXT'; + entries: string[]; + } + export interface AnyNsRecord { + type: 'NS'; + value: string; + } + export interface AnyPtrRecord { + type: 'PTR'; + value: string; + } + export interface AnyCnameRecord { + type: 'CNAME'; + value: string; + } + export type AnyRecord = AnyARecord | AnyAaaaRecord | AnyCnameRecord | AnyMxRecord | AnyNaptrRecord | AnyNsRecord | AnyPtrRecord | AnySoaRecord | AnySrvRecord | AnyTxtRecord; + /** + * Uses the DNS protocol to resolve a host name (e.g. `'nodejs.org'`) into an array + * of the resource records. The `callback` function has arguments`(err, records)`. When successful, `records` will be an array of resource + * records. The type and structure of individual results varies based on `rrtype`: + * + * + * + * On error, `err` is an `Error` object, where `err.code` is one of the `DNS error codes`. + * @since v0.1.27 + * @param hostname Host name to resolve. + * @param [rrtype='A'] Resource record type. + */ + export function resolve(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; + export function resolve(hostname: string, rrtype: 'A', callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; + export function resolve(hostname: string, rrtype: 'AAAA', callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; + export function resolve(hostname: string, rrtype: 'ANY', callback: (err: NodeJS.ErrnoException | null, addresses: AnyRecord[]) => void): void; + export function resolve(hostname: string, rrtype: 'CNAME', callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; + export function resolve(hostname: string, rrtype: 'MX', callback: (err: NodeJS.ErrnoException | null, addresses: MxRecord[]) => void): void; + export function resolve(hostname: string, rrtype: 'NAPTR', callback: (err: NodeJS.ErrnoException | null, addresses: NaptrRecord[]) => void): void; + export function resolve(hostname: string, rrtype: 'NS', callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; + export function resolve(hostname: string, rrtype: 'PTR', callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; + export function resolve(hostname: string, rrtype: 'SOA', callback: (err: NodeJS.ErrnoException | null, addresses: SoaRecord) => void): void; + export function resolve(hostname: string, rrtype: 'SRV', callback: (err: NodeJS.ErrnoException | null, addresses: SrvRecord[]) => void): void; + export function resolve(hostname: string, rrtype: 'TXT', callback: (err: NodeJS.ErrnoException | null, addresses: string[][]) => void): void; + export function resolve( + hostname: string, + rrtype: string, + callback: (err: NodeJS.ErrnoException | null, addresses: string[] | MxRecord[] | NaptrRecord[] | SoaRecord | SrvRecord[] | string[][] | AnyRecord[]) => void + ): void; + export namespace resolve { + function __promisify__(hostname: string, rrtype?: 'A' | 'AAAA' | 'CNAME' | 'NS' | 'PTR'): Promise; + function __promisify__(hostname: string, rrtype: 'ANY'): Promise; + function __promisify__(hostname: string, rrtype: 'MX'): Promise; + function __promisify__(hostname: string, rrtype: 'NAPTR'): Promise; + function __promisify__(hostname: string, rrtype: 'SOA'): Promise; + function __promisify__(hostname: string, rrtype: 'SRV'): Promise; + function __promisify__(hostname: string, rrtype: 'TXT'): Promise; + function __promisify__(hostname: string, rrtype: string): Promise; + } + /** + * Uses the DNS protocol to resolve a IPv4 addresses (`A` records) for the`hostname`. The `addresses` argument passed to the `callback` function + * will contain an array of IPv4 addresses (e.g.`['74.125.79.104', '74.125.79.105', '74.125.79.106']`). + * @since v0.1.16 + * @param hostname Host name to resolve. + */ + export function resolve4(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; + export function resolve4(hostname: string, options: ResolveWithTtlOptions, callback: (err: NodeJS.ErrnoException | null, addresses: RecordWithTtl[]) => void): void; + export function resolve4(hostname: string, options: ResolveOptions, callback: (err: NodeJS.ErrnoException | null, addresses: string[] | RecordWithTtl[]) => void): void; + export namespace resolve4 { + function __promisify__(hostname: string): Promise; + function __promisify__(hostname: string, options: ResolveWithTtlOptions): Promise; + function __promisify__(hostname: string, options?: ResolveOptions): Promise; + } + /** + * Uses the DNS protocol to resolve a IPv6 addresses (`AAAA` records) for the`hostname`. The `addresses` argument passed to the `callback` function + * will contain an array of IPv6 addresses. + * @since v0.1.16 + * @param hostname Host name to resolve. + */ + export function resolve6(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; + export function resolve6(hostname: string, options: ResolveWithTtlOptions, callback: (err: NodeJS.ErrnoException | null, addresses: RecordWithTtl[]) => void): void; + export function resolve6(hostname: string, options: ResolveOptions, callback: (err: NodeJS.ErrnoException | null, addresses: string[] | RecordWithTtl[]) => void): void; + export namespace resolve6 { + function __promisify__(hostname: string): Promise; + function __promisify__(hostname: string, options: ResolveWithTtlOptions): Promise; + function __promisify__(hostname: string, options?: ResolveOptions): Promise; + } + /** + * Uses the DNS protocol to resolve `CNAME` records for the `hostname`. The`addresses` argument passed to the `callback` function + * will contain an array of canonical name records available for the `hostname`(e.g. `['bar.example.com']`). + * @since v0.3.2 + */ + export function resolveCname(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; + export namespace resolveCname { + function __promisify__(hostname: string): Promise; + } + /** + * Uses the DNS protocol to resolve `CAA` records for the `hostname`. The`addresses` argument passed to the `callback` function + * will contain an array of certification authority authorization records + * available for the `hostname` (e.g. `[{critical: 0, iodef: 'mailto:pki@example.com'}, {critical: 128, issue: 'pki.example.com'}]`). + * @since v15.0.0 + */ + export function resolveCaa(hostname: string, callback: (err: NodeJS.ErrnoException | null, records: CaaRecord[]) => void): void; + export namespace resolveCaa { + function __promisify__(hostname: string): Promise; + } + /** + * Uses the DNS protocol to resolve mail exchange records (`MX` records) for the`hostname`. The `addresses` argument passed to the `callback` function will + * contain an array of objects containing both a `priority` and `exchange`property (e.g. `[{priority: 10, exchange: 'mx.example.com'}, ...]`). + * @since v0.1.27 + */ + export function resolveMx(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: MxRecord[]) => void): void; + export namespace resolveMx { + function __promisify__(hostname: string): Promise; + } + /** + * Uses the DNS protocol to resolve regular expression based records (`NAPTR`records) for the `hostname`. The `addresses` argument passed to the `callback`function will contain an array of + * objects with the following properties: + * + * * `flags` + * * `service` + * * `regexp` + * * `replacement` + * * `order` + * * `preference` + * + * ```js + * { + * flags: 's', + * service: 'SIP+D2U', + * regexp: '', + * replacement: '_sip._udp.example.com', + * order: 30, + * preference: 100 + * } + * ``` + * @since v0.9.12 + */ + export function resolveNaptr(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: NaptrRecord[]) => void): void; + export namespace resolveNaptr { + function __promisify__(hostname: string): Promise; + } + /** + * Uses the DNS protocol to resolve name server records (`NS` records) for the`hostname`. The `addresses` argument passed to the `callback` function will + * contain an array of name server records available for `hostname`(e.g. `['ns1.example.com', 'ns2.example.com']`). + * @since v0.1.90 + */ + export function resolveNs(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; + export namespace resolveNs { + function __promisify__(hostname: string): Promise; + } + /** + * Uses the DNS protocol to resolve pointer records (`PTR` records) for the`hostname`. The `addresses` argument passed to the `callback` function will + * be an array of strings containing the reply records. + * @since v6.0.0 + */ + export function resolvePtr(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; + export namespace resolvePtr { + function __promisify__(hostname: string): Promise; + } + /** + * Uses the DNS protocol to resolve a start of authority record (`SOA` record) for + * the `hostname`. The `address` argument passed to the `callback` function will + * be an object with the following properties: + * + * * `nsname` + * * `hostmaster` + * * `serial` + * * `refresh` + * * `retry` + * * `expire` + * * `minttl` + * + * ```js + * { + * nsname: 'ns.example.com', + * hostmaster: 'root.example.com', + * serial: 2013101809, + * refresh: 10000, + * retry: 2400, + * expire: 604800, + * minttl: 3600 + * } + * ``` + * @since v0.11.10 + */ + export function resolveSoa(hostname: string, callback: (err: NodeJS.ErrnoException | null, address: SoaRecord) => void): void; + export namespace resolveSoa { + function __promisify__(hostname: string): Promise; + } + /** + * Uses the DNS protocol to resolve service records (`SRV` records) for the`hostname`. The `addresses` argument passed to the `callback` function will + * be an array of objects with the following properties: + * + * * `priority` + * * `weight` + * * `port` + * * `name` + * + * ```js + * { + * priority: 10, + * weight: 5, + * port: 21223, + * name: 'service.example.com' + * } + * ``` + * @since v0.1.27 + */ + export function resolveSrv(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: SrvRecord[]) => void): void; + export namespace resolveSrv { + function __promisify__(hostname: string): Promise; + } + /** + * Uses the DNS protocol to resolve text queries (`TXT` records) for the`hostname`. The `records` argument passed to the `callback` function is a + * two-dimensional array of the text records available for `hostname` (e.g.`[ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]`). Each sub-array contains TXT chunks of + * one record. Depending on the use case, these could be either joined together or + * treated separately. + * @since v0.1.27 + */ + export function resolveTxt(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[][]) => void): void; + export namespace resolveTxt { + function __promisify__(hostname: string): Promise; + } + /** + * Uses the DNS protocol to resolve all records (also known as `ANY` or `*` query). + * The `ret` argument passed to the `callback` function will be an array containing + * various types of records. Each object has a property `type` that indicates the + * type of the current record. And depending on the `type`, additional properties + * will be present on the object: + * + * + * + * Here is an example of the `ret` object passed to the callback: + * + * ```js + * [ { type: 'A', address: '127.0.0.1', ttl: 299 }, + * { type: 'CNAME', value: 'example.com' }, + * { type: 'MX', exchange: 'alt4.aspmx.l.example.com', priority: 50 }, + * { type: 'NS', value: 'ns1.example.com' }, + * { type: 'TXT', entries: [ 'v=spf1 include:_spf.example.com ~all' ] }, + * { type: 'SOA', + * nsname: 'ns1.example.com', + * hostmaster: 'admin.example.com', + * serial: 156696742, + * refresh: 900, + * retry: 900, + * expire: 1800, + * minttl: 60 } ] + * ``` + * + * DNS server operators may choose not to respond to `ANY`queries. It may be better to call individual methods like {@link resolve4},{@link resolveMx}, and so on. For more details, see [RFC + * 8482](https://tools.ietf.org/html/rfc8482). + */ + export function resolveAny(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: AnyRecord[]) => void): void; + export namespace resolveAny { + function __promisify__(hostname: string): Promise; + } + /** + * Performs a reverse DNS query that resolves an IPv4 or IPv6 address to an + * array of host names. + * + * On error, `err` is an `Error` object, where `err.code` is + * one of the `DNS error codes`. + * @since v0.1.16 + */ + export function reverse(ip: string, callback: (err: NodeJS.ErrnoException | null, hostnames: string[]) => void): void; + /** + * Sets the IP address and port of servers to be used when performing DNS + * resolution. The `servers` argument is an array of [RFC 5952](https://tools.ietf.org/html/rfc5952#section-6) formatted + * addresses. If the port is the IANA default DNS port (53) it can be omitted. + * + * ```js + * dns.setServers([ + * '4.4.4.4', + * '[2001:4860:4860::8888]', + * '4.4.4.4:1053', + * '[2001:4860:4860::8888]:1053', + * ]); + * ``` + * + * An error will be thrown if an invalid address is provided. + * + * The `dns.setServers()` method must not be called while a DNS query is in + * progress. + * + * The {@link setServers} method affects only {@link resolve},`dns.resolve*()` and {@link reverse} (and specifically _not_ {@link lookup}). + * + * This method works much like [resolve.conf](https://man7.org/linux/man-pages/man5/resolv.conf.5.html). + * That is, if attempting to resolve with the first server provided results in a`NOTFOUND` error, the `resolve()` method will _not_ attempt to resolve with + * subsequent servers provided. Fallback DNS servers will only be used if the + * earlier ones time out or result in some other error. + * @since v0.11.3 + * @param servers array of `RFC 5952` formatted addresses + */ + export function setServers(servers: ReadonlyArray): void; + /** + * Returns an array of IP address strings, formatted according to [RFC 5952](https://tools.ietf.org/html/rfc5952#section-6), + * that are currently configured for DNS resolution. A string will include a port + * section if a custom port is used. + * + * ```js + * [ + * '4.4.4.4', + * '2001:4860:4860::8888', + * '4.4.4.4:1053', + * '[2001:4860:4860::8888]:1053', + * ] + * ``` + * @since v0.11.3 + */ + export function getServers(): string[]; + /** + * Set the default value of `verbatim` in {@link lookup}. The value could be: + * - `ipv4first`: sets default `verbatim` `false`. + * - `verbatim`: sets default `verbatim` `true`. + * + * The default is `ipv4first` and {@link setDefaultResultOrder} have higher priority than `--dns-result-order`. + * When using worker threads, {@link setDefaultResultOrder} from the main thread won't affect the default dns orders in workers. + * @since v14.18.0 + * @param order must be 'ipv4first' or 'verbatim'. + */ + export function setDefaultResultOrder(order: 'ipv4first' | 'verbatim'): void; + // Error codes + export const NODATA: string; + export const FORMERR: string; + export const SERVFAIL: string; + export const NOTFOUND: string; + export const NOTIMP: string; + export const REFUSED: string; + export const BADQUERY: string; + export const BADNAME: string; + export const BADFAMILY: string; + export const BADRESP: string; + export const CONNREFUSED: string; + export const TIMEOUT: string; + export const EOF: string; + export const FILE: string; + export const NOMEM: string; + export const DESTRUCTION: string; + export const BADSTR: string; + export const BADFLAGS: string; + export const NONAME: string; + export const BADHINTS: string; + export const NOTINITIALIZED: string; + export const LOADIPHLPAPI: string; + export const ADDRGETNETWORKPARAMS: string; + export const CANCELLED: string; + export interface ResolverOptions { + timeout?: number | undefined; + /** + * @default 4 + */ + tries?: number; + } + /** + * An independent resolver for DNS requests. + * + * Creating a new resolver uses the default server settings. Setting + * the servers used for a resolver using `resolver.setServers()` does not affect + * other resolvers: + * + * ```js + * const { Resolver } = require('dns'); + * const resolver = new Resolver(); + * resolver.setServers(['4.4.4.4']); + * + * // This request will use the server at 4.4.4.4, independent of global settings. + * resolver.resolve4('example.org', (err, addresses) => { + * // ... + * }); + * ``` + * + * The following methods from the `dns` module are available: + * + * * `resolver.getServers()` + * * `resolver.resolve()` + * * `resolver.resolve4()` + * * `resolver.resolve6()` + * * `resolver.resolveAny()` + * * `resolver.resolveCaa()` + * * `resolver.resolveCname()` + * * `resolver.resolveMx()` + * * `resolver.resolveNaptr()` + * * `resolver.resolveNs()` + * * `resolver.resolvePtr()` + * * `resolver.resolveSoa()` + * * `resolver.resolveSrv()` + * * `resolver.resolveTxt()` + * * `resolver.reverse()` + * * `resolver.setServers()` + * @since v8.3.0 + */ + export class Resolver { + constructor(options?: ResolverOptions); + /** + * Cancel all outstanding DNS queries made by this resolver. The corresponding + * callbacks will be called with an error with code `ECANCELLED`. + * @since v8.3.0 + */ + cancel(): void; + getServers: typeof getServers; + resolve: typeof resolve; + resolve4: typeof resolve4; + resolve6: typeof resolve6; + resolveAny: typeof resolveAny; + resolveCname: typeof resolveCname; + resolveMx: typeof resolveMx; + resolveNaptr: typeof resolveNaptr; + resolveNs: typeof resolveNs; + resolvePtr: typeof resolvePtr; + resolveSoa: typeof resolveSoa; + resolveSrv: typeof resolveSrv; + resolveTxt: typeof resolveTxt; + reverse: typeof reverse; + /** + * The resolver instance will send its requests from the specified IP address. + * This allows programs to specify outbound interfaces when used on multi-homed + * systems. + * + * If a v4 or v6 address is not specified, it is set to the default, and the + * operating system will choose a local address automatically. + * + * The resolver will use the v4 local address when making requests to IPv4 DNS + * servers, and the v6 local address when making requests to IPv6 DNS servers. + * The `rrtype` of resolution requests has no impact on the local address used. + * @since v15.1.0 + * @param [ipv4='0.0.0.0'] A string representation of an IPv4 address. + * @param [ipv6='::0'] A string representation of an IPv6 address. + */ + setLocalAddress(ipv4?: string, ipv6?: string): void; + setServers: typeof setServers; + } + export { dnsPromises as promises }; +} +declare module 'node:dns' { + export * from 'dns'; +} diff --git a/node_modules/@types/node/dns/promises.d.ts b/node_modules/@types/node/dns/promises.d.ts new file mode 100755 index 00000000..a236b5ac --- /dev/null +++ b/node_modules/@types/node/dns/promises.d.ts @@ -0,0 +1,368 @@ +/** + * The `dns.promises` API provides an alternative set of asynchronous DNS methods + * that return `Promise` objects rather than using callbacks. The API is accessible + * via `require('dns').promises` or `require('dns/promises')`. + * @since v10.6.0 + */ +declare module 'dns/promises' { + import { + LookupAddress, + LookupOneOptions, + LookupAllOptions, + LookupOptions, + AnyRecord, + CaaRecord, + MxRecord, + NaptrRecord, + SoaRecord, + SrvRecord, + ResolveWithTtlOptions, + RecordWithTtl, + ResolveOptions, + ResolverOptions, + } from 'node:dns'; + /** + * Returns an array of IP address strings, formatted according to [RFC 5952](https://tools.ietf.org/html/rfc5952#section-6), + * that are currently configured for DNS resolution. A string will include a port + * section if a custom port is used. + * + * ```js + * [ + * '4.4.4.4', + * '2001:4860:4860::8888', + * '4.4.4.4:1053', + * '[2001:4860:4860::8888]:1053', + * ] + * ``` + * @since v10.6.0 + */ + function getServers(): string[]; + /** + * Resolves a host name (e.g. `'nodejs.org'`) into the first found A (IPv4) or + * AAAA (IPv6) record. All `option` properties are optional. If `options` is an + * integer, then it must be `4` or `6` – if `options` is not provided, then IPv4 + * and IPv6 addresses are both returned if found. + * + * With the `all` option set to `true`, the `Promise` is resolved with `addresses`being an array of objects with the properties `address` and `family`. + * + * On error, the `Promise` is rejected with an `Error` object, where `err.code`is the error code. + * Keep in mind that `err.code` will be set to `'ENOTFOUND'` not only when + * the host name does not exist but also when the lookup fails in other ways + * such as no available file descriptors. + * + * `dnsPromises.lookup()` does not necessarily have anything to do with the DNS + * protocol. The implementation uses an operating system facility that can + * associate names with addresses, and vice versa. This implementation can have + * subtle but important consequences on the behavior of any Node.js program. Please + * take some time to consult the `Implementation considerations section` before + * using `dnsPromises.lookup()`. + * + * Example usage: + * + * ```js + * const dns = require('dns'); + * const dnsPromises = dns.promises; + * const options = { + * family: 6, + * hints: dns.ADDRCONFIG | dns.V4MAPPED, + * }; + * + * dnsPromises.lookup('example.com', options).then((result) => { + * console.log('address: %j family: IPv%s', result.address, result.family); + * // address: "2606:2800:220:1:248:1893:25c8:1946" family: IPv6 + * }); + * + * // When options.all is true, the result will be an Array. + * options.all = true; + * dnsPromises.lookup('example.com', options).then((result) => { + * console.log('addresses: %j', result); + * // addresses: [{"address":"2606:2800:220:1:248:1893:25c8:1946","family":6}] + * }); + * ``` + * @since v10.6.0 + */ + function lookup(hostname: string, family: number): Promise; + function lookup(hostname: string, options: LookupOneOptions): Promise; + function lookup(hostname: string, options: LookupAllOptions): Promise; + function lookup(hostname: string, options: LookupOptions): Promise; + function lookup(hostname: string): Promise; + /** + * Resolves the given `address` and `port` into a host name and service using + * the operating system's underlying `getnameinfo` implementation. + * + * If `address` is not a valid IP address, a `TypeError` will be thrown. + * The `port` will be coerced to a number. If it is not a legal port, a `TypeError`will be thrown. + * + * On error, the `Promise` is rejected with an `Error` object, where `err.code`is the error code. + * + * ```js + * const dnsPromises = require('dns').promises; + * dnsPromises.lookupService('127.0.0.1', 22).then((result) => { + * console.log(result.hostname, result.service); + * // Prints: localhost ssh + * }); + * ``` + * @since v10.6.0 + */ + function lookupService( + address: string, + port: number + ): Promise<{ + hostname: string; + service: string; + }>; + /** + * Uses the DNS protocol to resolve a host name (e.g. `'nodejs.org'`) into an array + * of the resource records. When successful, the `Promise` is resolved with an + * array of resource records. The type and structure of individual results vary + * based on `rrtype`: + * + * + * + * On error, the `Promise` is rejected with an `Error` object, where `err.code`is one of the `DNS error codes`. + * @since v10.6.0 + * @param hostname Host name to resolve. + * @param [rrtype='A'] Resource record type. + */ + function resolve(hostname: string): Promise; + function resolve(hostname: string, rrtype: 'A'): Promise; + function resolve(hostname: string, rrtype: 'AAAA'): Promise; + function resolve(hostname: string, rrtype: 'ANY'): Promise; + function resolve(hostname: string, rrtype: 'CAA'): Promise; + function resolve(hostname: string, rrtype: 'CNAME'): Promise; + function resolve(hostname: string, rrtype: 'MX'): Promise; + function resolve(hostname: string, rrtype: 'NAPTR'): Promise; + function resolve(hostname: string, rrtype: 'NS'): Promise; + function resolve(hostname: string, rrtype: 'PTR'): Promise; + function resolve(hostname: string, rrtype: 'SOA'): Promise; + function resolve(hostname: string, rrtype: 'SRV'): Promise; + function resolve(hostname: string, rrtype: 'TXT'): Promise; + function resolve(hostname: string, rrtype: string): Promise; + /** + * Uses the DNS protocol to resolve IPv4 addresses (`A` records) for the`hostname`. On success, the `Promise` is resolved with an array of IPv4 + * addresses (e.g. `['74.125.79.104', '74.125.79.105', '74.125.79.106']`). + * @since v10.6.0 + * @param hostname Host name to resolve. + */ + function resolve4(hostname: string): Promise; + function resolve4(hostname: string, options: ResolveWithTtlOptions): Promise; + function resolve4(hostname: string, options: ResolveOptions): Promise; + /** + * Uses the DNS protocol to resolve IPv6 addresses (`AAAA` records) for the`hostname`. On success, the `Promise` is resolved with an array of IPv6 + * addresses. + * @since v10.6.0 + * @param hostname Host name to resolve. + */ + function resolve6(hostname: string): Promise; + function resolve6(hostname: string, options: ResolveWithTtlOptions): Promise; + function resolve6(hostname: string, options: ResolveOptions): Promise; + /** + * Uses the DNS protocol to resolve all records (also known as `ANY` or `*` query). + * On success, the `Promise` is resolved with an array containing various types of + * records. Each object has a property `type` that indicates the type of the + * current record. And depending on the `type`, additional properties will be + * present on the object: + * + * + * + * Here is an example of the result object: + * + * ```js + * [ { type: 'A', address: '127.0.0.1', ttl: 299 }, + * { type: 'CNAME', value: 'example.com' }, + * { type: 'MX', exchange: 'alt4.aspmx.l.example.com', priority: 50 }, + * { type: 'NS', value: 'ns1.example.com' }, + * { type: 'TXT', entries: [ 'v=spf1 include:_spf.example.com ~all' ] }, + * { type: 'SOA', + * nsname: 'ns1.example.com', + * hostmaster: 'admin.example.com', + * serial: 156696742, + * refresh: 900, + * retry: 900, + * expire: 1800, + * minttl: 60 } ] + * ``` + * @since v10.6.0 + */ + function resolveAny(hostname: string): Promise; + /** + * Uses the DNS protocol to resolve `CAA` records for the `hostname`. On success, + * the `Promise` is resolved with an array of objects containing available + * certification authority authorization records available for the `hostname`(e.g. `[{critical: 0, iodef: 'mailto:pki@example.com'},{critical: 128, issue: 'pki.example.com'}]`). + * @since v15.0.0 + */ + function resolveCaa(hostname: string): Promise; + /** + * Uses the DNS protocol to resolve `CNAME` records for the `hostname`. On success, + * the `Promise` is resolved with an array of canonical name records available for + * the `hostname` (e.g. `['bar.example.com']`). + * @since v10.6.0 + */ + function resolveCname(hostname: string): Promise; + /** + * Uses the DNS protocol to resolve mail exchange records (`MX` records) for the`hostname`. On success, the `Promise` is resolved with an array of objects + * containing both a `priority` and `exchange` property (e.g.`[{priority: 10, exchange: 'mx.example.com'}, ...]`). + * @since v10.6.0 + */ + function resolveMx(hostname: string): Promise; + /** + * Uses the DNS protocol to resolve regular expression based records (`NAPTR`records) for the `hostname`. On success, the `Promise` is resolved with an array + * of objects with the following properties: + * + * * `flags` + * * `service` + * * `regexp` + * * `replacement` + * * `order` + * * `preference` + * + * ```js + * { + * flags: 's', + * service: 'SIP+D2U', + * regexp: '', + * replacement: '_sip._udp.example.com', + * order: 30, + * preference: 100 + * } + * ``` + * @since v10.6.0 + */ + function resolveNaptr(hostname: string): Promise; + /** + * Uses the DNS protocol to resolve name server records (`NS` records) for the`hostname`. On success, the `Promise` is resolved with an array of name server + * records available for `hostname` (e.g.`['ns1.example.com', 'ns2.example.com']`). + * @since v10.6.0 + */ + function resolveNs(hostname: string): Promise; + /** + * Uses the DNS protocol to resolve pointer records (`PTR` records) for the`hostname`. On success, the `Promise` is resolved with an array of strings + * containing the reply records. + * @since v10.6.0 + */ + function resolvePtr(hostname: string): Promise; + /** + * Uses the DNS protocol to resolve a start of authority record (`SOA` record) for + * the `hostname`. On success, the `Promise` is resolved with an object with the + * following properties: + * + * * `nsname` + * * `hostmaster` + * * `serial` + * * `refresh` + * * `retry` + * * `expire` + * * `minttl` + * + * ```js + * { + * nsname: 'ns.example.com', + * hostmaster: 'root.example.com', + * serial: 2013101809, + * refresh: 10000, + * retry: 2400, + * expire: 604800, + * minttl: 3600 + * } + * ``` + * @since v10.6.0 + */ + function resolveSoa(hostname: string): Promise; + /** + * Uses the DNS protocol to resolve service records (`SRV` records) for the`hostname`. On success, the `Promise` is resolved with an array of objects with + * the following properties: + * + * * `priority` + * * `weight` + * * `port` + * * `name` + * + * ```js + * { + * priority: 10, + * weight: 5, + * port: 21223, + * name: 'service.example.com' + * } + * ``` + * @since v10.6.0 + */ + function resolveSrv(hostname: string): Promise; + /** + * Uses the DNS protocol to resolve text queries (`TXT` records) for the`hostname`. On success, the `Promise` is resolved with a two-dimensional array + * of the text records available for `hostname` (e.g.`[ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]`). Each sub-array contains TXT chunks of + * one record. Depending on the use case, these could be either joined together or + * treated separately. + * @since v10.6.0 + */ + function resolveTxt(hostname: string): Promise; + /** + * Performs a reverse DNS query that resolves an IPv4 or IPv6 address to an + * array of host names. + * + * On error, the `Promise` is rejected with an `Error` object, where `err.code`is one of the `DNS error codes`. + * @since v10.6.0 + */ + function reverse(ip: string): Promise; + /** + * Sets the IP address and port of servers to be used when performing DNS + * resolution. The `servers` argument is an array of [RFC 5952](https://tools.ietf.org/html/rfc5952#section-6) formatted + * addresses. If the port is the IANA default DNS port (53) it can be omitted. + * + * ```js + * dnsPromises.setServers([ + * '4.4.4.4', + * '[2001:4860:4860::8888]', + * '4.4.4.4:1053', + * '[2001:4860:4860::8888]:1053', + * ]); + * ``` + * + * An error will be thrown if an invalid address is provided. + * + * The `dnsPromises.setServers()` method must not be called while a DNS query is in + * progress. + * + * This method works much like [resolve.conf](https://man7.org/linux/man-pages/man5/resolv.conf.5.html). + * That is, if attempting to resolve with the first server provided results in a`NOTFOUND` error, the `resolve()` method will _not_ attempt to resolve with + * subsequent servers provided. Fallback DNS servers will only be used if the + * earlier ones time out or result in some other error. + * @since v10.6.0 + * @param servers array of `RFC 5952` formatted addresses + */ + function setServers(servers: ReadonlyArray): void; + /** + * Set the default value of `verbatim` in {@link lookup}. The value could be: + * - `ipv4first`: sets default `verbatim` `false`. + * - `verbatim`: sets default `verbatim` `true`. + * + * The default is `ipv4first` and {@link setDefaultResultOrder} have higher priority than `--dns-result-order`. + * When using worker threads, {@link setDefaultResultOrder} from the main thread won't affect the default dns orders in workers. + * @since v14.18.0 + * @param order must be 'ipv4first' or 'verbatim'. + */ + function setDefaultResultOrder(order: 'ipv4first' | 'verbatim'): void; + class Resolver { + constructor(options?: ResolverOptions); + cancel(): void; + getServers: typeof getServers; + resolve: typeof resolve; + resolve4: typeof resolve4; + resolve6: typeof resolve6; + resolveAny: typeof resolveAny; + resolveCname: typeof resolveCname; + resolveMx: typeof resolveMx; + resolveNaptr: typeof resolveNaptr; + resolveNs: typeof resolveNs; + resolvePtr: typeof resolvePtr; + resolveSoa: typeof resolveSoa; + resolveSrv: typeof resolveSrv; + resolveTxt: typeof resolveTxt; + reverse: typeof reverse; + setLocalAddress(ipv4?: string, ipv6?: string): void; + setServers: typeof setServers; + } +} +declare module 'node:dns/promises' { + export * from 'dns/promises'; +} diff --git a/node_modules/@types/node/domain.d.ts b/node_modules/@types/node/domain.d.ts new file mode 100755 index 00000000..383e3855 --- /dev/null +++ b/node_modules/@types/node/domain.d.ts @@ -0,0 +1,169 @@ +/** + * **This module is pending deprecation.** Once a replacement API has been + * finalized, this module will be fully deprecated. Most developers should**not** have cause to use this module. Users who absolutely must have + * the functionality that domains provide may rely on it for the time being + * but should expect to have to migrate to a different solution + * in the future. + * + * Domains provide a way to handle multiple different IO operations as a + * single group. If any of the event emitters or callbacks registered to a + * domain emit an `'error'` event, or throw an error, then the domain object + * will be notified, rather than losing the context of the error in the`process.on('uncaughtException')` handler, or causing the program to + * exit immediately with an error code. + * @deprecated Since v1.4.2 - Deprecated + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/domain.js) + */ +declare module 'domain' { + import EventEmitter = require('node:events'); + /** + * The `Domain` class encapsulates the functionality of routing errors and + * uncaught exceptions to the active `Domain` object. + * + * To handle the errors that it catches, listen to its `'error'` event. + */ + class Domain extends EventEmitter { + /** + * An array of timers and event emitters that have been explicitly added + * to the domain. + */ + members: Array; + /** + * The `enter()` method is plumbing used by the `run()`, `bind()`, and`intercept()` methods to set the active domain. It sets `domain.active` and`process.domain` to the domain, and implicitly + * pushes the domain onto the domain + * stack managed by the domain module (see {@link exit} for details on the + * domain stack). The call to `enter()` delimits the beginning of a chain of + * asynchronous calls and I/O operations bound to a domain. + * + * Calling `enter()` changes only the active domain, and does not alter the domain + * itself. `enter()` and `exit()` can be called an arbitrary number of times on a + * single domain. + */ + enter(): void; + /** + * The `exit()` method exits the current domain, popping it off the domain stack. + * Any time execution is going to switch to the context of a different chain of + * asynchronous calls, it's important to ensure that the current domain is exited. + * The call to `exit()` delimits either the end of or an interruption to the chain + * of asynchronous calls and I/O operations bound to a domain. + * + * If there are multiple, nested domains bound to the current execution context,`exit()` will exit any domains nested within this domain. + * + * Calling `exit()` changes only the active domain, and does not alter the domain + * itself. `enter()` and `exit()` can be called an arbitrary number of times on a + * single domain. + */ + exit(): void; + /** + * Run the supplied function in the context of the domain, implicitly + * binding all event emitters, timers, and lowlevel requests that are + * created in that context. Optionally, arguments can be passed to + * the function. + * + * This is the most basic way to use a domain. + * + * ```js + * const domain = require('domain'); + * const fs = require('fs'); + * const d = domain.create(); + * d.on('error', (er) => { + * console.error('Caught error!', er); + * }); + * d.run(() => { + * process.nextTick(() => { + * setTimeout(() => { // Simulating some various async stuff + * fs.open('non-existent file', 'r', (er, fd) => { + * if (er) throw er; + * // proceed... + * }); + * }, 100); + * }); + * }); + * ``` + * + * In this example, the `d.on('error')` handler will be triggered, rather + * than crashing the program. + */ + run(fn: (...args: any[]) => T, ...args: any[]): T; + /** + * Explicitly adds an emitter to the domain. If any event handlers called by + * the emitter throw an error, or if the emitter emits an `'error'` event, it + * will be routed to the domain's `'error'` event, just like with implicit + * binding. + * + * This also works with timers that are returned from `setInterval()` and `setTimeout()`. If their callback function throws, it will be caught by + * the domain `'error'` handler. + * + * If the Timer or `EventEmitter` was already bound to a domain, it is removed + * from that one, and bound to this one instead. + * @param emitter emitter or timer to be added to the domain + */ + add(emitter: EventEmitter | NodeJS.Timer): void; + /** + * The opposite of {@link add}. Removes domain handling from the + * specified emitter. + * @param emitter emitter or timer to be removed from the domain + */ + remove(emitter: EventEmitter | NodeJS.Timer): void; + /** + * The returned function will be a wrapper around the supplied callback + * function. When the returned function is called, any errors that are + * thrown will be routed to the domain's `'error'` event. + * + * ```js + * const d = domain.create(); + * + * function readSomeFile(filename, cb) { + * fs.readFile(filename, 'utf8', d.bind((er, data) => { + * // If this throws, it will also be passed to the domain. + * return cb(er, data ? JSON.parse(data) : null); + * })); + * } + * + * d.on('error', (er) => { + * // An error occurred somewhere. If we throw it now, it will crash the program + * // with the normal line number and stack message. + * }); + * ``` + * @param callback The callback function + * @return The bound function + */ + bind(callback: T): T; + /** + * This method is almost identical to {@link bind}. However, in + * addition to catching thrown errors, it will also intercept `Error` objects sent as the first argument to the function. + * + * In this way, the common `if (err) return callback(err);` pattern can be replaced + * with a single error handler in a single place. + * + * ```js + * const d = domain.create(); + * + * function readSomeFile(filename, cb) { + * fs.readFile(filename, 'utf8', d.intercept((data) => { + * // Note, the first argument is never passed to the + * // callback since it is assumed to be the 'Error' argument + * // and thus intercepted by the domain. + * + * // If this throws, it will also be passed to the domain + * // so the error-handling logic can be moved to the 'error' + * // event on the domain instead of being repeated throughout + * // the program. + * return cb(null, JSON.parse(data)); + * })); + * } + * + * d.on('error', (er) => { + * // An error occurred somewhere. If we throw it now, it will crash the program + * // with the normal line number and stack message. + * }); + * ``` + * @param callback The callback function + * @return The intercepted function + */ + intercept(callback: T): T; + } + function create(): Domain; +} +declare module 'node:domain' { + export * from 'domain'; +} diff --git a/node_modules/@types/node/events.d.ts b/node_modules/@types/node/events.d.ts new file mode 100755 index 00000000..a1ed5ab7 --- /dev/null +++ b/node_modules/@types/node/events.d.ts @@ -0,0 +1,623 @@ +/** + * Much of the Node.js core API is built around an idiomatic asynchronous + * event-driven architecture in which certain kinds of objects (called "emitters") + * emit named events that cause `Function` objects ("listeners") to be called. + * + * For instance: a `net.Server` object emits an event each time a peer + * connects to it; a `fs.ReadStream` emits an event when the file is opened; + * a `stream` emits an event whenever data is available to be read. + * + * All objects that emit events are instances of the `EventEmitter` class. These + * objects expose an `eventEmitter.on()` function that allows one or more + * functions to be attached to named events emitted by the object. Typically, + * event names are camel-cased strings but any valid JavaScript property key + * can be used. + * + * When the `EventEmitter` object emits an event, all of the functions attached + * to that specific event are called _synchronously_. Any values returned by the + * called listeners are _ignored_ and discarded. + * + * The following example shows a simple `EventEmitter` instance with a single + * listener. The `eventEmitter.on()` method is used to register listeners, while + * the `eventEmitter.emit()` method is used to trigger the event. + * + * ```js + * const EventEmitter = require('events'); + * + * class MyEmitter extends EventEmitter {} + * + * const myEmitter = new MyEmitter(); + * myEmitter.on('event', () => { + * console.log('an event occurred!'); + * }); + * myEmitter.emit('event'); + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/events.js) + */ +declare module 'events' { + interface EventEmitterOptions { + /** + * Enables automatic capturing of promise rejection. + */ + captureRejections?: boolean | undefined; + } + interface NodeEventTarget { + once(eventName: string | symbol, listener: (...args: any[]) => void): this; + } + interface DOMEventTarget { + addEventListener( + eventName: string, + listener: (...args: any[]) => void, + opts?: { + once: boolean; + } + ): any; + } + interface StaticEventEmitterOptions { + signal?: AbortSignal | undefined; + } + interface EventEmitter extends NodeJS.EventEmitter {} + /** + * The `EventEmitter` class is defined and exposed by the `events` module: + * + * ```js + * const EventEmitter = require('events'); + * ``` + * + * All `EventEmitter`s emit the event `'newListener'` when new listeners are + * added and `'removeListener'` when existing listeners are removed. + * + * It supports the following option: + * @since v0.1.26 + */ + class EventEmitter { + constructor(options?: EventEmitterOptions); + /** + * Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given + * event or that is rejected if the `EventEmitter` emits `'error'` while waiting. + * The `Promise` will resolve with an array of all the arguments emitted to the + * given event. + * + * This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event + * semantics and does not listen to the `'error'` event. + * + * ```js + * const { once, EventEmitter } = require('events'); + * + * async function run() { + * const ee = new EventEmitter(); + * + * process.nextTick(() => { + * ee.emit('myevent', 42); + * }); + * + * const [value] = await once(ee, 'myevent'); + * console.log(value); + * + * const err = new Error('kaboom'); + * process.nextTick(() => { + * ee.emit('error', err); + * }); + * + * try { + * await once(ee, 'myevent'); + * } catch (err) { + * console.log('error happened', err); + * } + * } + * + * run(); + * ``` + * + * The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the + * '`error'` event itself, then it is treated as any other kind of event without + * special handling: + * + * ```js + * const { EventEmitter, once } = require('events'); + * + * const ee = new EventEmitter(); + * + * once(ee, 'error') + * .then(([err]) => console.log('ok', err.message)) + * .catch((err) => console.log('error', err.message)); + * + * ee.emit('error', new Error('boom')); + * + * // Prints: ok boom + * ``` + * + * An `AbortSignal` can be used to cancel waiting for the event: + * + * ```js + * const { EventEmitter, once } = require('events'); + * + * const ee = new EventEmitter(); + * const ac = new AbortController(); + * + * async function foo(emitter, event, signal) { + * try { + * await once(emitter, event, { signal }); + * console.log('event emitted!'); + * } catch (error) { + * if (error.name === 'AbortError') { + * console.error('Waiting for the event was canceled!'); + * } else { + * console.error('There was an error', error.message); + * } + * } + * } + * + * foo(ee, 'foo', ac.signal); + * ac.abort(); // Abort waiting for the event + * ee.emit('foo'); // Prints: Waiting for the event was canceled! + * ``` + * @since v11.13.0, v10.16.0 + */ + static once(emitter: NodeEventTarget, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise; + static once(emitter: DOMEventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise; + /** + * ```js + * const { on, EventEmitter } = require('events'); + * + * (async () => { + * const ee = new EventEmitter(); + * + * // Emit later on + * process.nextTick(() => { + * ee.emit('foo', 'bar'); + * ee.emit('foo', 42); + * }); + * + * for await (const event of on(ee, 'foo')) { + * // The execution of this inner block is synchronous and it + * // processes one event at a time (even with await). Do not use + * // if concurrent execution is required. + * console.log(event); // prints ['bar'] [42] + * } + * // Unreachable here + * })(); + * ``` + * + * Returns an `AsyncIterator` that iterates `eventName` events. It will throw + * if the `EventEmitter` emits `'error'`. It removes all listeners when + * exiting the loop. The `value` returned by each iteration is an array + * composed of the emitted event arguments. + * + * An `AbortSignal` can be used to cancel waiting on events: + * + * ```js + * const { on, EventEmitter } = require('events'); + * const ac = new AbortController(); + * + * (async () => { + * const ee = new EventEmitter(); + * + * // Emit later on + * process.nextTick(() => { + * ee.emit('foo', 'bar'); + * ee.emit('foo', 42); + * }); + * + * for await (const event of on(ee, 'foo', { signal: ac.signal })) { + * // The execution of this inner block is synchronous and it + * // processes one event at a time (even with await). Do not use + * // if concurrent execution is required. + * console.log(event); // prints ['bar'] [42] + * } + * // Unreachable here + * })(); + * + * process.nextTick(() => ac.abort()); + * ``` + * @since v13.6.0, v12.16.0 + * @param eventName The name of the event being listened for + * @return that iterates `eventName` events emitted by the `emitter` + */ + static on(emitter: NodeJS.EventEmitter, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator; + /** + * A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + * + * ```js + * const { EventEmitter, listenerCount } = require('events'); + * const myEmitter = new EventEmitter(); + * myEmitter.on('event', () => {}); + * myEmitter.on('event', () => {}); + * console.log(listenerCount(myEmitter, 'event')); + * // Prints: 2 + * ``` + * @since v0.9.12 + * @deprecated Since v3.2.0 - Use `listenerCount` instead. + * @param emitter The emitter to query + * @param eventName The event name + */ + static listenerCount(emitter: NodeJS.EventEmitter, eventName: string | symbol): number; + /** + * Returns a copy of the array of listeners for the event named `eventName`. + * + * For `EventEmitter`s this behaves exactly the same as calling `.listeners` on + * the emitter. + * + * For `EventTarget`s this is the only way to get the event listeners for the + * event target. This is useful for debugging and diagnostic purposes. + * + * ```js + * const { getEventListeners, EventEmitter } = require('events'); + * + * { + * const ee = new EventEmitter(); + * const listener = () => console.log('Events are fun'); + * ee.on('foo', listener); + * getEventListeners(ee, 'foo'); // [listener] + * } + * { + * const et = new EventTarget(); + * const listener = () => console.log('Events are fun'); + * et.addEventListener('foo', listener); + * getEventListeners(et, 'foo'); // [listener] + * } + * ``` + * @since v15.2.0 + */ + static getEventListeners(emitter: DOMEventTarget | NodeJS.EventEmitter, name: string | symbol): Function[]; + /** + * This symbol shall be used to install a listener for only monitoring `'error'` + * events. Listeners installed using this symbol are called before the regular + * `'error'` listeners are called. + * + * Installing a listener using this symbol does not change the behavior once an + * `'error'` event is emitted, therefore the process will still crash if no + * regular `'error'` listener is installed. + */ + static readonly errorMonitor: unique symbol; + static readonly captureRejectionSymbol: unique symbol; + /** + * Sets or gets the default captureRejection value for all emitters. + */ + // TODO: These should be described using static getter/setter pairs: + static captureRejections: boolean; + static defaultMaxListeners: number; + } + import internal = require('node:events'); + namespace EventEmitter { + // Should just be `export { EventEmitter }`, but that doesn't work in TypeScript 3.4 + export { internal as EventEmitter }; + export interface Abortable { + /** + * When provided the corresponding `AbortController` can be used to cancel an asynchronous action. + */ + signal?: AbortSignal | undefined; + } + } + global { + namespace NodeJS { + interface EventEmitter { + /** + * Alias for `emitter.on(eventName, listener)`. + * @since v0.1.26 + */ + addListener(eventName: string | symbol, listener: (...args: any[]) => void): this; + /** + * Adds the `listener` function to the end of the listeners array for the + * event named `eventName`. No checks are made to see if the `listener` has + * already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple + * times. + * + * ```js + * server.on('connection', (stream) => { + * console.log('someone connected!'); + * }); + * ``` + * + * Returns a reference to the `EventEmitter`, so that calls can be chained. + * + * By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the + * event listener to the beginning of the listeners array. + * + * ```js + * const myEE = new EventEmitter(); + * myEE.on('foo', () => console.log('a')); + * myEE.prependListener('foo', () => console.log('b')); + * myEE.emit('foo'); + * // Prints: + * // b + * // a + * ``` + * @since v0.1.101 + * @param eventName The name of the event. + * @param listener The callback function + */ + on(eventName: string | symbol, listener: (...args: any[]) => void): this; + /** + * Adds a **one-time**`listener` function for the event named `eventName`. The + * next time `eventName` is triggered, this listener is removed and then invoked. + * + * ```js + * server.once('connection', (stream) => { + * console.log('Ah, we have our first user!'); + * }); + * ``` + * + * Returns a reference to the `EventEmitter`, so that calls can be chained. + * + * By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the + * event listener to the beginning of the listeners array. + * + * ```js + * const myEE = new EventEmitter(); + * myEE.once('foo', () => console.log('a')); + * myEE.prependOnceListener('foo', () => console.log('b')); + * myEE.emit('foo'); + * // Prints: + * // b + * // a + * ``` + * @since v0.3.0 + * @param eventName The name of the event. + * @param listener The callback function + */ + once(eventName: string | symbol, listener: (...args: any[]) => void): this; + /** + * Removes the specified `listener` from the listener array for the event named`eventName`. + * + * ```js + * const callback = (stream) => { + * console.log('someone connected!'); + * }; + * server.on('connection', callback); + * // ... + * server.removeListener('connection', callback); + * ``` + * + * `removeListener()` will remove, at most, one instance of a listener from the + * listener array. If any single listener has been added multiple times to the + * listener array for the specified `eventName`, then `removeListener()` must be + * called multiple times to remove each instance. + * + * Once an event is emitted, all listeners attached to it at the + * time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and_before_ the last listener finishes execution will + * not remove them from`emit()` in progress. Subsequent events behave as expected. + * + * ```js + * const myEmitter = new MyEmitter(); + * + * const callbackA = () => { + * console.log('A'); + * myEmitter.removeListener('event', callbackB); + * }; + * + * const callbackB = () => { + * console.log('B'); + * }; + * + * myEmitter.on('event', callbackA); + * + * myEmitter.on('event', callbackB); + * + * // callbackA removes listener callbackB but it will still be called. + * // Internal listener array at time of emit [callbackA, callbackB] + * myEmitter.emit('event'); + * // Prints: + * // A + * // B + * + * // callbackB is now removed. + * // Internal listener array [callbackA] + * myEmitter.emit('event'); + * // Prints: + * // A + * ``` + * + * Because listeners are managed using an internal array, calling this will + * change the position indices of any listener registered _after_ the listener + * being removed. This will not impact the order in which listeners are called, + * but it means that any copies of the listener array as returned by + * the `emitter.listeners()` method will need to be recreated. + * + * When a single function has been added as a handler multiple times for a single + * event (as in the example below), `removeListener()` will remove the most + * recently added instance. In the example the `once('ping')`listener is removed: + * + * ```js + * const ee = new EventEmitter(); + * + * function pong() { + * console.log('pong'); + * } + * + * ee.on('ping', pong); + * ee.once('ping', pong); + * ee.removeListener('ping', pong); + * + * ee.emit('ping'); + * ee.emit('ping'); + * ``` + * + * Returns a reference to the `EventEmitter`, so that calls can be chained. + * @since v0.1.26 + */ + removeListener(eventName: string | symbol, listener: (...args: any[]) => void): this; + /** + * Alias for `emitter.removeListener()`. + * @since v10.0.0 + */ + off(eventName: string | symbol, listener: (...args: any[]) => void): this; + /** + * Removes all listeners, or those of the specified `eventName`. + * + * It is bad practice to remove listeners added elsewhere in the code, + * particularly when the `EventEmitter` instance was created by some other + * component or module (e.g. sockets or file streams). + * + * Returns a reference to the `EventEmitter`, so that calls can be chained. + * @since v0.1.26 + */ + removeAllListeners(event?: string | symbol): this; + /** + * By default `EventEmitter`s will print a warning if more than `10` listeners are + * added for a particular event. This is a useful default that helps finding + * memory leaks. The `emitter.setMaxListeners()` method allows the limit to be + * modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + * + * Returns a reference to the `EventEmitter`, so that calls can be chained. + * @since v0.3.5 + */ + setMaxListeners(n: number): this; + /** + * Returns the current max listener value for the `EventEmitter` which is either + * set by `emitter.setMaxListeners(n)` or defaults to {@link defaultMaxListeners}. + * @since v1.0.0 + */ + getMaxListeners(): number; + /** + * Returns a copy of the array of listeners for the event named `eventName`. + * + * ```js + * server.on('connection', (stream) => { + * console.log('someone connected!'); + * }); + * console.log(util.inspect(server.listeners('connection'))); + * // Prints: [ [Function] ] + * ``` + * @since v0.1.26 + */ + listeners(eventName: string | symbol): Function[]; + /** + * Returns a copy of the array of listeners for the event named `eventName`, + * including any wrappers (such as those created by `.once()`). + * + * ```js + * const emitter = new EventEmitter(); + * emitter.once('log', () => console.log('log once')); + * + * // Returns a new Array with a function `onceWrapper` which has a property + * // `listener` which contains the original listener bound above + * const listeners = emitter.rawListeners('log'); + * const logFnWrapper = listeners[0]; + * + * // Logs "log once" to the console and does not unbind the `once` event + * logFnWrapper.listener(); + * + * // Logs "log once" to the console and removes the listener + * logFnWrapper(); + * + * emitter.on('log', () => console.log('log persistently')); + * // Will return a new Array with a single function bound by `.on()` above + * const newListeners = emitter.rawListeners('log'); + * + * // Logs "log persistently" twice + * newListeners[0](); + * emitter.emit('log'); + * ``` + * @since v9.4.0 + */ + rawListeners(eventName: string | symbol): Function[]; + /** + * Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments + * to each. + * + * Returns `true` if the event had listeners, `false` otherwise. + * + * ```js + * const EventEmitter = require('events'); + * const myEmitter = new EventEmitter(); + * + * // First listener + * myEmitter.on('event', function firstListener() { + * console.log('Helloooo! first listener'); + * }); + * // Second listener + * myEmitter.on('event', function secondListener(arg1, arg2) { + * console.log(`event with parameters ${arg1}, ${arg2} in second listener`); + * }); + * // Third listener + * myEmitter.on('event', function thirdListener(...args) { + * const parameters = args.join(', '); + * console.log(`event with parameters ${parameters} in third listener`); + * }); + * + * console.log(myEmitter.listeners('event')); + * + * myEmitter.emit('event', 1, 2, 3, 4, 5); + * + * // Prints: + * // [ + * // [Function: firstListener], + * // [Function: secondListener], + * // [Function: thirdListener] + * // ] + * // Helloooo! first listener + * // event with parameters 1, 2 in second listener + * // event with parameters 1, 2, 3, 4, 5 in third listener + * ``` + * @since v0.1.26 + */ + emit(eventName: string | symbol, ...args: any[]): boolean; + /** + * Returns the number of listeners listening to the event named `eventName`. + * @since v3.2.0 + * @param eventName The name of the event being listened for + */ + listenerCount(eventName: string | symbol): number; + /** + * Adds the `listener` function to the _beginning_ of the listeners array for the + * event named `eventName`. No checks are made to see if the `listener` has + * already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple + * times. + * + * ```js + * server.prependListener('connection', (stream) => { + * console.log('someone connected!'); + * }); + * ``` + * + * Returns a reference to the `EventEmitter`, so that calls can be chained. + * @since v6.0.0 + * @param eventName The name of the event. + * @param listener The callback function + */ + prependListener(eventName: string | symbol, listener: (...args: any[]) => void): this; + /** + * Adds a **one-time**`listener` function for the event named `eventName` to the_beginning_ of the listeners array. The next time `eventName` is triggered, this + * listener is removed, and then invoked. + * + * ```js + * server.prependOnceListener('connection', (stream) => { + * console.log('Ah, we have our first user!'); + * }); + * ``` + * + * Returns a reference to the `EventEmitter`, so that calls can be chained. + * @since v6.0.0 + * @param eventName The name of the event. + * @param listener The callback function + */ + prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): this; + /** + * Returns an array listing the events for which the emitter has registered + * listeners. The values in the array are strings or `Symbol`s. + * + * ```js + * const EventEmitter = require('events'); + * const myEE = new EventEmitter(); + * myEE.on('foo', () => {}); + * myEE.on('bar', () => {}); + * + * const sym = Symbol('symbol'); + * myEE.on(sym, () => {}); + * + * console.log(myEE.eventNames()); + * // Prints: [ 'foo', 'bar', Symbol(symbol) ] + * ``` + * @since v6.0.0 + */ + eventNames(): Array; + } + } + } + export = EventEmitter; +} +declare module 'node:events' { + import events = require('events'); + export = events; +} diff --git a/node_modules/@types/node/fs.d.ts b/node_modules/@types/node/fs.d.ts new file mode 100755 index 00000000..900b4651 --- /dev/null +++ b/node_modules/@types/node/fs.d.ts @@ -0,0 +1,3784 @@ +/** + * The `fs` module enables interacting with the file system in a + * way modeled on standard POSIX functions. + * + * To use the promise-based APIs: + * + * ```js + * import * as fs from 'fs/promises'; + * ``` + * + * To use the callback and sync APIs: + * + * ```js + * import * as fs from 'fs'; + * ``` + * + * All file system operations have synchronous, callback, and promise-based + * forms, and are accessible using both CommonJS syntax and ES6 Modules (ESM). + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/fs.js) + */ +declare module 'fs' { + import * as stream from 'node:stream'; + import { Abortable, EventEmitter } from 'node:events'; + import { URL } from 'node:url'; + import * as promises from 'node:fs/promises'; + export { promises }; + /** + * Valid types for path values in "fs". + */ + export type PathLike = string | Buffer | URL; + export type PathOrFileDescriptor = PathLike | number; + export type TimeLike = string | number | Date; + export type NoParamCallback = (err: NodeJS.ErrnoException | null) => void; + export type BufferEncodingOption = + | 'buffer' + | { + encoding: 'buffer'; + }; + export interface ObjectEncodingOptions { + encoding?: BufferEncoding | null | undefined; + } + export type EncodingOption = ObjectEncodingOptions | BufferEncoding | undefined | null; + export type OpenMode = number | string; + export type Mode = number | string; + export interface StatsBase { + isFile(): boolean; + isDirectory(): boolean; + isBlockDevice(): boolean; + isCharacterDevice(): boolean; + isSymbolicLink(): boolean; + isFIFO(): boolean; + isSocket(): boolean; + dev: T; + ino: T; + mode: T; + nlink: T; + uid: T; + gid: T; + rdev: T; + size: T; + blksize: T; + blocks: T; + atimeMs: T; + mtimeMs: T; + ctimeMs: T; + birthtimeMs: T; + atime: Date; + mtime: Date; + ctime: Date; + birthtime: Date; + } + export interface Stats extends StatsBase {} + /** + * A `fs.Stats` object provides information about a file. + * + * Objects returned from {@link stat}, {@link lstat} and {@link fstat} and + * their synchronous counterparts are of this type. + * If `bigint` in the `options` passed to those methods is true, the numeric values + * will be `bigint` instead of `number`, and the object will contain additional + * nanosecond-precision properties suffixed with `Ns`. + * + * ```console + * Stats { + * dev: 2114, + * ino: 48064969, + * mode: 33188, + * nlink: 1, + * uid: 85, + * gid: 100, + * rdev: 0, + * size: 527, + * blksize: 4096, + * blocks: 8, + * atimeMs: 1318289051000.1, + * mtimeMs: 1318289051000.1, + * ctimeMs: 1318289051000.1, + * birthtimeMs: 1318289051000.1, + * atime: Mon, 10 Oct 2011 23:24:11 GMT, + * mtime: Mon, 10 Oct 2011 23:24:11 GMT, + * ctime: Mon, 10 Oct 2011 23:24:11 GMT, + * birthtime: Mon, 10 Oct 2011 23:24:11 GMT } + * ``` + * + * `bigint` version: + * + * ```console + * BigIntStats { + * dev: 2114n, + * ino: 48064969n, + * mode: 33188n, + * nlink: 1n, + * uid: 85n, + * gid: 100n, + * rdev: 0n, + * size: 527n, + * blksize: 4096n, + * blocks: 8n, + * atimeMs: 1318289051000n, + * mtimeMs: 1318289051000n, + * ctimeMs: 1318289051000n, + * birthtimeMs: 1318289051000n, + * atimeNs: 1318289051000000000n, + * mtimeNs: 1318289051000000000n, + * ctimeNs: 1318289051000000000n, + * birthtimeNs: 1318289051000000000n, + * atime: Mon, 10 Oct 2011 23:24:11 GMT, + * mtime: Mon, 10 Oct 2011 23:24:11 GMT, + * ctime: Mon, 10 Oct 2011 23:24:11 GMT, + * birthtime: Mon, 10 Oct 2011 23:24:11 GMT } + * ``` + * @since v0.1.21 + */ + export class Stats {} + /** + * A representation of a directory entry, which can be a file or a subdirectory + * within the directory, as returned by reading from an `fs.Dir`. The + * directory entry is a combination of the file name and file type pairs. + * + * Additionally, when {@link readdir} or {@link readdirSync} is called with + * the `withFileTypes` option set to `true`, the resulting array is filled with `fs.Dirent` objects, rather than strings or `Buffer` s. + * @since v10.10.0 + */ + export class Dirent { + /** + * Returns `true` if the `fs.Dirent` object describes a regular file. + * @since v10.10.0 + */ + isFile(): boolean; + /** + * Returns `true` if the `fs.Dirent` object describes a file system + * directory. + * @since v10.10.0 + */ + isDirectory(): boolean; + /** + * Returns `true` if the `fs.Dirent` object describes a block device. + * @since v10.10.0 + */ + isBlockDevice(): boolean; + /** + * Returns `true` if the `fs.Dirent` object describes a character device. + * @since v10.10.0 + */ + isCharacterDevice(): boolean; + /** + * Returns `true` if the `fs.Dirent` object describes a symbolic link. + * @since v10.10.0 + */ + isSymbolicLink(): boolean; + /** + * Returns `true` if the `fs.Dirent` object describes a first-in-first-out + * (FIFO) pipe. + * @since v10.10.0 + */ + isFIFO(): boolean; + /** + * Returns `true` if the `fs.Dirent` object describes a socket. + * @since v10.10.0 + */ + isSocket(): boolean; + /** + * The file name that this `fs.Dirent` object refers to. The type of this + * value is determined by the `options.encoding` passed to {@link readdir} or {@link readdirSync}. + * @since v10.10.0 + */ + name: string; + } + /** + * A class representing a directory stream. + * + * Created by {@link opendir}, {@link opendirSync}, or `fsPromises.opendir()`. + * + * ```js + * import { opendir } from 'fs/promises'; + * + * try { + * const dir = await opendir('./'); + * for await (const dirent of dir) + * console.log(dirent.name); + * } catch (err) { + * console.error(err); + * } + * ``` + * + * When using the async iterator, the `fs.Dir` object will be automatically + * closed after the iterator exits. + * @since v12.12.0 + */ + export class Dir implements AsyncIterable { + /** + * The read-only path of this directory as was provided to {@link opendir},{@link opendirSync}, or `fsPromises.opendir()`. + * @since v12.12.0 + */ + readonly path: string; + /** + * Asynchronously iterates over the directory via `readdir(3)` until all entries have been read. + */ + [Symbol.asyncIterator](): AsyncIterableIterator; + /** + * Asynchronously close the directory's underlying resource handle. + * Subsequent reads will result in errors. + * + * A promise is returned that will be resolved after the resource has been + * closed. + * @since v12.12.0 + */ + close(): Promise; + close(cb: NoParamCallback): void; + /** + * Synchronously close the directory's underlying resource handle. + * Subsequent reads will result in errors. + * @since v12.12.0 + */ + closeSync(): void; + /** + * Asynchronously read the next directory entry via [`readdir(3)`](http://man7.org/linux/man-pages/man3/readdir.3.html) as an `fs.Dirent`. + * + * A promise is returned that will be resolved with an `fs.Dirent`, or `null`if there are no more directory entries to read. + * + * Directory entries returned by this function are in no particular order as + * provided by the operating system's underlying directory mechanisms. + * Entries added or removed while iterating over the directory might not be + * included in the iteration results. + * @since v12.12.0 + * @return containing {fs.Dirent|null} + */ + read(): Promise; + read(cb: (err: NodeJS.ErrnoException | null, dirEnt: Dirent | null) => void): void; + /** + * Synchronously read the next directory entry as an `fs.Dirent`. See the + * POSIX [`readdir(3)`](http://man7.org/linux/man-pages/man3/readdir.3.html) documentation for more detail. + * + * If there are no more directory entries to read, `null` will be returned. + * + * Directory entries returned by this function are in no particular order as + * provided by the operating system's underlying directory mechanisms. + * Entries added or removed while iterating over the directory might not be + * included in the iteration results. + * @since v12.12.0 + */ + readSync(): Dirent | null; + } + /** + * Class: fs.StatWatcher + * @since v14.3.0, v12.20.0 + * Extends `EventEmitter` + * A successful call to {@link watchFile} method will return a new fs.StatWatcher object. + */ + export interface StatWatcher extends EventEmitter { + /** + * @since v14.3.0, v12.20.0 + * When called, requests that the Node.js event loop not exit so long as the `fs.StatWatcher` is active. + * Calling `watcher.ref()` multiple times will have no effect. + * By default, all `fs.StatWatcher`` objects are "ref'ed", making it normally unnecessary to call `watcher.ref()` + * unless `watcher.unref()` had been called previously. + */ + ref(): this; + /** + * @since v14.3.0, v12.20.0 + * When called, the active `fs.StatWatcher`` object will not require the Node.js event loop to remain active. + * If there is no other activity keeping the event loop running, the process may exit before the `fs.StatWatcher`` object's callback is invoked. + * `Calling watcher.unref()` multiple times will have no effect. + */ + unref(): this; + } + export interface FSWatcher extends EventEmitter { + /** + * Stop watching for changes on the given `fs.FSWatcher`. Once stopped, the `fs.FSWatcher` object is no longer usable. + * @since v0.5.8 + */ + close(): void; + /** + * events.EventEmitter + * 1. change + * 2. error + */ + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'change', listener: (eventType: string, filename: string | Buffer) => void): this; + addListener(event: 'error', listener: (error: Error) => void): this; + addListener(event: 'close', listener: () => void): this; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'change', listener: (eventType: string, filename: string | Buffer) => void): this; + on(event: 'error', listener: (error: Error) => void): this; + on(event: 'close', listener: () => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'change', listener: (eventType: string, filename: string | Buffer) => void): this; + once(event: 'error', listener: (error: Error) => void): this; + once(event: 'close', listener: () => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'change', listener: (eventType: string, filename: string | Buffer) => void): this; + prependListener(event: 'error', listener: (error: Error) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'change', listener: (eventType: string, filename: string | Buffer) => void): this; + prependOnceListener(event: 'error', listener: (error: Error) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + } + /** + * Instances of `fs.ReadStream` are created and returned using the {@link createReadStream} function. + * @since v0.1.93 + */ + export class ReadStream extends stream.Readable { + close(callback?: (err?: NodeJS.ErrnoException | null) => void): void; + /** + * The number of bytes that have been read so far. + * @since v6.4.0 + */ + bytesRead: number; + /** + * The path to the file the stream is reading from as specified in the first + * argument to `fs.createReadStream()`. If `path` is passed as a string, then`readStream.path` will be a string. If `path` is passed as a `Buffer`, then`readStream.path` will be a + * `Buffer`. If `fd` is specified, then`readStream.path` will be `undefined`. + * @since v0.1.93 + */ + path: string | Buffer; + /** + * This property is `true` if the underlying file has not been opened yet, + * i.e. before the `'ready'` event is emitted. + * @since v11.2.0, v10.16.0 + */ + pending: boolean; + /** + * events.EventEmitter + * 1. open + * 2. close + * 3. ready + */ + addListener(event: 'close', listener: () => void): this; + addListener(event: 'data', listener: (chunk: Buffer | string) => void): this; + addListener(event: 'end', listener: () => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'open', listener: (fd: number) => void): this; + addListener(event: 'pause', listener: () => void): this; + addListener(event: 'readable', listener: () => void): this; + addListener(event: 'ready', listener: () => void): this; + addListener(event: 'resume', listener: () => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + on(event: 'close', listener: () => void): this; + on(event: 'data', listener: (chunk: Buffer | string) => void): this; + on(event: 'end', listener: () => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'open', listener: (fd: number) => void): this; + on(event: 'pause', listener: () => void): this; + on(event: 'readable', listener: () => void): this; + on(event: 'ready', listener: () => void): this; + on(event: 'resume', listener: () => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'data', listener: (chunk: Buffer | string) => void): this; + once(event: 'end', listener: () => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'open', listener: (fd: number) => void): this; + once(event: 'pause', listener: () => void): this; + once(event: 'readable', listener: () => void): this; + once(event: 'ready', listener: () => void): this; + once(event: 'resume', listener: () => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'data', listener: (chunk: Buffer | string) => void): this; + prependListener(event: 'end', listener: () => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'open', listener: (fd: number) => void): this; + prependListener(event: 'pause', listener: () => void): this; + prependListener(event: 'readable', listener: () => void): this; + prependListener(event: 'ready', listener: () => void): this; + prependListener(event: 'resume', listener: () => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'data', listener: (chunk: Buffer | string) => void): this; + prependOnceListener(event: 'end', listener: () => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'open', listener: (fd: number) => void): this; + prependOnceListener(event: 'pause', listener: () => void): this; + prependOnceListener(event: 'readable', listener: () => void): this; + prependOnceListener(event: 'ready', listener: () => void): this; + prependOnceListener(event: 'resume', listener: () => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + /** + * * Extends `stream.Writable` + * + * Instances of `fs.WriteStream` are created and returned using the {@link createWriteStream} function. + * @since v0.1.93 + */ + export class WriteStream extends stream.Writable { + /** + * Closes `writeStream`. Optionally accepts a + * callback that will be executed once the `writeStream`is closed. + * @since v0.9.4 + */ + close(callback?: (err?: NodeJS.ErrnoException | null) => void): void; + /** + * The number of bytes written so far. Does not include data that is still queued + * for writing. + * @since v0.4.7 + */ + bytesWritten: number; + /** + * The path to the file the stream is writing to as specified in the first + * argument to {@link createWriteStream}. If `path` is passed as a string, then`writeStream.path` will be a string. If `path` is passed as a `Buffer`, then`writeStream.path` will be a + * `Buffer`. + * @since v0.1.93 + */ + path: string | Buffer; + /** + * This property is `true` if the underlying file has not been opened yet, + * i.e. before the `'ready'` event is emitted. + * @since v11.2.0 + */ + pending: boolean; + /** + * events.EventEmitter + * 1. open + * 2. close + * 3. ready + */ + addListener(event: 'close', listener: () => void): this; + addListener(event: 'drain', listener: () => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'finish', listener: () => void): this; + addListener(event: 'open', listener: (fd: number) => void): this; + addListener(event: 'pipe', listener: (src: stream.Readable) => void): this; + addListener(event: 'ready', listener: () => void): this; + addListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + on(event: 'close', listener: () => void): this; + on(event: 'drain', listener: () => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'finish', listener: () => void): this; + on(event: 'open', listener: (fd: number) => void): this; + on(event: 'pipe', listener: (src: stream.Readable) => void): this; + on(event: 'ready', listener: () => void): this; + on(event: 'unpipe', listener: (src: stream.Readable) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'drain', listener: () => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'finish', listener: () => void): this; + once(event: 'open', listener: (fd: number) => void): this; + once(event: 'pipe', listener: (src: stream.Readable) => void): this; + once(event: 'ready', listener: () => void): this; + once(event: 'unpipe', listener: (src: stream.Readable) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'drain', listener: () => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'finish', listener: () => void): this; + prependListener(event: 'open', listener: (fd: number) => void): this; + prependListener(event: 'pipe', listener: (src: stream.Readable) => void): this; + prependListener(event: 'ready', listener: () => void): this; + prependListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'drain', listener: () => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'finish', listener: () => void): this; + prependOnceListener(event: 'open', listener: (fd: number) => void): this; + prependOnceListener(event: 'pipe', listener: (src: stream.Readable) => void): this; + prependOnceListener(event: 'ready', listener: () => void): this; + prependOnceListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + /** + * Asynchronously rename file at `oldPath` to the pathname provided + * as `newPath`. In the case that `newPath` already exists, it will + * be overwritten. If there is a directory at `newPath`, an error will + * be raised instead. No arguments other than a possible exception are + * given to the completion callback. + * + * See also: [`rename(2)`](http://man7.org/linux/man-pages/man2/rename.2.html). + * + * ```js + * import { rename } from 'fs'; + * + * rename('oldFile.txt', 'newFile.txt', (err) => { + * if (err) throw err; + * console.log('Rename complete!'); + * }); + * ``` + * @since v0.0.2 + */ + export function rename(oldPath: PathLike, newPath: PathLike, callback: NoParamCallback): void; + export namespace rename { + /** + * Asynchronous rename(2) - Change the name or location of a file or directory. + * @param oldPath A path to a file. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + */ + function __promisify__(oldPath: PathLike, newPath: PathLike): Promise; + } + /** + * Renames the file from `oldPath` to `newPath`. Returns `undefined`. + * + * See the POSIX [`rename(2)`](http://man7.org/linux/man-pages/man2/rename.2.html) documentation for more details. + * @since v0.1.21 + */ + export function renameSync(oldPath: PathLike, newPath: PathLike): void; + /** + * Truncates the file. No arguments other than a possible exception are + * given to the completion callback. A file descriptor can also be passed as the + * first argument. In this case, `fs.ftruncate()` is called. + * + * ```js + * import { truncate } from 'fs'; + * // Assuming that 'path/file.txt' is a regular file. + * truncate('path/file.txt', (err) => { + * if (err) throw err; + * console.log('path/file.txt was truncated'); + * }); + * ``` + * + * Passing a file descriptor is deprecated and may result in an error being thrown + * in the future. + * + * See the POSIX [`truncate(2)`](http://man7.org/linux/man-pages/man2/truncate.2.html) documentation for more details. + * @since v0.8.6 + * @param [len=0] + */ + export function truncate(path: PathLike, len: number | undefined | null, callback: NoParamCallback): void; + /** + * Asynchronous truncate(2) - Truncate a file to a specified length. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + export function truncate(path: PathLike, callback: NoParamCallback): void; + export namespace truncate { + /** + * Asynchronous truncate(2) - Truncate a file to a specified length. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param len If not specified, defaults to `0`. + */ + function __promisify__(path: PathLike, len?: number | null): Promise; + } + /** + * Truncates the file. Returns `undefined`. A file descriptor can also be + * passed as the first argument. In this case, `fs.ftruncateSync()` is called. + * + * Passing a file descriptor is deprecated and may result in an error being thrown + * in the future. + * @since v0.8.6 + * @param [len=0] + */ + export function truncateSync(path: PathLike, len?: number | null): void; + /** + * Truncates the file descriptor. No arguments other than a possible exception are + * given to the completion callback. + * + * See the POSIX [`ftruncate(2)`](http://man7.org/linux/man-pages/man2/ftruncate.2.html) documentation for more detail. + * + * If the file referred to by the file descriptor was larger than `len` bytes, only + * the first `len` bytes will be retained in the file. + * + * For example, the following program retains only the first four bytes of the + * file: + * + * ```js + * import { open, close, ftruncate } from 'fs'; + * + * function closeFd(fd) { + * close(fd, (err) => { + * if (err) throw err; + * }); + * } + * + * open('temp.txt', 'r+', (err, fd) => { + * if (err) throw err; + * + * try { + * ftruncate(fd, 4, (err) => { + * closeFd(fd); + * if (err) throw err; + * }); + * } catch (err) { + * closeFd(fd); + * if (err) throw err; + * } + * }); + * ``` + * + * If the file previously was shorter than `len` bytes, it is extended, and the + * extended part is filled with null bytes (`'\0'`): + * + * If `len` is negative then `0` will be used. + * @since v0.8.6 + * @param [len=0] + */ + export function ftruncate(fd: number, len: number | undefined | null, callback: NoParamCallback): void; + /** + * Asynchronous ftruncate(2) - Truncate a file to a specified length. + * @param fd A file descriptor. + */ + export function ftruncate(fd: number, callback: NoParamCallback): void; + export namespace ftruncate { + /** + * Asynchronous ftruncate(2) - Truncate a file to a specified length. + * @param fd A file descriptor. + * @param len If not specified, defaults to `0`. + */ + function __promisify__(fd: number, len?: number | null): Promise; + } + /** + * Truncates the file descriptor. Returns `undefined`. + * + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link ftruncate}. + * @since v0.8.6 + * @param [len=0] + */ + export function ftruncateSync(fd: number, len?: number | null): void; + /** + * Asynchronously changes owner and group of a file. No arguments other than a + * possible exception are given to the completion callback. + * + * See the POSIX [`chown(2)`](http://man7.org/linux/man-pages/man2/chown.2.html) documentation for more detail. + * @since v0.1.97 + */ + export function chown(path: PathLike, uid: number, gid: number, callback: NoParamCallback): void; + export namespace chown { + /** + * Asynchronous chown(2) - Change ownership of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function __promisify__(path: PathLike, uid: number, gid: number): Promise; + } + /** + * Synchronously changes owner and group of a file. Returns `undefined`. + * This is the synchronous version of {@link chown}. + * + * See the POSIX [`chown(2)`](http://man7.org/linux/man-pages/man2/chown.2.html) documentation for more detail. + * @since v0.1.97 + */ + export function chownSync(path: PathLike, uid: number, gid: number): void; + /** + * Sets the owner of the file. No arguments other than a possible exception are + * given to the completion callback. + * + * See the POSIX [`fchown(2)`](http://man7.org/linux/man-pages/man2/fchown.2.html) documentation for more detail. + * @since v0.4.7 + */ + export function fchown(fd: number, uid: number, gid: number, callback: NoParamCallback): void; + export namespace fchown { + /** + * Asynchronous fchown(2) - Change ownership of a file. + * @param fd A file descriptor. + */ + function __promisify__(fd: number, uid: number, gid: number): Promise; + } + /** + * Sets the owner of the file. Returns `undefined`. + * + * See the POSIX [`fchown(2)`](http://man7.org/linux/man-pages/man2/fchown.2.html) documentation for more detail. + * @since v0.4.7 + * @param uid The file's new owner's user id. + * @param gid The file's new group's group id. + */ + export function fchownSync(fd: number, uid: number, gid: number): void; + /** + * Set the owner of the symbolic link. No arguments other than a possible + * exception are given to the completion callback. + * + * See the POSIX [`lchown(2)`](http://man7.org/linux/man-pages/man2/lchown.2.html) documentation for more detail. + */ + export function lchown(path: PathLike, uid: number, gid: number, callback: NoParamCallback): void; + export namespace lchown { + /** + * Asynchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function __promisify__(path: PathLike, uid: number, gid: number): Promise; + } + /** + * Set the owner for the path. Returns `undefined`. + * + * See the POSIX [`lchown(2)`](http://man7.org/linux/man-pages/man2/lchown.2.html) documentation for more details. + * @param uid The file's new owner's user id. + * @param gid The file's new group's group id. + */ + export function lchownSync(path: PathLike, uid: number, gid: number): void; + /** + * Changes the access and modification times of a file in the same way as {@link utimes}, with the difference that if the path refers to a symbolic + * link, then the link is not dereferenced: instead, the timestamps of the + * symbolic link itself are changed. + * + * No arguments other than a possible exception are given to the completion + * callback. + * @since v14.5.0, v12.19.0 + */ + export function lutimes(path: PathLike, atime: TimeLike, mtime: TimeLike, callback: NoParamCallback): void; + export namespace lutimes { + /** + * Changes the access and modification times of a file in the same way as `fsPromises.utimes()`, + * with the difference that if the path refers to a symbolic link, then the link is not + * dereferenced: instead, the timestamps of the symbolic link itself are changed. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + function __promisify__(path: PathLike, atime: TimeLike, mtime: TimeLike): Promise; + } + /** + * Change the file system timestamps of the symbolic link referenced by `path`. + * Returns `undefined`, or throws an exception when parameters are incorrect or + * the operation fails. This is the synchronous version of {@link lutimes}. + * @since v14.5.0, v12.19.0 + */ + export function lutimesSync(path: PathLike, atime: TimeLike, mtime: TimeLike): void; + /** + * Asynchronously changes the permissions of a file. No arguments other than a + * possible exception are given to the completion callback. + * + * See the POSIX [`chmod(2)`](http://man7.org/linux/man-pages/man2/chmod.2.html) documentation for more detail. + * + * ```js + * import { chmod } from 'fs'; + * + * chmod('my_file.txt', 0o775, (err) => { + * if (err) throw err; + * console.log('The permissions for file "my_file.txt" have been changed!'); + * }); + * ``` + * @since v0.1.30 + */ + export function chmod(path: PathLike, mode: Mode, callback: NoParamCallback): void; + export namespace chmod { + /** + * Asynchronous chmod(2) - Change permissions of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param mode A file mode. If a string is passed, it is parsed as an octal integer. + */ + function __promisify__(path: PathLike, mode: Mode): Promise; + } + /** + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link chmod}. + * + * See the POSIX [`chmod(2)`](http://man7.org/linux/man-pages/man2/chmod.2.html) documentation for more detail. + * @since v0.6.7 + */ + export function chmodSync(path: PathLike, mode: Mode): void; + /** + * Sets the permissions on the file. No arguments other than a possible exception + * are given to the completion callback. + * + * See the POSIX [`fchmod(2)`](http://man7.org/linux/man-pages/man2/fchmod.2.html) documentation for more detail. + * @since v0.4.7 + */ + export function fchmod(fd: number, mode: Mode, callback: NoParamCallback): void; + export namespace fchmod { + /** + * Asynchronous fchmod(2) - Change permissions of a file. + * @param fd A file descriptor. + * @param mode A file mode. If a string is passed, it is parsed as an octal integer. + */ + function __promisify__(fd: number, mode: Mode): Promise; + } + /** + * Sets the permissions on the file. Returns `undefined`. + * + * See the POSIX [`fchmod(2)`](http://man7.org/linux/man-pages/man2/fchmod.2.html) documentation for more detail. + * @since v0.4.7 + */ + export function fchmodSync(fd: number, mode: Mode): void; + /** + * Changes the permissions on a symbolic link. No arguments other than a possible + * exception are given to the completion callback. + * + * This method is only implemented on macOS. + * + * See the POSIX [`lchmod(2)`](https://www.freebsd.org/cgi/man.cgi?query=lchmod&sektion=2) documentation for more detail. + * @deprecated Since v0.4.7 + */ + export function lchmod(path: PathLike, mode: Mode, callback: NoParamCallback): void; + /** @deprecated */ + export namespace lchmod { + /** + * Asynchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param mode A file mode. If a string is passed, it is parsed as an octal integer. + */ + function __promisify__(path: PathLike, mode: Mode): Promise; + } + /** + * Changes the permissions on a symbolic link. Returns `undefined`. + * + * This method is only implemented on macOS. + * + * See the POSIX [`lchmod(2)`](https://www.freebsd.org/cgi/man.cgi?query=lchmod&sektion=2) documentation for more detail. + * @deprecated Since v0.4.7 + */ + export function lchmodSync(path: PathLike, mode: Mode): void; + /** + * Asynchronous [`stat(2)`](http://man7.org/linux/man-pages/man2/stat.2.html). The callback gets two arguments `(err, stats)` where`stats` is an `fs.Stats` object. + * + * In case of an error, the `err.code` will be one of `Common System Errors`. + * + * Using `fs.stat()` to check for the existence of a file before calling`fs.open()`, `fs.readFile()` or `fs.writeFile()` is not recommended. + * Instead, user code should open/read/write the file directly and handle the + * error raised if the file is not available. + * + * To check if a file exists without manipulating it afterwards, {@link access} is recommended. + * + * For example, given the following directory structure: + * + * ```text + * - txtDir + * -- file.txt + * - app.js + * ``` + * + * The next program will check for the stats of the given paths: + * + * ```js + * import { stat } from 'fs'; + * + * const pathsToCheck = ['./txtDir', './txtDir/file.txt']; + * + * for (let i = 0; i < pathsToCheck.length; i++) { + * stat(pathsToCheck[i], (err, stats) => { + * console.log(stats.isDirectory()); + * console.log(stats); + * }); + * } + * ``` + * + * The resulting output will resemble: + * + * ```console + * true + * Stats { + * dev: 16777220, + * mode: 16877, + * nlink: 3, + * uid: 501, + * gid: 20, + * rdev: 0, + * blksize: 4096, + * ino: 14214262, + * size: 96, + * blocks: 0, + * atimeMs: 1561174653071.963, + * mtimeMs: 1561174614583.3518, + * ctimeMs: 1561174626623.5366, + * birthtimeMs: 1561174126937.2893, + * atime: 2019-06-22T03:37:33.072Z, + * mtime: 2019-06-22T03:36:54.583Z, + * ctime: 2019-06-22T03:37:06.624Z, + * birthtime: 2019-06-22T03:28:46.937Z + * } + * false + * Stats { + * dev: 16777220, + * mode: 33188, + * nlink: 1, + * uid: 501, + * gid: 20, + * rdev: 0, + * blksize: 4096, + * ino: 14214074, + * size: 8, + * blocks: 8, + * atimeMs: 1561174616618.8555, + * mtimeMs: 1561174614584, + * ctimeMs: 1561174614583.8145, + * birthtimeMs: 1561174007710.7478, + * atime: 2019-06-22T03:36:56.619Z, + * mtime: 2019-06-22T03:36:54.584Z, + * ctime: 2019-06-22T03:36:54.584Z, + * birthtime: 2019-06-22T03:26:47.711Z + * } + * ``` + * @since v0.0.2 + */ + export function stat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; + export function stat( + path: PathLike, + options: + | (StatOptions & { + bigint?: false | undefined; + }) + | undefined, + callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void + ): void; + export function stat( + path: PathLike, + options: StatOptions & { + bigint: true; + }, + callback: (err: NodeJS.ErrnoException | null, stats: BigIntStats) => void + ): void; + export function stat(path: PathLike, options: StatOptions | undefined, callback: (err: NodeJS.ErrnoException | null, stats: Stats | BigIntStats) => void): void; + export namespace stat { + /** + * Asynchronous stat(2) - Get file status. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function __promisify__( + path: PathLike, + options?: StatOptions & { + bigint?: false | undefined; + } + ): Promise; + function __promisify__( + path: PathLike, + options: StatOptions & { + bigint: true; + } + ): Promise; + function __promisify__(path: PathLike, options?: StatOptions): Promise; + } + export interface StatSyncFn extends Function { + (path: PathLike, options?: undefined): Stats; + ( + path: PathLike, + options?: StatSyncOptions & { + bigint?: false | undefined; + throwIfNoEntry: false; + } + ): Stats | undefined; + ( + path: PathLike, + options: StatSyncOptions & { + bigint: true; + throwIfNoEntry: false; + } + ): BigIntStats | undefined; + ( + path: PathLike, + options?: StatSyncOptions & { + bigint?: false | undefined; + } + ): Stats; + ( + path: PathLike, + options: StatSyncOptions & { + bigint: true; + } + ): BigIntStats; + ( + path: PathLike, + options: StatSyncOptions & { + bigint: boolean; + throwIfNoEntry?: false | undefined; + } + ): Stats | BigIntStats; + (path: PathLike, options?: StatSyncOptions): Stats | BigIntStats | undefined; + } + /** + * Synchronous stat(2) - Get file status. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + export const statSync: StatSyncFn; + /** + * Invokes the callback with the `fs.Stats` for the file descriptor. + * + * See the POSIX [`fstat(2)`](http://man7.org/linux/man-pages/man2/fstat.2.html) documentation for more detail. + * @since v0.1.95 + */ + export function fstat(fd: number, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; + export function fstat( + fd: number, + options: + | (StatOptions & { + bigint?: false | undefined; + }) + | undefined, + callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void + ): void; + export function fstat( + fd: number, + options: StatOptions & { + bigint: true; + }, + callback: (err: NodeJS.ErrnoException | null, stats: BigIntStats) => void + ): void; + export function fstat(fd: number, options: StatOptions | undefined, callback: (err: NodeJS.ErrnoException | null, stats: Stats | BigIntStats) => void): void; + export namespace fstat { + /** + * Asynchronous fstat(2) - Get file status. + * @param fd A file descriptor. + */ + function __promisify__( + fd: number, + options?: StatOptions & { + bigint?: false | undefined; + } + ): Promise; + function __promisify__( + fd: number, + options: StatOptions & { + bigint: true; + } + ): Promise; + function __promisify__(fd: number, options?: StatOptions): Promise; + } + /** + * Synchronous fstat(2) - Get file status. + * @param fd A file descriptor. + */ + export function fstatSync( + fd: number, + options?: StatOptions & { + bigint?: false | undefined; + } + ): Stats; + export function fstatSync( + fd: number, + options: StatOptions & { + bigint: true; + } + ): BigIntStats; + export function fstatSync(fd: number, options?: StatOptions): Stats | BigIntStats; + + /** + * Retrieves the `fs.Stats` for the symbolic link referred to by the path. + * The callback gets two arguments `(err, stats)` where `stats` is a `fs.Stats` object. `lstat()` is identical to `stat()`, except that if `path` is a symbolic + * link, then the link itself is stat-ed, not the file that it refers to. + * + * See the POSIX [`lstat(2)`](http://man7.org/linux/man-pages/man2/lstat.2.html) documentation for more details. + * @since v0.1.30 + */ + export function lstat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void; + export function lstat( + path: PathLike, + options: + | (StatOptions & { + bigint?: false | undefined; + }) + | undefined, + callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void + ): void; + export function lstat( + path: PathLike, + options: StatOptions & { + bigint: true; + }, + callback: (err: NodeJS.ErrnoException | null, stats: BigIntStats) => void + ): void; + export function lstat(path: PathLike, options: StatOptions | undefined, callback: (err: NodeJS.ErrnoException | null, stats: Stats | BigIntStats) => void): void; + export namespace lstat { + /** + * Asynchronous lstat(2) - Get file status. Does not dereference symbolic links. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function __promisify__( + path: PathLike, + options?: StatOptions & { + bigint?: false | undefined; + } + ): Promise; + function __promisify__( + path: PathLike, + options: StatOptions & { + bigint: true; + } + ): Promise; + function __promisify__(path: PathLike, options?: StatOptions): Promise; + } + /** + * Synchronous lstat(2) - Get file status. Does not dereference symbolic links. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + export const lstatSync: StatSyncFn; + /** + * Creates a new link from the `existingPath` to the `newPath`. See the POSIX [`link(2)`](http://man7.org/linux/man-pages/man2/link.2.html) documentation for more detail. No arguments other than + * a possible + * exception are given to the completion callback. + * @since v0.1.31 + */ + export function link(existingPath: PathLike, newPath: PathLike, callback: NoParamCallback): void; + export namespace link { + /** + * Asynchronous link(2) - Create a new link (also known as a hard link) to an existing file. + * @param existingPath A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function __promisify__(existingPath: PathLike, newPath: PathLike): Promise; + } + /** + * Creates a new link from the `existingPath` to the `newPath`. See the POSIX [`link(2)`](http://man7.org/linux/man-pages/man2/link.2.html) documentation for more detail. Returns `undefined`. + * @since v0.1.31 + */ + export function linkSync(existingPath: PathLike, newPath: PathLike): void; + /** + * Creates the link called `path` pointing to `target`. No arguments other than a + * possible exception are given to the completion callback. + * + * See the POSIX [`symlink(2)`](http://man7.org/linux/man-pages/man2/symlink.2.html) documentation for more details. + * + * The `type` argument is only available on Windows and ignored on other platforms. + * It can be set to `'dir'`, `'file'`, or `'junction'`. If the `type` argument is + * not set, Node.js will autodetect `target` type and use `'file'` or `'dir'`. If + * the `target` does not exist, `'file'` will be used. Windows junction points + * require the destination path to be absolute. When using `'junction'`, the`target` argument will automatically be normalized to absolute path. + * + * Relative targets are relative to the link’s parent directory. + * + * ```js + * import { symlink } from 'fs'; + * + * symlink('./mew', './example/mewtwo', callback); + * ``` + * + * The above example creates a symbolic link `mewtwo` in the `example` which points + * to `mew` in the same directory: + * + * ```bash + * $ tree example/ + * example/ + * ├── mew + * └── mewtwo -> ./mew + * ``` + * @since v0.1.31 + */ + export function symlink(target: PathLike, path: PathLike, type: symlink.Type | undefined | null, callback: NoParamCallback): void; + /** + * Asynchronous symlink(2) - Create a new symbolic link to an existing file. + * @param target A path to an existing file. If a URL is provided, it must use the `file:` protocol. + * @param path A path to the new symlink. If a URL is provided, it must use the `file:` protocol. + */ + export function symlink(target: PathLike, path: PathLike, callback: NoParamCallback): void; + export namespace symlink { + /** + * Asynchronous symlink(2) - Create a new symbolic link to an existing file. + * @param target A path to an existing file. If a URL is provided, it must use the `file:` protocol. + * @param path A path to the new symlink. If a URL is provided, it must use the `file:` protocol. + * @param type May be set to `'dir'`, `'file'`, or `'junction'` (default is `'file'`) and is only available on Windows (ignored on other platforms). + * When using `'junction'`, the `target` argument will automatically be normalized to an absolute path. + */ + function __promisify__(target: PathLike, path: PathLike, type?: string | null): Promise; + type Type = 'dir' | 'file' | 'junction'; + } + /** + * Returns `undefined`. + * + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link symlink}. + * @since v0.1.31 + */ + export function symlinkSync(target: PathLike, path: PathLike, type?: symlink.Type | null): void; + /** + * Reads the contents of the symbolic link referred to by `path`. The callback gets + * two arguments `(err, linkString)`. + * + * See the POSIX [`readlink(2)`](http://man7.org/linux/man-pages/man2/readlink.2.html) documentation for more details. + * + * The optional `options` argument can be a string specifying an encoding, or an + * object with an `encoding` property specifying the character encoding to use for + * the link path passed to the callback. If the `encoding` is set to `'buffer'`, + * the link path returned will be passed as a `Buffer` object. + * @since v0.1.31 + */ + export function readlink(path: PathLike, options: EncodingOption, callback: (err: NodeJS.ErrnoException | null, linkString: string) => void): void; + /** + * Asynchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function readlink(path: PathLike, options: BufferEncodingOption, callback: (err: NodeJS.ErrnoException | null, linkString: Buffer) => void): void; + /** + * Asynchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function readlink(path: PathLike, options: EncodingOption, callback: (err: NodeJS.ErrnoException | null, linkString: string | Buffer) => void): void; + /** + * Asynchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + export function readlink(path: PathLike, callback: (err: NodeJS.ErrnoException | null, linkString: string) => void): void; + export namespace readlink { + /** + * Asynchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function __promisify__(path: PathLike, options?: EncodingOption): Promise; + /** + * Asynchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function __promisify__(path: PathLike, options: BufferEncodingOption): Promise; + /** + * Asynchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function __promisify__(path: PathLike, options?: EncodingOption): Promise; + } + /** + * Returns the symbolic link's string value. + * + * See the POSIX [`readlink(2)`](http://man7.org/linux/man-pages/man2/readlink.2.html) documentation for more details. + * + * The optional `options` argument can be a string specifying an encoding, or an + * object with an `encoding` property specifying the character encoding to use for + * the link path returned. If the `encoding` is set to `'buffer'`, + * the link path returned will be passed as a `Buffer` object. + * @since v0.1.31 + */ + export function readlinkSync(path: PathLike, options?: EncodingOption): string; + /** + * Synchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function readlinkSync(path: PathLike, options: BufferEncodingOption): Buffer; + /** + * Synchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function readlinkSync(path: PathLike, options?: EncodingOption): string | Buffer; + /** + * Asynchronously computes the canonical pathname by resolving `.`, `..` and + * symbolic links. + * + * A canonical pathname is not necessarily unique. Hard links and bind mounts can + * expose a file system entity through many pathnames. + * + * This function behaves like [`realpath(3)`](http://man7.org/linux/man-pages/man3/realpath.3.html), with some exceptions: + * + * 1. No case conversion is performed on case-insensitive file systems. + * 2. The maximum number of symbolic links is platform-independent and generally + * (much) higher than what the native [`realpath(3)`](http://man7.org/linux/man-pages/man3/realpath.3.html) implementation supports. + * + * The `callback` gets two arguments `(err, resolvedPath)`. May use `process.cwd`to resolve relative paths. + * + * Only paths that can be converted to UTF8 strings are supported. + * + * The optional `options` argument can be a string specifying an encoding, or an + * object with an `encoding` property specifying the character encoding to use for + * the path passed to the callback. If the `encoding` is set to `'buffer'`, + * the path returned will be passed as a `Buffer` object. + * + * If `path` resolves to a socket or a pipe, the function will return a system + * dependent name for that object. + * @since v0.1.31 + */ + export function realpath(path: PathLike, options: EncodingOption, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void): void; + /** + * Asynchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function realpath(path: PathLike, options: BufferEncodingOption, callback: (err: NodeJS.ErrnoException | null, resolvedPath: Buffer) => void): void; + /** + * Asynchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function realpath(path: PathLike, options: EncodingOption, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string | Buffer) => void): void; + /** + * Asynchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + export function realpath(path: PathLike, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void): void; + export namespace realpath { + /** + * Asynchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function __promisify__(path: PathLike, options?: EncodingOption): Promise; + /** + * Asynchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function __promisify__(path: PathLike, options: BufferEncodingOption): Promise; + /** + * Asynchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function __promisify__(path: PathLike, options?: EncodingOption): Promise; + /** + * Asynchronous [`realpath(3)`](http://man7.org/linux/man-pages/man3/realpath.3.html). + * + * The `callback` gets two arguments `(err, resolvedPath)`. + * + * Only paths that can be converted to UTF8 strings are supported. + * + * The optional `options` argument can be a string specifying an encoding, or an + * object with an `encoding` property specifying the character encoding to use for + * the path passed to the callback. If the `encoding` is set to `'buffer'`, + * the path returned will be passed as a `Buffer` object. + * + * On Linux, when Node.js is linked against musl libc, the procfs file system must + * be mounted on `/proc` in order for this function to work. Glibc does not have + * this restriction. + * @since v9.2.0 + */ + function native(path: PathLike, options: EncodingOption, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void): void; + function native(path: PathLike, options: BufferEncodingOption, callback: (err: NodeJS.ErrnoException | null, resolvedPath: Buffer) => void): void; + function native(path: PathLike, options: EncodingOption, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string | Buffer) => void): void; + function native(path: PathLike, callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void): void; + } + /** + * Returns the resolved pathname. + * + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link realpath}. + * @since v0.1.31 + */ + export function realpathSync(path: PathLike, options?: EncodingOption): string; + /** + * Synchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function realpathSync(path: PathLike, options: BufferEncodingOption): Buffer; + /** + * Synchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function realpathSync(path: PathLike, options?: EncodingOption): string | Buffer; + export namespace realpathSync { + function native(path: PathLike, options?: EncodingOption): string; + function native(path: PathLike, options: BufferEncodingOption): Buffer; + function native(path: PathLike, options?: EncodingOption): string | Buffer; + } + /** + * Asynchronously removes a file or symbolic link. No arguments other than a + * possible exception are given to the completion callback. + * + * ```js + * import { unlink } from 'fs'; + * // Assuming that 'path/file.txt' is a regular file. + * unlink('path/file.txt', (err) => { + * if (err) throw err; + * console.log('path/file.txt was deleted'); + * }); + * ``` + * + * `fs.unlink()` will not work on a directory, empty or otherwise. To remove a + * directory, use {@link rmdir}. + * + * See the POSIX [`unlink(2)`](http://man7.org/linux/man-pages/man2/unlink.2.html) documentation for more details. + * @since v0.0.2 + */ + export function unlink(path: PathLike, callback: NoParamCallback): void; + export namespace unlink { + /** + * Asynchronous unlink(2) - delete a name and possibly the file it refers to. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function __promisify__(path: PathLike): Promise; + } + /** + * Synchronous [`unlink(2)`](http://man7.org/linux/man-pages/man2/unlink.2.html). Returns `undefined`. + * @since v0.1.21 + */ + export function unlinkSync(path: PathLike): void; + export interface RmDirOptions { + /** + * If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or + * `EPERM` error is encountered, Node.js will retry the operation with a linear + * backoff wait of `retryDelay` ms longer on each try. This option represents the + * number of retries. This option is ignored if the `recursive` option is not + * `true`. + * @default 0 + */ + maxRetries?: number | undefined; + /** + * @deprecated since v14.14.0 In future versions of Node.js and will trigger a warning + * `fs.rmdir(path, { recursive: true })` will throw if `path` does not exist or is a file. + * Use `fs.rm(path, { recursive: true, force: true })` instead. + * + * If `true`, perform a recursive directory removal. In + * recursive mode soperations are retried on failure. + * @default false + */ + recursive?: boolean | undefined; + /** + * The amount of time in milliseconds to wait between retries. + * This option is ignored if the `recursive` option is not `true`. + * @default 100 + */ + retryDelay?: number | undefined; + } + /** + * Asynchronous [`rmdir(2)`](http://man7.org/linux/man-pages/man2/rmdir.2.html). No arguments other than a possible exception are given + * to the completion callback. + * + * Using `fs.rmdir()` on a file (not a directory) results in an `ENOENT` error on + * Windows and an `ENOTDIR` error on POSIX. + * + * To get a behavior similar to the `rm -rf` Unix command, use {@link rm} with options `{ recursive: true, force: true }`. + * @since v0.0.2 + */ + export function rmdir(path: PathLike, callback: NoParamCallback): void; + export function rmdir(path: PathLike, options: RmDirOptions, callback: NoParamCallback): void; + export namespace rmdir { + /** + * Asynchronous rmdir(2) - delete a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + function __promisify__(path: PathLike, options?: RmDirOptions): Promise; + } + /** + * Synchronous [`rmdir(2)`](http://man7.org/linux/man-pages/man2/rmdir.2.html). Returns `undefined`. + * + * Using `fs.rmdirSync()` on a file (not a directory) results in an `ENOENT` error + * on Windows and an `ENOTDIR` error on POSIX. + * + * To get a behavior similar to the `rm -rf` Unix command, use {@link rmSync} with options `{ recursive: true, force: true }`. + * @since v0.1.21 + */ + export function rmdirSync(path: PathLike, options?: RmDirOptions): void; + export interface RmOptions { + /** + * When `true`, exceptions will be ignored if `path` does not exist. + * @default false + */ + force?: boolean | undefined; + /** + * If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or + * `EPERM` error is encountered, Node.js will retry the operation with a linear + * backoff wait of `retryDelay` ms longer on each try. This option represents the + * number of retries. This option is ignored if the `recursive` option is not + * `true`. + * @default 0 + */ + maxRetries?: number | undefined; + /** + * If `true`, perform a recursive directory removal. In + * recursive mode, operations are retried on failure. + * @default false + */ + recursive?: boolean | undefined; + /** + * The amount of time in milliseconds to wait between retries. + * This option is ignored if the `recursive` option is not `true`. + * @default 100 + */ + retryDelay?: number | undefined; + } + /** + * Asynchronously removes files and directories (modeled on the standard POSIX `rm`utility). No arguments other than a possible exception are given to the + * completion callback. + * @since v14.14.0 + */ + export function rm(path: PathLike, callback: NoParamCallback): void; + export function rm(path: PathLike, options: RmOptions, callback: NoParamCallback): void; + export namespace rm { + /** + * Asynchronously removes files and directories (modeled on the standard POSIX `rm` utility). + */ + function __promisify__(path: PathLike, options?: RmOptions): Promise; + } + /** + * Synchronously removes files and directories (modeled on the standard POSIX `rm`utility). Returns `undefined`. + * @since v14.14.0 + */ + export function rmSync(path: PathLike, options?: RmOptions): void; + export interface MakeDirectoryOptions { + /** + * Indicates whether parent folders should be created. + * If a folder was created, the path to the first created folder will be returned. + * @default false + */ + recursive?: boolean | undefined; + /** + * A file mode. If a string is passed, it is parsed as an octal integer. If not specified + * @default 0o777 + */ + mode?: Mode | undefined; + } + /** + * Asynchronously creates a directory. + * + * The callback is given a possible exception and, if `recursive` is `true`, the + * first directory path created, `(err[, path])`.`path` can still be `undefined` when `recursive` is `true`, if no directory was + * created. + * + * The optional `options` argument can be an integer specifying `mode` (permission + * and sticky bits), or an object with a `mode` property and a `recursive`property indicating whether parent directories should be created. Calling`fs.mkdir()` when `path` is a directory that + * exists results in an error only + * when `recursive` is false. + * + * ```js + * import { mkdir } from 'fs'; + * + * // Creates /tmp/a/apple, regardless of whether `/tmp` and /tmp/a exist. + * mkdir('/tmp/a/apple', { recursive: true }, (err) => { + * if (err) throw err; + * }); + * ``` + * + * On Windows, using `fs.mkdir()` on the root directory even with recursion will + * result in an error: + * + * ```js + * import { mkdir } from 'fs'; + * + * mkdir('/', { recursive: true }, (err) => { + * // => [Error: EPERM: operation not permitted, mkdir 'C:\'] + * }); + * ``` + * + * See the POSIX [`mkdir(2)`](http://man7.org/linux/man-pages/man2/mkdir.2.html) documentation for more details. + * @since v0.1.8 + */ + export function mkdir( + path: PathLike, + options: MakeDirectoryOptions & { + recursive: true; + }, + callback: (err: NodeJS.ErrnoException | null, path?: string) => void + ): void; + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + export function mkdir( + path: PathLike, + options: + | Mode + | (MakeDirectoryOptions & { + recursive?: false | undefined; + }) + | null + | undefined, + callback: NoParamCallback + ): void; + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + export function mkdir(path: PathLike, options: Mode | MakeDirectoryOptions | null | undefined, callback: (err: NodeJS.ErrnoException | null, path?: string) => void): void; + /** + * Asynchronous mkdir(2) - create a directory with a mode of `0o777`. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + export function mkdir(path: PathLike, callback: NoParamCallback): void; + export namespace mkdir { + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + function __promisify__( + path: PathLike, + options: MakeDirectoryOptions & { + recursive: true; + } + ): Promise; + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + function __promisify__( + path: PathLike, + options?: + | Mode + | (MakeDirectoryOptions & { + recursive?: false | undefined; + }) + | null + ): Promise; + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + function __promisify__(path: PathLike, options?: Mode | MakeDirectoryOptions | null): Promise; + } + /** + * Synchronously creates a directory. Returns `undefined`, or if `recursive` is`true`, the first directory path created. + * This is the synchronous version of {@link mkdir}. + * + * See the POSIX [`mkdir(2)`](http://man7.org/linux/man-pages/man2/mkdir.2.html) documentation for more details. + * @since v0.1.21 + */ + export function mkdirSync( + path: PathLike, + options: MakeDirectoryOptions & { + recursive: true; + } + ): string | undefined; + /** + * Synchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + export function mkdirSync( + path: PathLike, + options?: + | Mode + | (MakeDirectoryOptions & { + recursive?: false | undefined; + }) + | null + ): void; + /** + * Synchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + export function mkdirSync(path: PathLike, options?: Mode | MakeDirectoryOptions | null): string | undefined; + /** + * Creates a unique temporary directory. + * + * Generates six random characters to be appended behind a required`prefix` to create a unique temporary directory. Due to platform + * inconsistencies, avoid trailing `X` characters in `prefix`. Some platforms, + * notably the BSDs, can return more than six random characters, and replace + * trailing `X` characters in `prefix` with random characters. + * + * The created directory path is passed as a string to the callback's second + * parameter. + * + * The optional `options` argument can be a string specifying an encoding, or an + * object with an `encoding` property specifying the character encoding to use. + * + * ```js + * import { mkdtemp } from 'fs'; + * + * mkdtemp(path.join(os.tmpdir(), 'foo-'), (err, directory) => { + * if (err) throw err; + * console.log(directory); + * // Prints: /tmp/foo-itXde2 or C:\Users\...\AppData\Local\Temp\foo-itXde2 + * }); + * ``` + * + * The `fs.mkdtemp()` method will append the six randomly selected characters + * directly to the `prefix` string. For instance, given a directory `/tmp`, if the + * intention is to create a temporary directory _within_`/tmp`, the `prefix`must end with a trailing platform-specific path separator + * (`require('path').sep`). + * + * ```js + * import { tmpdir } from 'os'; + * import { mkdtemp } from 'fs'; + * + * // The parent directory for the new temporary directory + * const tmpDir = tmpdir(); + * + * // This method is *INCORRECT*: + * mkdtemp(tmpDir, (err, directory) => { + * if (err) throw err; + * console.log(directory); + * // Will print something similar to `/tmpabc123`. + * // A new temporary directory is created at the file system root + * // rather than *within* the /tmp directory. + * }); + * + * // This method is *CORRECT*: + * import { sep } from 'path'; + * mkdtemp(`${tmpDir}${sep}`, (err, directory) => { + * if (err) throw err; + * console.log(directory); + * // Will print something similar to `/tmp/abc123`. + * // A new temporary directory is created within + * // the /tmp directory. + * }); + * ``` + * @since v5.10.0 + */ + export function mkdtemp(prefix: string, options: EncodingOption, callback: (err: NodeJS.ErrnoException | null, folder: string) => void): void; + /** + * Asynchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function mkdtemp( + prefix: string, + options: + | 'buffer' + | { + encoding: 'buffer'; + }, + callback: (err: NodeJS.ErrnoException | null, folder: Buffer) => void + ): void; + /** + * Asynchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function mkdtemp(prefix: string, options: EncodingOption, callback: (err: NodeJS.ErrnoException | null, folder: string | Buffer) => void): void; + /** + * Asynchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. + */ + export function mkdtemp(prefix: string, callback: (err: NodeJS.ErrnoException | null, folder: string) => void): void; + export namespace mkdtemp { + /** + * Asynchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function __promisify__(prefix: string, options?: EncodingOption): Promise; + /** + * Asynchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function __promisify__(prefix: string, options: BufferEncodingOption): Promise; + /** + * Asynchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function __promisify__(prefix: string, options?: EncodingOption): Promise; + } + /** + * Returns the created directory path. + * + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link mkdtemp}. + * + * The optional `options` argument can be a string specifying an encoding, or an + * object with an `encoding` property specifying the character encoding to use. + * @since v5.10.0 + */ + export function mkdtempSync(prefix: string, options?: EncodingOption): string; + /** + * Synchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function mkdtempSync(prefix: string, options: BufferEncodingOption): Buffer; + /** + * Synchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required prefix to create a unique temporary directory. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function mkdtempSync(prefix: string, options?: EncodingOption): string | Buffer; + /** + * Reads the contents of a directory. The callback gets two arguments `(err, files)`where `files` is an array of the names of the files in the directory excluding`'.'` and `'..'`. + * + * See the POSIX [`readdir(3)`](http://man7.org/linux/man-pages/man3/readdir.3.html) documentation for more details. + * + * The optional `options` argument can be a string specifying an encoding, or an + * object with an `encoding` property specifying the character encoding to use for + * the filenames passed to the callback. If the `encoding` is set to `'buffer'`, + * the filenames returned will be passed as `Buffer` objects. + * + * If `options.withFileTypes` is set to `true`, the `files` array will contain `fs.Dirent` objects. + * @since v0.1.8 + */ + export function readdir( + path: PathLike, + options: + | { + encoding: BufferEncoding | null; + withFileTypes?: false | undefined; + } + | BufferEncoding + | undefined + | null, + callback: (err: NodeJS.ErrnoException | null, files: string[]) => void + ): void; + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function readdir( + path: PathLike, + options: + | { + encoding: 'buffer'; + withFileTypes?: false | undefined; + } + | 'buffer', + callback: (err: NodeJS.ErrnoException | null, files: Buffer[]) => void + ): void; + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function readdir( + path: PathLike, + options: + | (ObjectEncodingOptions & { + withFileTypes?: false | undefined; + }) + | BufferEncoding + | undefined + | null, + callback: (err: NodeJS.ErrnoException | null, files: string[] | Buffer[]) => void + ): void; + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + export function readdir(path: PathLike, callback: (err: NodeJS.ErrnoException | null, files: string[]) => void): void; + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options If called with `withFileTypes: true` the result data will be an array of Dirent. + */ + export function readdir( + path: PathLike, + options: ObjectEncodingOptions & { + withFileTypes: true; + }, + callback: (err: NodeJS.ErrnoException | null, files: Dirent[]) => void + ): void; + export namespace readdir { + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function __promisify__( + path: PathLike, + options?: + | { + encoding: BufferEncoding | null; + withFileTypes?: false | undefined; + } + | BufferEncoding + | null + ): Promise; + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function __promisify__( + path: PathLike, + options: + | 'buffer' + | { + encoding: 'buffer'; + withFileTypes?: false | undefined; + } + ): Promise; + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function __promisify__( + path: PathLike, + options?: + | (ObjectEncodingOptions & { + withFileTypes?: false | undefined; + }) + | BufferEncoding + | null + ): Promise; + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options If called with `withFileTypes: true` the result data will be an array of Dirent + */ + function __promisify__( + path: PathLike, + options: ObjectEncodingOptions & { + withFileTypes: true; + } + ): Promise; + } + /** + * Reads the contents of the directory. + * + * See the POSIX [`readdir(3)`](http://man7.org/linux/man-pages/man3/readdir.3.html) documentation for more details. + * + * The optional `options` argument can be a string specifying an encoding, or an + * object with an `encoding` property specifying the character encoding to use for + * the filenames returned. If the `encoding` is set to `'buffer'`, + * the filenames returned will be passed as `Buffer` objects. + * + * If `options.withFileTypes` is set to `true`, the result will contain `fs.Dirent` objects. + * @since v0.1.21 + */ + export function readdirSync( + path: PathLike, + options?: + | { + encoding: BufferEncoding | null; + withFileTypes?: false | undefined; + } + | BufferEncoding + | null + ): string[]; + /** + * Synchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function readdirSync( + path: PathLike, + options: + | { + encoding: 'buffer'; + withFileTypes?: false | undefined; + } + | 'buffer' + ): Buffer[]; + /** + * Synchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + export function readdirSync( + path: PathLike, + options?: + | (ObjectEncodingOptions & { + withFileTypes?: false | undefined; + }) + | BufferEncoding + | null + ): string[] | Buffer[]; + /** + * Synchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options If called with `withFileTypes: true` the result data will be an array of Dirent. + */ + export function readdirSync( + path: PathLike, + options: ObjectEncodingOptions & { + withFileTypes: true; + } + ): Dirent[]; + /** + * Closes the file descriptor. No arguments other than a possible exception are + * given to the completion callback. + * + * Calling `fs.close()` on any file descriptor (`fd`) that is currently in use + * through any other `fs` operation may lead to undefined behavior. + * + * See the POSIX [`close(2)`](http://man7.org/linux/man-pages/man2/close.2.html) documentation for more detail. + * @since v0.0.2 + */ + export function close(fd: number, callback?: NoParamCallback): void; + export namespace close { + /** + * Asynchronous close(2) - close a file descriptor. + * @param fd A file descriptor. + */ + function __promisify__(fd: number): Promise; + } + /** + * Closes the file descriptor. Returns `undefined`. + * + * Calling `fs.closeSync()` on any file descriptor (`fd`) that is currently in use + * through any other `fs` operation may lead to undefined behavior. + * + * See the POSIX [`close(2)`](http://man7.org/linux/man-pages/man2/close.2.html) documentation for more detail. + * @since v0.1.21 + */ + export function closeSync(fd: number): void; + /** + * Asynchronous file open. See the POSIX [`open(2)`](http://man7.org/linux/man-pages/man2/open.2.html) documentation for more details. + * + * `mode` sets the file mode (permission and sticky bits), but only if the file was + * created. On Windows, only the write permission can be manipulated; see {@link chmod}. + * + * The callback gets two arguments `(err, fd)`. + * + * Some characters (`< > : " / \ | ? *`) are reserved under Windows as documented + * by [Naming Files, Paths, and Namespaces](https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file). Under NTFS, if the filename contains + * a colon, Node.js will open a file system stream, as described by [this MSDN page](https://docs.microsoft.com/en-us/windows/desktop/FileIO/using-streams). + * + * Functions based on `fs.open()` exhibit this behavior as well:`fs.writeFile()`, `fs.readFile()`, etc. + * @since v0.0.2 + * @param [flags='r'] See `support of file system `flags``. + * @param [mode=0o666] + */ + export function open(path: PathLike, flags: OpenMode, mode: Mode | undefined | null, callback: (err: NodeJS.ErrnoException | null, fd: number) => void): void; + /** + * Asynchronous open(2) - open and possibly create a file. If the file is created, its mode will be `0o666`. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + */ + export function open(path: PathLike, flags: OpenMode, callback: (err: NodeJS.ErrnoException | null, fd: number) => void): void; + export namespace open { + /** + * Asynchronous open(2) - open and possibly create a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param mode A file mode. If a string is passed, it is parsed as an octal integer. If not supplied, defaults to `0o666`. + */ + function __promisify__(path: PathLike, flags: OpenMode, mode?: Mode | null): Promise; + } + /** + * Returns an integer representing the file descriptor. + * + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link open}. + * @since v0.1.21 + * @param [flags='r'] + * @param [mode=0o666] + */ + export function openSync(path: PathLike, flags: OpenMode, mode?: Mode | null): number; + /** + * Change the file system timestamps of the object referenced by `path`. + * + * The `atime` and `mtime` arguments follow these rules: + * + * * Values can be either numbers representing Unix epoch time in seconds,`Date`s, or a numeric string like `'123456789.0'`. + * * If the value can not be converted to a number, or is `NaN`, `Infinity` or`-Infinity`, an `Error` will be thrown. + * @since v0.4.2 + */ + export function utimes(path: PathLike, atime: TimeLike, mtime: TimeLike, callback: NoParamCallback): void; + export namespace utimes { + /** + * Asynchronously change file timestamps of the file referenced by the supplied path. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + function __promisify__(path: PathLike, atime: TimeLike, mtime: TimeLike): Promise; + } + /** + * Returns `undefined`. + * + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link utimes}. + * @since v0.4.2 + */ + export function utimesSync(path: PathLike, atime: TimeLike, mtime: TimeLike): void; + /** + * Change the file system timestamps of the object referenced by the supplied file + * descriptor. See {@link utimes}. + * @since v0.4.2 + */ + export function futimes(fd: number, atime: TimeLike, mtime: TimeLike, callback: NoParamCallback): void; + export namespace futimes { + /** + * Asynchronously change file timestamps of the file referenced by the supplied file descriptor. + * @param fd A file descriptor. + * @param atime The last access time. If a string is provided, it will be coerced to number. + * @param mtime The last modified time. If a string is provided, it will be coerced to number. + */ + function __promisify__(fd: number, atime: TimeLike, mtime: TimeLike): Promise; + } + /** + * Synchronous version of {@link futimes}. Returns `undefined`. + * @since v0.4.2 + */ + export function futimesSync(fd: number, atime: TimeLike, mtime: TimeLike): void; + /** + * Request that all data for the open file descriptor is flushed to the storage + * device. The specific implementation is operating system and device specific. + * Refer to the POSIX [`fsync(2)`](http://man7.org/linux/man-pages/man2/fsync.2.html) documentation for more detail. No arguments other + * than a possible exception are given to the completion callback. + * @since v0.1.96 + */ + export function fsync(fd: number, callback: NoParamCallback): void; + export namespace fsync { + /** + * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. + * @param fd A file descriptor. + */ + function __promisify__(fd: number): Promise; + } + /** + * Request that all data for the open file descriptor is flushed to the storage + * device. The specific implementation is operating system and device specific. + * Refer to the POSIX [`fsync(2)`](http://man7.org/linux/man-pages/man2/fsync.2.html) documentation for more detail. Returns `undefined`. + * @since v0.1.96 + */ + export function fsyncSync(fd: number): void; + /** + * Write `buffer` to the file specified by `fd`. If `buffer` is a normal object, it + * must have an own `toString` function property. + * + * `offset` determines the part of the buffer to be written, and `length` is + * an integer specifying the number of bytes to write. + * + * `position` refers to the offset from the beginning of the file where this data + * should be written. If `typeof position !== 'number'`, the data will be written + * at the current position. See [`pwrite(2)`](http://man7.org/linux/man-pages/man2/pwrite.2.html). + * + * The callback will be given three arguments `(err, bytesWritten, buffer)` where`bytesWritten` specifies how many _bytes_ were written from `buffer`. + * + * If this method is invoked as its `util.promisify()` ed version, it returns + * a promise for an `Object` with `bytesWritten` and `buffer` properties. + * + * It is unsafe to use `fs.write()` multiple times on the same file without waiting + * for the callback. For this scenario, {@link createWriteStream} is + * recommended. + * + * On Linux, positional writes don't work when the file is opened in append mode. + * The kernel ignores the position argument and always appends the data to + * the end of the file. + * @since v0.0.2 + */ + export function write( + fd: number, + buffer: TBuffer, + offset: number | undefined | null, + length: number | undefined | null, + position: number | undefined | null, + callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void + ): void; + /** + * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor. + * @param fd A file descriptor. + * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. + * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. + */ + export function write( + fd: number, + buffer: TBuffer, + offset: number | undefined | null, + length: number | undefined | null, + callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void + ): void; + /** + * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor. + * @param fd A file descriptor. + * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. + */ + export function write( + fd: number, + buffer: TBuffer, + offset: number | undefined | null, + callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void + ): void; + /** + * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor. + * @param fd A file descriptor. + */ + export function write(fd: number, buffer: TBuffer, callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void): void; + /** + * Asynchronously writes `string` to the file referenced by the supplied file descriptor. + * @param fd A file descriptor. + * @param string A string to write. + * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. + * @param encoding The expected string encoding. + */ + export function write( + fd: number, + string: string, + position: number | undefined | null, + encoding: BufferEncoding | undefined | null, + callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void + ): void; + /** + * Asynchronously writes `string` to the file referenced by the supplied file descriptor. + * @param fd A file descriptor. + * @param string A string to write. + * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. + */ + export function write(fd: number, string: string, position: number | undefined | null, callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void): void; + /** + * Asynchronously writes `string` to the file referenced by the supplied file descriptor. + * @param fd A file descriptor. + * @param string A string to write. + */ + export function write(fd: number, string: string, callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void): void; + export namespace write { + /** + * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor. + * @param fd A file descriptor. + * @param offset The part of the buffer to be written. If not supplied, defaults to `0`. + * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. + * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. + */ + function __promisify__( + fd: number, + buffer?: TBuffer, + offset?: number, + length?: number, + position?: number | null + ): Promise<{ + bytesWritten: number; + buffer: TBuffer; + }>; + /** + * Asynchronously writes `string` to the file referenced by the supplied file descriptor. + * @param fd A file descriptor. + * @param string A string to write. + * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. + * @param encoding The expected string encoding. + */ + function __promisify__( + fd: number, + string: string, + position?: number | null, + encoding?: BufferEncoding | null + ): Promise<{ + bytesWritten: number; + buffer: string; + }>; + } + /** + * If `buffer` is a plain object, it must have an own (not inherited) `toString`function property. + * + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link write}. + * @since v0.1.21 + * @return The number of bytes written. + */ + export function writeSync(fd: number, buffer: NodeJS.ArrayBufferView, offset?: number | null, length?: number | null, position?: number | null): number; + /** + * Synchronously writes `string` to the file referenced by the supplied file descriptor, returning the number of bytes written. + * @param fd A file descriptor. + * @param string A string to write. + * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. + * @param encoding The expected string encoding. + */ + export function writeSync(fd: number, string: string, position?: number | null, encoding?: BufferEncoding | null): number; + export type ReadPosition = number | bigint; + /** + * Read data from the file specified by `fd`. + * + * The callback is given the three arguments, `(err, bytesRead, buffer)`. + * + * If the file is not modified concurrently, the end-of-file is reached when the + * number of bytes read is zero. + * + * If this method is invoked as its `util.promisify()` ed version, it returns + * a promise for an `Object` with `bytesRead` and `buffer` properties. + * @since v0.0.2 + * @param buffer The buffer that the data will be written to. + * @param offset The position in `buffer` to write the data to. + * @param length The number of bytes to read. + * @param position Specifies where to begin reading from in the file. If `position` is `null` or `-1 `, data will be read from the current file position, and the file position will be updated. If + * `position` is an integer, the file position will be unchanged. + */ + export function read( + fd: number, + buffer: TBuffer, + offset: number, + length: number, + position: ReadPosition | null, + callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void + ): void; + export namespace read { + /** + * @param fd A file descriptor. + * @param buffer The buffer that the data will be written to. + * @param offset The offset in the buffer at which to start writing. + * @param length The number of bytes to read. + * @param position The offset from the beginning of the file from which data should be read. If `null`, data will be read from the current position. + */ + function __promisify__( + fd: number, + buffer: TBuffer, + offset: number, + length: number, + position: number | null + ): Promise<{ + bytesRead: number; + buffer: TBuffer; + }>; + } + export interface ReadSyncOptions { + /** + * @default 0 + */ + offset?: number | undefined; + /** + * @default `length of buffer` + */ + length?: number | undefined; + /** + * @default null + */ + position?: ReadPosition | null | undefined; + } + /** + * Returns the number of `bytesRead`. + * + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link read}. + * @since v0.1.21 + */ + export function readSync(fd: number, buffer: NodeJS.ArrayBufferView, offset: number, length: number, position: ReadPosition | null): number; + /** + * Similar to the above `fs.readSync` function, this version takes an optional `options` object. + * If no `options` object is specified, it will default with the above values. + */ + export function readSync(fd: number, buffer: NodeJS.ArrayBufferView, opts?: ReadSyncOptions): number; + /** + * Asynchronously reads the entire contents of a file. + * + * ```js + * import { readFile } from 'fs'; + * + * readFile('/etc/passwd', (err, data) => { + * if (err) throw err; + * console.log(data); + * }); + * ``` + * + * The callback is passed two arguments `(err, data)`, where `data` is the + * contents of the file. + * + * If no encoding is specified, then the raw buffer is returned. + * + * If `options` is a string, then it specifies the encoding: + * + * ```js + * import { readFile } from 'fs'; + * + * readFile('/etc/passwd', 'utf8', callback); + * ``` + * + * When the path is a directory, the behavior of `fs.readFile()` and {@link readFileSync} is platform-specific. On macOS, Linux, and Windows, an + * error will be returned. On FreeBSD, a representation of the directory's contents + * will be returned. + * + * ```js + * import { readFile } from 'fs'; + * + * // macOS, Linux, and Windows + * readFile('', (err, data) => { + * // => [Error: EISDIR: illegal operation on a directory, read ] + * }); + * + * // FreeBSD + * readFile('', (err, data) => { + * // => null, + * }); + * ``` + * + * It is possible to abort an ongoing request using an `AbortSignal`. If a + * request is aborted the callback is called with an `AbortError`: + * + * ```js + * import { readFile } from 'fs'; + * + * const controller = new AbortController(); + * const signal = controller.signal; + * readFile(fileInfo[0].name, { signal }, (err, buf) => { + * // ... + * }); + * // When you want to abort the request + * controller.abort(); + * ``` + * + * The `fs.readFile()` function buffers the entire file. To minimize memory costs, + * when possible prefer streaming via `fs.createReadStream()`. + * + * Aborting an ongoing request does not abort individual operating + * system requests but rather the internal buffering `fs.readFile` performs. + * @since v0.1.29 + * @param path filename or file descriptor + */ + export function readFile( + path: PathOrFileDescriptor, + options: + | ({ + encoding?: null | undefined; + flag?: string | undefined; + } & Abortable) + | undefined + | null, + callback: (err: NodeJS.ErrnoException | null, data: Buffer) => void + ): void; + /** + * Asynchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a file descriptor is provided, the underlying file will _not_ be closed automatically. + * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + export function readFile( + path: PathOrFileDescriptor, + options: + | ({ + encoding: BufferEncoding; + flag?: string | undefined; + } & Abortable) + | BufferEncoding, + callback: (err: NodeJS.ErrnoException | null, data: string) => void + ): void; + /** + * Asynchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a file descriptor is provided, the underlying file will _not_ be closed automatically. + * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + export function readFile( + path: PathOrFileDescriptor, + options: + | (ObjectEncodingOptions & { + flag?: string | undefined; + } & Abortable) + | BufferEncoding + | undefined + | null, + callback: (err: NodeJS.ErrnoException | null, data: string | Buffer) => void + ): void; + /** + * Asynchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a file descriptor is provided, the underlying file will _not_ be closed automatically. + */ + export function readFile(path: PathOrFileDescriptor, callback: (err: NodeJS.ErrnoException | null, data: Buffer) => void): void; + export namespace readFile { + /** + * Asynchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a file descriptor is provided, the underlying file will _not_ be closed automatically. + * @param options An object that may contain an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + function __promisify__( + path: PathOrFileDescriptor, + options?: { + encoding?: null | undefined; + flag?: string | undefined; + } | null + ): Promise; + /** + * Asynchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + * If a file descriptor is provided, the underlying file will _not_ be closed automatically. + * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + function __promisify__( + path: PathOrFileDescriptor, + options: + | { + encoding: BufferEncoding; + flag?: string | undefined; + } + | BufferEncoding + ): Promise; + /** + * Asynchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + * If a file descriptor is provided, the underlying file will _not_ be closed automatically. + * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + function __promisify__( + path: PathOrFileDescriptor, + options?: + | (ObjectEncodingOptions & { + flag?: string | undefined; + }) + | BufferEncoding + | null + ): Promise; + } + /** + * Returns the contents of the `path`. + * + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link readFile}. + * + * If the `encoding` option is specified then this function returns a + * string. Otherwise it returns a buffer. + * + * Similar to {@link readFile}, when the path is a directory, the behavior of`fs.readFileSync()` is platform-specific. + * + * ```js + * import { readFileSync } from 'fs'; + * + * // macOS, Linux, and Windows + * readFileSync(''); + * // => [Error: EISDIR: illegal operation on a directory, read ] + * + * // FreeBSD + * readFileSync(''); // => + * ``` + * @since v0.1.8 + * @param path filename or file descriptor + */ + export function readFileSync( + path: PathOrFileDescriptor, + options?: { + encoding?: null | undefined; + flag?: string | undefined; + } | null + ): Buffer; + /** + * Synchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a file descriptor is provided, the underlying file will _not_ be closed automatically. + * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + export function readFileSync( + path: PathOrFileDescriptor, + options: + | { + encoding: BufferEncoding; + flag?: string | undefined; + } + | BufferEncoding + ): string; + /** + * Synchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a file descriptor is provided, the underlying file will _not_ be closed automatically. + * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + export function readFileSync( + path: PathOrFileDescriptor, + options?: + | (ObjectEncodingOptions & { + flag?: string | undefined; + }) + | BufferEncoding + | null + ): string | Buffer; + export type WriteFileOptions = + | (ObjectEncodingOptions & + Abortable & { + mode?: Mode | undefined; + flag?: string | undefined; + }) + | BufferEncoding + | null; + /** + * When `file` is a filename, asynchronously writes data to the file, replacing the + * file if it already exists. `data` can be a string or a buffer. + * + * When `file` is a file descriptor, the behavior is similar to calling`fs.write()` directly (which is recommended). See the notes below on using + * a file descriptor. + * + * The `encoding` option is ignored if `data` is a buffer. + * + * The `mode` option only affects the newly created file. See {@link open} for more details. + * + * If `data` is a plain object, it must have an own (not inherited) `toString`function property. + * + * ```js + * import { writeFile } from 'fs'; + * import { Buffer } from 'buffer'; + * + * const data = new Uint8Array(Buffer.from('Hello Node.js')); + * writeFile('message.txt', data, (err) => { + * if (err) throw err; + * console.log('The file has been saved!'); + * }); + * ``` + * + * If `options` is a string, then it specifies the encoding: + * + * ```js + * import { writeFile } from 'fs'; + * + * writeFile('message.txt', 'Hello Node.js', 'utf8', callback); + * ``` + * + * It is unsafe to use `fs.writeFile()` multiple times on the same file without + * waiting for the callback. For this scenario, {@link createWriteStream} is + * recommended. + * + * Similarly to `fs.readFile` \- `fs.writeFile` is a convenience method that + * performs multiple `write` calls internally to write the buffer passed to it. + * For performance sensitive code consider using {@link createWriteStream}. + * + * It is possible to use an `AbortSignal` to cancel an `fs.writeFile()`. + * Cancelation is "best effort", and some amount of data is likely still + * to be written. + * + * ```js + * import { writeFile } from 'fs'; + * import { Buffer } from 'buffer'; + * + * const controller = new AbortController(); + * const { signal } = controller; + * const data = new Uint8Array(Buffer.from('Hello Node.js')); + * writeFile('message.txt', data, { signal }, (err) => { + * // When a request is aborted - the callback is called with an AbortError + * }); + * // When the request should be aborted + * controller.abort(); + * ``` + * + * Aborting an ongoing request does not abort individual operating + * system requests but rather the internal buffering `fs.writeFile` performs. + * @since v0.1.29 + * @param file filename or file descriptor + */ + export function writeFile(file: PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView, options: WriteFileOptions, callback: NoParamCallback): void; + /** + * Asynchronously writes data to a file, replacing the file if it already exists. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a file descriptor is provided, the underlying file will _not_ be closed automatically. + * @param data The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string. + */ + export function writeFile(path: PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView, callback: NoParamCallback): void; + export namespace writeFile { + /** + * Asynchronously writes data to a file, replacing the file if it already exists. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + * If a file descriptor is provided, the underlying file will _not_ be closed automatically. + * @param data The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string. + * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. + * If `encoding` is not supplied, the default of `'utf8'` is used. + * If `mode` is not supplied, the default of `0o666` is used. + * If `mode` is a string, it is parsed as an octal integer. + * If `flag` is not supplied, the default of `'w'` is used. + */ + function __promisify__(path: PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions): Promise; + } + /** + * Returns `undefined`. + * + * If `data` is a plain object, it must have an own (not inherited) `toString`function property. + * + * The `mode` option only affects the newly created file. See {@link open} for more details. + * + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link writeFile}. + * @since v0.1.29 + * @param file filename or file descriptor + */ + export function writeFileSync(file: PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions): void; + /** + * Asynchronously append data to a file, creating the file if it does not yet + * exist. `data` can be a string or a `Buffer`. + * + * The `mode` option only affects the newly created file. See {@link open} for more details. + * + * ```js + * import { appendFile } from 'fs'; + * + * appendFile('message.txt', 'data to append', (err) => { + * if (err) throw err; + * console.log('The "data to append" was appended to file!'); + * }); + * ``` + * + * If `options` is a string, then it specifies the encoding: + * + * ```js + * import { appendFile } from 'fs'; + * + * appendFile('message.txt', 'data to append', 'utf8', callback); + * ``` + * + * The `path` may be specified as a numeric file descriptor that has been opened + * for appending (using `fs.open()` or `fs.openSync()`). The file descriptor will + * not be closed automatically. + * + * ```js + * import { open, close, appendFile } from 'fs'; + * + * function closeFd(fd) { + * close(fd, (err) => { + * if (err) throw err; + * }); + * } + * + * open('message.txt', 'a', (err, fd) => { + * if (err) throw err; + * + * try { + * appendFile(fd, 'data to append', 'utf8', (err) => { + * closeFd(fd); + * if (err) throw err; + * }); + * } catch (err) { + * closeFd(fd); + * throw err; + * } + * }); + * ``` + * @since v0.6.7 + * @param path filename or file descriptor + */ + export function appendFile(path: PathOrFileDescriptor, data: string | Uint8Array, options: WriteFileOptions, callback: NoParamCallback): void; + /** + * Asynchronously append data to a file, creating the file if it does not exist. + * @param file A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a file descriptor is provided, the underlying file will _not_ be closed automatically. + * @param data The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string. + */ + export function appendFile(file: PathOrFileDescriptor, data: string | Uint8Array, callback: NoParamCallback): void; + export namespace appendFile { + /** + * Asynchronously append data to a file, creating the file if it does not exist. + * @param file A path to a file. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + * If a file descriptor is provided, the underlying file will _not_ be closed automatically. + * @param data The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string. + * @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. + * If `encoding` is not supplied, the default of `'utf8'` is used. + * If `mode` is not supplied, the default of `0o666` is used. + * If `mode` is a string, it is parsed as an octal integer. + * If `flag` is not supplied, the default of `'a'` is used. + */ + function __promisify__(file: PathOrFileDescriptor, data: string | Uint8Array, options?: WriteFileOptions): Promise; + } + /** + * Synchronously append data to a file, creating the file if it does not yet + * exist. `data` can be a string or a `Buffer`. + * + * The `mode` option only affects the newly created file. See {@link open} for more details. + * + * ```js + * import { appendFileSync } from 'fs'; + * + * try { + * appendFileSync('message.txt', 'data to append'); + * console.log('The "data to append" was appended to file!'); + * } catch (err) { + * // Handle the error + * } + * ``` + * + * If `options` is a string, then it specifies the encoding: + * + * ```js + * import { appendFileSync } from 'fs'; + * + * appendFileSync('message.txt', 'data to append', 'utf8'); + * ``` + * + * The `path` may be specified as a numeric file descriptor that has been opened + * for appending (using `fs.open()` or `fs.openSync()`). The file descriptor will + * not be closed automatically. + * + * ```js + * import { openSync, closeSync, appendFileSync } from 'fs'; + * + * let fd; + * + * try { + * fd = openSync('message.txt', 'a'); + * appendFileSync(fd, 'data to append', 'utf8'); + * } catch (err) { + * // Handle the error + * } finally { + * if (fd !== undefined) + * closeSync(fd); + * } + * ``` + * @since v0.6.7 + * @param path filename or file descriptor + */ + export function appendFileSync(path: PathOrFileDescriptor, data: string | Uint8Array, options?: WriteFileOptions): void; + /** + * Watch for changes on `filename`. The callback `listener` will be called each + * time the file is accessed. + * + * The `options` argument may be omitted. If provided, it should be an object. The`options` object may contain a boolean named `persistent` that indicates + * whether the process should continue to run as long as files are being watched. + * The `options` object may specify an `interval` property indicating how often the + * target should be polled in milliseconds. + * + * The `listener` gets two arguments the current stat object and the previous + * stat object: + * + * ```js + * import { watchFile } from 'fs'; + * + * watchFile('message.text', (curr, prev) => { + * console.log(`the current mtime is: ${curr.mtime}`); + * console.log(`the previous mtime was: ${prev.mtime}`); + * }); + * ``` + * + * These stat objects are instances of `fs.Stat`. If the `bigint` option is `true`, + * the numeric values in these objects are specified as `BigInt`s. + * + * To be notified when the file was modified, not just accessed, it is necessary + * to compare `curr.mtimeMs` and `prev.mtimeMs`. + * + * When an `fs.watchFile` operation results in an `ENOENT` error, it + * will invoke the listener once, with all the fields zeroed (or, for dates, the + * Unix Epoch). If the file is created later on, the listener will be called + * again, with the latest stat objects. This is a change in functionality since + * v0.10. + * + * Using {@link watch} is more efficient than `fs.watchFile` and`fs.unwatchFile`. `fs.watch` should be used instead of `fs.watchFile` and`fs.unwatchFile` when possible. + * + * When a file being watched by `fs.watchFile()` disappears and reappears, + * then the contents of `previous` in the second callback event (the file's + * reappearance) will be the same as the contents of `previous` in the first + * callback event (its disappearance). + * + * This happens when: + * + * * the file is deleted, followed by a restore + * * the file is renamed and then renamed a second time back to its original name + * @since v0.1.31 + */ + export interface WatchFileOptions { + bigint?: boolean | undefined; + persistent?: boolean | undefined; + interval?: number | undefined; + } + export function watchFile( + filename: PathLike, + options: + | (WatchFileOptions & { + bigint?: false | undefined; + }) + | undefined, + listener: (curr: Stats, prev: Stats) => void + ): StatWatcher; + export function watchFile( + filename: PathLike, + options: + | (WatchFileOptions & { + bigint: true; + }) + | undefined, + listener: (curr: BigIntStats, prev: BigIntStats) => void + ): StatWatcher; + /** + * Watch for changes on `filename`. The callback `listener` will be called each time the file is accessed. + * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol. + */ + export function watchFile(filename: PathLike, listener: (curr: Stats, prev: Stats) => void): StatWatcher; + /** + * Stop watching for changes on `filename`. If `listener` is specified, only that + * particular listener is removed. Otherwise, _all_ listeners are removed, + * effectively stopping watching of `filename`. + * + * Calling `fs.unwatchFile()` with a filename that is not being watched is a + * no-op, not an error. + * + * Using {@link watch} is more efficient than `fs.watchFile()` and`fs.unwatchFile()`. `fs.watch()` should be used instead of `fs.watchFile()`and `fs.unwatchFile()` when possible. + * @since v0.1.31 + * @param listener Optional, a listener previously attached using `fs.watchFile()` + */ + export function unwatchFile(filename: PathLike, listener?: (curr: Stats, prev: Stats) => void): void; + export interface WatchOptions extends Abortable { + encoding?: BufferEncoding | 'buffer' | undefined; + persistent?: boolean | undefined; + recursive?: boolean | undefined; + } + export type WatchEventType = 'rename' | 'change'; + export type WatchListener = (event: WatchEventType, filename: T) => void; + /** + * Watch for changes on `filename`, where `filename` is either a file or a + * directory. + * + * The second argument is optional. If `options` is provided as a string, it + * specifies the `encoding`. Otherwise `options` should be passed as an object. + * + * The listener callback gets two arguments `(eventType, filename)`. `eventType`is either `'rename'` or `'change'`, and `filename` is the name of the file + * which triggered the event. + * + * On most platforms, `'rename'` is emitted whenever a filename appears or + * disappears in the directory. + * + * The listener callback is attached to the `'change'` event fired by `fs.FSWatcher`, but it is not the same thing as the `'change'` value of`eventType`. + * + * If a `signal` is passed, aborting the corresponding AbortController will close + * the returned `fs.FSWatcher`. + * @since v0.5.10 + * @param listener + */ + export function watch( + filename: PathLike, + options: + | (WatchOptions & { + encoding: 'buffer'; + }) + | 'buffer', + listener?: WatchListener + ): FSWatcher; + /** + * Watch for changes on `filename`, where `filename` is either a file or a directory, returning an `FSWatcher`. + * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol. + * @param options Either the encoding for the filename provided to the listener, or an object optionally specifying encoding, persistent, and recursive options. + * If `encoding` is not supplied, the default of `'utf8'` is used. + * If `persistent` is not supplied, the default of `true` is used. + * If `recursive` is not supplied, the default of `false` is used. + */ + export function watch(filename: PathLike, options?: WatchOptions | BufferEncoding | null, listener?: WatchListener): FSWatcher; + /** + * Watch for changes on `filename`, where `filename` is either a file or a directory, returning an `FSWatcher`. + * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol. + * @param options Either the encoding for the filename provided to the listener, or an object optionally specifying encoding, persistent, and recursive options. + * If `encoding` is not supplied, the default of `'utf8'` is used. + * If `persistent` is not supplied, the default of `true` is used. + * If `recursive` is not supplied, the default of `false` is used. + */ + export function watch(filename: PathLike, options: WatchOptions | string, listener?: WatchListener): FSWatcher; + /** + * Watch for changes on `filename`, where `filename` is either a file or a directory, returning an `FSWatcher`. + * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol. + */ + export function watch(filename: PathLike, listener?: WatchListener): FSWatcher; + /** + * Test whether or not the given path exists by checking with the file system. + * Then call the `callback` argument with either true or false: + * + * ```js + * import { exists } from 'fs'; + * + * exists('/etc/passwd', (e) => { + * console.log(e ? 'it exists' : 'no passwd!'); + * }); + * ``` + * + * **The parameters for this callback are not consistent with other Node.js** + * **callbacks.** Normally, the first parameter to a Node.js callback is an `err`parameter, optionally followed by other parameters. The `fs.exists()` callback + * has only one boolean parameter. This is one reason `fs.access()` is recommended + * instead of `fs.exists()`. + * + * Using `fs.exists()` to check for the existence of a file before calling`fs.open()`, `fs.readFile()` or `fs.writeFile()` is not recommended. Doing + * so introduces a race condition, since other processes may change the file's + * state between the two calls. Instead, user code should open/read/write the + * file directly and handle the error raised if the file does not exist. + * + * **write (NOT RECOMMENDED)** + * + * ```js + * import { exists, open, close } from 'fs'; + * + * exists('myfile', (e) => { + * if (e) { + * console.error('myfile already exists'); + * } else { + * open('myfile', 'wx', (err, fd) => { + * if (err) throw err; + * + * try { + * writeMyData(fd); + * } finally { + * close(fd, (err) => { + * if (err) throw err; + * }); + * } + * }); + * } + * }); + * ``` + * + * **write (RECOMMENDED)** + * + * ```js + * import { open, close } from 'fs'; + * open('myfile', 'wx', (err, fd) => { + * if (err) { + * if (err.code === 'EEXIST') { + * console.error('myfile already exists'); + * return; + * } + * + * throw err; + * } + * + * try { + * writeMyData(fd); + * } finally { + * close(fd, (err) => { + * if (err) throw err; + * }); + * } + * }); + * ``` + * + * **read (NOT RECOMMENDED)** + * + * ```js + * import { open, close, exists } from 'fs'; + * + * exists('myfile', (e) => { + * if (e) { + * open('myfile', 'r', (err, fd) => { + * if (err) throw err; + * + * try { + * readMyData(fd); + * } finally { + * close(fd, (err) => { + * if (err) throw err; + * }); + * } + * }); + * } else { + * console.error('myfile does not exist'); + * } + * }); + * ``` + * + * **read (RECOMMENDED)** + * + * ```js + * import { open, close } from 'fs'; + * + * open('myfile', 'r', (err, fd) => { + * if (err) { + * if (err.code === 'ENOENT') { + * console.error('myfile does not exist'); + * return; + * } + * + * throw err; + * } + * + * try { + * readMyData(fd); + * } finally { + * close(fd, (err) => { + * if (err) throw err; + * }); + * } + * }); + * ``` + * + * The "not recommended" examples above check for existence and then use the + * file; the "recommended" examples are better because they use the file directly + * and handle the error, if any. + * + * In general, check for the existence of a file only if the file won’t be + * used directly, for example when its existence is a signal from another + * process. + * @since v0.0.2 + * @deprecated Since v1.0.0 - Use {@link stat} or {@link access} instead. + */ + export function exists(path: PathLike, callback: (exists: boolean) => void): void; + /** @deprecated */ + export namespace exists { + /** + * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + */ + function __promisify__(path: PathLike): Promise; + } + /** + * Returns `true` if the path exists, `false` otherwise. + * + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link exists}. + * + * `fs.exists()` is deprecated, but `fs.existsSync()` is not. The `callback`parameter to `fs.exists()` accepts parameters that are inconsistent with other + * Node.js callbacks. `fs.existsSync()` does not use a callback. + * + * ```js + * import { existsSync } from 'fs'; + * + * if (existsSync('/etc/passwd')) + * console.log('The path exists.'); + * ``` + * @since v0.1.21 + */ + export function existsSync(path: PathLike): boolean; + export namespace constants { + // File Access Constants + /** Constant for fs.access(). File is visible to the calling process. */ + const F_OK: number; + /** Constant for fs.access(). File can be read by the calling process. */ + const R_OK: number; + /** Constant for fs.access(). File can be written by the calling process. */ + const W_OK: number; + /** Constant for fs.access(). File can be executed by the calling process. */ + const X_OK: number; + // File Copy Constants + /** Constant for fs.copyFile. Flag indicating the destination file should not be overwritten if it already exists. */ + const COPYFILE_EXCL: number; + /** + * Constant for fs.copyFile. copy operation will attempt to create a copy-on-write reflink. + * If the underlying platform does not support copy-on-write, then a fallback copy mechanism is used. + */ + const COPYFILE_FICLONE: number; + /** + * Constant for fs.copyFile. Copy operation will attempt to create a copy-on-write reflink. + * If the underlying platform does not support copy-on-write, then the operation will fail with an error. + */ + const COPYFILE_FICLONE_FORCE: number; + // File Open Constants + /** Constant for fs.open(). Flag indicating to open a file for read-only access. */ + const O_RDONLY: number; + /** Constant for fs.open(). Flag indicating to open a file for write-only access. */ + const O_WRONLY: number; + /** Constant for fs.open(). Flag indicating to open a file for read-write access. */ + const O_RDWR: number; + /** Constant for fs.open(). Flag indicating to create the file if it does not already exist. */ + const O_CREAT: number; + /** Constant for fs.open(). Flag indicating that opening a file should fail if the O_CREAT flag is set and the file already exists. */ + const O_EXCL: number; + /** + * Constant for fs.open(). Flag indicating that if path identifies a terminal device, + * opening the path shall not cause that terminal to become the controlling terminal for the process + * (if the process does not already have one). + */ + const O_NOCTTY: number; + /** Constant for fs.open(). Flag indicating that if the file exists and is a regular file, and the file is opened successfully for write access, its length shall be truncated to zero. */ + const O_TRUNC: number; + /** Constant for fs.open(). Flag indicating that data will be appended to the end of the file. */ + const O_APPEND: number; + /** Constant for fs.open(). Flag indicating that the open should fail if the path is not a directory. */ + const O_DIRECTORY: number; + /** + * constant for fs.open(). + * Flag indicating reading accesses to the file system will no longer result in + * an update to the atime information associated with the file. + * This flag is available on Linux operating systems only. + */ + const O_NOATIME: number; + /** Constant for fs.open(). Flag indicating that the open should fail if the path is a symbolic link. */ + const O_NOFOLLOW: number; + /** Constant for fs.open(). Flag indicating that the file is opened for synchronous I/O. */ + const O_SYNC: number; + /** Constant for fs.open(). Flag indicating that the file is opened for synchronous I/O with write operations waiting for data integrity. */ + const O_DSYNC: number; + /** Constant for fs.open(). Flag indicating to open the symbolic link itself rather than the resource it is pointing to. */ + const O_SYMLINK: number; + /** Constant for fs.open(). When set, an attempt will be made to minimize caching effects of file I/O. */ + const O_DIRECT: number; + /** Constant for fs.open(). Flag indicating to open the file in nonblocking mode when possible. */ + const O_NONBLOCK: number; + // File Type Constants + /** Constant for fs.Stats mode property for determining a file's type. Bit mask used to extract the file type code. */ + const S_IFMT: number; + /** Constant for fs.Stats mode property for determining a file's type. File type constant for a regular file. */ + const S_IFREG: number; + /** Constant for fs.Stats mode property for determining a file's type. File type constant for a directory. */ + const S_IFDIR: number; + /** Constant for fs.Stats mode property for determining a file's type. File type constant for a character-oriented device file. */ + const S_IFCHR: number; + /** Constant for fs.Stats mode property for determining a file's type. File type constant for a block-oriented device file. */ + const S_IFBLK: number; + /** Constant for fs.Stats mode property for determining a file's type. File type constant for a FIFO/pipe. */ + const S_IFIFO: number; + /** Constant for fs.Stats mode property for determining a file's type. File type constant for a symbolic link. */ + const S_IFLNK: number; + /** Constant for fs.Stats mode property for determining a file's type. File type constant for a socket. */ + const S_IFSOCK: number; + // File Mode Constants + /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by owner. */ + const S_IRWXU: number; + /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by owner. */ + const S_IRUSR: number; + /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by owner. */ + const S_IWUSR: number; + /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by owner. */ + const S_IXUSR: number; + /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by group. */ + const S_IRWXG: number; + /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by group. */ + const S_IRGRP: number; + /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by group. */ + const S_IWGRP: number; + /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by group. */ + const S_IXGRP: number; + /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by others. */ + const S_IRWXO: number; + /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by others. */ + const S_IROTH: number; + /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by others. */ + const S_IWOTH: number; + /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by others. */ + const S_IXOTH: number; + /** + * When set, a memory file mapping is used to access the file. This flag + * is available on Windows operating systems only. On other operating systems, + * this flag is ignored. + */ + const UV_FS_O_FILEMAP: number; + } + /** + * Tests a user's permissions for the file or directory specified by `path`. + * The `mode` argument is an optional integer that specifies the accessibility + * checks to be performed. Check `File access constants` for possible values + * of `mode`. It is possible to create a mask consisting of the bitwise OR of + * two or more values (e.g. `fs.constants.W_OK | fs.constants.R_OK`). + * + * The final argument, `callback`, is a callback function that is invoked with + * a possible error argument. If any of the accessibility checks fail, the error + * argument will be an `Error` object. The following examples check if`package.json` exists, and if it is readable or writable. + * + * ```js + * import { access, constants } from 'fs'; + * + * const file = 'package.json'; + * + * // Check if the file exists in the current directory. + * access(file, constants.F_OK, (err) => { + * console.log(`${file} ${err ? 'does not exist' : 'exists'}`); + * }); + * + * // Check if the file is readable. + * access(file, constants.R_OK, (err) => { + * console.log(`${file} ${err ? 'is not readable' : 'is readable'}`); + * }); + * + * // Check if the file is writable. + * access(file, constants.W_OK, (err) => { + * console.log(`${file} ${err ? 'is not writable' : 'is writable'}`); + * }); + * + * // Check if the file exists in the current directory, and if it is writable. + * access(file, constants.F_OK | constants.W_OK, (err) => { + * if (err) { + * console.error( + * `${file} ${err.code === 'ENOENT' ? 'does not exist' : 'is read-only'}`); + * } else { + * console.log(`${file} exists, and it is writable`); + * } + * }); + * ``` + * + * Do not use `fs.access()` to check for the accessibility of a file before calling`fs.open()`, `fs.readFile()` or `fs.writeFile()`. Doing + * so introduces a race condition, since other processes may change the file's + * state between the two calls. Instead, user code should open/read/write the + * file directly and handle the error raised if the file is not accessible. + * + * **write (NOT RECOMMENDED)** + * + * ```js + * import { access, open, close } from 'fs'; + * + * access('myfile', (err) => { + * if (!err) { + * console.error('myfile already exists'); + * return; + * } + * + * open('myfile', 'wx', (err, fd) => { + * if (err) throw err; + * + * try { + * writeMyData(fd); + * } finally { + * close(fd, (err) => { + * if (err) throw err; + * }); + * } + * }); + * }); + * ``` + * + * **write (RECOMMENDED)** + * + * ```js + * import { open, close } from 'fs'; + * + * open('myfile', 'wx', (err, fd) => { + * if (err) { + * if (err.code === 'EEXIST') { + * console.error('myfile already exists'); + * return; + * } + * + * throw err; + * } + * + * try { + * writeMyData(fd); + * } finally { + * close(fd, (err) => { + * if (err) throw err; + * }); + * } + * }); + * ``` + * + * **read (NOT RECOMMENDED)** + * + * ```js + * import { access, open, close } from 'fs'; + * access('myfile', (err) => { + * if (err) { + * if (err.code === 'ENOENT') { + * console.error('myfile does not exist'); + * return; + * } + * + * throw err; + * } + * + * open('myfile', 'r', (err, fd) => { + * if (err) throw err; + * + * try { + * readMyData(fd); + * } finally { + * close(fd, (err) => { + * if (err) throw err; + * }); + * } + * }); + * }); + * ``` + * + * **read (RECOMMENDED)** + * + * ```js + * import { open, close } from 'fs'; + * + * open('myfile', 'r', (err, fd) => { + * if (err) { + * if (err.code === 'ENOENT') { + * console.error('myfile does not exist'); + * return; + * } + * + * throw err; + * } + * + * try { + * readMyData(fd); + * } finally { + * close(fd, (err) => { + * if (err) throw err; + * }); + * } + * }); + * ``` + * + * The "not recommended" examples above check for accessibility and then use the + * file; the "recommended" examples are better because they use the file directly + * and handle the error, if any. + * + * In general, check for the accessibility of a file only if the file will not be + * used directly, for example when its accessibility is a signal from another + * process. + * + * On Windows, access-control policies (ACLs) on a directory may limit access to + * a file or directory. The `fs.access()` function, however, does not check the + * ACL and therefore may report that a path is accessible even if the ACL restricts + * the user from reading or writing to it. + * @since v0.11.15 + * @param [mode=fs.constants.F_OK] + */ + export function access(path: PathLike, mode: number | undefined, callback: NoParamCallback): void; + /** + * Asynchronously tests a user's permissions for the file specified by path. + * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. + */ + export function access(path: PathLike, callback: NoParamCallback): void; + export namespace access { + /** + * Asynchronously tests a user's permissions for the file specified by path. + * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. + * URL support is _experimental_. + */ + function __promisify__(path: PathLike, mode?: number): Promise; + } + /** + * Synchronously tests a user's permissions for the file or directory specified + * by `path`. The `mode` argument is an optional integer that specifies the + * accessibility checks to be performed. Check `File access constants` for + * possible values of `mode`. It is possible to create a mask consisting of + * the bitwise OR of two or more values + * (e.g. `fs.constants.W_OK | fs.constants.R_OK`). + * + * If any of the accessibility checks fail, an `Error` will be thrown. Otherwise, + * the method will return `undefined`. + * + * ```js + * import { accessSync, constants } from 'fs'; + * + * try { + * accessSync('etc/passwd', constants.R_OK | constants.W_OK); + * console.log('can read/write'); + * } catch (err) { + * console.error('no access!'); + * } + * ``` + * @since v0.11.15 + * @param [mode=fs.constants.F_OK] + */ + export function accessSync(path: PathLike, mode?: number): void; + interface StreamOptions { + flags?: string | undefined; + encoding?: BufferEncoding | undefined; + fd?: number | promises.FileHandle | undefined; + mode?: number | undefined; + autoClose?: boolean | undefined; + /** + * @default false + */ + emitClose?: boolean | undefined; + start?: number | undefined; + highWaterMark?: number | undefined; + } + interface ReadStreamOptions extends StreamOptions { + end?: number | undefined; + } + /** + * Unlike the 16 kb default `highWaterMark` for a `stream.Readable`, the stream + * returned by this method has a default `highWaterMark` of 64 kb. + * + * `options` can include `start` and `end` values to read a range of bytes from + * the file instead of the entire file. Both `start` and `end` are inclusive and + * start counting at 0, allowed values are in the + * \[0, [`Number.MAX_SAFE_INTEGER`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER)\] range. If `fd` is specified and `start` is + * omitted or `undefined`, `fs.createReadStream()` reads sequentially from the + * current file position. The `encoding` can be any one of those accepted by `Buffer`. + * + * If `fd` is specified, `ReadStream` will ignore the `path` argument and will use + * the specified file descriptor. This means that no `'open'` event will be + * emitted. `fd` should be blocking; non-blocking `fd`s should be passed to `net.Socket`. + * + * If `fd` points to a character device that only supports blocking reads + * (such as keyboard or sound card), read operations do not finish until data is + * available. This can prevent the process from exiting and the stream from + * closing naturally. + * + * By default, the stream will emit a `'close'` event after it has been + * destroyed. Set the `emitClose` option to `false` to change this behavior. + * + * By providing the `fs` option, it is possible to override the corresponding `fs`implementations for `open`, `read`, and `close`. When providing the `fs` option, + * an override for `read` is required. If no `fd` is provided, an override for`open` is also required. If `autoClose` is `true`, an override for `close` is + * also required. + * + * ```js + * import { createReadStream } from 'fs'; + * + * // Create a stream from some character device. + * const stream = createReadStream('/dev/input/event0'); + * setTimeout(() => { + * stream.close(); // This may not close the stream. + * // Artificially marking end-of-stream, as if the underlying resource had + * // indicated end-of-file by itself, allows the stream to close. + * // This does not cancel pending read operations, and if there is such an + * // operation, the process may still not be able to exit successfully + * // until it finishes. + * stream.push(null); + * stream.read(0); + * }, 100); + * ``` + * + * If `autoClose` is false, then the file descriptor won't be closed, even if + * there's an error. It is the application's responsibility to close it and make + * sure there's no file descriptor leak. If `autoClose` is set to true (default + * behavior), on `'error'` or `'end'` the file descriptor will be closed + * automatically. + * + * `mode` sets the file mode (permission and sticky bits), but only if the + * file was created. + * + * An example to read the last 10 bytes of a file which is 100 bytes long: + * + * ```js + * import { createReadStream } from 'fs'; + * + * createReadStream('sample.txt', { start: 90, end: 99 }); + * ``` + * + * If `options` is a string, then it specifies the encoding. + * @since v0.1.31 + */ + export function createReadStream(path: PathLike, options?: BufferEncoding | ReadStreamOptions): ReadStream; + /** + * `options` may also include a `start` option to allow writing data at some + * position past the beginning of the file, allowed values are in the + * \[0, [`Number.MAX_SAFE_INTEGER`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER)\] range. Modifying a file rather than replacing + * it may require the `flags` option to be set to `r+` rather than the default `w`. + * The `encoding` can be any one of those accepted by `Buffer`. + * + * If `autoClose` is set to true (default behavior) on `'error'` or `'finish'`the file descriptor will be closed automatically. If `autoClose` is false, + * then the file descriptor won't be closed, even if there's an error. + * It is the application's responsibility to close it and make sure there's no + * file descriptor leak. + * + * By default, the stream will emit a `'close'` event after it has been + * destroyed. Set the `emitClose` option to `false` to change this behavior. + * + * By providing the `fs` option it is possible to override the corresponding `fs`implementations for `open`, `write`, `writev` and `close`. Overriding `write()`without `writev()` can reduce + * performance as some optimizations (`_writev()`) + * will be disabled. When providing the `fs` option, overrides for at least one of`write` and `writev` are required. If no `fd` option is supplied, an override + * for `open` is also required. If `autoClose` is `true`, an override for `close`is also required. + * + * Like `fs.ReadStream`, if `fd` is specified, `fs.WriteStream` will ignore the`path` argument and will use the specified file descriptor. This means that no`'open'` event will be + * emitted. `fd` should be blocking; non-blocking `fd`s + * should be passed to `net.Socket`. + * + * If `options` is a string, then it specifies the encoding. + * @since v0.1.31 + */ + export function createWriteStream(path: PathLike, options?: BufferEncoding | StreamOptions): WriteStream; + /** + * Forces all currently queued I/O operations associated with the file to the + * operating system's synchronized I/O completion state. Refer to the POSIX [`fdatasync(2)`](http://man7.org/linux/man-pages/man2/fdatasync.2.html) documentation for details. No arguments other + * than a possible + * exception are given to the completion callback. + * @since v0.1.96 + */ + export function fdatasync(fd: number, callback: NoParamCallback): void; + export namespace fdatasync { + /** + * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. + * @param fd A file descriptor. + */ + function __promisify__(fd: number): Promise; + } + /** + * Forces all currently queued I/O operations associated with the file to the + * operating system's synchronized I/O completion state. Refer to the POSIX [`fdatasync(2)`](http://man7.org/linux/man-pages/man2/fdatasync.2.html) documentation for details. Returns `undefined`. + * @since v0.1.96 + */ + export function fdatasyncSync(fd: number): void; + /** + * Asynchronously copies `src` to `dest`. By default, `dest` is overwritten if it + * already exists. No arguments other than a possible exception are given to the + * callback function. Node.js makes no guarantees about the atomicity of the copy + * operation. If an error occurs after the destination file has been opened for + * writing, Node.js will attempt to remove the destination. + * + * `mode` is an optional integer that specifies the behavior + * of the copy operation. It is possible to create a mask consisting of the bitwise + * OR of two or more values (e.g.`fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE`). + * + * * `fs.constants.COPYFILE_EXCL`: The copy operation will fail if `dest` already + * exists. + * * `fs.constants.COPYFILE_FICLONE`: The copy operation will attempt to create a + * copy-on-write reflink. If the platform does not support copy-on-write, then a + * fallback copy mechanism is used. + * * `fs.constants.COPYFILE_FICLONE_FORCE`: The copy operation will attempt to + * create a copy-on-write reflink. If the platform does not support + * copy-on-write, then the operation will fail. + * + * ```js + * import { copyFile, constants } from 'fs'; + * + * function callback(err) { + * if (err) throw err; + * console.log('source.txt was copied to destination.txt'); + * } + * + * // destination.txt will be created or overwritten by default. + * copyFile('source.txt', 'destination.txt', callback); + * + * // By using COPYFILE_EXCL, the operation will fail if destination.txt exists. + * copyFile('source.txt', 'destination.txt', constants.COPYFILE_EXCL, callback); + * ``` + * @since v8.5.0 + * @param src source filename to copy + * @param dest destination filename of the copy operation + * @param [mode=0] modifiers for copy operation. + */ + export function copyFile(src: PathLike, dest: PathLike, callback: NoParamCallback): void; + export function copyFile(src: PathLike, dest: PathLike, mode: number, callback: NoParamCallback): void; + export namespace copyFile { + function __promisify__(src: PathLike, dst: PathLike, mode?: number): Promise; + } + /** + * Synchronously copies `src` to `dest`. By default, `dest` is overwritten if it + * already exists. Returns `undefined`. Node.js makes no guarantees about the + * atomicity of the copy operation. If an error occurs after the destination file + * has been opened for writing, Node.js will attempt to remove the destination. + * + * `mode` is an optional integer that specifies the behavior + * of the copy operation. It is possible to create a mask consisting of the bitwise + * OR of two or more values (e.g.`fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE`). + * + * * `fs.constants.COPYFILE_EXCL`: The copy operation will fail if `dest` already + * exists. + * * `fs.constants.COPYFILE_FICLONE`: The copy operation will attempt to create a + * copy-on-write reflink. If the platform does not support copy-on-write, then a + * fallback copy mechanism is used. + * * `fs.constants.COPYFILE_FICLONE_FORCE`: The copy operation will attempt to + * create a copy-on-write reflink. If the platform does not support + * copy-on-write, then the operation will fail. + * + * ```js + * import { copyFileSync, constants } from 'fs'; + * + * // destination.txt will be created or overwritten by default. + * copyFileSync('source.txt', 'destination.txt'); + * console.log('source.txt was copied to destination.txt'); + * + * // By using COPYFILE_EXCL, the operation will fail if destination.txt exists. + * copyFileSync('source.txt', 'destination.txt', constants.COPYFILE_EXCL); + * ``` + * @since v8.5.0 + * @param src source filename to copy + * @param dest destination filename of the copy operation + * @param [mode=0] modifiers for copy operation. + */ + export function copyFileSync(src: PathLike, dest: PathLike, mode?: number): void; + /** + * Write an array of `ArrayBufferView`s to the file specified by `fd` using`writev()`. + * + * `position` is the offset from the beginning of the file where this data + * should be written. If `typeof position !== 'number'`, the data will be written + * at the current position. + * + * The callback will be given three arguments: `err`, `bytesWritten`, and`buffers`. `bytesWritten` is how many bytes were written from `buffers`. + * + * If this method is `util.promisify()` ed, it returns a promise for an`Object` with `bytesWritten` and `buffers` properties. + * + * It is unsafe to use `fs.writev()` multiple times on the same file without + * waiting for the callback. For this scenario, use {@link createWriteStream}. + * + * On Linux, positional writes don't work when the file is opened in append mode. + * The kernel ignores the position argument and always appends the data to + * the end of the file. + * @since v12.9.0 + */ + export function writev(fd: number, buffers: ReadonlyArray, cb: (err: NodeJS.ErrnoException | null, bytesWritten: number, buffers: NodeJS.ArrayBufferView[]) => void): void; + export function writev( + fd: number, + buffers: ReadonlyArray, + position: number, + cb: (err: NodeJS.ErrnoException | null, bytesWritten: number, buffers: NodeJS.ArrayBufferView[]) => void + ): void; + export interface WriteVResult { + bytesWritten: number; + buffers: NodeJS.ArrayBufferView[]; + } + export namespace writev { + function __promisify__(fd: number, buffers: ReadonlyArray, position?: number): Promise; + } + /** + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link writev}. + * @since v12.9.0 + * @return The number of bytes written. + */ + export function writevSync(fd: number, buffers: ReadonlyArray, position?: number): number; + /** + * Read from a file specified by `fd` and write to an array of `ArrayBufferView`s + * using `readv()`. + * + * `position` is the offset from the beginning of the file from where data + * should be read. If `typeof position !== 'number'`, the data will be read + * from the current position. + * + * The callback will be given three arguments: `err`, `bytesRead`, and`buffers`. `bytesRead` is how many bytes were read from the file. + * + * If this method is invoked as its `util.promisify()` ed version, it returns + * a promise for an `Object` with `bytesRead` and `buffers` properties. + * @since v13.13.0, v12.17.0 + */ + export function readv(fd: number, buffers: ReadonlyArray, cb: (err: NodeJS.ErrnoException | null, bytesRead: number, buffers: NodeJS.ArrayBufferView[]) => void): void; + export function readv( + fd: number, + buffers: ReadonlyArray, + position: number, + cb: (err: NodeJS.ErrnoException | null, bytesRead: number, buffers: NodeJS.ArrayBufferView[]) => void + ): void; + export interface ReadVResult { + bytesRead: number; + buffers: NodeJS.ArrayBufferView[]; + } + export namespace readv { + function __promisify__(fd: number, buffers: ReadonlyArray, position?: number): Promise; + } + /** + * For detailed information, see the documentation of the asynchronous version of + * this API: {@link readv}. + * @since v13.13.0, v12.17.0 + * @return The number of bytes read. + */ + export function readvSync(fd: number, buffers: ReadonlyArray, position?: number): number; + export interface OpenDirOptions { + encoding?: BufferEncoding | undefined; + /** + * Number of directory entries that are buffered + * internally when reading from the directory. Higher values lead to better + * performance but higher memory usage. + * @default 32 + */ + bufferSize?: number | undefined; + } + /** + * Synchronously open a directory. See [`opendir(3)`](http://man7.org/linux/man-pages/man3/opendir.3.html). + * + * Creates an `fs.Dir`, which contains all further functions for reading from + * and cleaning up the directory. + * + * The `encoding` option sets the encoding for the `path` while opening the + * directory and subsequent read operations. + * @since v12.12.0 + */ + export function opendirSync(path: PathLike, options?: OpenDirOptions): Dir; + /** + * Asynchronously open a directory. See the POSIX [`opendir(3)`](http://man7.org/linux/man-pages/man3/opendir.3.html) documentation for + * more details. + * + * Creates an `fs.Dir`, which contains all further functions for reading from + * and cleaning up the directory. + * + * The `encoding` option sets the encoding for the `path` while opening the + * directory and subsequent read operations. + * @since v12.12.0 + */ + export function opendir(path: PathLike, cb: (err: NodeJS.ErrnoException | null, dir: Dir) => void): void; + export function opendir(path: PathLike, options: OpenDirOptions, cb: (err: NodeJS.ErrnoException | null, dir: Dir) => void): void; + export namespace opendir { + function __promisify__(path: PathLike, options?: OpenDirOptions): Promise

; + } + export interface BigIntStats extends StatsBase { + atimeNs: bigint; + mtimeNs: bigint; + ctimeNs: bigint; + birthtimeNs: bigint; + } + export interface BigIntOptions { + bigint: true; + } + export interface StatOptions { + bigint?: boolean | undefined; + } + export interface StatSyncOptions extends StatOptions { + throwIfNoEntry?: boolean | undefined; + } + export interface CopyOptions { + /** + * Dereference symlinks + * @default false + */ + dereference?: boolean; + /** + * When `force` is `false`, and the destination + * exists, throw an error. + * @default false + */ + errorOnExist?: boolean; + /** + * Function to filter copied files/directories. Return + * `true` to copy the item, `false` to ignore it. + */ + filter?(source: string, destination: string): boolean; + /** + * Overwrite existing file or directory. _The copy + * operation will ignore errors if you set this to false and the destination + * exists. Use the `errorOnExist` option to change this behavior. + * @default true + */ + force?: boolean; + /** + * When `true` timestamps from `src` will + * be preserved. + * @default false + */ + preserveTimestamps?: boolean; + /** + * Copy directories recursively. + * @default false + */ + recursive?: boolean; + } + /** + * Asynchronously copies the entire directory structure from `src` to `dest`, + * including subdirectories and files. + * + * When copying a directory to another directory, globs are not supported and + * behavior is similar to `cp dir1/ dir2/`. + * @since v16.7.0 + * @experimental + * @param src source path to copy. + * @param dest destination path to copy to. + */ + export function cp(source: string, destination: string, callback: (err: NodeJS.ErrnoException | null) => void): void; + export function cp(source: string, destination: string, opts: CopyOptions, callback: (err: NodeJS.ErrnoException | null) => void): void; + /** + * Synchronously copies the entire directory structure from `src` to `dest`, + * including subdirectories and files. + * + * When copying a directory to another directory, globs are not supported and + * behavior is similar to `cp dir1/ dir2/`. + * @since v16.7.0 + * @experimental + * @param src source path to copy. + * @param dest destination path to copy to. + */ + export function cpSync(source: string, destination: string, opts?: CopyOptions): void; +} +declare module 'node:fs' { + export * from 'fs'; +} diff --git a/node_modules/@types/node/fs/promises.d.ts b/node_modules/@types/node/fs/promises.d.ts new file mode 100755 index 00000000..f2e981d8 --- /dev/null +++ b/node_modules/@types/node/fs/promises.d.ts @@ -0,0 +1,1091 @@ +/** + * The `fs/promises` API provides asynchronous file system methods that return + * promises. + * + * The promise APIs use the underlying Node.js threadpool to perform file + * system operations off the event loop thread. These operations are not + * synchronized or threadsafe. Care must be taken when performing multiple + * concurrent modifications on the same file or data corruption may occur. + * @since v10.0.0 + */ +declare module 'fs/promises' { + import { Abortable } from 'node:events'; + import { Stream } from 'node:stream'; + import { + Stats, + BigIntStats, + StatOptions, + WriteVResult, + ReadVResult, + PathLike, + RmDirOptions, + RmOptions, + MakeDirectoryOptions, + Dirent, + OpenDirOptions, + Dir, + ObjectEncodingOptions, + BufferEncodingOption, + OpenMode, + Mode, + WatchOptions, + WatchEventType, + CopyOptions, + ReadStream, + WriteStream, + } from 'node:fs'; + interface FileChangeInfo { + eventType: WatchEventType; + filename: T; + } + interface FlagAndOpenMode { + mode?: Mode | undefined; + flag?: OpenMode | undefined; + } + interface FileReadResult { + bytesRead: number; + buffer: T; + } + interface FileReadOptions { + /** + * @default `Buffer.alloc(0xffff)` + */ + buffer?: T; + /** + * @default 0 + */ + offset?: number | null; + /** + * @default `buffer.byteLength` + */ + length?: number | null; + position?: number | null; + } + interface CreateReadStreamOptions { + encoding?: BufferEncoding | null | undefined; + autoClose?: boolean | undefined; + emitClose?: boolean | undefined; + start?: number | undefined; + end?: number | undefined; + highWaterMark?: number | undefined; + } + interface CreateWriteStreamOptions { + encoding?: BufferEncoding | null | undefined; + autoClose?: boolean | undefined; + emitClose?: boolean | undefined; + start?: number | undefined; + } + // TODO: Add `EventEmitter` close + interface FileHandle { + /** + * The numeric file descriptor managed by the {FileHandle} object. + * @since v10.0.0 + */ + readonly fd: number; + /** + * Alias of `filehandle.writeFile()`. + * + * When operating on file handles, the mode cannot be changed from what it was set + * to with `fsPromises.open()`. Therefore, this is equivalent to `filehandle.writeFile()`. + * @since v10.0.0 + * @return Fulfills with `undefined` upon success. + */ + appendFile(data: string | Uint8Array, options?: (ObjectEncodingOptions & FlagAndOpenMode) | BufferEncoding | null): Promise; + /** + * Changes the ownership of the file. A wrapper for [`chown(2)`](http://man7.org/linux/man-pages/man2/chown.2.html). + * @since v10.0.0 + * @param uid The file's new owner's user id. + * @param gid The file's new group's group id. + * @return Fulfills with `undefined` upon success. + */ + chown(uid: number, gid: number): Promise; + /** + * Modifies the permissions on the file. See [`chmod(2)`](http://man7.org/linux/man-pages/man2/chmod.2.html). + * @since v10.0.0 + * @param mode the file mode bit mask. + * @return Fulfills with `undefined` upon success. + */ + chmod(mode: Mode): Promise; + /** + * Unlike the 16 kb default `highWaterMark` for a `stream.Readable`, the stream + * returned by this method has a default `highWaterMark` of 64 kb. + * + * `options` can include `start` and `end` values to read a range of bytes from + * the file instead of the entire file. Both `start` and `end` are inclusive and + * start counting at 0, allowed values are in the + * \[0, [`Number.MAX_SAFE_INTEGER`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER)\] range. If `start` is + * omitted or `undefined`, `filehandle.createReadStream()` reads sequentially from + * the current file position. The `encoding` can be any one of those accepted by `Buffer`. + * + * If the `FileHandle` points to a character device that only supports blocking + * reads (such as keyboard or sound card), read operations do not finish until data + * is available. This can prevent the process from exiting and the stream from + * closing naturally. + * + * By default, the stream will emit a `'close'` event after it has been + * destroyed. Set the `emitClose` option to `false` to change this behavior. + * + * ```js + * import { open } from 'fs/promises'; + * + * const fd = await open('/dev/input/event0'); + * // Create a stream from some character device. + * const stream = fd.createReadStream(); + * setTimeout(() => { + * stream.close(); // This may not close the stream. + * // Artificially marking end-of-stream, as if the underlying resource had + * // indicated end-of-file by itself, allows the stream to close. + * // This does not cancel pending read operations, and if there is such an + * // operation, the process may still not be able to exit successfully + * // until it finishes. + * stream.push(null); + * stream.read(0); + * }, 100); + * ``` + * + * If `autoClose` is false, then the file descriptor won't be closed, even if + * there's an error. It is the application's responsibility to close it and make + * sure there's no file descriptor leak. If `autoClose` is set to true (default + * behavior), on `'error'` or `'end'` the file descriptor will be closed + * automatically. + * + * An example to read the last 10 bytes of a file which is 100 bytes long: + * + * ```js + * import { open } from 'fs/promises'; + * + * const fd = await open('sample.txt'); + * fd.createReadStream({ start: 90, end: 99 }); + * ``` + * @since v16.11.0 + */ + createReadStream(options?: CreateReadStreamOptions): ReadStream; + /** + * `options` may also include a `start` option to allow writing data at some + * position past the beginning of the file, allowed values are in the + * \[0, [`Number.MAX_SAFE_INTEGER`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER)\] range. Modifying a file rather than replacing + * it may require the `flags` `open` option to be set to `r+` rather than the + * default `r`. The `encoding` can be any one of those accepted by `Buffer`. + * + * If `autoClose` is set to true (default behavior) on `'error'` or `'finish'`the file descriptor will be closed automatically. If `autoClose` is false, + * then the file descriptor won't be closed, even if there's an error. + * It is the application's responsibility to close it and make sure there's no + * file descriptor leak. + * + * By default, the stream will emit a `'close'` event after it has been + * destroyed. Set the `emitClose` option to `false` to change this behavior. + * @since v16.11.0 + */ + createWriteStream(options?: CreateWriteStreamOptions): WriteStream; + /** + * Forces all currently queued I/O operations associated with the file to the + * operating system's synchronized I/O completion state. Refer to the POSIX [`fdatasync(2)`](http://man7.org/linux/man-pages/man2/fdatasync.2.html) documentation for details. + * + * Unlike `filehandle.sync` this method does not flush modified metadata. + * @since v10.0.0 + * @return Fulfills with `undefined` upon success. + */ + datasync(): Promise; + /** + * Request that all data for the open file descriptor is flushed to the storage + * device. The specific implementation is operating system and device specific. + * Refer to the POSIX [`fsync(2)`](http://man7.org/linux/man-pages/man2/fsync.2.html) documentation for more detail. + * @since v10.0.0 + * @return Fufills with `undefined` upon success. + */ + sync(): Promise; + /** + * Reads data from the file and stores that in the given buffer. + * + * If the file is not modified concurrently, the end-of-file is reached when the + * number of bytes read is zero. + * @since v10.0.0 + * @param buffer A buffer that will be filled with the file data read. + * @param offset The location in the buffer at which to start filling. + * @param length The number of bytes to read. + * @param position The location where to begin reading data from the file. If `null`, data will be read from the current file position, and the position will be updated. If `position` is an + * integer, the current file position will remain unchanged. + * @return Fulfills upon success with an object with two properties: + */ + read(buffer: T, offset?: number | null, length?: number | null, position?: number | null): Promise>; + read(options?: FileReadOptions): Promise>; + /** + * Asynchronously reads the entire contents of a file. + * + * If `options` is a string, then it specifies the `encoding`. + * + * The `FileHandle` has to support reading. + * + * If one or more `filehandle.read()` calls are made on a file handle and then a`filehandle.readFile()` call is made, the data will be read from the current + * position till the end of the file. It doesn't always read from the beginning + * of the file. + * @since v10.0.0 + * @return Fulfills upon a successful read with the contents of the file. If no encoding is specified (using `options.encoding`), the data is returned as a {Buffer} object. Otherwise, the + * data will be a string. + */ + readFile( + options?: { + encoding?: null | undefined; + flag?: OpenMode | undefined; + } | null + ): Promise; + /** + * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. + * The `FileHandle` must have been opened for reading. + * @param options An object that may contain an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + readFile( + options: + | { + encoding: BufferEncoding; + flag?: OpenMode | undefined; + } + | BufferEncoding + ): Promise; + /** + * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. + * The `FileHandle` must have been opened for reading. + * @param options An object that may contain an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + readFile( + options?: + | (ObjectEncodingOptions & { + flag?: OpenMode | undefined; + }) + | BufferEncoding + | null + ): Promise; + /** + * @since v10.0.0 + * @return Fulfills with an {fs.Stats} for the file. + */ + stat( + opts?: StatOptions & { + bigint?: false | undefined; + } + ): Promise; + stat( + opts: StatOptions & { + bigint: true; + } + ): Promise; + stat(opts?: StatOptions): Promise; + /** + * Truncates the file. + * + * If the file was larger than `len` bytes, only the first `len` bytes will be + * retained in the file. + * + * The following example retains only the first four bytes of the file: + * + * ```js + * import { open } from 'fs/promises'; + * + * let filehandle = null; + * try { + * filehandle = await open('temp.txt', 'r+'); + * await filehandle.truncate(4); + * } finally { + * await filehandle?.close(); + * } + * ``` + * + * If the file previously was shorter than `len` bytes, it is extended, and the + * extended part is filled with null bytes (`'\0'`): + * + * If `len` is negative then `0` will be used. + * @since v10.0.0 + * @param [len=0] + * @return Fulfills with `undefined` upon success. + */ + truncate(len?: number): Promise; + /** + * Change the file system timestamps of the object referenced by the `FileHandle` then resolves the promise with no arguments upon success. + * @since v10.0.0 + */ + utimes(atime: string | number | Date, mtime: string | number | Date): Promise; + /** + * Asynchronously writes data to a file, replacing the file if it already exists.`data` can be a string, a buffer, an + * [AsyncIterable](https://tc39.github.io/ecma262/#sec-asynciterable-interface) or + * [Iterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterable_protocol) object, or an + * object with an own `toString` function + * property. The promise is resolved with no arguments upon success. + * + * If `options` is a string, then it specifies the `encoding`. + * + * The `FileHandle` has to support writing. + * + * It is unsafe to use `filehandle.writeFile()` multiple times on the same file + * without waiting for the promise to be resolved (or rejected). + * + * If one or more `filehandle.write()` calls are made on a file handle and then a`filehandle.writeFile()` call is made, the data will be written from the + * current position till the end of the file. It doesn't always write from the + * beginning of the file. + * @since v10.0.0 + */ + writeFile(data: string | Uint8Array, options?: (ObjectEncodingOptions & FlagAndOpenMode & Abortable) | BufferEncoding | null): Promise; + /** + * Write `buffer` to the file. + * + * If `buffer` is a plain object, it must have an own (not inherited) `toString`function property. + * + * The promise is resolved with an object containing two properties: + * + * It is unsafe to use `filehandle.write()` multiple times on the same file + * without waiting for the promise to be resolved (or rejected). For this + * scenario, use `fs.createWriteStream()`. + * + * On Linux, positional writes do not work when the file is opened in append mode. + * The kernel ignores the position argument and always appends the data to + * the end of the file. + * @since v10.0.0 + * @param [offset=0] The start position from within `buffer` where the data to write begins. + * @param [length=buffer.byteLength] The number of bytes from `buffer` to write. + * @param position The offset from the beginning of the file where the data from `buffer` should be written. If `position` is not a `number`, the data will be written at the current position. + * See the POSIX pwrite(2) documentation for more detail. + */ + write( + buffer: TBuffer, + offset?: number | null, + length?: number | null, + position?: number | null + ): Promise<{ + bytesWritten: number; + buffer: TBuffer; + }>; + write( + data: string, + position?: number | null, + encoding?: BufferEncoding | null + ): Promise<{ + bytesWritten: number; + buffer: string; + }>; + /** + * Write an array of [ArrayBufferView](https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView) s to the file. + * + * The promise is resolved with an object containing a two properties: + * + * It is unsafe to call `writev()` multiple times on the same file without waiting + * for the promise to be resolved (or rejected). + * + * On Linux, positional writes don't work when the file is opened in append mode. + * The kernel ignores the position argument and always appends the data to + * the end of the file. + * @since v12.9.0 + * @param position The offset from the beginning of the file where the data from `buffers` should be written. If `position` is not a `number`, the data will be written at the current + * position. + */ + writev(buffers: ReadonlyArray, position?: number): Promise; + /** + * Read from a file and write to an array of [ArrayBufferView](https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView) s + * @since v13.13.0, v12.17.0 + * @param position The offset from the beginning of the file where the data should be read from. If `position` is not a `number`, the data will be read from the current position. + * @return Fulfills upon success an object containing two properties: + */ + readv(buffers: ReadonlyArray, position?: number): Promise; + /** + * Closes the file handle after waiting for any pending operation on the handle to + * complete. + * + * ```js + * import { open } from 'fs/promises'; + * + * let filehandle; + * try { + * filehandle = await open('thefile.txt', 'r'); + * } finally { + * await filehandle?.close(); + * } + * ``` + * @since v10.0.0 + * @return Fulfills with `undefined` upon success. + */ + close(): Promise; + } + /** + * Tests a user's permissions for the file or directory specified by `path`. + * The `mode` argument is an optional integer that specifies the accessibility + * checks to be performed. Check `File access constants` for possible values + * of `mode`. It is possible to create a mask consisting of the bitwise OR of + * two or more values (e.g. `fs.constants.W_OK | fs.constants.R_OK`). + * + * If the accessibility check is successful, the promise is resolved with no + * value. If any of the accessibility checks fail, the promise is rejected + * with an [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object. The following example checks if the file`/etc/passwd` can be read and + * written by the current process. + * + * ```js + * import { access } from 'fs/promises'; + * import { constants } from 'fs'; + * + * try { + * await access('/etc/passwd', constants.R_OK | constants.W_OK); + * console.log('can access'); + * } catch { + * console.error('cannot access'); + * } + * ``` + * + * Using `fsPromises.access()` to check for the accessibility of a file before + * calling `fsPromises.open()` is not recommended. Doing so introduces a race + * condition, since other processes may change the file's state between the two + * calls. Instead, user code should open/read/write the file directly and handle + * the error raised if the file is not accessible. + * @since v10.0.0 + * @param [mode=fs.constants.F_OK] + * @return Fulfills with `undefined` upon success. + */ + function access(path: PathLike, mode?: number): Promise; + /** + * Asynchronously copies `src` to `dest`. By default, `dest` is overwritten if it + * already exists. + * + * No guarantees are made about the atomicity of the copy operation. If an + * error occurs after the destination file has been opened for writing, an attempt + * will be made to remove the destination. + * + * ```js + * import { constants } from 'fs'; + * import { copyFile } from 'fs/promises'; + * + * try { + * await copyFile('source.txt', 'destination.txt'); + * console.log('source.txt was copied to destination.txt'); + * } catch { + * console.log('The file could not be copied'); + * } + * + * // By using COPYFILE_EXCL, the operation will fail if destination.txt exists. + * try { + * await copyFile('source.txt', 'destination.txt', constants.COPYFILE_EXCL); + * console.log('source.txt was copied to destination.txt'); + * } catch { + * console.log('The file could not be copied'); + * } + * ``` + * @since v10.0.0 + * @param src source filename to copy + * @param dest destination filename of the copy operation + * @param [mode=0] Optional modifiers that specify the behavior of the copy operation. It is possible to create a mask consisting of the bitwise OR of two or more values (e.g. + * `fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE`) + * @return Fulfills with `undefined` upon success. + */ + function copyFile(src: PathLike, dest: PathLike, mode?: number): Promise; + /** + * Opens a `FileHandle`. + * + * Refer to the POSIX [`open(2)`](http://man7.org/linux/man-pages/man2/open.2.html) documentation for more detail. + * + * Some characters (`< > : " / \ | ? *`) are reserved under Windows as documented + * by [Naming Files, Paths, and Namespaces](https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file). Under NTFS, if the filename contains + * a colon, Node.js will open a file system stream, as described by [this MSDN page](https://docs.microsoft.com/en-us/windows/desktop/FileIO/using-streams). + * @since v10.0.0 + * @param [flags='r'] See `support of file system `flags``. + * @param [mode=0o666] Sets the file mode (permission and sticky bits) if the file is created. + * @return Fulfills with a {FileHandle} object. + */ + function open(path: PathLike, flags: string | number, mode?: Mode): Promise; + /** + * Renames `oldPath` to `newPath`. + * @since v10.0.0 + * @return Fulfills with `undefined` upon success. + */ + function rename(oldPath: PathLike, newPath: PathLike): Promise; + /** + * Truncates (shortens or extends the length) of the content at `path` to `len`bytes. + * @since v10.0.0 + * @param [len=0] + * @return Fulfills with `undefined` upon success. + */ + function truncate(path: PathLike, len?: number): Promise; + /** + * Removes the directory identified by `path`. + * + * Using `fsPromises.rmdir()` on a file (not a directory) results in the + * promise being rejected with an `ENOENT` error on Windows and an `ENOTDIR`error on POSIX. + * + * To get a behavior similar to the `rm -rf` Unix command, use `fsPromises.rm()` with options `{ recursive: true, force: true }`. + * @since v10.0.0 + * @return Fulfills with `undefined` upon success. + */ + function rmdir(path: PathLike, options?: RmDirOptions): Promise; + /** + * Removes files and directories (modeled on the standard POSIX `rm` utility). + * @since v14.14.0 + * @return Fulfills with `undefined` upon success. + */ + function rm(path: PathLike, options?: RmOptions): Promise; + /** + * Asynchronously creates a directory. + * + * The optional `options` argument can be an integer specifying `mode` (permission + * and sticky bits), or an object with a `mode` property and a `recursive`property indicating whether parent directories should be created. Calling`fsPromises.mkdir()` when `path` is a directory + * that exists results in a + * rejection only when `recursive` is false. + * @since v10.0.0 + * @return Upon success, fulfills with `undefined` if `recursive` is `false`, or the first directory path created if `recursive` is `true`. + */ + function mkdir( + path: PathLike, + options: MakeDirectoryOptions & { + recursive: true; + } + ): Promise; + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + function mkdir( + path: PathLike, + options?: + | Mode + | (MakeDirectoryOptions & { + recursive?: false | undefined; + }) + | null + ): Promise; + /** + * Asynchronous mkdir(2) - create a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders + * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. + */ + function mkdir(path: PathLike, options?: Mode | MakeDirectoryOptions | null): Promise; + /** + * Reads the contents of a directory. + * + * The optional `options` argument can be a string specifying an encoding, or an + * object with an `encoding` property specifying the character encoding to use for + * the filenames. If the `encoding` is set to `'buffer'`, the filenames returned + * will be passed as `Buffer` objects. + * + * If `options.withFileTypes` is set to `true`, the resolved array will contain `fs.Dirent` objects. + * + * ```js + * import { readdir } from 'fs/promises'; + * + * try { + * const files = await readdir(path); + * for (const file of files) + * console.log(file); + * } catch (err) { + * console.error(err); + * } + * ``` + * @since v10.0.0 + * @return Fulfills with an array of the names of the files in the directory excluding `'.'` and `'..'`. + */ + function readdir( + path: PathLike, + options?: + | (ObjectEncodingOptions & { + withFileTypes?: false | undefined; + }) + | BufferEncoding + | null + ): Promise; + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function readdir( + path: PathLike, + options: + | { + encoding: 'buffer'; + withFileTypes?: false | undefined; + } + | 'buffer' + ): Promise; + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function readdir( + path: PathLike, + options?: + | (ObjectEncodingOptions & { + withFileTypes?: false | undefined; + }) + | BufferEncoding + | null + ): Promise; + /** + * Asynchronous readdir(3) - read a directory. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options If called with `withFileTypes: true` the result data will be an array of Dirent. + */ + function readdir( + path: PathLike, + options: ObjectEncodingOptions & { + withFileTypes: true; + } + ): Promise; + /** + * Reads the contents of the symbolic link referred to by `path`. See the POSIX [`readlink(2)`](http://man7.org/linux/man-pages/man2/readlink.2.html) documentation for more detail. The promise is + * resolved with the`linkString` upon success. + * + * The optional `options` argument can be a string specifying an encoding, or an + * object with an `encoding` property specifying the character encoding to use for + * the link path returned. If the `encoding` is set to `'buffer'`, the link path + * returned will be passed as a `Buffer` object. + * @since v10.0.0 + * @return Fulfills with the `linkString` upon success. + */ + function readlink(path: PathLike, options?: ObjectEncodingOptions | BufferEncoding | null): Promise; + /** + * Asynchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function readlink(path: PathLike, options: BufferEncodingOption): Promise; + /** + * Asynchronous readlink(2) - read value of a symbolic link. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function readlink(path: PathLike, options?: ObjectEncodingOptions | string | null): Promise; + /** + * Creates a symbolic link. + * + * The `type` argument is only used on Windows platforms and can be one of `'dir'`,`'file'`, or `'junction'`. Windows junction points require the destination path + * to be absolute. When using `'junction'`, the `target` argument will + * automatically be normalized to absolute path. + * @since v10.0.0 + * @param [type='file'] + * @return Fulfills with `undefined` upon success. + */ + function symlink(target: PathLike, path: PathLike, type?: string | null): Promise; + /** + * Equivalent to `fsPromises.stat()` unless `path` refers to a symbolic link, + * in which case the link itself is stat-ed, not the file that it refers to. + * Refer to the POSIX [`lstat(2)`](http://man7.org/linux/man-pages/man2/lstat.2.html) document for more detail. + * @since v10.0.0 + * @return Fulfills with the {fs.Stats} object for the given symbolic link `path`. + */ + function lstat( + path: PathLike, + opts?: StatOptions & { + bigint?: false | undefined; + } + ): Promise; + function lstat( + path: PathLike, + opts: StatOptions & { + bigint: true; + } + ): Promise; + function lstat(path: PathLike, opts?: StatOptions): Promise; + /** + * @since v10.0.0 + * @return Fulfills with the {fs.Stats} object for the given `path`. + */ + function stat( + path: PathLike, + opts?: StatOptions & { + bigint?: false | undefined; + } + ): Promise; + function stat( + path: PathLike, + opts: StatOptions & { + bigint: true; + } + ): Promise; + function stat(path: PathLike, opts?: StatOptions): Promise; + /** + * Creates a new link from the `existingPath` to the `newPath`. See the POSIX [`link(2)`](http://man7.org/linux/man-pages/man2/link.2.html) documentation for more detail. + * @since v10.0.0 + * @return Fulfills with `undefined` upon success. + */ + function link(existingPath: PathLike, newPath: PathLike): Promise; + /** + * If `path` refers to a symbolic link, then the link is removed without affecting + * the file or directory to which that link refers. If the `path` refers to a file + * path that is not a symbolic link, the file is deleted. See the POSIX [`unlink(2)`](http://man7.org/linux/man-pages/man2/unlink.2.html) documentation for more detail. + * @since v10.0.0 + * @return Fulfills with `undefined` upon success. + */ + function unlink(path: PathLike): Promise; + /** + * Changes the permissions of a file. + * @since v10.0.0 + * @return Fulfills with `undefined` upon success. + */ + function chmod(path: PathLike, mode: Mode): Promise; + /** + * Changes the permissions on a symbolic link. + * + * This method is only implemented on macOS. + * @deprecated Since v10.0.0 + * @return Fulfills with `undefined` upon success. + */ + function lchmod(path: PathLike, mode: Mode): Promise; + /** + * Changes the ownership on a symbolic link. + * @since v10.0.0 + * @return Fulfills with `undefined` upon success. + */ + function lchown(path: PathLike, uid: number, gid: number): Promise; + /** + * Changes the access and modification times of a file in the same way as `fsPromises.utimes()`, with the difference that if the path refers to a + * symbolic link, then the link is not dereferenced: instead, the timestamps of + * the symbolic link itself are changed. + * @since v14.5.0, v12.19.0 + * @return Fulfills with `undefined` upon success. + */ + function lutimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date): Promise; + /** + * Changes the ownership of a file. + * @since v10.0.0 + * @return Fulfills with `undefined` upon success. + */ + function chown(path: PathLike, uid: number, gid: number): Promise; + /** + * Change the file system timestamps of the object referenced by `path`. + * + * The `atime` and `mtime` arguments follow these rules: + * + * * Values can be either numbers representing Unix epoch time, `Date`s, or a + * numeric string like `'123456789.0'`. + * * If the value can not be converted to a number, or is `NaN`, `Infinity` or`-Infinity`, an `Error` will be thrown. + * @since v10.0.0 + * @return Fulfills with `undefined` upon success. + */ + function utimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date): Promise; + /** + * Determines the actual location of `path` using the same semantics as the`fs.realpath.native()` function. + * + * Only paths that can be converted to UTF8 strings are supported. + * + * The optional `options` argument can be a string specifying an encoding, or an + * object with an `encoding` property specifying the character encoding to use for + * the path. If the `encoding` is set to `'buffer'`, the path returned will be + * passed as a `Buffer` object. + * + * On Linux, when Node.js is linked against musl libc, the procfs file system must + * be mounted on `/proc` in order for this function to work. Glibc does not have + * this restriction. + * @since v10.0.0 + * @return Fulfills with the resolved path upon success. + */ + function realpath(path: PathLike, options?: ObjectEncodingOptions | BufferEncoding | null): Promise; + /** + * Asynchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function realpath(path: PathLike, options: BufferEncodingOption): Promise; + /** + * Asynchronous realpath(3) - return the canonicalized absolute pathname. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function realpath(path: PathLike, options?: ObjectEncodingOptions | BufferEncoding | null): Promise; + /** + * Creates a unique temporary directory. A unique directory name is generated by + * appending six random characters to the end of the provided `prefix`. Due to + * platform inconsistencies, avoid trailing `X` characters in `prefix`. Some + * platforms, notably the BSDs, can return more than six random characters, and + * replace trailing `X` characters in `prefix` with random characters. + * + * The optional `options` argument can be a string specifying an encoding, or an + * object with an `encoding` property specifying the character encoding to use. + * + * ```js + * import { mkdtemp } from 'fs/promises'; + * + * try { + * await mkdtemp(path.join(os.tmpdir(), 'foo-')); + * } catch (err) { + * console.error(err); + * } + * ``` + * + * The `fsPromises.mkdtemp()` method will append the six randomly selected + * characters directly to the `prefix` string. For instance, given a directory`/tmp`, if the intention is to create a temporary directory _within_`/tmp`, the`prefix` must end with a trailing + * platform-specific path separator + * (`require('path').sep`). + * @since v10.0.0 + * @return Fulfills with a string containing the filesystem path of the newly created temporary directory. + */ + function mkdtemp(prefix: string, options?: ObjectEncodingOptions | BufferEncoding | null): Promise; + /** + * Asynchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function mkdtemp(prefix: string, options: BufferEncodingOption): Promise; + /** + * Asynchronously creates a unique temporary directory. + * Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. + * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. + */ + function mkdtemp(prefix: string, options?: ObjectEncodingOptions | BufferEncoding | null): Promise; + /** + * Asynchronously writes data to a file, replacing the file if it already exists.`data` can be a string, a `Buffer`, or, an object with an own (not inherited)`toString` function property. + * + * The `encoding` option is ignored if `data` is a buffer. + * + * If `options` is a string, then it specifies the encoding. + * + * The `mode` option only affects the newly created file. See `fs.open()` for more details. + * + * Any specified `FileHandle` has to support writing. + * + * It is unsafe to use `fsPromises.writeFile()` multiple times on the same file + * without waiting for the promise to be settled. + * + * Similarly to `fsPromises.readFile` \- `fsPromises.writeFile` is a convenience + * method that performs multiple `write` calls internally to write the buffer + * passed to it. For performance sensitive code consider using `fs.createWriteStream()`. + * + * It is possible to use an `AbortSignal` to cancel an `fsPromises.writeFile()`. + * Cancelation is "best effort", and some amount of data is likely still + * to be written. + * + * ```js + * import { writeFile } from 'fs/promises'; + * import { Buffer } from 'buffer'; + * + * try { + * const controller = new AbortController(); + * const { signal } = controller; + * const data = new Uint8Array(Buffer.from('Hello Node.js')); + * const promise = writeFile('message.txt', data, { signal }); + * + * // Abort the request before the promise settles. + * controller.abort(); + * + * await promise; + * } catch (err) { + * // When a request is aborted - err is an AbortError + * console.error(err); + * } + * ``` + * + * Aborting an ongoing request does not abort individual operating + * system requests but rather the internal buffering `fs.writeFile` performs. + * @since v10.0.0 + * @param file filename or `FileHandle` + * @return Fulfills with `undefined` upon success. + */ + function writeFile( + file: PathLike | FileHandle, + data: string | NodeJS.ArrayBufferView | Iterable | AsyncIterable | Stream, + options?: + | (ObjectEncodingOptions & { + mode?: Mode | undefined; + flag?: OpenMode | undefined; + } & Abortable) + | BufferEncoding + | null + ): Promise; + /** + * Asynchronously append data to a file, creating the file if it does not yet + * exist. `data` can be a string or a `Buffer`. + * + * If `options` is a string, then it specifies the `encoding`. + * + * The `mode` option only affects the newly created file. See `fs.open()` for more details. + * + * The `path` may be specified as a `FileHandle` that has been opened + * for appending (using `fsPromises.open()`). + * @since v10.0.0 + * @param path filename or {FileHandle} + * @return Fulfills with `undefined` upon success. + */ + function appendFile(path: PathLike | FileHandle, data: string | Uint8Array, options?: (ObjectEncodingOptions & FlagAndOpenMode) | BufferEncoding | null): Promise; + /** + * Asynchronously reads the entire contents of a file. + * + * If no encoding is specified (using `options.encoding`), the data is returned + * as a `Buffer` object. Otherwise, the data will be a string. + * + * If `options` is a string, then it specifies the encoding. + * + * When the `path` is a directory, the behavior of `fsPromises.readFile()` is + * platform-specific. On macOS, Linux, and Windows, the promise will be rejected + * with an error. On FreeBSD, a representation of the directory's contents will be + * returned. + * + * It is possible to abort an ongoing `readFile` using an `AbortSignal`. If a + * request is aborted the promise returned is rejected with an `AbortError`: + * + * ```js + * import { readFile } from 'fs/promises'; + * + * try { + * const controller = new AbortController(); + * const { signal } = controller; + * const promise = readFile(fileName, { signal }); + * + * // Abort the request before the promise settles. + * controller.abort(); + * + * await promise; + * } catch (err) { + * // When a request is aborted - err is an AbortError + * console.error(err); + * } + * ``` + * + * Aborting an ongoing request does not abort individual operating + * system requests but rather the internal buffering `fs.readFile` performs. + * + * Any specified `FileHandle` has to support reading. + * @since v10.0.0 + * @param path filename or `FileHandle` + * @return Fulfills with the contents of the file. + */ + function readFile( + path: PathLike | FileHandle, + options?: + | ({ + encoding?: null | undefined; + flag?: OpenMode | undefined; + } & Abortable) + | null + ): Promise; + /** + * Asynchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. + * @param options An object that may contain an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + function readFile( + path: PathLike | FileHandle, + options: + | ({ + encoding: BufferEncoding; + flag?: OpenMode | undefined; + } & Abortable) + | BufferEncoding + ): Promise; + /** + * Asynchronously reads the entire contents of a file. + * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. + * If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. + * @param options An object that may contain an optional flag. + * If a flag is not provided, it defaults to `'r'`. + */ + function readFile( + path: PathLike | FileHandle, + options?: + | (ObjectEncodingOptions & + Abortable & { + flag?: OpenMode | undefined; + }) + | BufferEncoding + | null + ): Promise; + /** + * Asynchronously open a directory for iterative scanning. See the POSIX [`opendir(3)`](http://man7.org/linux/man-pages/man3/opendir.3.html) documentation for more detail. + * + * Creates an `fs.Dir`, which contains all further functions for reading from + * and cleaning up the directory. + * + * The `encoding` option sets the encoding for the `path` while opening the + * directory and subsequent read operations. + * + * Example using async iteration: + * + * ```js + * import { opendir } from 'fs/promises'; + * + * try { + * const dir = await opendir('./'); + * for await (const dirent of dir) + * console.log(dirent.name); + * } catch (err) { + * console.error(err); + * } + * ``` + * + * When using the async iterator, the `fs.Dir` object will be automatically + * closed after the iterator exits. + * @since v12.12.0 + * @return Fulfills with an {fs.Dir}. + */ + function opendir(path: PathLike, options?: OpenDirOptions): Promise; + /** + * Returns an async iterator that watches for changes on `filename`, where `filename`is either a file or a directory. + * + * ```js + * const { watch } = require('fs/promises'); + * + * const ac = new AbortController(); + * const { signal } = ac; + * setTimeout(() => ac.abort(), 10000); + * + * (async () => { + * try { + * const watcher = watch(__filename, { signal }); + * for await (const event of watcher) + * console.log(event); + * } catch (err) { + * if (err.name === 'AbortError') + * return; + * throw err; + * } + * })(); + * ``` + * + * On most platforms, `'rename'` is emitted whenever a filename appears or + * disappears in the directory. + * + * All the `caveats` for `fs.watch()` also apply to `fsPromises.watch()`. + * @since v15.9.0 + * @return of objects with the properties: + */ + function watch( + filename: PathLike, + options: + | (WatchOptions & { + encoding: 'buffer'; + }) + | 'buffer' + ): AsyncIterable>; + /** + * Watch for changes on `filename`, where `filename` is either a file or a directory, returning an `FSWatcher`. + * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol. + * @param options Either the encoding for the filename provided to the listener, or an object optionally specifying encoding, persistent, and recursive options. + * If `encoding` is not supplied, the default of `'utf8'` is used. + * If `persistent` is not supplied, the default of `true` is used. + * If `recursive` is not supplied, the default of `false` is used. + */ + function watch(filename: PathLike, options?: WatchOptions | BufferEncoding): AsyncIterable>; + /** + * Watch for changes on `filename`, where `filename` is either a file or a directory, returning an `FSWatcher`. + * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol. + * @param options Either the encoding for the filename provided to the listener, or an object optionally specifying encoding, persistent, and recursive options. + * If `encoding` is not supplied, the default of `'utf8'` is used. + * If `persistent` is not supplied, the default of `true` is used. + * If `recursive` is not supplied, the default of `false` is used. + */ + function watch(filename: PathLike, options: WatchOptions | string): AsyncIterable> | AsyncIterable>; + /** + * Asynchronously copies the entire directory structure from `src` to `dest`, + * including subdirectories and files. + * + * When copying a directory to another directory, globs are not supported and + * behavior is similar to `cp dir1/ dir2/`. + * @since v16.7.0 + * @experimental + * @param src source path to copy. + * @param dest destination path to copy to. + * @return Fulfills with `undefined` upon success. + */ + function cp(source: string, destination: string, opts?: CopyOptions): Promise; +} +declare module 'node:fs/promises' { + export * from 'fs/promises'; +} diff --git a/node_modules/@types/node/globals.d.ts b/node_modules/@types/node/globals.d.ts new file mode 100755 index 00000000..ae974db7 --- /dev/null +++ b/node_modules/@types/node/globals.d.ts @@ -0,0 +1,284 @@ +// Declare "static" methods in Error +interface ErrorConstructor { + /** Create .stack property on a target object */ + captureStackTrace(targetObject: object, constructorOpt?: Function): void; + + /** + * Optional override for formatting stack traces + * + * @see https://v8.dev/docs/stack-trace-api#customizing-stack-traces + */ + prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined; + + stackTraceLimit: number; +} + +/*-----------------------------------------------* + * * + * GLOBAL * + * * + ------------------------------------------------*/ + +// For backwards compability +interface NodeRequire extends NodeJS.Require { } +interface RequireResolve extends NodeJS.RequireResolve { } +interface NodeModule extends NodeJS.Module { } + +declare var process: NodeJS.Process; +declare var console: Console; + +declare var __filename: string; +declare var __dirname: string; + +declare var require: NodeRequire; +declare var module: NodeModule; + +// Same as module.exports +declare var exports: any; + +/** + * Only available if `--expose-gc` is passed to the process. + */ +declare var gc: undefined | (() => void); + +//#region borrowed +// from https://github.com/microsoft/TypeScript/blob/38da7c600c83e7b31193a62495239a0fe478cb67/lib/lib.webworker.d.ts#L633 until moved to separate lib +/** A controller object that allows you to abort one or more DOM requests as and when desired. */ +interface AbortController { + /** + * Returns the AbortSignal object associated with this object. + */ + + readonly signal: AbortSignal; + /** + * Invoking this method will set this object's AbortSignal's aborted flag and signal to any observers that the associated activity is to be aborted. + */ + abort(): void; +} + +/** A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object. */ +interface AbortSignal { + /** + * Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise. + */ + readonly aborted: boolean; +} + +declare var AbortController: { + prototype: AbortController; + new(): AbortController; +}; + +declare var AbortSignal: { + prototype: AbortSignal; + new(): AbortSignal; + // TODO: Add abort() static +}; +//#endregion borrowed + +//#region ArrayLike.at() +interface RelativeIndexable { + /** + * Takes an integer value and returns the item at that index, + * allowing for positive and negative integers. + * Negative integers count back from the last item in the array. + */ + at(index: number): T | undefined; +} +interface String extends RelativeIndexable {} +interface Array extends RelativeIndexable {} +interface Int8Array extends RelativeIndexable {} +interface Uint8Array extends RelativeIndexable {} +interface Uint8ClampedArray extends RelativeIndexable {} +interface Int16Array extends RelativeIndexable {} +interface Uint16Array extends RelativeIndexable {} +interface Int32Array extends RelativeIndexable {} +interface Uint32Array extends RelativeIndexable {} +interface Float32Array extends RelativeIndexable {} +interface Float64Array extends RelativeIndexable {} +interface BigInt64Array extends RelativeIndexable {} +interface BigUint64Array extends RelativeIndexable {} +//#endregion ArrayLike.at() end + +/*----------------------------------------------* +* * +* GLOBAL INTERFACES * +* * +*-----------------------------------------------*/ +declare namespace NodeJS { + interface CallSite { + /** + * Value of "this" + */ + getThis(): unknown; + + /** + * Type of "this" as a string. + * This is the name of the function stored in the constructor field of + * "this", if available. Otherwise the object's [[Class]] internal + * property. + */ + getTypeName(): string | null; + + /** + * Current function + */ + getFunction(): Function | undefined; + + /** + * Name of the current function, typically its name property. + * If a name property is not available an attempt will be made to try + * to infer a name from the function's context. + */ + getFunctionName(): string | null; + + /** + * Name of the property [of "this" or one of its prototypes] that holds + * the current function + */ + getMethodName(): string | null; + + /** + * Name of the script [if this function was defined in a script] + */ + getFileName(): string | null; + + /** + * Current line number [if this function was defined in a script] + */ + getLineNumber(): number | null; + + /** + * Current column number [if this function was defined in a script] + */ + getColumnNumber(): number | null; + + /** + * A call site object representing the location where eval was called + * [if this function was created using a call to eval] + */ + getEvalOrigin(): string | undefined; + + /** + * Is this a toplevel invocation, that is, is "this" the global object? + */ + isToplevel(): boolean; + + /** + * Does this call take place in code defined by a call to eval? + */ + isEval(): boolean; + + /** + * Is this call in native V8 code? + */ + isNative(): boolean; + + /** + * Is this a constructor call? + */ + isConstructor(): boolean; + } + + interface ErrnoException extends Error { + errno?: number | undefined; + code?: string | undefined; + path?: string | undefined; + syscall?: string | undefined; + } + + interface ReadableStream extends EventEmitter { + readable: boolean; + read(size?: number): string | Buffer; + setEncoding(encoding: BufferEncoding): this; + pause(): this; + resume(): this; + isPaused(): boolean; + pipe(destination: T, options?: { end?: boolean | undefined; }): T; + unpipe(destination?: WritableStream): this; + unshift(chunk: string | Uint8Array, encoding?: BufferEncoding): void; + wrap(oldStream: ReadableStream): this; + [Symbol.asyncIterator](): AsyncIterableIterator; + } + + interface WritableStream extends EventEmitter { + writable: boolean; + write(buffer: Uint8Array | string, cb?: (err?: Error | null) => void): boolean; + write(str: string, encoding?: BufferEncoding, cb?: (err?: Error | null) => void): boolean; + end(cb?: () => void): void; + end(data: string | Uint8Array, cb?: () => void): void; + end(str: string, encoding?: BufferEncoding, cb?: () => void): void; + } + + interface ReadWriteStream extends ReadableStream, WritableStream { } + + interface RefCounted { + ref(): this; + unref(): this; + } + + type TypedArray = + | Uint8Array + | Uint8ClampedArray + | Uint16Array + | Uint32Array + | Int8Array + | Int16Array + | Int32Array + | BigUint64Array + | BigInt64Array + | Float32Array + | Float64Array; + type ArrayBufferView = TypedArray | DataView; + + interface Require { + (id: string): any; + resolve: RequireResolve; + cache: Dict; + /** + * @deprecated + */ + extensions: RequireExtensions; + main: Module | undefined; + } + + interface RequireResolve { + (id: string, options?: { paths?: string[] | undefined; }): string; + paths(request: string): string[] | null; + } + + interface RequireExtensions extends Dict<(m: Module, filename: string) => any> { + '.js': (m: Module, filename: string) => any; + '.json': (m: Module, filename: string) => any; + '.node': (m: Module, filename: string) => any; + } + interface Module { + /** + * `true` if the module is running during the Node.js preload + */ + isPreloading: boolean; + exports: any; + require: Require; + id: string; + filename: string; + loaded: boolean; + /** @deprecated since 14.6.0 Please use `require.main` and `module.children` instead. */ + parent: Module | null | undefined; + children: Module[]; + /** + * @since 11.14.0 + * + * The directory name of the module. This is usually the same as the path.dirname() of the module.id. + */ + path: string; + paths: string[]; + } + + interface Dict { + [key: string]: T | undefined; + } + + interface ReadOnlyDict { + readonly [key: string]: T | undefined; + } +} diff --git a/node_modules/@types/node/globals.global.d.ts b/node_modules/@types/node/globals.global.d.ts new file mode 100755 index 00000000..ef1198c0 --- /dev/null +++ b/node_modules/@types/node/globals.global.d.ts @@ -0,0 +1 @@ +declare var global: typeof globalThis; diff --git a/node_modules/@types/node/http.d.ts b/node_modules/@types/node/http.d.ts new file mode 100755 index 00000000..8edac71c --- /dev/null +++ b/node_modules/@types/node/http.d.ts @@ -0,0 +1,1369 @@ +/** + * To use the HTTP server and client one must `require('http')`. + * + * The HTTP interfaces in Node.js are designed to support many features + * of the protocol which have been traditionally difficult to use. + * In particular, large, possibly chunk-encoded, messages. The interface is + * careful to never buffer entire requests or responses, so the + * user is able to stream data. + * + * HTTP message headers are represented by an object like this: + * + * ```js + * { 'content-length': '123', + * 'content-type': 'text/plain', + * 'connection': 'keep-alive', + * 'host': 'mysite.com', + * 'accept': '*' } + * ``` + * + * Keys are lowercased. Values are not modified. + * + * In order to support the full spectrum of possible HTTP applications, the Node.js + * HTTP API is very low-level. It deals with stream handling and message + * parsing only. It parses a message into headers and body but it does not + * parse the actual headers or the body. + * + * See `message.headers` for details on how duplicate headers are handled. + * + * The raw headers as they were received are retained in the `rawHeaders`property, which is an array of `[key, value, key2, value2, ...]`. For + * example, the previous message header object might have a `rawHeaders`list like the following: + * + * ```js + * [ 'ConTent-Length', '123456', + * 'content-LENGTH', '123', + * 'content-type', 'text/plain', + * 'CONNECTION', 'keep-alive', + * 'Host', 'mysite.com', + * 'accepT', '*' ] + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/http.js) + */ +declare module 'http' { + import * as stream from 'node:stream'; + import { URL } from 'node:url'; + import { TcpSocketConnectOpts, Socket, Server as NetServer, LookupFunction } from 'node:net'; + // incoming headers will never contain number + interface IncomingHttpHeaders extends NodeJS.Dict { + accept?: string | undefined; + 'accept-language'?: string | undefined; + 'accept-patch'?: string | undefined; + 'accept-ranges'?: string | undefined; + 'access-control-allow-credentials'?: string | undefined; + 'access-control-allow-headers'?: string | undefined; + 'access-control-allow-methods'?: string | undefined; + 'access-control-allow-origin'?: string | undefined; + 'access-control-expose-headers'?: string | undefined; + 'access-control-max-age'?: string | undefined; + 'access-control-request-headers'?: string | undefined; + 'access-control-request-method'?: string | undefined; + age?: string | undefined; + allow?: string | undefined; + 'alt-svc'?: string | undefined; + authorization?: string | undefined; + 'cache-control'?: string | undefined; + connection?: string | undefined; + 'content-disposition'?: string | undefined; + 'content-encoding'?: string | undefined; + 'content-language'?: string | undefined; + 'content-length'?: string | undefined; + 'content-location'?: string | undefined; + 'content-range'?: string | undefined; + 'content-type'?: string | undefined; + cookie?: string | undefined; + date?: string | undefined; + etag?: string | undefined; + expect?: string | undefined; + expires?: string | undefined; + forwarded?: string | undefined; + from?: string | undefined; + host?: string | undefined; + 'if-match'?: string | undefined; + 'if-modified-since'?: string | undefined; + 'if-none-match'?: string | undefined; + 'if-unmodified-since'?: string | undefined; + 'last-modified'?: string | undefined; + location?: string | undefined; + origin?: string | undefined; + pragma?: string | undefined; + 'proxy-authenticate'?: string | undefined; + 'proxy-authorization'?: string | undefined; + 'public-key-pins'?: string | undefined; + range?: string | undefined; + referer?: string | undefined; + 'retry-after'?: string | undefined; + 'sec-websocket-accept'?: string | undefined; + 'sec-websocket-extensions'?: string | undefined; + 'sec-websocket-key'?: string | undefined; + 'sec-websocket-protocol'?: string | undefined; + 'sec-websocket-version'?: string | undefined; + 'set-cookie'?: string[] | undefined; + 'strict-transport-security'?: string | undefined; + tk?: string | undefined; + trailer?: string | undefined; + 'transfer-encoding'?: string | undefined; + upgrade?: string | undefined; + 'user-agent'?: string | undefined; + vary?: string | undefined; + via?: string | undefined; + warning?: string | undefined; + 'www-authenticate'?: string | undefined; + } + // outgoing headers allows numbers (as they are converted internally to strings) + type OutgoingHttpHeader = number | string | string[]; + interface OutgoingHttpHeaders extends NodeJS.Dict {} + interface ClientRequestArgs { + abort?: AbortSignal | undefined; + protocol?: string | null | undefined; + host?: string | null | undefined; + hostname?: string | null | undefined; + family?: number | undefined; + port?: number | string | null | undefined; + defaultPort?: number | string | undefined; + localAddress?: string | undefined; + socketPath?: string | undefined; + /** + * @default 8192 + */ + maxHeaderSize?: number | undefined; + method?: string | undefined; + path?: string | null | undefined; + headers?: OutgoingHttpHeaders | undefined; + auth?: string | null | undefined; + agent?: Agent | boolean | undefined; + _defaultAgent?: Agent | undefined; + timeout?: number | undefined; + setHost?: boolean | undefined; + // https://github.com/nodejs/node/blob/master/lib/_http_client.js#L278 + createConnection?: ((options: ClientRequestArgs, oncreate: (err: Error, socket: Socket) => void) => Socket) | undefined; + lookup?: LookupFunction | undefined; + } + interface ServerOptions { + IncomingMessage?: typeof IncomingMessage | undefined; + ServerResponse?: typeof ServerResponse | undefined; + /** + * Optionally overrides the value of + * `--max-http-header-size` for requests received by this server, i.e. + * the maximum length of request headers in bytes. + * @default 8192 + */ + maxHeaderSize?: number | undefined; + /** + * Use an insecure HTTP parser that accepts invalid HTTP headers when true. + * Using the insecure parser should be avoided. + * See --insecure-http-parser for more information. + * @default false + */ + insecureHTTPParser?: boolean | undefined; + } + type RequestListener = (req: IncomingMessage, res: ServerResponse) => void; + /** + * @since v0.1.17 + */ + class Server extends NetServer { + constructor(requestListener?: RequestListener); + constructor(options: ServerOptions, requestListener?: RequestListener); + /** + * Sets the timeout value for sockets, and emits a `'timeout'` event on + * the Server object, passing the socket as an argument, if a timeout + * occurs. + * + * If there is a `'timeout'` event listener on the Server object, then it + * will be called with the timed-out socket as an argument. + * + * By default, the Server does not timeout sockets. However, if a callback + * is assigned to the Server's `'timeout'` event, timeouts must be handled + * explicitly. + * @since v0.9.12 + * @param [msecs=0 (no timeout)] + */ + setTimeout(msecs?: number, callback?: () => void): this; + setTimeout(callback: () => void): this; + /** + * Limits maximum incoming headers count. If set to 0, no limit will be applied. + * @since v0.7.0 + */ + maxHeadersCount: number | null; + /** + * The maximum number of requests socket can handle + * before closing keep alive connection. + * + * A value of `0` will disable the limit. + * + * When the limit is reached it will set the `Connection` header value to `close`, + * but will not actually close the connection, subsequent requests sent + * after the limit is reached will get `503 Service Unavailable` as a response. + * @since v16.10.0 + */ + maxRequestsPerSocket: number | null; + /** + * The number of milliseconds of inactivity before a socket is presumed + * to have timed out. + * + * A value of `0` will disable the timeout behavior on incoming connections. + * + * The socket timeout logic is set up on connection, so changing this + * value only affects new connections to the server, not any existing connections. + * @since v0.9.12 + */ + timeout: number; + /** + * Limit the amount of time the parser will wait to receive the complete HTTP + * headers. + * + * In case of inactivity, the rules defined in `server.timeout` apply. However, + * that inactivity based timeout would still allow the connection to be kept open + * if the headers are being sent very slowly (by default, up to a byte per 2 + * minutes). In order to prevent this, whenever header data arrives an additional + * check is made that more than `server.headersTimeout` milliseconds has not + * passed since the connection was established. If the check fails, a `'timeout'`event is emitted on the server object, and (by default) the socket is destroyed. + * See `server.timeout` for more information on how timeout behavior can be + * customized. + * @since v11.3.0, v10.14.0 + */ + headersTimeout: number; + /** + * The number of milliseconds of inactivity a server needs to wait for additional + * incoming data, after it has finished writing the last response, before a socket + * will be destroyed. If the server receives new data before the keep-alive + * timeout has fired, it will reset the regular inactivity timeout, i.e.,`server.timeout`. + * + * A value of `0` will disable the keep-alive timeout behavior on incoming + * connections. + * A value of `0` makes the http server behave similarly to Node.js versions prior + * to 8.0.0, which did not have a keep-alive timeout. + * + * The socket timeout logic is set up on connection, so changing this value only + * affects new connections to the server, not any existing connections. + * @since v8.0.0 + */ + keepAliveTimeout: number; + /** + * Sets the timeout value in milliseconds for receiving the entire request from + * the client. + * + * If the timeout expires, the server responds with status 408 without + * forwarding the request to the request listener and then closes the connection. + * + * It must be set to a non-zero value (e.g. 120 seconds) to protect against + * potential Denial-of-Service attacks in case the server is deployed without a + * reverse proxy in front. + * @since v14.11.0 + */ + requestTimeout: number; + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'close', listener: () => void): this; + addListener(event: 'connection', listener: (socket: Socket) => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'listening', listener: () => void): this; + addListener(event: 'checkContinue', listener: RequestListener): this; + addListener(event: 'checkExpectation', listener: RequestListener): this; + addListener(event: 'clientError', listener: (err: Error, socket: stream.Duplex) => void): this; + addListener(event: 'connect', listener: (req: IncomingMessage, socket: stream.Duplex, head: Buffer) => void): this; + addListener(event: 'request', listener: RequestListener): this; + addListener(event: 'upgrade', listener: (req: IncomingMessage, socket: stream.Duplex, head: Buffer) => void): this; + emit(event: string, ...args: any[]): boolean; + emit(event: 'close'): boolean; + emit(event: 'connection', socket: Socket): boolean; + emit(event: 'error', err: Error): boolean; + emit(event: 'listening'): boolean; + emit(event: 'checkContinue', req: IncomingMessage, res: ServerResponse): boolean; + emit(event: 'checkExpectation', req: IncomingMessage, res: ServerResponse): boolean; + emit(event: 'clientError', err: Error, socket: stream.Duplex): boolean; + emit(event: 'connect', req: IncomingMessage, socket: stream.Duplex, head: Buffer): boolean; + emit(event: 'request', req: IncomingMessage, res: ServerResponse): boolean; + emit(event: 'upgrade', req: IncomingMessage, socket: stream.Duplex, head: Buffer): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'close', listener: () => void): this; + on(event: 'connection', listener: (socket: Socket) => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'listening', listener: () => void): this; + on(event: 'checkContinue', listener: RequestListener): this; + on(event: 'checkExpectation', listener: RequestListener): this; + on(event: 'clientError', listener: (err: Error, socket: stream.Duplex) => void): this; + on(event: 'connect', listener: (req: IncomingMessage, socket: stream.Duplex, head: Buffer) => void): this; + on(event: 'request', listener: RequestListener): this; + on(event: 'upgrade', listener: (req: IncomingMessage, socket: stream.Duplex, head: Buffer) => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'connection', listener: (socket: Socket) => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'listening', listener: () => void): this; + once(event: 'checkContinue', listener: RequestListener): this; + once(event: 'checkExpectation', listener: RequestListener): this; + once(event: 'clientError', listener: (err: Error, socket: stream.Duplex) => void): this; + once(event: 'connect', listener: (req: IncomingMessage, socket: stream.Duplex, head: Buffer) => void): this; + once(event: 'request', listener: RequestListener): this; + once(event: 'upgrade', listener: (req: IncomingMessage, socket: stream.Duplex, head: Buffer) => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'connection', listener: (socket: Socket) => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'listening', listener: () => void): this; + prependListener(event: 'checkContinue', listener: RequestListener): this; + prependListener(event: 'checkExpectation', listener: RequestListener): this; + prependListener(event: 'clientError', listener: (err: Error, socket: stream.Duplex) => void): this; + prependListener(event: 'connect', listener: (req: IncomingMessage, socket: stream.Duplex, head: Buffer) => void): this; + prependListener(event: 'request', listener: RequestListener): this; + prependListener(event: 'upgrade', listener: (req: IncomingMessage, socket: stream.Duplex, head: Buffer) => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'connection', listener: (socket: Socket) => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'listening', listener: () => void): this; + prependOnceListener(event: 'checkContinue', listener: RequestListener): this; + prependOnceListener(event: 'checkExpectation', listener: RequestListener): this; + prependOnceListener(event: 'clientError', listener: (err: Error, socket: stream.Duplex) => void): this; + prependOnceListener(event: 'connect', listener: (req: IncomingMessage, socket: stream.Duplex, head: Buffer) => void): this; + prependOnceListener(event: 'request', listener: RequestListener): this; + prependOnceListener(event: 'upgrade', listener: (req: IncomingMessage, socket: stream.Duplex, head: Buffer) => void): this; + } + /** + * This class serves as the parent class of {@link ClientRequest} and {@link ServerResponse}. It is an abstract of outgoing message from + * the perspective of the participants of HTTP transaction. + * @since v0.1.17 + */ + class OutgoingMessage extends stream.Writable { + readonly req: IncomingMessage; + chunkedEncoding: boolean; + shouldKeepAlive: boolean; + useChunkedEncodingByDefault: boolean; + sendDate: boolean; + /** + * @deprecated Use `writableEnded` instead. + */ + finished: boolean; + /** + * Read-only. `true` if the headers were sent, otherwise `false`. + * @since v0.9.3 + */ + readonly headersSent: boolean; + /** + * Aliases of `outgoingMessage.socket` + * @since v0.3.0 + * @deprecated Since v15.12.0 - Use `socket` instead. + */ + readonly connection: Socket | null; + /** + * Reference to the underlying socket. Usually, users will not want to access + * this property. + * + * After calling `outgoingMessage.end()`, this property will be nulled. + * @since v0.3.0 + */ + readonly socket: Socket | null; + constructor(); + /** + * Once a socket is associated with the message and is connected,`socket.setTimeout()` will be called with `msecs` as the first parameter. + * @since v0.9.12 + * @param callback Optional function to be called when a timeout occurs. Same as binding to the `timeout` event. + */ + setTimeout(msecs: number, callback?: () => void): this; + /** + * Sets a single header value for the header object. + * @since v0.4.0 + * @param name Header name + * @param value Header value + */ + setHeader(name: string, value: number | string | ReadonlyArray): this; + /** + * Gets the value of HTTP header with the given name. If such a name doesn't + * exist in message, it will be `undefined`. + * @since v0.4.0 + * @param name Name of header + */ + getHeader(name: string): number | string | string[] | undefined; + /** + * Returns a shallow copy of the current outgoing headers. Since a shallow + * copy is used, array values may be mutated without additional calls to + * various header-related HTTP module methods. The keys of the returned + * object are the header names and the values are the respective header + * values. All header names are lowercase. + * + * The object returned by the `outgoingMessage.getHeaders()` method does + * not prototypically inherit from the JavaScript Object. This means that + * typical Object methods such as `obj.toString()`, `obj.hasOwnProperty()`, + * and others are not defined and will not work. + * + * ```js + * outgoingMessage.setHeader('Foo', 'bar'); + * outgoingMessage.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']); + * + * const headers = outgoingMessage.getHeaders(); + * // headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] } + * ``` + * @since v8.0.0 + */ + getHeaders(): OutgoingHttpHeaders; + /** + * Returns an array of names of headers of the outgoing outgoingMessage. All + * names are lowercase. + * @since v8.0.0 + */ + getHeaderNames(): string[]; + /** + * Returns `true` if the header identified by `name` is currently set in the + * outgoing headers. The header name is case-insensitive. + * + * ```js + * const hasContentType = outgoingMessage.hasHeader('content-type'); + * ``` + * @since v8.0.0 + */ + hasHeader(name: string): boolean; + /** + * Removes a header that is queued for implicit sending. + * + * ```js + * outgoingMessage.removeHeader('Content-Encoding'); + * ``` + * @since v0.4.0 + */ + removeHeader(name: string): void; + /** + * Adds HTTP trailers (headers but at the end of the message) to the message. + * + * Trailers are **only** be emitted if the message is chunked encoded. If not, + * the trailer will be silently discarded. + * + * HTTP requires the `Trailer` header to be sent to emit trailers, + * with a list of header fields in its value, e.g. + * + * ```js + * message.writeHead(200, { 'Content-Type': 'text/plain', + * 'Trailer': 'Content-MD5' }); + * message.write(fileData); + * message.addTrailers({ 'Content-MD5': '7895bf4b8828b55ceaf47747b4bca667' }); + * message.end(); + * ``` + * + * Attempting to set a header field name or value that contains invalid characters + * will result in a `TypeError` being thrown. + * @since v0.3.0 + */ + addTrailers(headers: OutgoingHttpHeaders | ReadonlyArray<[string, string]>): void; + /** + * Compulsorily flushes the message headers + * + * For efficiency reason, Node.js normally buffers the message headers + * until `outgoingMessage.end()` is called or the first chunk of message data + * is written. It then tries to pack the headers and data into a single TCP + * packet. + * + * It is usually desired (it saves a TCP round-trip), but not when the first + * data is not sent until possibly much later. `outgoingMessage.flushHeaders()`bypasses the optimization and kickstarts the request. + * @since v1.6.0 + */ + flushHeaders(): void; + } + /** + * This object is created internally by an HTTP server, not by the user. It is + * passed as the second parameter to the `'request'` event. + * @since v0.1.17 + */ + class ServerResponse extends OutgoingMessage { + /** + * When using implicit headers (not calling `response.writeHead()` explicitly), + * this property controls the status code that will be sent to the client when + * the headers get flushed. + * + * ```js + * response.statusCode = 404; + * ``` + * + * After response header was sent to the client, this property indicates the + * status code which was sent out. + * @since v0.4.0 + */ + statusCode: number; + /** + * When using implicit headers (not calling `response.writeHead()` explicitly), + * this property controls the status message that will be sent to the client when + * the headers get flushed. If this is left as `undefined` then the standard + * message for the status code will be used. + * + * ```js + * response.statusMessage = 'Not found'; + * ``` + * + * After response header was sent to the client, this property indicates the + * status message which was sent out. + * @since v0.11.8 + */ + statusMessage: string; + constructor(req: IncomingMessage); + assignSocket(socket: Socket): void; + detachSocket(socket: Socket): void; + /** + * Sends a HTTP/1.1 100 Continue message to the client, indicating that + * the request body should be sent. See the `'checkContinue'` event on`Server`. + * @since v0.3.0 + */ + writeContinue(callback?: () => void): void; + /** + * Sends a response header to the request. The status code is a 3-digit HTTP + * status code, like `404`. The last argument, `headers`, are the response headers. + * Optionally one can give a human-readable `statusMessage` as the second + * argument. + * + * `headers` may be an `Array` where the keys and values are in the same list. + * It is _not_ a list of tuples. So, the even-numbered offsets are key values, + * and the odd-numbered offsets are the associated values. The array is in the same + * format as `request.rawHeaders`. + * + * Returns a reference to the `ServerResponse`, so that calls can be chained. + * + * ```js + * const body = 'hello world'; + * response + * .writeHead(200, { + * 'Content-Length': Buffer.byteLength(body), + * 'Content-Type': 'text/plain' + * }) + * .end(body); + * ``` + * + * This method must only be called once on a message and it must + * be called before `response.end()` is called. + * + * If `response.write()` or `response.end()` are called before calling + * this, the implicit/mutable headers will be calculated and call this function. + * + * When headers have been set with `response.setHeader()`, they will be merged + * with any headers passed to `response.writeHead()`, with the headers passed + * to `response.writeHead()` given precedence. + * + * If this method is called and `response.setHeader()` has not been called, + * it will directly write the supplied header values onto the network channel + * without caching internally, and the `response.getHeader()` on the header + * will not yield the expected result. If progressive population of headers is + * desired with potential future retrieval and modification, use `response.setHeader()` instead. + * + * ```js + * // Returns content-type = text/plain + * const server = http.createServer((req, res) => { + * res.setHeader('Content-Type', 'text/html'); + * res.setHeader('X-Foo', 'bar'); + * res.writeHead(200, { 'Content-Type': 'text/plain' }); + * res.end('ok'); + * }); + * ``` + * + * `Content-Length` is given in bytes, not characters. Use `Buffer.byteLength()` to determine the length of the body in bytes. Node.js + * does not check whether `Content-Length` and the length of the body which has + * been transmitted are equal or not. + * + * Attempting to set a header field name or value that contains invalid characters + * will result in a `TypeError` being thrown. + * @since v0.1.30 + */ + writeHead(statusCode: number, statusMessage?: string, headers?: OutgoingHttpHeaders | OutgoingHttpHeader[]): this; + writeHead(statusCode: number, headers?: OutgoingHttpHeaders | OutgoingHttpHeader[]): this; + /** + * Sends a HTTP/1.1 102 Processing message to the client, indicating that + * the request body should be sent. + * @since v10.0.0 + */ + writeProcessing(): void; + } + interface InformationEvent { + statusCode: number; + statusMessage: string; + httpVersion: string; + httpVersionMajor: number; + httpVersionMinor: number; + headers: IncomingHttpHeaders; + rawHeaders: string[]; + } + /** + * This object is created internally and returned from {@link request}. It + * represents an _in-progress_ request whose header has already been queued. The + * header is still mutable using the `setHeader(name, value)`,`getHeader(name)`, `removeHeader(name)` API. The actual header will + * be sent along with the first data chunk or when calling `request.end()`. + * + * To get the response, add a listener for `'response'` to the request object.`'response'` will be emitted from the request object when the response + * headers have been received. The `'response'` event is executed with one + * argument which is an instance of {@link IncomingMessage}. + * + * During the `'response'` event, one can add listeners to the + * response object; particularly to listen for the `'data'` event. + * + * If no `'response'` handler is added, then the response will be + * entirely discarded. However, if a `'response'` event handler is added, + * then the data from the response object **must** be consumed, either by + * calling `response.read()` whenever there is a `'readable'` event, or + * by adding a `'data'` handler, or by calling the `.resume()` method. + * Until the data is consumed, the `'end'` event will not fire. Also, until + * the data is read it will consume memory that can eventually lead to a + * 'process out of memory' error. + * + * For backward compatibility, `res` will only emit `'error'` if there is an`'error'` listener registered. + * + * Node.js does not check whether Content-Length and the length of the + * body which has been transmitted are equal or not. + * @since v0.1.17 + */ + class ClientRequest extends OutgoingMessage { + /** + * The `request.aborted` property will be `true` if the request has + * been aborted. + * @since v0.11.14 + */ + aborted: boolean; + /** + * The request host. + * @since v14.5.0, v12.19.0 + */ + host: string; + /** + * The request protocol. + * @since v14.5.0, v12.19.0 + */ + protocol: string; + constructor(url: string | URL | ClientRequestArgs, cb?: (res: IncomingMessage) => void); + /** + * The request method. + * @since v0.1.97 + */ + method: string; + /** + * The request path. + * @since v0.4.0 + */ + path: string; + /** + * Marks the request as aborting. Calling this will cause remaining data + * in the response to be dropped and the socket to be destroyed. + * @since v0.3.8 + * @deprecated Since v14.1.0,v13.14.0 - Use `destroy` instead. + */ + abort(): void; + onSocket(socket: Socket): void; + /** + * Once a socket is assigned to this request and is connected `socket.setTimeout()` will be called. + * @since v0.5.9 + * @param timeout Milliseconds before a request times out. + * @param callback Optional function to be called when a timeout occurs. Same as binding to the `'timeout'` event. + */ + setTimeout(timeout: number, callback?: () => void): this; + /** + * Once a socket is assigned to this request and is connected `socket.setNoDelay()` will be called. + * @since v0.5.9 + */ + setNoDelay(noDelay?: boolean): void; + /** + * Once a socket is assigned to this request and is connected `socket.setKeepAlive()` will be called. + * @since v0.5.9 + */ + setSocketKeepAlive(enable?: boolean, initialDelay?: number): void; + /** + * Returns an array containing the unique names of the current outgoing raw + * headers. Header names are returned with their exact casing being set. + * + * ```js + * request.setHeader('Foo', 'bar'); + * request.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']); + * + * const headerNames = request.getRawHeaderNames(); + * // headerNames === ['Foo', 'Set-Cookie'] + * ``` + * @since v15.13.0 + */ + getRawHeaderNames(): string[]; + addListener(event: 'abort', listener: () => void): this; + addListener(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; + addListener(event: 'continue', listener: () => void): this; + addListener(event: 'information', listener: (info: InformationEvent) => void): this; + addListener(event: 'response', listener: (response: IncomingMessage) => void): this; + addListener(event: 'socket', listener: (socket: Socket) => void): this; + addListener(event: 'timeout', listener: () => void): this; + addListener(event: 'upgrade', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; + addListener(event: 'close', listener: () => void): this; + addListener(event: 'drain', listener: () => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'finish', listener: () => void): this; + addListener(event: 'pipe', listener: (src: stream.Readable) => void): this; + addListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + on(event: 'abort', listener: () => void): this; + on(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; + on(event: 'continue', listener: () => void): this; + on(event: 'information', listener: (info: InformationEvent) => void): this; + on(event: 'response', listener: (response: IncomingMessage) => void): this; + on(event: 'socket', listener: (socket: Socket) => void): this; + on(event: 'timeout', listener: () => void): this; + on(event: 'upgrade', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; + on(event: 'close', listener: () => void): this; + on(event: 'drain', listener: () => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'finish', listener: () => void): this; + on(event: 'pipe', listener: (src: stream.Readable) => void): this; + on(event: 'unpipe', listener: (src: stream.Readable) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'abort', listener: () => void): this; + once(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; + once(event: 'continue', listener: () => void): this; + once(event: 'information', listener: (info: InformationEvent) => void): this; + once(event: 'response', listener: (response: IncomingMessage) => void): this; + once(event: 'socket', listener: (socket: Socket) => void): this; + once(event: 'timeout', listener: () => void): this; + once(event: 'upgrade', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'drain', listener: () => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'finish', listener: () => void): this; + once(event: 'pipe', listener: (src: stream.Readable) => void): this; + once(event: 'unpipe', listener: (src: stream.Readable) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'abort', listener: () => void): this; + prependListener(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; + prependListener(event: 'continue', listener: () => void): this; + prependListener(event: 'information', listener: (info: InformationEvent) => void): this; + prependListener(event: 'response', listener: (response: IncomingMessage) => void): this; + prependListener(event: 'socket', listener: (socket: Socket) => void): this; + prependListener(event: 'timeout', listener: () => void): this; + prependListener(event: 'upgrade', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'drain', listener: () => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'finish', listener: () => void): this; + prependListener(event: 'pipe', listener: (src: stream.Readable) => void): this; + prependListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'abort', listener: () => void): this; + prependOnceListener(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; + prependOnceListener(event: 'continue', listener: () => void): this; + prependOnceListener(event: 'information', listener: (info: InformationEvent) => void): this; + prependOnceListener(event: 'response', listener: (response: IncomingMessage) => void): this; + prependOnceListener(event: 'socket', listener: (socket: Socket) => void): this; + prependOnceListener(event: 'timeout', listener: () => void): this; + prependOnceListener(event: 'upgrade', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'drain', listener: () => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'finish', listener: () => void): this; + prependOnceListener(event: 'pipe', listener: (src: stream.Readable) => void): this; + prependOnceListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + /** + * An `IncomingMessage` object is created by {@link Server} or {@link ClientRequest} and passed as the first argument to the `'request'` and `'response'` event respectively. It may be used to + * access response + * status, headers and data. + * + * Different from its `socket` value which is a subclass of `stream.Duplex`, the`IncomingMessage` itself extends `stream.Readable` and is created separately to + * parse and emit the incoming HTTP headers and payload, as the underlying socket + * may be reused multiple times in case of keep-alive. + * @since v0.1.17 + */ + class IncomingMessage extends stream.Readable { + constructor(socket: Socket); + /** + * The `message.aborted` property will be `true` if the request has + * been aborted. + * @since v10.1.0 + */ + aborted: boolean; + /** + * In case of server request, the HTTP version sent by the client. In the case of + * client response, the HTTP version of the connected-to server. + * Probably either `'1.1'` or `'1.0'`. + * + * Also `message.httpVersionMajor` is the first integer and`message.httpVersionMinor` is the second. + * @since v0.1.1 + */ + httpVersion: string; + httpVersionMajor: number; + httpVersionMinor: number; + /** + * The `message.complete` property will be `true` if a complete HTTP message has + * been received and successfully parsed. + * + * This property is particularly useful as a means of determining if a client or + * server fully transmitted a message before a connection was terminated: + * + * ```js + * const req = http.request({ + * host: '127.0.0.1', + * port: 8080, + * method: 'POST' + * }, (res) => { + * res.resume(); + * res.on('end', () => { + * if (!res.complete) + * console.error( + * 'The connection was terminated while the message was still being sent'); + * }); + * }); + * ``` + * @since v0.3.0 + */ + complete: boolean; + /** + * Alias for `message.socket`. + * @since v0.1.90 + * @deprecated Since v16.0.0 - Use `socket`. + */ + connection: Socket; + /** + * The `net.Socket` object associated with the connection. + * + * With HTTPS support, use `request.socket.getPeerCertificate()` to obtain the + * client's authentication details. + * + * This property is guaranteed to be an instance of the `net.Socket` class, + * a subclass of `stream.Duplex`, unless the user specified a socket + * type other than `net.Socket`. + * @since v0.3.0 + */ + socket: Socket; + /** + * The request/response headers object. + * + * Key-value pairs of header names and values. Header names are lower-cased. + * + * ```js + * // Prints something like: + * // + * // { 'user-agent': 'curl/7.22.0', + * // host: '127.0.0.1:8000', + * // accept: '*' } + * console.log(request.headers); + * ``` + * + * Duplicates in raw headers are handled in the following ways, depending on the + * header name: + * + * * Duplicates of `age`, `authorization`, `content-length`, `content-type`,`etag`, `expires`, `from`, `host`, `if-modified-since`, `if-unmodified-since`,`last-modified`, `location`, + * `max-forwards`, `proxy-authorization`, `referer`,`retry-after`, `server`, or `user-agent` are discarded. + * * `set-cookie` is always an array. Duplicates are added to the array. + * * For duplicate `cookie` headers, the values are joined together with '; '. + * * For all other headers, the values are joined together with ', '. + * @since v0.1.5 + */ + headers: IncomingHttpHeaders; + /** + * The raw request/response headers list exactly as they were received. + * + * The keys and values are in the same list. It is _not_ a + * list of tuples. So, the even-numbered offsets are key values, and the + * odd-numbered offsets are the associated values. + * + * Header names are not lowercased, and duplicates are not merged. + * + * ```js + * // Prints something like: + * // + * // [ 'user-agent', + * // 'this is invalid because there can be only one', + * // 'User-Agent', + * // 'curl/7.22.0', + * // 'Host', + * // '127.0.0.1:8000', + * // 'ACCEPT', + * // '*' ] + * console.log(request.rawHeaders); + * ``` + * @since v0.11.6 + */ + rawHeaders: string[]; + /** + * The request/response trailers object. Only populated at the `'end'` event. + * @since v0.3.0 + */ + trailers: NodeJS.Dict; + /** + * The raw request/response trailer keys and values exactly as they were + * received. Only populated at the `'end'` event. + * @since v0.11.6 + */ + rawTrailers: string[]; + /** + * Calls `message.socket.setTimeout(msecs, callback)`. + * @since v0.5.9 + */ + setTimeout(msecs: number, callback?: () => void): this; + /** + * **Only valid for request obtained from {@link Server}.** + * + * The request method as a string. Read only. Examples: `'GET'`, `'DELETE'`. + * @since v0.1.1 + */ + method?: string | undefined; + /** + * **Only valid for request obtained from {@link Server}.** + * + * Request URL string. This contains only the URL that is present in the actual + * HTTP request. Take the following request: + * + * ```http + * GET /status?name=ryan HTTP/1.1 + * Accept: text/plain + * ``` + * + * To parse the URL into its parts: + * + * ```js + * new URL(request.url, `http://${request.headers.host}`); + * ``` + * + * When `request.url` is `'/status?name=ryan'` and`request.headers.host` is `'localhost:3000'`: + * + * ```console + * $ node + * > new URL(request.url, `http://${request.headers.host}`) + * URL { + * href: 'http://localhost:3000/status?name=ryan', + * origin: 'http://localhost:3000', + * protocol: 'http:', + * username: '', + * password: '', + * host: 'localhost:3000', + * hostname: 'localhost', + * port: '3000', + * pathname: '/status', + * search: '?name=ryan', + * searchParams: URLSearchParams { 'name' => 'ryan' }, + * hash: '' + * } + * ``` + * @since v0.1.90 + */ + url?: string | undefined; + /** + * **Only valid for response obtained from {@link ClientRequest}.** + * + * The 3-digit HTTP response status code. E.G. `404`. + * @since v0.1.1 + */ + statusCode?: number | undefined; + /** + * **Only valid for response obtained from {@link ClientRequest}.** + * + * The HTTP response status message (reason phrase). E.G. `OK` or `Internal Server Error`. + * @since v0.11.10 + */ + statusMessage?: string | undefined; + /** + * Calls `destroy()` on the socket that received the `IncomingMessage`. If `error`is provided, an `'error'` event is emitted on the socket and `error` is passed + * as an argument to any listeners on the event. + * @since v0.3.0 + */ + destroy(error?: Error): void; + } + interface AgentOptions extends Partial { + /** + * Keep sockets around in a pool to be used by other requests in the future. Default = false + */ + keepAlive?: boolean | undefined; + /** + * When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. + * Only relevant if keepAlive is set to true. + */ + keepAliveMsecs?: number | undefined; + /** + * Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity + */ + maxSockets?: number | undefined; + /** + * Maximum number of sockets allowed for all hosts in total. Each request will use a new socket until the maximum is reached. Default: Infinity. + */ + maxTotalSockets?: number | undefined; + /** + * Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256. + */ + maxFreeSockets?: number | undefined; + /** + * Socket timeout in milliseconds. This will set the timeout after the socket is connected. + */ + timeout?: number | undefined; + /** + * Scheduling strategy to apply when picking the next free socket to use. + * @default `lifo` + */ + scheduling?: 'fifo' | 'lifo' | undefined; + } + /** + * An `Agent` is responsible for managing connection persistence + * and reuse for HTTP clients. It maintains a queue of pending requests + * for a given host and port, reusing a single socket connection for each + * until the queue is empty, at which time the socket is either destroyed + * or put into a pool where it is kept to be used again for requests to the + * same host and port. Whether it is destroyed or pooled depends on the`keepAlive` `option`. + * + * Pooled connections have TCP Keep-Alive enabled for them, but servers may + * still close idle connections, in which case they will be removed from the + * pool and a new connection will be made when a new HTTP request is made for + * that host and port. Servers may also refuse to allow multiple requests + * over the same connection, in which case the connection will have to be + * remade for every request and cannot be pooled. The `Agent` will still make + * the requests to that server, but each one will occur over a new connection. + * + * When a connection is closed by the client or the server, it is removed + * from the pool. Any unused sockets in the pool will be unrefed so as not + * to keep the Node.js process running when there are no outstanding requests. + * (see `socket.unref()`). + * + * It is good practice, to `destroy()` an `Agent` instance when it is no + * longer in use, because unused sockets consume OS resources. + * + * Sockets are removed from an agent when the socket emits either + * a `'close'` event or an `'agentRemove'` event. When intending to keep one + * HTTP request open for a long time without keeping it in the agent, something + * like the following may be done: + * + * ```js + * http.get(options, (res) => { + * // Do stuff + * }).on('socket', (socket) => { + * socket.emit('agentRemove'); + * }); + * ``` + * + * An agent may also be used for an individual request. By providing`{agent: false}` as an option to the `http.get()` or `http.request()`functions, a one-time use `Agent` with default options + * will be used + * for the client connection. + * + * `agent:false`: + * + * ```js + * http.get({ + * hostname: 'localhost', + * port: 80, + * path: '/', + * agent: false // Create a new agent just for this one request + * }, (res) => { + * // Do stuff with response + * }); + * ``` + * @since v0.3.4 + */ + class Agent { + /** + * By default set to 256\. For agents with `keepAlive` enabled, this + * sets the maximum number of sockets that will be left open in the free + * state. + * @since v0.11.7 + */ + maxFreeSockets: number; + /** + * By default set to `Infinity`. Determines how many concurrent sockets the agent + * can have open per origin. Origin is the returned value of `agent.getName()`. + * @since v0.3.6 + */ + maxSockets: number; + /** + * By default set to `Infinity`. Determines how many concurrent sockets the agent + * can have open. Unlike `maxSockets`, this parameter applies across all origins. + * @since v14.5.0, v12.19.0 + */ + maxTotalSockets: number; + /** + * An object which contains arrays of sockets currently awaiting use by + * the agent when `keepAlive` is enabled. Do not modify. + * + * Sockets in the `freeSockets` list will be automatically destroyed and + * removed from the array on `'timeout'`. + * @since v0.11.4 + */ + readonly freeSockets: NodeJS.ReadOnlyDict; + /** + * An object which contains arrays of sockets currently in use by the + * agent. Do not modify. + * @since v0.3.6 + */ + readonly sockets: NodeJS.ReadOnlyDict; + /** + * An object which contains queues of requests that have not yet been assigned to + * sockets. Do not modify. + * @since v0.5.9 + */ + readonly requests: NodeJS.ReadOnlyDict; + constructor(opts?: AgentOptions); + /** + * Destroy any sockets that are currently in use by the agent. + * + * It is usually not necessary to do this. However, if using an + * agent with `keepAlive` enabled, then it is best to explicitly shut down + * the agent when it is no longer needed. Otherwise, + * sockets might stay open for quite a long time before the server + * terminates them. + * @since v0.11.4 + */ + destroy(): void; + } + const METHODS: string[]; + const STATUS_CODES: { + [errorCode: number]: string | undefined; + [errorCode: string]: string | undefined; + }; + /** + * Returns a new instance of {@link Server}. + * + * The `requestListener` is a function which is automatically + * added to the `'request'` event. + * @since v0.1.13 + */ + function createServer(requestListener?: RequestListener): Server; + function createServer(options: ServerOptions, requestListener?: RequestListener): Server; + // although RequestOptions are passed as ClientRequestArgs to ClientRequest directly, + // create interface RequestOptions would make the naming more clear to developers + interface RequestOptions extends ClientRequestArgs {} + /** + * Node.js maintains several connections per server to make HTTP requests. + * This function allows one to transparently issue requests. + * + * `url` can be a string or a `URL` object. If `url` is a + * string, it is automatically parsed with `new URL()`. If it is a `URL` object, it will be automatically converted to an ordinary `options` object. + * + * If both `url` and `options` are specified, the objects are merged, with the`options` properties taking precedence. + * + * The optional `callback` parameter will be added as a one-time listener for + * the `'response'` event. + * + * `http.request()` returns an instance of the {@link ClientRequest} class. The `ClientRequest` instance is a writable stream. If one needs to + * upload a file with a POST request, then write to the `ClientRequest` object. + * + * ```js + * const http = require('http'); + * + * const postData = JSON.stringify({ + * 'msg': 'Hello World!' + * }); + * + * const options = { + * hostname: 'www.google.com', + * port: 80, + * path: '/upload', + * method: 'POST', + * headers: { + * 'Content-Type': 'application/json', + * 'Content-Length': Buffer.byteLength(postData) + * } + * }; + * + * const req = http.request(options, (res) => { + * console.log(`STATUS: ${res.statusCode}`); + * console.log(`HEADERS: ${JSON.stringify(res.headers)}`); + * res.setEncoding('utf8'); + * res.on('data', (chunk) => { + * console.log(`BODY: ${chunk}`); + * }); + * res.on('end', () => { + * console.log('No more data in response.'); + * }); + * }); + * + * req.on('error', (e) => { + * console.error(`problem with request: ${e.message}`); + * }); + * + * // Write data to request body + * req.write(postData); + * req.end(); + * ``` + * + * In the example `req.end()` was called. With `http.request()` one + * must always call `req.end()` to signify the end of the request - + * even if there is no data being written to the request body. + * + * If any error is encountered during the request (be that with DNS resolution, + * TCP level errors, or actual HTTP parse errors) an `'error'` event is emitted + * on the returned request object. As with all `'error'` events, if no listeners + * are registered the error will be thrown. + * + * There are a few special headers that should be noted. + * + * * Sending a 'Connection: keep-alive' will notify Node.js that the connection to + * the server should be persisted until the next request. + * * Sending a 'Content-Length' header will disable the default chunked encoding. + * * Sending an 'Expect' header will immediately send the request headers. + * Usually, when sending 'Expect: 100-continue', both a timeout and a listener + * for the `'continue'` event should be set. See RFC 2616 Section 8.2.3 for more + * information. + * * Sending an Authorization header will override using the `auth` option + * to compute basic authentication. + * + * Example using a `URL` as `options`: + * + * ```js + * const options = new URL('http://abc:xyz@example.com'); + * + * const req = http.request(options, (res) => { + * // ... + * }); + * ``` + * + * In a successful request, the following events will be emitted in the following + * order: + * + * * `'socket'` + * * `'response'` + * * `'data'` any number of times, on the `res` object + * (`'data'` will not be emitted at all if the response body is empty, for + * instance, in most redirects) + * * `'end'` on the `res` object + * * `'close'` + * + * In the case of a connection error, the following events will be emitted: + * + * * `'socket'` + * * `'error'` + * * `'close'` + * + * In the case of a premature connection close before the response is received, + * the following events will be emitted in the following order: + * + * * `'socket'` + * * `'error'` with an error with message `'Error: socket hang up'` and code`'ECONNRESET'` + * * `'close'` + * + * In the case of a premature connection close after the response is received, + * the following events will be emitted in the following order: + * + * * `'socket'` + * * `'response'` + * * `'data'` any number of times, on the `res` object + * * (connection closed here) + * * `'aborted'` on the `res` object + * * `'error'` on the `res` object with an error with message`'Error: aborted'` and code `'ECONNRESET'`. + * * `'close'` + * * `'close'` on the `res` object + * + * If `req.destroy()` is called before a socket is assigned, the following + * events will be emitted in the following order: + * + * * (`req.destroy()` called here) + * * `'error'` with an error with message `'Error: socket hang up'` and code`'ECONNRESET'` + * * `'close'` + * + * If `req.destroy()` is called before the connection succeeds, the following + * events will be emitted in the following order: + * + * * `'socket'` + * * (`req.destroy()` called here) + * * `'error'` with an error with message `'Error: socket hang up'` and code`'ECONNRESET'` + * * `'close'` + * + * If `req.destroy()` is called after the response is received, the following + * events will be emitted in the following order: + * + * * `'socket'` + * * `'response'` + * * `'data'` any number of times, on the `res` object + * * (`req.destroy()` called here) + * * `'aborted'` on the `res` object + * * `'error'` on the `res` object with an error with message`'Error: aborted'` and code `'ECONNRESET'`. + * * `'close'` + * * `'close'` on the `res` object + * + * If `req.abort()` is called before a socket is assigned, the following + * events will be emitted in the following order: + * + * * (`req.abort()` called here) + * * `'abort'` + * * `'close'` + * + * If `req.abort()` is called before the connection succeeds, the following + * events will be emitted in the following order: + * + * * `'socket'` + * * (`req.abort()` called here) + * * `'abort'` + * * `'error'` with an error with message `'Error: socket hang up'` and code`'ECONNRESET'` + * * `'close'` + * + * If `req.abort()` is called after the response is received, the following + * events will be emitted in the following order: + * + * * `'socket'` + * * `'response'` + * * `'data'` any number of times, on the `res` object + * * (`req.abort()` called here) + * * `'abort'` + * * `'aborted'` on the `res` object + * * `'error'` on the `res` object with an error with message`'Error: aborted'` and code `'ECONNRESET'`. + * * `'close'` + * * `'close'` on the `res` object + * + * Setting the `timeout` option or using the `setTimeout()` function will + * not abort the request or do anything besides add a `'timeout'` event. + * + * Passing an `AbortSignal` and then calling `abort` on the corresponding`AbortController` will behave the same way as calling `.destroy()` on the + * request itself. + * @since v0.3.6 + */ + function request(options: RequestOptions | string | URL, callback?: (res: IncomingMessage) => void): ClientRequest; + function request(url: string | URL, options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest; + /** + * Since most requests are GET requests without bodies, Node.js provides this + * convenience method. The only difference between this method and {@link request} is that it sets the method to GET and calls `req.end()`automatically. The callback must take care to consume the + * response + * data for reasons stated in {@link ClientRequest} section. + * + * The `callback` is invoked with a single argument that is an instance of {@link IncomingMessage}. + * + * JSON fetching example: + * + * ```js + * http.get('http://localhost:8000/', (res) => { + * const { statusCode } = res; + * const contentType = res.headers['content-type']; + * + * let error; + * // Any 2xx status code signals a successful response but + * // here we're only checking for 200. + * if (statusCode !== 200) { + * error = new Error('Request Failed.\n' + + * `Status Code: ${statusCode}`); + * } else if (!/^application\/json/.test(contentType)) { + * error = new Error('Invalid content-type.\n' + + * `Expected application/json but received ${contentType}`); + * } + * if (error) { + * console.error(error.message); + * // Consume response data to free up memory + * res.resume(); + * return; + * } + * + * res.setEncoding('utf8'); + * let rawData = ''; + * res.on('data', (chunk) => { rawData += chunk; }); + * res.on('end', () => { + * try { + * const parsedData = JSON.parse(rawData); + * console.log(parsedData); + * } catch (e) { + * console.error(e.message); + * } + * }); + * }).on('error', (e) => { + * console.error(`Got error: ${e.message}`); + * }); + * + * // Create a local server to receive data from + * const server = http.createServer((req, res) => { + * res.writeHead(200, { 'Content-Type': 'application/json' }); + * res.end(JSON.stringify({ + * data: 'Hello World!' + * })); + * }); + * + * server.listen(8000); + * ``` + * @since v0.3.6 + * @param options Accepts the same `options` as {@link request}, with the `method` always set to `GET`. Properties that are inherited from the prototype are ignored. + */ + function get(options: RequestOptions | string | URL, callback?: (res: IncomingMessage) => void): ClientRequest; + function get(url: string | URL, options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest; + let globalAgent: Agent; + /** + * Read-only property specifying the maximum allowed size of HTTP headers in bytes. + * Defaults to 16KB. Configurable using the `--max-http-header-size` CLI option. + */ + const maxHeaderSize: number; +} +declare module 'node:http' { + export * from 'http'; +} diff --git a/node_modules/@types/node/http2.d.ts b/node_modules/@types/node/http2.d.ts new file mode 100755 index 00000000..3aa9497e --- /dev/null +++ b/node_modules/@types/node/http2.d.ts @@ -0,0 +1,2100 @@ +/** + * The `http2` module provides an implementation of the [HTTP/2](https://tools.ietf.org/html/rfc7540) protocol. It + * can be accessed using: + * + * ```js + * const http2 = require('http2'); + * ``` + * @since v8.4.0 + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/http2.js) + */ +declare module 'http2' { + import EventEmitter = require('node:events'); + import * as fs from 'node:fs'; + import * as net from 'node:net'; + import * as stream from 'node:stream'; + import * as tls from 'node:tls'; + import * as url from 'node:url'; + import { IncomingHttpHeaders as Http1IncomingHttpHeaders, OutgoingHttpHeaders, IncomingMessage, ServerResponse } from 'node:http'; + export { OutgoingHttpHeaders } from 'node:http'; + export interface IncomingHttpStatusHeader { + ':status'?: number | undefined; + } + export interface IncomingHttpHeaders extends Http1IncomingHttpHeaders { + ':path'?: string | undefined; + ':method'?: string | undefined; + ':authority'?: string | undefined; + ':scheme'?: string | undefined; + } + // Http2Stream + export interface StreamPriorityOptions { + exclusive?: boolean | undefined; + parent?: number | undefined; + weight?: number | undefined; + silent?: boolean | undefined; + } + export interface StreamState { + localWindowSize?: number | undefined; + state?: number | undefined; + localClose?: number | undefined; + remoteClose?: number | undefined; + sumDependencyWeight?: number | undefined; + weight?: number | undefined; + } + export interface ServerStreamResponseOptions { + endStream?: boolean | undefined; + waitForTrailers?: boolean | undefined; + } + export interface StatOptions { + offset: number; + length: number; + } + export interface ServerStreamFileResponseOptions { + statCheck?(stats: fs.Stats, headers: OutgoingHttpHeaders, statOptions: StatOptions): void | boolean; + waitForTrailers?: boolean | undefined; + offset?: number | undefined; + length?: number | undefined; + } + export interface ServerStreamFileResponseOptionsWithError extends ServerStreamFileResponseOptions { + onError?(err: NodeJS.ErrnoException): void; + } + export interface Http2Stream extends stream.Duplex { + /** + * Set to `true` if the `Http2Stream` instance was aborted abnormally. When set, + * the `'aborted'` event will have been emitted. + * @since v8.4.0 + */ + readonly aborted: boolean; + /** + * This property shows the number of characters currently buffered to be written. + * See `net.Socket.bufferSize` for details. + * @since v11.2.0, v10.16.0 + */ + readonly bufferSize: number; + /** + * Set to `true` if the `Http2Stream` instance has been closed. + * @since v9.4.0 + */ + readonly closed: boolean; + /** + * Set to `true` if the `Http2Stream` instance has been destroyed and is no longer + * usable. + * @since v8.4.0 + */ + readonly destroyed: boolean; + /** + * Set the `true` if the `END_STREAM` flag was set in the request or response + * HEADERS frame received, indicating that no additional data should be received + * and the readable side of the `Http2Stream` will be closed. + * @since v10.11.0 + */ + readonly endAfterHeaders: boolean; + /** + * The numeric stream identifier of this `Http2Stream` instance. Set to `undefined`if the stream identifier has not yet been assigned. + * @since v8.4.0 + */ + readonly id?: number | undefined; + /** + * Set to `true` if the `Http2Stream` instance has not yet been assigned a + * numeric stream identifier. + * @since v9.4.0 + */ + readonly pending: boolean; + /** + * Set to the `RST_STREAM` `error code` reported when the `Http2Stream` is + * destroyed after either receiving an `RST_STREAM` frame from the connected peer, + * calling `http2stream.close()`, or `http2stream.destroy()`. Will be`undefined` if the `Http2Stream` has not been closed. + * @since v8.4.0 + */ + readonly rstCode: number; + /** + * An object containing the outbound headers sent for this `Http2Stream`. + * @since v9.5.0 + */ + readonly sentHeaders: OutgoingHttpHeaders; + /** + * An array of objects containing the outbound informational (additional) headers + * sent for this `Http2Stream`. + * @since v9.5.0 + */ + readonly sentInfoHeaders?: OutgoingHttpHeaders[] | undefined; + /** + * An object containing the outbound trailers sent for this `HttpStream`. + * @since v9.5.0 + */ + readonly sentTrailers?: OutgoingHttpHeaders | undefined; + /** + * A reference to the `Http2Session` instance that owns this `Http2Stream`. The + * value will be `undefined` after the `Http2Stream` instance is destroyed. + * @since v8.4.0 + */ + readonly session: Http2Session; + /** + * Provides miscellaneous information about the current state of the`Http2Stream`. + * + * A current state of this `Http2Stream`. + * @since v8.4.0 + */ + readonly state: StreamState; + /** + * Closes the `Http2Stream` instance by sending an `RST_STREAM` frame to the + * connected HTTP/2 peer. + * @since v8.4.0 + * @param [code=http2.constants.NGHTTP2_NO_ERROR] Unsigned 32-bit integer identifying the error code. + * @param callback An optional function registered to listen for the `'close'` event. + */ + close(code?: number, callback?: () => void): void; + /** + * Updates the priority for this `Http2Stream` instance. + * @since v8.4.0 + */ + priority(options: StreamPriorityOptions): void; + /** + * ```js + * const http2 = require('http2'); + * const client = http2.connect('http://example.org:8000'); + * const { NGHTTP2_CANCEL } = http2.constants; + * const req = client.request({ ':path': '/' }); + * + * // Cancel the stream if there's no activity after 5 seconds + * req.setTimeout(5000, () => req.close(NGHTTP2_CANCEL)); + * ``` + * @since v8.4.0 + */ + setTimeout(msecs: number, callback?: () => void): void; + /** + * Sends a trailing `HEADERS` frame to the connected HTTP/2 peer. This method + * will cause the `Http2Stream` to be immediately closed and must only be + * called after the `'wantTrailers'` event has been emitted. When sending a + * request or sending a response, the `options.waitForTrailers` option must be set + * in order to keep the `Http2Stream` open after the final `DATA` frame so that + * trailers can be sent. + * + * ```js + * const http2 = require('http2'); + * const server = http2.createServer(); + * server.on('stream', (stream) => { + * stream.respond(undefined, { waitForTrailers: true }); + * stream.on('wantTrailers', () => { + * stream.sendTrailers({ xyz: 'abc' }); + * }); + * stream.end('Hello World'); + * }); + * ``` + * + * The HTTP/1 specification forbids trailers from containing HTTP/2 pseudo-header + * fields (e.g. `':method'`, `':path'`, etc). + * @since v10.0.0 + */ + sendTrailers(headers: OutgoingHttpHeaders): void; + addListener(event: 'aborted', listener: () => void): this; + addListener(event: 'close', listener: () => void): this; + addListener(event: 'data', listener: (chunk: Buffer | string) => void): this; + addListener(event: 'drain', listener: () => void): this; + addListener(event: 'end', listener: () => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'finish', listener: () => void): this; + addListener(event: 'frameError', listener: (frameType: number, errorCode: number) => void): this; + addListener(event: 'pipe', listener: (src: stream.Readable) => void): this; + addListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; + addListener(event: 'streamClosed', listener: (code: number) => void): this; + addListener(event: 'timeout', listener: () => void): this; + addListener(event: 'trailers', listener: (trailers: IncomingHttpHeaders, flags: number) => void): this; + addListener(event: 'wantTrailers', listener: () => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + emit(event: 'aborted'): boolean; + emit(event: 'close'): boolean; + emit(event: 'data', chunk: Buffer | string): boolean; + emit(event: 'drain'): boolean; + emit(event: 'end'): boolean; + emit(event: 'error', err: Error): boolean; + emit(event: 'finish'): boolean; + emit(event: 'frameError', frameType: number, errorCode: number): boolean; + emit(event: 'pipe', src: stream.Readable): boolean; + emit(event: 'unpipe', src: stream.Readable): boolean; + emit(event: 'streamClosed', code: number): boolean; + emit(event: 'timeout'): boolean; + emit(event: 'trailers', trailers: IncomingHttpHeaders, flags: number): boolean; + emit(event: 'wantTrailers'): boolean; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'aborted', listener: () => void): this; + on(event: 'close', listener: () => void): this; + on(event: 'data', listener: (chunk: Buffer | string) => void): this; + on(event: 'drain', listener: () => void): this; + on(event: 'end', listener: () => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'finish', listener: () => void): this; + on(event: 'frameError', listener: (frameType: number, errorCode: number) => void): this; + on(event: 'pipe', listener: (src: stream.Readable) => void): this; + on(event: 'unpipe', listener: (src: stream.Readable) => void): this; + on(event: 'streamClosed', listener: (code: number) => void): this; + on(event: 'timeout', listener: () => void): this; + on(event: 'trailers', listener: (trailers: IncomingHttpHeaders, flags: number) => void): this; + on(event: 'wantTrailers', listener: () => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'aborted', listener: () => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'data', listener: (chunk: Buffer | string) => void): this; + once(event: 'drain', listener: () => void): this; + once(event: 'end', listener: () => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'finish', listener: () => void): this; + once(event: 'frameError', listener: (frameType: number, errorCode: number) => void): this; + once(event: 'pipe', listener: (src: stream.Readable) => void): this; + once(event: 'unpipe', listener: (src: stream.Readable) => void): this; + once(event: 'streamClosed', listener: (code: number) => void): this; + once(event: 'timeout', listener: () => void): this; + once(event: 'trailers', listener: (trailers: IncomingHttpHeaders, flags: number) => void): this; + once(event: 'wantTrailers', listener: () => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'aborted', listener: () => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'data', listener: (chunk: Buffer | string) => void): this; + prependListener(event: 'drain', listener: () => void): this; + prependListener(event: 'end', listener: () => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'finish', listener: () => void): this; + prependListener(event: 'frameError', listener: (frameType: number, errorCode: number) => void): this; + prependListener(event: 'pipe', listener: (src: stream.Readable) => void): this; + prependListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; + prependListener(event: 'streamClosed', listener: (code: number) => void): this; + prependListener(event: 'timeout', listener: () => void): this; + prependListener(event: 'trailers', listener: (trailers: IncomingHttpHeaders, flags: number) => void): this; + prependListener(event: 'wantTrailers', listener: () => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'aborted', listener: () => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'data', listener: (chunk: Buffer | string) => void): this; + prependOnceListener(event: 'drain', listener: () => void): this; + prependOnceListener(event: 'end', listener: () => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'finish', listener: () => void): this; + prependOnceListener(event: 'frameError', listener: (frameType: number, errorCode: number) => void): this; + prependOnceListener(event: 'pipe', listener: (src: stream.Readable) => void): this; + prependOnceListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; + prependOnceListener(event: 'streamClosed', listener: (code: number) => void): this; + prependOnceListener(event: 'timeout', listener: () => void): this; + prependOnceListener(event: 'trailers', listener: (trailers: IncomingHttpHeaders, flags: number) => void): this; + prependOnceListener(event: 'wantTrailers', listener: () => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + export interface ClientHttp2Stream extends Http2Stream { + addListener(event: 'continue', listener: () => {}): this; + addListener(event: 'headers', listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + addListener(event: 'push', listener: (headers: IncomingHttpHeaders, flags: number) => void): this; + addListener(event: 'response', listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + emit(event: 'continue'): boolean; + emit(event: 'headers', headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number): boolean; + emit(event: 'push', headers: IncomingHttpHeaders, flags: number): boolean; + emit(event: 'response', headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number): boolean; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'continue', listener: () => {}): this; + on(event: 'headers', listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + on(event: 'push', listener: (headers: IncomingHttpHeaders, flags: number) => void): this; + on(event: 'response', listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'continue', listener: () => {}): this; + once(event: 'headers', listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + once(event: 'push', listener: (headers: IncomingHttpHeaders, flags: number) => void): this; + once(event: 'response', listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'continue', listener: () => {}): this; + prependListener(event: 'headers', listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + prependListener(event: 'push', listener: (headers: IncomingHttpHeaders, flags: number) => void): this; + prependListener(event: 'response', listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'continue', listener: () => {}): this; + prependOnceListener(event: 'headers', listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + prependOnceListener(event: 'push', listener: (headers: IncomingHttpHeaders, flags: number) => void): this; + prependOnceListener(event: 'response', listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + export interface ServerHttp2Stream extends Http2Stream { + /** + * True if headers were sent, false otherwise (read-only). + * @since v8.4.0 + */ + readonly headersSent: boolean; + /** + * Read-only property mapped to the `SETTINGS_ENABLE_PUSH` flag of the remote + * client's most recent `SETTINGS` frame. Will be `true` if the remote peer + * accepts push streams, `false` otherwise. Settings are the same for every`Http2Stream` in the same `Http2Session`. + * @since v8.4.0 + */ + readonly pushAllowed: boolean; + /** + * Sends an additional informational `HEADERS` frame to the connected HTTP/2 peer. + * @since v8.4.0 + */ + additionalHeaders(headers: OutgoingHttpHeaders): void; + /** + * Initiates a push stream. The callback is invoked with the new `Http2Stream`instance created for the push stream passed as the second argument, or an`Error` passed as the first argument. + * + * ```js + * const http2 = require('http2'); + * const server = http2.createServer(); + * server.on('stream', (stream) => { + * stream.respond({ ':status': 200 }); + * stream.pushStream({ ':path': '/' }, (err, pushStream, headers) => { + * if (err) throw err; + * pushStream.respond({ ':status': 200 }); + * pushStream.end('some pushed data'); + * }); + * stream.end('some data'); + * }); + * ``` + * + * Setting the weight of a push stream is not allowed in the `HEADERS` frame. Pass + * a `weight` value to `http2stream.priority` with the `silent` option set to`true` to enable server-side bandwidth balancing between concurrent streams. + * + * Calling `http2stream.pushStream()` from within a pushed stream is not permitted + * and will throw an error. + * @since v8.4.0 + * @param callback Callback that is called once the push stream has been initiated. + */ + pushStream(headers: OutgoingHttpHeaders, callback?: (err: Error | null, pushStream: ServerHttp2Stream, headers: OutgoingHttpHeaders) => void): void; + pushStream(headers: OutgoingHttpHeaders, options?: StreamPriorityOptions, callback?: (err: Error | null, pushStream: ServerHttp2Stream, headers: OutgoingHttpHeaders) => void): void; + /** + * ```js + * const http2 = require('http2'); + * const server = http2.createServer(); + * server.on('stream', (stream) => { + * stream.respond({ ':status': 200 }); + * stream.end('some data'); + * }); + * ``` + * + * When the `options.waitForTrailers` option is set, the `'wantTrailers'` event + * will be emitted immediately after queuing the last chunk of payload data to be + * sent. The `http2stream.sendTrailers()` method can then be used to sent trailing + * header fields to the peer. + * + * When `options.waitForTrailers` is set, the `Http2Stream` will not automatically + * close when the final `DATA` frame is transmitted. User code must call either`http2stream.sendTrailers()` or `http2stream.close()` to close the`Http2Stream`. + * + * ```js + * const http2 = require('http2'); + * const server = http2.createServer(); + * server.on('stream', (stream) => { + * stream.respond({ ':status': 200 }, { waitForTrailers: true }); + * stream.on('wantTrailers', () => { + * stream.sendTrailers({ ABC: 'some value to send' }); + * }); + * stream.end('some data'); + * }); + * ``` + * @since v8.4.0 + */ + respond(headers?: OutgoingHttpHeaders, options?: ServerStreamResponseOptions): void; + /** + * Initiates a response whose data is read from the given file descriptor. No + * validation is performed on the given file descriptor. If an error occurs while + * attempting to read data using the file descriptor, the `Http2Stream` will be + * closed using an `RST_STREAM` frame using the standard `INTERNAL_ERROR` code. + * + * When used, the `Http2Stream` object's `Duplex` interface will be closed + * automatically. + * + * ```js + * const http2 = require('http2'); + * const fs = require('fs'); + * + * const server = http2.createServer(); + * server.on('stream', (stream) => { + * const fd = fs.openSync('/some/file', 'r'); + * + * const stat = fs.fstatSync(fd); + * const headers = { + * 'content-length': stat.size, + * 'last-modified': stat.mtime.toUTCString(), + * 'content-type': 'text/plain; charset=utf-8' + * }; + * stream.respondWithFD(fd, headers); + * stream.on('close', () => fs.closeSync(fd)); + * }); + * ``` + * + * The optional `options.statCheck` function may be specified to give user code + * an opportunity to set additional content headers based on the `fs.Stat` details + * of the given fd. If the `statCheck` function is provided, the`http2stream.respondWithFD()` method will perform an `fs.fstat()` call to + * collect details on the provided file descriptor. + * + * The `offset` and `length` options may be used to limit the response to a + * specific range subset. This can be used, for instance, to support HTTP Range + * requests. + * + * The file descriptor or `FileHandle` is not closed when the stream is closed, + * so it will need to be closed manually once it is no longer needed. + * Using the same file descriptor concurrently for multiple streams + * is not supported and may result in data loss. Re-using a file descriptor + * after a stream has finished is supported. + * + * When the `options.waitForTrailers` option is set, the `'wantTrailers'` event + * will be emitted immediately after queuing the last chunk of payload data to be + * sent. The `http2stream.sendTrailers()` method can then be used to sent trailing + * header fields to the peer. + * + * When `options.waitForTrailers` is set, the `Http2Stream` will not automatically + * close when the final `DATA` frame is transmitted. User code _must_ call either`http2stream.sendTrailers()` or `http2stream.close()` to close the`Http2Stream`. + * + * ```js + * const http2 = require('http2'); + * const fs = require('fs'); + * + * const server = http2.createServer(); + * server.on('stream', (stream) => { + * const fd = fs.openSync('/some/file', 'r'); + * + * const stat = fs.fstatSync(fd); + * const headers = { + * 'content-length': stat.size, + * 'last-modified': stat.mtime.toUTCString(), + * 'content-type': 'text/plain; charset=utf-8' + * }; + * stream.respondWithFD(fd, headers, { waitForTrailers: true }); + * stream.on('wantTrailers', () => { + * stream.sendTrailers({ ABC: 'some value to send' }); + * }); + * + * stream.on('close', () => fs.closeSync(fd)); + * }); + * ``` + * @since v8.4.0 + * @param fd A readable file descriptor. + */ + respondWithFD(fd: number | fs.promises.FileHandle, headers?: OutgoingHttpHeaders, options?: ServerStreamFileResponseOptions): void; + /** + * Sends a regular file as the response. The `path` must specify a regular file + * or an `'error'` event will be emitted on the `Http2Stream` object. + * + * When used, the `Http2Stream` object's `Duplex` interface will be closed + * automatically. + * + * The optional `options.statCheck` function may be specified to give user code + * an opportunity to set additional content headers based on the `fs.Stat` details + * of the given file: + * + * If an error occurs while attempting to read the file data, the `Http2Stream`will be closed using an `RST_STREAM` frame using the standard `INTERNAL_ERROR`code. If the `onError` callback is + * defined, then it will be called. Otherwise + * the stream will be destroyed. + * + * Example using a file path: + * + * ```js + * const http2 = require('http2'); + * const server = http2.createServer(); + * server.on('stream', (stream) => { + * function statCheck(stat, headers) { + * headers['last-modified'] = stat.mtime.toUTCString(); + * } + * + * function onError(err) { + * // stream.respond() can throw if the stream has been destroyed by + * // the other side. + * try { + * if (err.code === 'ENOENT') { + * stream.respond({ ':status': 404 }); + * } else { + * stream.respond({ ':status': 500 }); + * } + * } catch (err) { + * // Perform actual error handling. + * console.log(err); + * } + * stream.end(); + * } + * + * stream.respondWithFile('/some/file', + * { 'content-type': 'text/plain; charset=utf-8' }, + * { statCheck, onError }); + * }); + * ``` + * + * The `options.statCheck` function may also be used to cancel the send operation + * by returning `false`. For instance, a conditional request may check the stat + * results to determine if the file has been modified to return an appropriate`304` response: + * + * ```js + * const http2 = require('http2'); + * const server = http2.createServer(); + * server.on('stream', (stream) => { + * function statCheck(stat, headers) { + * // Check the stat here... + * stream.respond({ ':status': 304 }); + * return false; // Cancel the send operation + * } + * stream.respondWithFile('/some/file', + * { 'content-type': 'text/plain; charset=utf-8' }, + * { statCheck }); + * }); + * ``` + * + * The `content-length` header field will be automatically set. + * + * The `offset` and `length` options may be used to limit the response to a + * specific range subset. This can be used, for instance, to support HTTP Range + * requests. + * + * The `options.onError` function may also be used to handle all the errors + * that could happen before the delivery of the file is initiated. The + * default behavior is to destroy the stream. + * + * When the `options.waitForTrailers` option is set, the `'wantTrailers'` event + * will be emitted immediately after queuing the last chunk of payload data to be + * sent. The `http2stream.sendTrailers()` method can then be used to sent trailing + * header fields to the peer. + * + * When `options.waitForTrailers` is set, the `Http2Stream` will not automatically + * close when the final `DATA` frame is transmitted. User code must call either`http2stream.sendTrailers()` or `http2stream.close()` to close the`Http2Stream`. + * + * ```js + * const http2 = require('http2'); + * const server = http2.createServer(); + * server.on('stream', (stream) => { + * stream.respondWithFile('/some/file', + * { 'content-type': 'text/plain; charset=utf-8' }, + * { waitForTrailers: true }); + * stream.on('wantTrailers', () => { + * stream.sendTrailers({ ABC: 'some value to send' }); + * }); + * }); + * ``` + * @since v8.4.0 + */ + respondWithFile(path: string, headers?: OutgoingHttpHeaders, options?: ServerStreamFileResponseOptionsWithError): void; + } + // Http2Session + export interface Settings { + headerTableSize?: number | undefined; + enablePush?: boolean | undefined; + initialWindowSize?: number | undefined; + maxFrameSize?: number | undefined; + maxConcurrentStreams?: number | undefined; + maxHeaderListSize?: number | undefined; + enableConnectProtocol?: boolean | undefined; + } + export interface ClientSessionRequestOptions { + endStream?: boolean | undefined; + exclusive?: boolean | undefined; + parent?: number | undefined; + weight?: number | undefined; + waitForTrailers?: boolean | undefined; + } + export interface SessionState { + effectiveLocalWindowSize?: number | undefined; + effectiveRecvDataLength?: number | undefined; + nextStreamID?: number | undefined; + localWindowSize?: number | undefined; + lastProcStreamID?: number | undefined; + remoteWindowSize?: number | undefined; + outboundQueueSize?: number | undefined; + deflateDynamicTableSize?: number | undefined; + inflateDynamicTableSize?: number | undefined; + } + export interface Http2Session extends EventEmitter { + /** + * Value will be `undefined` if the `Http2Session` is not yet connected to a + * socket, `h2c` if the `Http2Session` is not connected to a `TLSSocket`, or + * will return the value of the connected `TLSSocket`'s own `alpnProtocol`property. + * @since v9.4.0 + */ + readonly alpnProtocol?: string | undefined; + /** + * Will be `true` if this `Http2Session` instance has been closed, otherwise`false`. + * @since v9.4.0 + */ + readonly closed: boolean; + /** + * Will be `true` if this `Http2Session` instance is still connecting, will be set + * to `false` before emitting `connect` event and/or calling the `http2.connect`callback. + * @since v10.0.0 + */ + readonly connecting: boolean; + /** + * Will be `true` if this `Http2Session` instance has been destroyed and must no + * longer be used, otherwise `false`. + * @since v8.4.0 + */ + readonly destroyed: boolean; + /** + * Value is `undefined` if the `Http2Session` session socket has not yet been + * connected, `true` if the `Http2Session` is connected with a `TLSSocket`, + * and `false` if the `Http2Session` is connected to any other kind of socket + * or stream. + * @since v9.4.0 + */ + readonly encrypted?: boolean | undefined; + /** + * A prototype-less object describing the current local settings of this`Http2Session`. The local settings are local to _this_`Http2Session` instance. + * @since v8.4.0 + */ + readonly localSettings: Settings; + /** + * If the `Http2Session` is connected to a `TLSSocket`, the `originSet` property + * will return an `Array` of origins for which the `Http2Session` may be + * considered authoritative. + * + * The `originSet` property is only available when using a secure TLS connection. + * @since v9.4.0 + */ + readonly originSet?: string[] | undefined; + /** + * Indicates whether the `Http2Session` is currently waiting for acknowledgment of + * a sent `SETTINGS` frame. Will be `true` after calling the`http2session.settings()` method. Will be `false` once all sent `SETTINGS`frames have been acknowledged. + * @since v8.4.0 + */ + readonly pendingSettingsAck: boolean; + /** + * A prototype-less object describing the current remote settings of this`Http2Session`. The remote settings are set by the _connected_ HTTP/2 peer. + * @since v8.4.0 + */ + readonly remoteSettings: Settings; + /** + * Returns a `Proxy` object that acts as a `net.Socket` (or `tls.TLSSocket`) but + * limits available methods to ones safe to use with HTTP/2. + * + * `destroy`, `emit`, `end`, `pause`, `read`, `resume`, and `write` will throw + * an error with code `ERR_HTTP2_NO_SOCKET_MANIPULATION`. See `Http2Session and Sockets` for more information. + * + * `setTimeout` method will be called on this `Http2Session`. + * + * All other interactions will be routed directly to the socket. + * @since v8.4.0 + */ + readonly socket: net.Socket | tls.TLSSocket; + /** + * Provides miscellaneous information about the current state of the`Http2Session`. + * + * An object describing the current status of this `Http2Session`. + * @since v8.4.0 + */ + readonly state: SessionState; + /** + * The `http2session.type` will be equal to`http2.constants.NGHTTP2_SESSION_SERVER` if this `Http2Session` instance is a + * server, and `http2.constants.NGHTTP2_SESSION_CLIENT` if the instance is a + * client. + * @since v8.4.0 + */ + readonly type: number; + /** + * Gracefully closes the `Http2Session`, allowing any existing streams to + * complete on their own and preventing new `Http2Stream` instances from being + * created. Once closed, `http2session.destroy()`_might_ be called if there + * are no open `Http2Stream` instances. + * + * If specified, the `callback` function is registered as a handler for the`'close'` event. + * @since v9.4.0 + */ + close(callback?: () => void): void; + /** + * Immediately terminates the `Http2Session` and the associated `net.Socket` or`tls.TLSSocket`. + * + * Once destroyed, the `Http2Session` will emit the `'close'` event. If `error`is not undefined, an `'error'` event will be emitted immediately before the`'close'` event. + * + * If there are any remaining open `Http2Streams` associated with the`Http2Session`, those will also be destroyed. + * @since v8.4.0 + * @param error An `Error` object if the `Http2Session` is being destroyed due to an error. + * @param code The HTTP/2 error code to send in the final `GOAWAY` frame. If unspecified, and `error` is not undefined, the default is `INTERNAL_ERROR`, otherwise defaults to `NO_ERROR`. + */ + destroy(error?: Error, code?: number): void; + /** + * Transmits a `GOAWAY` frame to the connected peer _without_ shutting down the`Http2Session`. + * @since v9.4.0 + * @param code An HTTP/2 error code + * @param lastStreamID The numeric ID of the last processed `Http2Stream` + * @param opaqueData A `TypedArray` or `DataView` instance containing additional data to be carried within the `GOAWAY` frame. + */ + goaway(code?: number, lastStreamID?: number, opaqueData?: NodeJS.ArrayBufferView): void; + /** + * Sends a `PING` frame to the connected HTTP/2 peer. A `callback` function must + * be provided. The method will return `true` if the `PING` was sent, `false`otherwise. + * + * The maximum number of outstanding (unacknowledged) pings is determined by the`maxOutstandingPings` configuration option. The default maximum is 10. + * + * If provided, the `payload` must be a `Buffer`, `TypedArray`, or `DataView`containing 8 bytes of data that will be transmitted with the `PING` and + * returned with the ping acknowledgment. + * + * The callback will be invoked with three arguments: an error argument that will + * be `null` if the `PING` was successfully acknowledged, a `duration` argument + * that reports the number of milliseconds elapsed since the ping was sent and the + * acknowledgment was received, and a `Buffer` containing the 8-byte `PING`payload. + * + * ```js + * session.ping(Buffer.from('abcdefgh'), (err, duration, payload) => { + * if (!err) { + * console.log(`Ping acknowledged in ${duration} milliseconds`); + * console.log(`With payload '${payload.toString()}'`); + * } + * }); + * ``` + * + * If the `payload` argument is not specified, the default payload will be the + * 64-bit timestamp (little endian) marking the start of the `PING` duration. + * @since v8.9.3 + * @param payload Optional ping payload. + */ + ping(callback: (err: Error | null, duration: number, payload: Buffer) => void): boolean; + ping(payload: NodeJS.ArrayBufferView, callback: (err: Error | null, duration: number, payload: Buffer) => void): boolean; + /** + * Calls `ref()` on this `Http2Session`instance's underlying `net.Socket`. + * @since v9.4.0 + */ + ref(): void; + /** + * Sets the local endpoint's window size. + * The `windowSize` is the total window size to set, not + * the delta. + * + * ```js + * const http2 = require('http2'); + * + * const server = http2.createServer(); + * const expectedWindowSize = 2 ** 20; + * server.on('connect', (session) => { + * + * // Set local window size to be 2 ** 20 + * session.setLocalWindowSize(expectedWindowSize); + * }); + * ``` + * @since v15.3.0 + */ + setLocalWindowSize(windowSize: number): void; + /** + * Used to set a callback function that is called when there is no activity on + * the `Http2Session` after `msecs` milliseconds. The given `callback` is + * registered as a listener on the `'timeout'` event. + * @since v8.4.0 + */ + setTimeout(msecs: number, callback?: () => void): void; + /** + * Updates the current local settings for this `Http2Session` and sends a new`SETTINGS` frame to the connected HTTP/2 peer. + * + * Once called, the `http2session.pendingSettingsAck` property will be `true`while the session is waiting for the remote peer to acknowledge the new + * settings. + * + * The new settings will not become effective until the `SETTINGS` acknowledgment + * is received and the `'localSettings'` event is emitted. It is possible to send + * multiple `SETTINGS` frames while acknowledgment is still pending. + * @since v8.4.0 + * @param callback Callback that is called once the session is connected or right away if the session is already connected. + */ + settings(settings: Settings): void; + /** + * Calls `unref()` on this `Http2Session`instance's underlying `net.Socket`. + * @since v9.4.0 + */ + unref(): void; + addListener(event: 'close', listener: () => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'frameError', listener: (frameType: number, errorCode: number, streamID: number) => void): this; + addListener(event: 'goaway', listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this; + addListener(event: 'localSettings', listener: (settings: Settings) => void): this; + addListener(event: 'ping', listener: () => void): this; + addListener(event: 'remoteSettings', listener: (settings: Settings) => void): this; + addListener(event: 'timeout', listener: () => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + emit(event: 'close'): boolean; + emit(event: 'error', err: Error): boolean; + emit(event: 'frameError', frameType: number, errorCode: number, streamID: number): boolean; + emit(event: 'goaway', errorCode: number, lastStreamID: number, opaqueData: Buffer): boolean; + emit(event: 'localSettings', settings: Settings): boolean; + emit(event: 'ping'): boolean; + emit(event: 'remoteSettings', settings: Settings): boolean; + emit(event: 'timeout'): boolean; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'close', listener: () => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'frameError', listener: (frameType: number, errorCode: number, streamID: number) => void): this; + on(event: 'goaway', listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this; + on(event: 'localSettings', listener: (settings: Settings) => void): this; + on(event: 'ping', listener: () => void): this; + on(event: 'remoteSettings', listener: (settings: Settings) => void): this; + on(event: 'timeout', listener: () => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'frameError', listener: (frameType: number, errorCode: number, streamID: number) => void): this; + once(event: 'goaway', listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this; + once(event: 'localSettings', listener: (settings: Settings) => void): this; + once(event: 'ping', listener: () => void): this; + once(event: 'remoteSettings', listener: (settings: Settings) => void): this; + once(event: 'timeout', listener: () => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'frameError', listener: (frameType: number, errorCode: number, streamID: number) => void): this; + prependListener(event: 'goaway', listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this; + prependListener(event: 'localSettings', listener: (settings: Settings) => void): this; + prependListener(event: 'ping', listener: () => void): this; + prependListener(event: 'remoteSettings', listener: (settings: Settings) => void): this; + prependListener(event: 'timeout', listener: () => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'frameError', listener: (frameType: number, errorCode: number, streamID: number) => void): this; + prependOnceListener(event: 'goaway', listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this; + prependOnceListener(event: 'localSettings', listener: (settings: Settings) => void): this; + prependOnceListener(event: 'ping', listener: () => void): this; + prependOnceListener(event: 'remoteSettings', listener: (settings: Settings) => void): this; + prependOnceListener(event: 'timeout', listener: () => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + export interface ClientHttp2Session extends Http2Session { + /** + * For HTTP/2 Client `Http2Session` instances only, the `http2session.request()`creates and returns an `Http2Stream` instance that can be used to send an + * HTTP/2 request to the connected server. + * + * This method is only available if `http2session.type` is equal to`http2.constants.NGHTTP2_SESSION_CLIENT`. + * + * ```js + * const http2 = require('http2'); + * const clientSession = http2.connect('https://localhost:1234'); + * const { + * HTTP2_HEADER_PATH, + * HTTP2_HEADER_STATUS + * } = http2.constants; + * + * const req = clientSession.request({ [HTTP2_HEADER_PATH]: '/' }); + * req.on('response', (headers) => { + * console.log(headers[HTTP2_HEADER_STATUS]); + * req.on('data', (chunk) => { // .. }); + * req.on('end', () => { // .. }); + * }); + * ``` + * + * When the `options.waitForTrailers` option is set, the `'wantTrailers'` event + * is emitted immediately after queuing the last chunk of payload data to be sent. + * The `http2stream.sendTrailers()` method can then be called to send trailing + * headers to the peer. + * + * When `options.waitForTrailers` is set, the `Http2Stream` will not automatically + * close when the final `DATA` frame is transmitted. User code must call either`http2stream.sendTrailers()` or `http2stream.close()` to close the`Http2Stream`. + * + * When `options.signal` is set with an `AbortSignal` and then `abort` on the + * corresponding `AbortController` is called, the request will emit an `'error'`event with an `AbortError` error. + * + * The `:method` and `:path` pseudo-headers are not specified within `headers`, + * they respectively default to: + * + * * `:method` \= `'GET'` + * * `:path` \= `/` + * @since v8.4.0 + */ + request(headers?: OutgoingHttpHeaders, options?: ClientSessionRequestOptions): ClientHttp2Stream; + addListener(event: 'altsvc', listener: (alt: string, origin: string, stream: number) => void): this; + addListener(event: 'origin', listener: (origins: string[]) => void): this; + addListener(event: 'connect', listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; + addListener(event: 'stream', listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + emit(event: 'altsvc', alt: string, origin: string, stream: number): boolean; + emit(event: 'origin', origins: ReadonlyArray): boolean; + emit(event: 'connect', session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket): boolean; + emit(event: 'stream', stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number): boolean; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'altsvc', listener: (alt: string, origin: string, stream: number) => void): this; + on(event: 'origin', listener: (origins: string[]) => void): this; + on(event: 'connect', listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; + on(event: 'stream', listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'altsvc', listener: (alt: string, origin: string, stream: number) => void): this; + once(event: 'origin', listener: (origins: string[]) => void): this; + once(event: 'connect', listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; + once(event: 'stream', listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'altsvc', listener: (alt: string, origin: string, stream: number) => void): this; + prependListener(event: 'origin', listener: (origins: string[]) => void): this; + prependListener(event: 'connect', listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; + prependListener(event: 'stream', listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'altsvc', listener: (alt: string, origin: string, stream: number) => void): this; + prependOnceListener(event: 'origin', listener: (origins: string[]) => void): this; + prependOnceListener(event: 'connect', listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; + prependOnceListener(event: 'stream', listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + export interface AlternativeServiceOptions { + origin: number | string | url.URL; + } + export interface ServerHttp2Session extends Http2Session { + readonly server: Http2Server | Http2SecureServer; + /** + * Submits an `ALTSVC` frame (as defined by [RFC 7838](https://tools.ietf.org/html/rfc7838)) to the connected client. + * + * ```js + * const http2 = require('http2'); + * + * const server = http2.createServer(); + * server.on('session', (session) => { + * // Set altsvc for origin https://example.org:80 + * session.altsvc('h2=":8000"', 'https://example.org:80'); + * }); + * + * server.on('stream', (stream) => { + * // Set altsvc for a specific stream + * stream.session.altsvc('h2=":8000"', stream.id); + * }); + * ``` + * + * Sending an `ALTSVC` frame with a specific stream ID indicates that the alternate + * service is associated with the origin of the given `Http2Stream`. + * + * The `alt` and origin string _must_ contain only ASCII bytes and are + * strictly interpreted as a sequence of ASCII bytes. The special value `'clear'`may be passed to clear any previously set alternative service for a given + * domain. + * + * When a string is passed for the `originOrStream` argument, it will be parsed as + * a URL and the origin will be derived. For instance, the origin for the + * HTTP URL `'https://example.org/foo/bar'` is the ASCII string`'https://example.org'`. An error will be thrown if either the given string + * cannot be parsed as a URL or if a valid origin cannot be derived. + * + * A `URL` object, or any object with an `origin` property, may be passed as`originOrStream`, in which case the value of the `origin` property will be + * used. The value of the `origin` property _must_ be a properly serialized + * ASCII origin. + * @since v9.4.0 + * @param alt A description of the alternative service configuration as defined by `RFC 7838`. + * @param originOrStream Either a URL string specifying the origin (or an `Object` with an `origin` property) or the numeric identifier of an active `Http2Stream` as given by the + * `http2stream.id` property. + */ + altsvc(alt: string, originOrStream: number | string | url.URL | AlternativeServiceOptions): void; + /** + * Submits an `ORIGIN` frame (as defined by [RFC 8336](https://tools.ietf.org/html/rfc8336)) to the connected client + * to advertise the set of origins for which the server is capable of providing + * authoritative responses. + * + * ```js + * const http2 = require('http2'); + * const options = getSecureOptionsSomehow(); + * const server = http2.createSecureServer(options); + * server.on('stream', (stream) => { + * stream.respond(); + * stream.end('ok'); + * }); + * server.on('session', (session) => { + * session.origin('https://example.com', 'https://example.org'); + * }); + * ``` + * + * When a string is passed as an `origin`, it will be parsed as a URL and the + * origin will be derived. For instance, the origin for the HTTP URL`'https://example.org/foo/bar'` is the ASCII string`'https://example.org'`. An error will be thrown if either the given + * string + * cannot be parsed as a URL or if a valid origin cannot be derived. + * + * A `URL` object, or any object with an `origin` property, may be passed as + * an `origin`, in which case the value of the `origin` property will be + * used. The value of the `origin` property _must_ be a properly serialized + * ASCII origin. + * + * Alternatively, the `origins` option may be used when creating a new HTTP/2 + * server using the `http2.createSecureServer()` method: + * + * ```js + * const http2 = require('http2'); + * const options = getSecureOptionsSomehow(); + * options.origins = ['https://example.com', 'https://example.org']; + * const server = http2.createSecureServer(options); + * server.on('stream', (stream) => { + * stream.respond(); + * stream.end('ok'); + * }); + * ``` + * @since v10.12.0 + * @param origins One or more URL Strings passed as separate arguments. + */ + origin( + ...origins: Array< + | string + | url.URL + | { + origin: string; + } + > + ): void; + addListener(event: 'connect', listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; + addListener(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + emit(event: 'connect', session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket): boolean; + emit(event: 'stream', stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): boolean; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'connect', listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; + on(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'connect', listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; + once(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'connect', listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; + prependListener(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'connect', listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; + prependOnceListener(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + // Http2Server + export interface SessionOptions { + maxDeflateDynamicTableSize?: number | undefined; + maxSessionMemory?: number | undefined; + maxHeaderListPairs?: number | undefined; + maxOutstandingPings?: number | undefined; + maxSendHeaderBlockLength?: number | undefined; + paddingStrategy?: number | undefined; + peerMaxConcurrentStreams?: number | undefined; + settings?: Settings | undefined; + /** + * Specifies a timeout in milliseconds that + * a server should wait when an [`'unknownProtocol'`][] is emitted. If the + * socket has not been destroyed by that time the server will destroy it. + * @default 100000 + */ + unknownProtocolTimeout?: number | undefined; + selectPadding?(frameLen: number, maxFrameLen: number): number; + createConnection?(authority: url.URL, option: SessionOptions): stream.Duplex; + } + export interface ClientSessionOptions extends SessionOptions { + maxReservedRemoteStreams?: number | undefined; + createConnection?: ((authority: url.URL, option: SessionOptions) => stream.Duplex) | undefined; + protocol?: 'http:' | 'https:' | undefined; + } + export interface ServerSessionOptions extends SessionOptions { + Http1IncomingMessage?: typeof IncomingMessage | undefined; + Http1ServerResponse?: typeof ServerResponse | undefined; + Http2ServerRequest?: typeof Http2ServerRequest | undefined; + Http2ServerResponse?: typeof Http2ServerResponse | undefined; + } + export interface SecureClientSessionOptions extends ClientSessionOptions, tls.ConnectionOptions {} + export interface SecureServerSessionOptions extends ServerSessionOptions, tls.TlsOptions {} + export interface ServerOptions extends ServerSessionOptions {} + export interface SecureServerOptions extends SecureServerSessionOptions { + allowHTTP1?: boolean | undefined; + origins?: string[] | undefined; + } + interface HTTP2ServerCommon { + setTimeout(msec?: number, callback?: () => void): this; + /** + * Throws ERR_HTTP2_INVALID_SETTING_VALUE for invalid settings values. + * Throws ERR_INVALID_ARG_TYPE for invalid settings argument. + */ + updateSettings(settings: Settings): void; + } + export interface Http2Server extends net.Server, HTTP2ServerCommon { + addListener(event: 'checkContinue', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + addListener(event: 'request', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + addListener(event: 'session', listener: (session: ServerHttp2Session) => void): this; + addListener(event: 'sessionError', listener: (err: Error) => void): this; + addListener(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + addListener(event: 'timeout', listener: () => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + emit(event: 'checkContinue', request: Http2ServerRequest, response: Http2ServerResponse): boolean; + emit(event: 'request', request: Http2ServerRequest, response: Http2ServerResponse): boolean; + emit(event: 'session', session: ServerHttp2Session): boolean; + emit(event: 'sessionError', err: Error): boolean; + emit(event: 'stream', stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): boolean; + emit(event: 'timeout'): boolean; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'checkContinue', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + on(event: 'request', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + on(event: 'session', listener: (session: ServerHttp2Session) => void): this; + on(event: 'sessionError', listener: (err: Error) => void): this; + on(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + on(event: 'timeout', listener: () => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'checkContinue', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + once(event: 'request', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + once(event: 'session', listener: (session: ServerHttp2Session) => void): this; + once(event: 'sessionError', listener: (err: Error) => void): this; + once(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + once(event: 'timeout', listener: () => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'checkContinue', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + prependListener(event: 'request', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + prependListener(event: 'session', listener: (session: ServerHttp2Session) => void): this; + prependListener(event: 'sessionError', listener: (err: Error) => void): this; + prependListener(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + prependListener(event: 'timeout', listener: () => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'checkContinue', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + prependOnceListener(event: 'request', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + prependOnceListener(event: 'session', listener: (session: ServerHttp2Session) => void): this; + prependOnceListener(event: 'sessionError', listener: (err: Error) => void): this; + prependOnceListener(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + prependOnceListener(event: 'timeout', listener: () => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + export interface Http2SecureServer extends tls.Server, HTTP2ServerCommon { + addListener(event: 'checkContinue', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + addListener(event: 'request', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + addListener(event: 'session', listener: (session: ServerHttp2Session) => void): this; + addListener(event: 'sessionError', listener: (err: Error) => void): this; + addListener(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + addListener(event: 'timeout', listener: () => void): this; + addListener(event: 'unknownProtocol', listener: (socket: tls.TLSSocket) => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + emit(event: 'checkContinue', request: Http2ServerRequest, response: Http2ServerResponse): boolean; + emit(event: 'request', request: Http2ServerRequest, response: Http2ServerResponse): boolean; + emit(event: 'session', session: ServerHttp2Session): boolean; + emit(event: 'sessionError', err: Error): boolean; + emit(event: 'stream', stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): boolean; + emit(event: 'timeout'): boolean; + emit(event: 'unknownProtocol', socket: tls.TLSSocket): boolean; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'checkContinue', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + on(event: 'request', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + on(event: 'session', listener: (session: ServerHttp2Session) => void): this; + on(event: 'sessionError', listener: (err: Error) => void): this; + on(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + on(event: 'timeout', listener: () => void): this; + on(event: 'unknownProtocol', listener: (socket: tls.TLSSocket) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'checkContinue', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + once(event: 'request', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + once(event: 'session', listener: (session: ServerHttp2Session) => void): this; + once(event: 'sessionError', listener: (err: Error) => void): this; + once(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + once(event: 'timeout', listener: () => void): this; + once(event: 'unknownProtocol', listener: (socket: tls.TLSSocket) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'checkContinue', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + prependListener(event: 'request', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + prependListener(event: 'session', listener: (session: ServerHttp2Session) => void): this; + prependListener(event: 'sessionError', listener: (err: Error) => void): this; + prependListener(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + prependListener(event: 'timeout', listener: () => void): this; + prependListener(event: 'unknownProtocol', listener: (socket: tls.TLSSocket) => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'checkContinue', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + prependOnceListener(event: 'request', listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; + prependOnceListener(event: 'session', listener: (session: ServerHttp2Session) => void): this; + prependOnceListener(event: 'sessionError', listener: (err: Error) => void): this; + prependOnceListener(event: 'stream', listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; + prependOnceListener(event: 'timeout', listener: () => void): this; + prependOnceListener(event: 'unknownProtocol', listener: (socket: tls.TLSSocket) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + /** + * A `Http2ServerRequest` object is created by {@link Server} or {@link SecureServer} and passed as the first argument to the `'request'` event. It may be used to access a request status, + * headers, and + * data. + * @since v8.4.0 + */ + export class Http2ServerRequest extends stream.Readable { + constructor(stream: ServerHttp2Stream, headers: IncomingHttpHeaders, options: stream.ReadableOptions, rawHeaders: ReadonlyArray); + /** + * The `request.aborted` property will be `true` if the request has + * been aborted. + * @since v10.1.0 + */ + readonly aborted: boolean; + /** + * The request authority pseudo header field. Because HTTP/2 allows requests + * to set either `:authority` or `host`, this value is derived from`req.headers[':authority']` if present. Otherwise, it is derived from`req.headers['host']`. + * @since v8.4.0 + */ + readonly authority: string; + /** + * See `request.socket`. + * @since v8.4.0 + * @deprecated Since v13.0.0 - Use `socket`. + */ + readonly connection: net.Socket | tls.TLSSocket; + /** + * The `request.complete` property will be `true` if the request has + * been completed, aborted, or destroyed. + * @since v12.10.0 + */ + readonly complete: boolean; + /** + * The request/response headers object. + * + * Key-value pairs of header names and values. Header names are lower-cased. + * + * ```js + * // Prints something like: + * // + * // { 'user-agent': 'curl/7.22.0', + * // host: '127.0.0.1:8000', + * // accept: '*' } + * console.log(request.headers); + * ``` + * + * See `HTTP/2 Headers Object`. + * + * In HTTP/2, the request path, host name, protocol, and method are represented as + * special headers prefixed with the `:` character (e.g. `':path'`). These special + * headers will be included in the `request.headers` object. Care must be taken not + * to inadvertently modify these special headers or errors may occur. For instance, + * removing all headers from the request will cause errors to occur: + * + * ```js + * removeAllHeaders(request.headers); + * assert(request.url); // Fails because the :path header has been removed + * ``` + * @since v8.4.0 + */ + readonly headers: IncomingHttpHeaders; + /** + * In case of server request, the HTTP version sent by the client. In the case of + * client response, the HTTP version of the connected-to server. Returns`'2.0'`. + * + * Also `message.httpVersionMajor` is the first integer and`message.httpVersionMinor` is the second. + * @since v8.4.0 + */ + readonly httpVersion: string; + readonly httpVersionMinor: number; + readonly httpVersionMajor: number; + /** + * The request method as a string. Read-only. Examples: `'GET'`, `'DELETE'`. + * @since v8.4.0 + */ + readonly method: string; + /** + * The raw request/response headers list exactly as they were received. + * + * The keys and values are in the same list. It is _not_ a + * list of tuples. So, the even-numbered offsets are key values, and the + * odd-numbered offsets are the associated values. + * + * Header names are not lowercased, and duplicates are not merged. + * + * ```js + * // Prints something like: + * // + * // [ 'user-agent', + * // 'this is invalid because there can be only one', + * // 'User-Agent', + * // 'curl/7.22.0', + * // 'Host', + * // '127.0.0.1:8000', + * // 'ACCEPT', + * // '*' ] + * console.log(request.rawHeaders); + * ``` + * @since v8.4.0 + */ + readonly rawHeaders: string[]; + /** + * The raw request/response trailer keys and values exactly as they were + * received. Only populated at the `'end'` event. + * @since v8.4.0 + */ + readonly rawTrailers: string[]; + /** + * The request scheme pseudo header field indicating the scheme + * portion of the target URL. + * @since v8.4.0 + */ + readonly scheme: string; + /** + * Returns a `Proxy` object that acts as a `net.Socket` (or `tls.TLSSocket`) but + * applies getters, setters, and methods based on HTTP/2 logic. + * + * `destroyed`, `readable`, and `writable` properties will be retrieved from and + * set on `request.stream`. + * + * `destroy`, `emit`, `end`, `on` and `once` methods will be called on`request.stream`. + * + * `setTimeout` method will be called on `request.stream.session`. + * + * `pause`, `read`, `resume`, and `write` will throw an error with code`ERR_HTTP2_NO_SOCKET_MANIPULATION`. See `Http2Session and Sockets` for + * more information. + * + * All other interactions will be routed directly to the socket. With TLS support, + * use `request.socket.getPeerCertificate()` to obtain the client's + * authentication details. + * @since v8.4.0 + */ + readonly socket: net.Socket | tls.TLSSocket; + /** + * The `Http2Stream` object backing the request. + * @since v8.4.0 + */ + readonly stream: ServerHttp2Stream; + /** + * The request/response trailers object. Only populated at the `'end'` event. + * @since v8.4.0 + */ + readonly trailers: IncomingHttpHeaders; + /** + * Request URL string. This contains only the URL that is present in the actual + * HTTP request. If the request is: + * + * ```http + * GET /status?name=ryan HTTP/1.1 + * Accept: text/plain + * ``` + * + * Then `request.url` will be: + * + * ```js + * '/status?name=ryan' + * ``` + * + * To parse the url into its parts, `new URL()` can be used: + * + * ```console + * $ node + * > new URL('/status?name=ryan', 'http://example.com') + * URL { + * href: 'http://example.com/status?name=ryan', + * origin: 'http://example.com', + * protocol: 'http:', + * username: '', + * password: '', + * host: 'example.com', + * hostname: 'example.com', + * port: '', + * pathname: '/status', + * search: '?name=ryan', + * searchParams: URLSearchParams { 'name' => 'ryan' }, + * hash: '' + * } + * ``` + * @since v8.4.0 + */ + readonly url: string; + /** + * Sets the `Http2Stream`'s timeout value to `msecs`. If a callback is + * provided, then it is added as a listener on the `'timeout'` event on + * the response object. + * + * If no `'timeout'` listener is added to the request, the response, or + * the server, then `Http2Stream` s are destroyed when they time out. If a + * handler is assigned to the request, the response, or the server's `'timeout'`events, timed out sockets must be handled explicitly. + * @since v8.4.0 + */ + setTimeout(msecs: number, callback?: () => void): void; + read(size?: number): Buffer | string | null; + addListener(event: 'aborted', listener: (hadError: boolean, code: number) => void): this; + addListener(event: 'close', listener: () => void): this; + addListener(event: 'data', listener: (chunk: Buffer | string) => void): this; + addListener(event: 'end', listener: () => void): this; + addListener(event: 'readable', listener: () => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + emit(event: 'aborted', hadError: boolean, code: number): boolean; + emit(event: 'close'): boolean; + emit(event: 'data', chunk: Buffer | string): boolean; + emit(event: 'end'): boolean; + emit(event: 'readable'): boolean; + emit(event: 'error', err: Error): boolean; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'aborted', listener: (hadError: boolean, code: number) => void): this; + on(event: 'close', listener: () => void): this; + on(event: 'data', listener: (chunk: Buffer | string) => void): this; + on(event: 'end', listener: () => void): this; + on(event: 'readable', listener: () => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'aborted', listener: (hadError: boolean, code: number) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'data', listener: (chunk: Buffer | string) => void): this; + once(event: 'end', listener: () => void): this; + once(event: 'readable', listener: () => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'aborted', listener: (hadError: boolean, code: number) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'data', listener: (chunk: Buffer | string) => void): this; + prependListener(event: 'end', listener: () => void): this; + prependListener(event: 'readable', listener: () => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'aborted', listener: (hadError: boolean, code: number) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'data', listener: (chunk: Buffer | string) => void): this; + prependOnceListener(event: 'end', listener: () => void): this; + prependOnceListener(event: 'readable', listener: () => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + /** + * This object is created internally by an HTTP server, not by the user. It is + * passed as the second parameter to the `'request'` event. + * @since v8.4.0 + */ + export class Http2ServerResponse extends stream.Writable { + constructor(stream: ServerHttp2Stream); + /** + * See `response.socket`. + * @since v8.4.0 + * @deprecated Since v13.0.0 - Use `socket`. + */ + readonly connection: net.Socket | tls.TLSSocket; + /** + * Boolean value that indicates whether the response has completed. Starts + * as `false`. After `response.end()` executes, the value will be `true`. + * @since v8.4.0 + * @deprecated Since v13.4.0,v12.16.0 - Use `writableEnded`. + */ + readonly finished: boolean; + /** + * True if headers were sent, false otherwise (read-only). + * @since v8.4.0 + */ + readonly headersSent: boolean; + /** + * A reference to the original HTTP2 request object. + * @since v15.7.0 + */ + readonly req: Http2ServerRequest; + /** + * Returns a `Proxy` object that acts as a `net.Socket` (or `tls.TLSSocket`) but + * applies getters, setters, and methods based on HTTP/2 logic. + * + * `destroyed`, `readable`, and `writable` properties will be retrieved from and + * set on `response.stream`. + * + * `destroy`, `emit`, `end`, `on` and `once` methods will be called on`response.stream`. + * + * `setTimeout` method will be called on `response.stream.session`. + * + * `pause`, `read`, `resume`, and `write` will throw an error with code`ERR_HTTP2_NO_SOCKET_MANIPULATION`. See `Http2Session and Sockets` for + * more information. + * + * All other interactions will be routed directly to the socket. + * + * ```js + * const http2 = require('http2'); + * const server = http2.createServer((req, res) => { + * const ip = req.socket.remoteAddress; + * const port = req.socket.remotePort; + * res.end(`Your IP address is ${ip} and your source port is ${port}.`); + * }).listen(3000); + * ``` + * @since v8.4.0 + */ + readonly socket: net.Socket | tls.TLSSocket; + /** + * The `Http2Stream` object backing the response. + * @since v8.4.0 + */ + readonly stream: ServerHttp2Stream; + /** + * When true, the Date header will be automatically generated and sent in + * the response if it is not already present in the headers. Defaults to true. + * + * This should only be disabled for testing; HTTP requires the Date header + * in responses. + * @since v8.4.0 + */ + sendDate: boolean; + /** + * When using implicit headers (not calling `response.writeHead()` explicitly), + * this property controls the status code that will be sent to the client when + * the headers get flushed. + * + * ```js + * response.statusCode = 404; + * ``` + * + * After response header was sent to the client, this property indicates the + * status code which was sent out. + * @since v8.4.0 + */ + statusCode: number; + /** + * Status message is not supported by HTTP/2 (RFC 7540 8.1.2.4). It returns + * an empty string. + * @since v8.4.0 + */ + statusMessage: ''; + /** + * This method adds HTTP trailing headers (a header but at the end of the + * message) to the response. + * + * Attempting to set a header field name or value that contains invalid characters + * will result in a `TypeError` being thrown. + * @since v8.4.0 + */ + addTrailers(trailers: OutgoingHttpHeaders): void; + /** + * This method signals to the server that all of the response headers and body + * have been sent; that server should consider this message complete. + * The method, `response.end()`, MUST be called on each response. + * + * If `data` is specified, it is equivalent to calling `response.write(data, encoding)` followed by `response.end(callback)`. + * + * If `callback` is specified, it will be called when the response stream + * is finished. + * @since v8.4.0 + */ + end(callback?: () => void): void; + end(data: string | Uint8Array, callback?: () => void): void; + end(data: string | Uint8Array, encoding: BufferEncoding, callback?: () => void): void; + /** + * Reads out a header that has already been queued but not sent to the client. + * The name is case-insensitive. + * + * ```js + * const contentType = response.getHeader('content-type'); + * ``` + * @since v8.4.0 + */ + getHeader(name: string): string; + /** + * Returns an array containing the unique names of the current outgoing headers. + * All header names are lowercase. + * + * ```js + * response.setHeader('Foo', 'bar'); + * response.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']); + * + * const headerNames = response.getHeaderNames(); + * // headerNames === ['foo', 'set-cookie'] + * ``` + * @since v8.4.0 + */ + getHeaderNames(): string[]; + /** + * Returns a shallow copy of the current outgoing headers. Since a shallow copy + * is used, array values may be mutated without additional calls to various + * header-related http module methods. The keys of the returned object are the + * header names and the values are the respective header values. All header names + * are lowercase. + * + * The object returned by the `response.getHeaders()` method _does not_prototypically inherit from the JavaScript `Object`. This means that typical`Object` methods such as `obj.toString()`, + * `obj.hasOwnProperty()`, and others + * are not defined and _will not work_. + * + * ```js + * response.setHeader('Foo', 'bar'); + * response.setHeader('Set-Cookie', ['foo=bar', 'bar=baz']); + * + * const headers = response.getHeaders(); + * // headers === { foo: 'bar', 'set-cookie': ['foo=bar', 'bar=baz'] } + * ``` + * @since v8.4.0 + */ + getHeaders(): OutgoingHttpHeaders; + /** + * Returns `true` if the header identified by `name` is currently set in the + * outgoing headers. The header name matching is case-insensitive. + * + * ```js + * const hasContentType = response.hasHeader('content-type'); + * ``` + * @since v8.4.0 + */ + hasHeader(name: string): boolean; + /** + * Removes a header that has been queued for implicit sending. + * + * ```js + * response.removeHeader('Content-Encoding'); + * ``` + * @since v8.4.0 + */ + removeHeader(name: string): void; + /** + * Sets a single header value for implicit headers. If this header already exists + * in the to-be-sent headers, its value will be replaced. Use an array of strings + * here to send multiple headers with the same name. + * + * ```js + * response.setHeader('Content-Type', 'text/html; charset=utf-8'); + * ``` + * + * or + * + * ```js + * response.setHeader('Set-Cookie', ['type=ninja', 'language=javascript']); + * ``` + * + * Attempting to set a header field name or value that contains invalid characters + * will result in a `TypeError` being thrown. + * + * When headers have been set with `response.setHeader()`, they will be merged + * with any headers passed to `response.writeHead()`, with the headers passed + * to `response.writeHead()` given precedence. + * + * ```js + * // Returns content-type = text/plain + * const server = http2.createServer((req, res) => { + * res.setHeader('Content-Type', 'text/html; charset=utf-8'); + * res.setHeader('X-Foo', 'bar'); + * res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' }); + * res.end('ok'); + * }); + * ``` + * @since v8.4.0 + */ + setHeader(name: string, value: number | string | ReadonlyArray): void; + /** + * Sets the `Http2Stream`'s timeout value to `msecs`. If a callback is + * provided, then it is added as a listener on the `'timeout'` event on + * the response object. + * + * If no `'timeout'` listener is added to the request, the response, or + * the server, then `Http2Stream` s are destroyed when they time out. If a + * handler is assigned to the request, the response, or the server's `'timeout'`events, timed out sockets must be handled explicitly. + * @since v8.4.0 + */ + setTimeout(msecs: number, callback?: () => void): void; + /** + * If this method is called and `response.writeHead()` has not been called, + * it will switch to implicit header mode and flush the implicit headers. + * + * This sends a chunk of the response body. This method may + * be called multiple times to provide successive parts of the body. + * + * In the `http` module, the response body is omitted when the + * request is a HEAD request. Similarly, the `204` and `304` responses_must not_ include a message body. + * + * `chunk` can be a string or a buffer. If `chunk` is a string, + * the second parameter specifies how to encode it into a byte stream. + * By default the `encoding` is `'utf8'`. `callback` will be called when this chunk + * of data is flushed. + * + * This is the raw HTTP body and has nothing to do with higher-level multi-part + * body encodings that may be used. + * + * The first time `response.write()` is called, it will send the buffered + * header information and the first chunk of the body to the client. The second + * time `response.write()` is called, Node.js assumes data will be streamed, + * and sends the new data separately. That is, the response is buffered up to the + * first chunk of the body. + * + * Returns `true` if the entire data was flushed successfully to the kernel + * buffer. Returns `false` if all or part of the data was queued in user memory.`'drain'` will be emitted when the buffer is free again. + * @since v8.4.0 + */ + write(chunk: string | Uint8Array, callback?: (err: Error) => void): boolean; + write(chunk: string | Uint8Array, encoding: BufferEncoding, callback?: (err: Error) => void): boolean; + /** + * Sends a status `100 Continue` to the client, indicating that the request body + * should be sent. See the `'checkContinue'` event on `Http2Server` and`Http2SecureServer`. + * @since v8.4.0 + */ + writeContinue(): void; + /** + * Sends a response header to the request. The status code is a 3-digit HTTP + * status code, like `404`. The last argument, `headers`, are the response headers. + * + * Returns a reference to the `Http2ServerResponse`, so that calls can be chained. + * + * For compatibility with `HTTP/1`, a human-readable `statusMessage` may be + * passed as the second argument. However, because the `statusMessage` has no + * meaning within HTTP/2, the argument will have no effect and a process warning + * will be emitted. + * + * ```js + * const body = 'hello world'; + * response.writeHead(200, { + * 'Content-Length': Buffer.byteLength(body), + * 'Content-Type': 'text/plain; charset=utf-8', + * }); + * ``` + * + * `Content-Length` is given in bytes not characters. The`Buffer.byteLength()` API may be used to determine the number of bytes in a + * given encoding. On outbound messages, Node.js does not check if Content-Length + * and the length of the body being transmitted are equal or not. However, when + * receiving messages, Node.js will automatically reject messages when the`Content-Length` does not match the actual payload size. + * + * This method may be called at most one time on a message before `response.end()` is called. + * + * If `response.write()` or `response.end()` are called before calling + * this, the implicit/mutable headers will be calculated and call this function. + * + * When headers have been set with `response.setHeader()`, they will be merged + * with any headers passed to `response.writeHead()`, with the headers passed + * to `response.writeHead()` given precedence. + * + * ```js + * // Returns content-type = text/plain + * const server = http2.createServer((req, res) => { + * res.setHeader('Content-Type', 'text/html; charset=utf-8'); + * res.setHeader('X-Foo', 'bar'); + * res.writeHead(200, { 'Content-Type': 'text/plain; charset=utf-8' }); + * res.end('ok'); + * }); + * ``` + * + * Attempting to set a header field name or value that contains invalid characters + * will result in a `TypeError` being thrown. + * @since v8.4.0 + */ + writeHead(statusCode: number, headers?: OutgoingHttpHeaders): this; + writeHead(statusCode: number, statusMessage: string, headers?: OutgoingHttpHeaders): this; + /** + * Call `http2stream.pushStream()` with the given headers, and wrap the + * given `Http2Stream` on a newly created `Http2ServerResponse` as the callback + * parameter if successful. When `Http2ServerRequest` is closed, the callback is + * called with an error `ERR_HTTP2_INVALID_STREAM`. + * @since v8.4.0 + * @param headers An object describing the headers + * @param callback Called once `http2stream.pushStream()` is finished, or either when the attempt to create the pushed `Http2Stream` has failed or has been rejected, or the state of + * `Http2ServerRequest` is closed prior to calling the `http2stream.pushStream()` method + */ + createPushResponse(headers: OutgoingHttpHeaders, callback: (err: Error | null, res: Http2ServerResponse) => void): void; + addListener(event: 'close', listener: () => void): this; + addListener(event: 'drain', listener: () => void): this; + addListener(event: 'error', listener: (error: Error) => void): this; + addListener(event: 'finish', listener: () => void): this; + addListener(event: 'pipe', listener: (src: stream.Readable) => void): this; + addListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + emit(event: 'close'): boolean; + emit(event: 'drain'): boolean; + emit(event: 'error', error: Error): boolean; + emit(event: 'finish'): boolean; + emit(event: 'pipe', src: stream.Readable): boolean; + emit(event: 'unpipe', src: stream.Readable): boolean; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'close', listener: () => void): this; + on(event: 'drain', listener: () => void): this; + on(event: 'error', listener: (error: Error) => void): this; + on(event: 'finish', listener: () => void): this; + on(event: 'pipe', listener: (src: stream.Readable) => void): this; + on(event: 'unpipe', listener: (src: stream.Readable) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'drain', listener: () => void): this; + once(event: 'error', listener: (error: Error) => void): this; + once(event: 'finish', listener: () => void): this; + once(event: 'pipe', listener: (src: stream.Readable) => void): this; + once(event: 'unpipe', listener: (src: stream.Readable) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'drain', listener: () => void): this; + prependListener(event: 'error', listener: (error: Error) => void): this; + prependListener(event: 'finish', listener: () => void): this; + prependListener(event: 'pipe', listener: (src: stream.Readable) => void): this; + prependListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'drain', listener: () => void): this; + prependOnceListener(event: 'error', listener: (error: Error) => void): this; + prependOnceListener(event: 'finish', listener: () => void): this; + prependOnceListener(event: 'pipe', listener: (src: stream.Readable) => void): this; + prependOnceListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + export namespace constants { + const NGHTTP2_SESSION_SERVER: number; + const NGHTTP2_SESSION_CLIENT: number; + const NGHTTP2_STREAM_STATE_IDLE: number; + const NGHTTP2_STREAM_STATE_OPEN: number; + const NGHTTP2_STREAM_STATE_RESERVED_LOCAL: number; + const NGHTTP2_STREAM_STATE_RESERVED_REMOTE: number; + const NGHTTP2_STREAM_STATE_HALF_CLOSED_LOCAL: number; + const NGHTTP2_STREAM_STATE_HALF_CLOSED_REMOTE: number; + const NGHTTP2_STREAM_STATE_CLOSED: number; + const NGHTTP2_NO_ERROR: number; + const NGHTTP2_PROTOCOL_ERROR: number; + const NGHTTP2_INTERNAL_ERROR: number; + const NGHTTP2_FLOW_CONTROL_ERROR: number; + const NGHTTP2_SETTINGS_TIMEOUT: number; + const NGHTTP2_STREAM_CLOSED: number; + const NGHTTP2_FRAME_SIZE_ERROR: number; + const NGHTTP2_REFUSED_STREAM: number; + const NGHTTP2_CANCEL: number; + const NGHTTP2_COMPRESSION_ERROR: number; + const NGHTTP2_CONNECT_ERROR: number; + const NGHTTP2_ENHANCE_YOUR_CALM: number; + const NGHTTP2_INADEQUATE_SECURITY: number; + const NGHTTP2_HTTP_1_1_REQUIRED: number; + const NGHTTP2_ERR_FRAME_SIZE_ERROR: number; + const NGHTTP2_FLAG_NONE: number; + const NGHTTP2_FLAG_END_STREAM: number; + const NGHTTP2_FLAG_END_HEADERS: number; + const NGHTTP2_FLAG_ACK: number; + const NGHTTP2_FLAG_PADDED: number; + const NGHTTP2_FLAG_PRIORITY: number; + const DEFAULT_SETTINGS_HEADER_TABLE_SIZE: number; + const DEFAULT_SETTINGS_ENABLE_PUSH: number; + const DEFAULT_SETTINGS_INITIAL_WINDOW_SIZE: number; + const DEFAULT_SETTINGS_MAX_FRAME_SIZE: number; + const MAX_MAX_FRAME_SIZE: number; + const MIN_MAX_FRAME_SIZE: number; + const MAX_INITIAL_WINDOW_SIZE: number; + const NGHTTP2_DEFAULT_WEIGHT: number; + const NGHTTP2_SETTINGS_HEADER_TABLE_SIZE: number; + const NGHTTP2_SETTINGS_ENABLE_PUSH: number; + const NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS: number; + const NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE: number; + const NGHTTP2_SETTINGS_MAX_FRAME_SIZE: number; + const NGHTTP2_SETTINGS_MAX_HEADER_LIST_SIZE: number; + const PADDING_STRATEGY_NONE: number; + const PADDING_STRATEGY_MAX: number; + const PADDING_STRATEGY_CALLBACK: number; + const HTTP2_HEADER_STATUS: string; + const HTTP2_HEADER_METHOD: string; + const HTTP2_HEADER_AUTHORITY: string; + const HTTP2_HEADER_SCHEME: string; + const HTTP2_HEADER_PATH: string; + const HTTP2_HEADER_ACCEPT_CHARSET: string; + const HTTP2_HEADER_ACCEPT_ENCODING: string; + const HTTP2_HEADER_ACCEPT_LANGUAGE: string; + const HTTP2_HEADER_ACCEPT_RANGES: string; + const HTTP2_HEADER_ACCEPT: string; + const HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN: string; + const HTTP2_HEADER_AGE: string; + const HTTP2_HEADER_ALLOW: string; + const HTTP2_HEADER_AUTHORIZATION: string; + const HTTP2_HEADER_CACHE_CONTROL: string; + const HTTP2_HEADER_CONNECTION: string; + const HTTP2_HEADER_CONTENT_DISPOSITION: string; + const HTTP2_HEADER_CONTENT_ENCODING: string; + const HTTP2_HEADER_CONTENT_LANGUAGE: string; + const HTTP2_HEADER_CONTENT_LENGTH: string; + const HTTP2_HEADER_CONTENT_LOCATION: string; + const HTTP2_HEADER_CONTENT_MD5: string; + const HTTP2_HEADER_CONTENT_RANGE: string; + const HTTP2_HEADER_CONTENT_TYPE: string; + const HTTP2_HEADER_COOKIE: string; + const HTTP2_HEADER_DATE: string; + const HTTP2_HEADER_ETAG: string; + const HTTP2_HEADER_EXPECT: string; + const HTTP2_HEADER_EXPIRES: string; + const HTTP2_HEADER_FROM: string; + const HTTP2_HEADER_HOST: string; + const HTTP2_HEADER_IF_MATCH: string; + const HTTP2_HEADER_IF_MODIFIED_SINCE: string; + const HTTP2_HEADER_IF_NONE_MATCH: string; + const HTTP2_HEADER_IF_RANGE: string; + const HTTP2_HEADER_IF_UNMODIFIED_SINCE: string; + const HTTP2_HEADER_LAST_MODIFIED: string; + const HTTP2_HEADER_LINK: string; + const HTTP2_HEADER_LOCATION: string; + const HTTP2_HEADER_MAX_FORWARDS: string; + const HTTP2_HEADER_PREFER: string; + const HTTP2_HEADER_PROXY_AUTHENTICATE: string; + const HTTP2_HEADER_PROXY_AUTHORIZATION: string; + const HTTP2_HEADER_RANGE: string; + const HTTP2_HEADER_REFERER: string; + const HTTP2_HEADER_REFRESH: string; + const HTTP2_HEADER_RETRY_AFTER: string; + const HTTP2_HEADER_SERVER: string; + const HTTP2_HEADER_SET_COOKIE: string; + const HTTP2_HEADER_STRICT_TRANSPORT_SECURITY: string; + const HTTP2_HEADER_TRANSFER_ENCODING: string; + const HTTP2_HEADER_TE: string; + const HTTP2_HEADER_UPGRADE: string; + const HTTP2_HEADER_USER_AGENT: string; + const HTTP2_HEADER_VARY: string; + const HTTP2_HEADER_VIA: string; + const HTTP2_HEADER_WWW_AUTHENTICATE: string; + const HTTP2_HEADER_HTTP2_SETTINGS: string; + const HTTP2_HEADER_KEEP_ALIVE: string; + const HTTP2_HEADER_PROXY_CONNECTION: string; + const HTTP2_METHOD_ACL: string; + const HTTP2_METHOD_BASELINE_CONTROL: string; + const HTTP2_METHOD_BIND: string; + const HTTP2_METHOD_CHECKIN: string; + const HTTP2_METHOD_CHECKOUT: string; + const HTTP2_METHOD_CONNECT: string; + const HTTP2_METHOD_COPY: string; + const HTTP2_METHOD_DELETE: string; + const HTTP2_METHOD_GET: string; + const HTTP2_METHOD_HEAD: string; + const HTTP2_METHOD_LABEL: string; + const HTTP2_METHOD_LINK: string; + const HTTP2_METHOD_LOCK: string; + const HTTP2_METHOD_MERGE: string; + const HTTP2_METHOD_MKACTIVITY: string; + const HTTP2_METHOD_MKCALENDAR: string; + const HTTP2_METHOD_MKCOL: string; + const HTTP2_METHOD_MKREDIRECTREF: string; + const HTTP2_METHOD_MKWORKSPACE: string; + const HTTP2_METHOD_MOVE: string; + const HTTP2_METHOD_OPTIONS: string; + const HTTP2_METHOD_ORDERPATCH: string; + const HTTP2_METHOD_PATCH: string; + const HTTP2_METHOD_POST: string; + const HTTP2_METHOD_PRI: string; + const HTTP2_METHOD_PROPFIND: string; + const HTTP2_METHOD_PROPPATCH: string; + const HTTP2_METHOD_PUT: string; + const HTTP2_METHOD_REBIND: string; + const HTTP2_METHOD_REPORT: string; + const HTTP2_METHOD_SEARCH: string; + const HTTP2_METHOD_TRACE: string; + const HTTP2_METHOD_UNBIND: string; + const HTTP2_METHOD_UNCHECKOUT: string; + const HTTP2_METHOD_UNLINK: string; + const HTTP2_METHOD_UNLOCK: string; + const HTTP2_METHOD_UPDATE: string; + const HTTP2_METHOD_UPDATEREDIRECTREF: string; + const HTTP2_METHOD_VERSION_CONTROL: string; + const HTTP_STATUS_CONTINUE: number; + const HTTP_STATUS_SWITCHING_PROTOCOLS: number; + const HTTP_STATUS_PROCESSING: number; + const HTTP_STATUS_OK: number; + const HTTP_STATUS_CREATED: number; + const HTTP_STATUS_ACCEPTED: number; + const HTTP_STATUS_NON_AUTHORITATIVE_INFORMATION: number; + const HTTP_STATUS_NO_CONTENT: number; + const HTTP_STATUS_RESET_CONTENT: number; + const HTTP_STATUS_PARTIAL_CONTENT: number; + const HTTP_STATUS_MULTI_STATUS: number; + const HTTP_STATUS_ALREADY_REPORTED: number; + const HTTP_STATUS_IM_USED: number; + const HTTP_STATUS_MULTIPLE_CHOICES: number; + const HTTP_STATUS_MOVED_PERMANENTLY: number; + const HTTP_STATUS_FOUND: number; + const HTTP_STATUS_SEE_OTHER: number; + const HTTP_STATUS_NOT_MODIFIED: number; + const HTTP_STATUS_USE_PROXY: number; + const HTTP_STATUS_TEMPORARY_REDIRECT: number; + const HTTP_STATUS_PERMANENT_REDIRECT: number; + const HTTP_STATUS_BAD_REQUEST: number; + const HTTP_STATUS_UNAUTHORIZED: number; + const HTTP_STATUS_PAYMENT_REQUIRED: number; + const HTTP_STATUS_FORBIDDEN: number; + const HTTP_STATUS_NOT_FOUND: number; + const HTTP_STATUS_METHOD_NOT_ALLOWED: number; + const HTTP_STATUS_NOT_ACCEPTABLE: number; + const HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED: number; + const HTTP_STATUS_REQUEST_TIMEOUT: number; + const HTTP_STATUS_CONFLICT: number; + const HTTP_STATUS_GONE: number; + const HTTP_STATUS_LENGTH_REQUIRED: number; + const HTTP_STATUS_PRECONDITION_FAILED: number; + const HTTP_STATUS_PAYLOAD_TOO_LARGE: number; + const HTTP_STATUS_URI_TOO_LONG: number; + const HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE: number; + const HTTP_STATUS_RANGE_NOT_SATISFIABLE: number; + const HTTP_STATUS_EXPECTATION_FAILED: number; + const HTTP_STATUS_TEAPOT: number; + const HTTP_STATUS_MISDIRECTED_REQUEST: number; + const HTTP_STATUS_UNPROCESSABLE_ENTITY: number; + const HTTP_STATUS_LOCKED: number; + const HTTP_STATUS_FAILED_DEPENDENCY: number; + const HTTP_STATUS_UNORDERED_COLLECTION: number; + const HTTP_STATUS_UPGRADE_REQUIRED: number; + const HTTP_STATUS_PRECONDITION_REQUIRED: number; + const HTTP_STATUS_TOO_MANY_REQUESTS: number; + const HTTP_STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE: number; + const HTTP_STATUS_UNAVAILABLE_FOR_LEGAL_REASONS: number; + const HTTP_STATUS_INTERNAL_SERVER_ERROR: number; + const HTTP_STATUS_NOT_IMPLEMENTED: number; + const HTTP_STATUS_BAD_GATEWAY: number; + const HTTP_STATUS_SERVICE_UNAVAILABLE: number; + const HTTP_STATUS_GATEWAY_TIMEOUT: number; + const HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED: number; + const HTTP_STATUS_VARIANT_ALSO_NEGOTIATES: number; + const HTTP_STATUS_INSUFFICIENT_STORAGE: number; + const HTTP_STATUS_LOOP_DETECTED: number; + const HTTP_STATUS_BANDWIDTH_LIMIT_EXCEEDED: number; + const HTTP_STATUS_NOT_EXTENDED: number; + const HTTP_STATUS_NETWORK_AUTHENTICATION_REQUIRED: number; + } + /** + * This symbol can be set as a property on the HTTP/2 headers object with + * an array value in order to provide a list of headers considered sensitive. + */ + export const sensitiveHeaders: symbol; + /** + * Returns an object containing the default settings for an `Http2Session`instance. This method returns a new object instance every time it is called + * so instances returned may be safely modified for use. + * @since v8.4.0 + */ + export function getDefaultSettings(): Settings; + /** + * Returns a `Buffer` instance containing serialized representation of the given + * HTTP/2 settings as specified in the [HTTP/2](https://tools.ietf.org/html/rfc7540) specification. This is intended + * for use with the `HTTP2-Settings` header field. + * + * ```js + * const http2 = require('http2'); + * + * const packed = http2.getPackedSettings({ enablePush: false }); + * + * console.log(packed.toString('base64')); + * // Prints: AAIAAAAA + * ``` + * @since v8.4.0 + */ + export function getPackedSettings(settings: Settings): Buffer; + /** + * Returns a `HTTP/2 Settings Object` containing the deserialized settings from + * the given `Buffer` as generated by `http2.getPackedSettings()`. + * @since v8.4.0 + * @param buf The packed settings. + */ + export function getUnpackedSettings(buf: Uint8Array): Settings; + /** + * Returns a `net.Server` instance that creates and manages `Http2Session`instances. + * + * Since there are no browsers known that support [unencrypted HTTP/2](https://http2.github.io/faq/#does-http2-require-encryption), the use of {@link createSecureServer} is necessary when + * communicating + * with browser clients. + * + * ```js + * const http2 = require('http2'); + * + * // Create an unencrypted HTTP/2 server. + * // Since there are no browsers known that support + * // unencrypted HTTP/2, the use of `http2.createSecureServer()` + * // is necessary when communicating with browser clients. + * const server = http2.createServer(); + * + * server.on('stream', (stream, headers) => { + * stream.respond({ + * 'content-type': 'text/html; charset=utf-8', + * ':status': 200 + * }); + * stream.end('

Hello World

'); + * }); + * + * server.listen(80); + * ``` + * @since v8.4.0 + * @param onRequestHandler See `Compatibility API` + */ + export function createServer(onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void): Http2Server; + export function createServer(options: ServerOptions, onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void): Http2Server; + /** + * Returns a `tls.Server` instance that creates and manages `Http2Session`instances. + * + * ```js + * const http2 = require('http2'); + * const fs = require('fs'); + * + * const options = { + * key: fs.readFileSync('server-key.pem'), + * cert: fs.readFileSync('server-cert.pem') + * }; + * + * // Create a secure HTTP/2 server + * const server = http2.createSecureServer(options); + * + * server.on('stream', (stream, headers) => { + * stream.respond({ + * 'content-type': 'text/html; charset=utf-8', + * ':status': 200 + * }); + * stream.end('

Hello World

'); + * }); + * + * server.listen(80); + * ``` + * @since v8.4.0 + * @param onRequestHandler See `Compatibility API` + */ + export function createSecureServer(onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void): Http2SecureServer; + export function createSecureServer(options: SecureServerOptions, onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void): Http2SecureServer; + /** + * Returns a `ClientHttp2Session` instance. + * + * ```js + * const http2 = require('http2'); + * const client = http2.connect('https://localhost:1234'); + * + * // Use the client + * + * client.close(); + * ``` + * @since v8.4.0 + * @param authority The remote HTTP/2 server to connect to. This must be in the form of a minimal, valid URL with the `http://` or `https://` prefix, host name, and IP port (if a non-default port + * is used). Userinfo (user ID and password), path, querystring, and fragment details in the URL will be ignored. + * @param listener Will be registered as a one-time listener of the {@link 'connect'} event. + */ + export function connect(authority: string | url.URL, listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): ClientHttp2Session; + export function connect( + authority: string | url.URL, + options?: ClientSessionOptions | SecureClientSessionOptions, + listener?: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void + ): ClientHttp2Session; +} +declare module 'node:http2' { + export * from 'http2'; +} diff --git a/node_modules/@types/node/https.d.ts b/node_modules/@types/node/https.d.ts new file mode 100755 index 00000000..194a3ad1 --- /dev/null +++ b/node_modules/@types/node/https.d.ts @@ -0,0 +1,391 @@ +/** + * HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a + * separate module. + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/https.js) + */ +declare module 'https' { + import { Duplex } from 'node:stream'; + import * as tls from 'node:tls'; + import * as http from 'node:http'; + import { URL } from 'node:url'; + type ServerOptions = tls.SecureContextOptions & tls.TlsOptions & http.ServerOptions; + type RequestOptions = http.RequestOptions & + tls.SecureContextOptions & { + rejectUnauthorized?: boolean | undefined; // Defaults to true + servername?: string | undefined; // SNI TLS Extension + }; + interface AgentOptions extends http.AgentOptions, tls.ConnectionOptions { + rejectUnauthorized?: boolean | undefined; + maxCachedSessions?: number | undefined; + } + /** + * An `Agent` object for HTTPS similar to `http.Agent`. See {@link request} for more information. + * @since v0.4.5 + */ + class Agent extends http.Agent { + constructor(options?: AgentOptions); + options: AgentOptions; + } + interface Server extends http.Server {} + /** + * See `http.Server` for more information. + * @since v0.3.4 + */ + class Server extends tls.Server { + constructor(requestListener?: http.RequestListener); + constructor(options: ServerOptions, requestListener?: http.RequestListener); + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'keylog', listener: (line: Buffer, tlsSocket: tls.TLSSocket) => void): this; + addListener(event: 'newSession', listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; + addListener(event: 'OCSPRequest', listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; + addListener(event: 'resumeSession', listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; + addListener(event: 'secureConnection', listener: (tlsSocket: tls.TLSSocket) => void): this; + addListener(event: 'tlsClientError', listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this; + addListener(event: 'close', listener: () => void): this; + addListener(event: 'connection', listener: (socket: Duplex) => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'listening', listener: () => void): this; + addListener(event: 'checkContinue', listener: http.RequestListener): this; + addListener(event: 'checkExpectation', listener: http.RequestListener): this; + addListener(event: 'clientError', listener: (err: Error, socket: Duplex) => void): this; + addListener(event: 'connect', listener: (req: http.IncomingMessage, socket: Duplex, head: Buffer) => void): this; + addListener(event: 'request', listener: http.RequestListener): this; + addListener(event: 'upgrade', listener: (req: http.IncomingMessage, socket: Duplex, head: Buffer) => void): this; + emit(event: string, ...args: any[]): boolean; + emit(event: 'keylog', line: Buffer, tlsSocket: tls.TLSSocket): boolean; + emit(event: 'newSession', sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void): boolean; + emit(event: 'OCSPRequest', certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void): boolean; + emit(event: 'resumeSession', sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void): boolean; + emit(event: 'secureConnection', tlsSocket: tls.TLSSocket): boolean; + emit(event: 'tlsClientError', err: Error, tlsSocket: tls.TLSSocket): boolean; + emit(event: 'close'): boolean; + emit(event: 'connection', socket: Duplex): boolean; + emit(event: 'error', err: Error): boolean; + emit(event: 'listening'): boolean; + emit(event: 'checkContinue', req: http.IncomingMessage, res: http.ServerResponse): boolean; + emit(event: 'checkExpectation', req: http.IncomingMessage, res: http.ServerResponse): boolean; + emit(event: 'clientError', err: Error, socket: Duplex): boolean; + emit(event: 'connect', req: http.IncomingMessage, socket: Duplex, head: Buffer): boolean; + emit(event: 'request', req: http.IncomingMessage, res: http.ServerResponse): boolean; + emit(event: 'upgrade', req: http.IncomingMessage, socket: Duplex, head: Buffer): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'keylog', listener: (line: Buffer, tlsSocket: tls.TLSSocket) => void): this; + on(event: 'newSession', listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; + on(event: 'OCSPRequest', listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; + on(event: 'resumeSession', listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; + on(event: 'secureConnection', listener: (tlsSocket: tls.TLSSocket) => void): this; + on(event: 'tlsClientError', listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this; + on(event: 'close', listener: () => void): this; + on(event: 'connection', listener: (socket: Duplex) => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'listening', listener: () => void): this; + on(event: 'checkContinue', listener: http.RequestListener): this; + on(event: 'checkExpectation', listener: http.RequestListener): this; + on(event: 'clientError', listener: (err: Error, socket: Duplex) => void): this; + on(event: 'connect', listener: (req: http.IncomingMessage, socket: Duplex, head: Buffer) => void): this; + on(event: 'request', listener: http.RequestListener): this; + on(event: 'upgrade', listener: (req: http.IncomingMessage, socket: Duplex, head: Buffer) => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'keylog', listener: (line: Buffer, tlsSocket: tls.TLSSocket) => void): this; + once(event: 'newSession', listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; + once(event: 'OCSPRequest', listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; + once(event: 'resumeSession', listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; + once(event: 'secureConnection', listener: (tlsSocket: tls.TLSSocket) => void): this; + once(event: 'tlsClientError', listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'connection', listener: (socket: Duplex) => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'listening', listener: () => void): this; + once(event: 'checkContinue', listener: http.RequestListener): this; + once(event: 'checkExpectation', listener: http.RequestListener): this; + once(event: 'clientError', listener: (err: Error, socket: Duplex) => void): this; + once(event: 'connect', listener: (req: http.IncomingMessage, socket: Duplex, head: Buffer) => void): this; + once(event: 'request', listener: http.RequestListener): this; + once(event: 'upgrade', listener: (req: http.IncomingMessage, socket: Duplex, head: Buffer) => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'keylog', listener: (line: Buffer, tlsSocket: tls.TLSSocket) => void): this; + prependListener(event: 'newSession', listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; + prependListener(event: 'OCSPRequest', listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; + prependListener(event: 'resumeSession', listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; + prependListener(event: 'secureConnection', listener: (tlsSocket: tls.TLSSocket) => void): this; + prependListener(event: 'tlsClientError', listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'connection', listener: (socket: Duplex) => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'listening', listener: () => void): this; + prependListener(event: 'checkContinue', listener: http.RequestListener): this; + prependListener(event: 'checkExpectation', listener: http.RequestListener): this; + prependListener(event: 'clientError', listener: (err: Error, socket: Duplex) => void): this; + prependListener(event: 'connect', listener: (req: http.IncomingMessage, socket: Duplex, head: Buffer) => void): this; + prependListener(event: 'request', listener: http.RequestListener): this; + prependListener(event: 'upgrade', listener: (req: http.IncomingMessage, socket: Duplex, head: Buffer) => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'keylog', listener: (line: Buffer, tlsSocket: tls.TLSSocket) => void): this; + prependOnceListener(event: 'newSession', listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; + prependOnceListener(event: 'OCSPRequest', listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; + prependOnceListener(event: 'resumeSession', listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; + prependOnceListener(event: 'secureConnection', listener: (tlsSocket: tls.TLSSocket) => void): this; + prependOnceListener(event: 'tlsClientError', listener: (err: Error, tlsSocket: tls.TLSSocket) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'connection', listener: (socket: Duplex) => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'listening', listener: () => void): this; + prependOnceListener(event: 'checkContinue', listener: http.RequestListener): this; + prependOnceListener(event: 'checkExpectation', listener: http.RequestListener): this; + prependOnceListener(event: 'clientError', listener: (err: Error, socket: Duplex) => void): this; + prependOnceListener(event: 'connect', listener: (req: http.IncomingMessage, socket: Duplex, head: Buffer) => void): this; + prependOnceListener(event: 'request', listener: http.RequestListener): this; + prependOnceListener(event: 'upgrade', listener: (req: http.IncomingMessage, socket: Duplex, head: Buffer) => void): this; + } + /** + * ```js + * // curl -k https://localhost:8000/ + * const https = require('https'); + * const fs = require('fs'); + * + * const options = { + * key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'), + * cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem') + * }; + * + * https.createServer(options, (req, res) => { + * res.writeHead(200); + * res.end('hello world\n'); + * }).listen(8000); + * ``` + * + * Or + * + * ```js + * const https = require('https'); + * const fs = require('fs'); + * + * const options = { + * pfx: fs.readFileSync('test/fixtures/test_cert.pfx'), + * passphrase: 'sample' + * }; + * + * https.createServer(options, (req, res) => { + * res.writeHead(200); + * res.end('hello world\n'); + * }).listen(8000); + * ``` + * @since v0.3.4 + * @param options Accepts `options` from `createServer`, `createSecureContext` and `createServer`. + * @param requestListener A listener to be added to the `'request'` event. + */ + function createServer(requestListener?: http.RequestListener): Server; + function createServer(options: ServerOptions, requestListener?: http.RequestListener): Server; + /** + * Makes a request to a secure web server. + * + * The following additional `options` from `tls.connect()` are also accepted:`ca`, `cert`, `ciphers`, `clientCertEngine`, `crl`, `dhparam`, `ecdhCurve`,`honorCipherOrder`, `key`, `passphrase`, + * `pfx`, `rejectUnauthorized`,`secureOptions`, `secureProtocol`, `servername`, `sessionIdContext`,`highWaterMark`. + * + * `options` can be an object, a string, or a `URL` object. If `options` is a + * string, it is automatically parsed with `new URL()`. If it is a `URL` object, it will be automatically converted to an ordinary `options` object. + * + * `https.request()` returns an instance of the `http.ClientRequest` class. The `ClientRequest` instance is a writable stream. If one needs to + * upload a file with a POST request, then write to the `ClientRequest` object. + * + * ```js + * const https = require('https'); + * + * const options = { + * hostname: 'encrypted.google.com', + * port: 443, + * path: '/', + * method: 'GET' + * }; + * + * const req = https.request(options, (res) => { + * console.log('statusCode:', res.statusCode); + * console.log('headers:', res.headers); + * + * res.on('data', (d) => { + * process.stdout.write(d); + * }); + * }); + * + * req.on('error', (e) => { + * console.error(e); + * }); + * req.end(); + * ``` + * + * Example using options from `tls.connect()`: + * + * ```js + * const options = { + * hostname: 'encrypted.google.com', + * port: 443, + * path: '/', + * method: 'GET', + * key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'), + * cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem') + * }; + * options.agent = new https.Agent(options); + * + * const req = https.request(options, (res) => { + * // ... + * }); + * ``` + * + * Alternatively, opt out of connection pooling by not using an `Agent`. + * + * ```js + * const options = { + * hostname: 'encrypted.google.com', + * port: 443, + * path: '/', + * method: 'GET', + * key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'), + * cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem'), + * agent: false + * }; + * + * const req = https.request(options, (res) => { + * // ... + * }); + * ``` + * + * Example using a `URL` as `options`: + * + * ```js + * const options = new URL('https://abc:xyz@example.com'); + * + * const req = https.request(options, (res) => { + * // ... + * }); + * ``` + * + * Example pinning on certificate fingerprint, or the public key (similar to`pin-sha256`): + * + * ```js + * const tls = require('tls'); + * const https = require('https'); + * const crypto = require('crypto'); + * + * function sha256(s) { + * return crypto.createHash('sha256').update(s).digest('base64'); + * } + * const options = { + * hostname: 'github.com', + * port: 443, + * path: '/', + * method: 'GET', + * checkServerIdentity: function(host, cert) { + * // Make sure the certificate is issued to the host we are connected to + * const err = tls.checkServerIdentity(host, cert); + * if (err) { + * return err; + * } + * + * // Pin the public key, similar to HPKP pin-sha25 pinning + * const pubkey256 = 'pL1+qb9HTMRZJmuC/bB/ZI9d302BYrrqiVuRyW+DGrU='; + * if (sha256(cert.pubkey) !== pubkey256) { + * const msg = 'Certificate verification error: ' + + * `The public key of '${cert.subject.CN}' ` + + * 'does not match our pinned fingerprint'; + * return new Error(msg); + * } + * + * // Pin the exact certificate, rather than the pub key + * const cert256 = '25:FE:39:32:D9:63:8C:8A:FC:A1:9A:29:87:' + + * 'D8:3E:4C:1D:98:DB:71:E4:1A:48:03:98:EA:22:6A:BD:8B:93:16'; + * if (cert.fingerprint256 !== cert256) { + * const msg = 'Certificate verification error: ' + + * `The certificate of '${cert.subject.CN}' ` + + * 'does not match our pinned fingerprint'; + * return new Error(msg); + * } + * + * // This loop is informational only. + * // Print the certificate and public key fingerprints of all certs in the + * // chain. Its common to pin the public key of the issuer on the public + * // internet, while pinning the public key of the service in sensitive + * // environments. + * do { + * console.log('Subject Common Name:', cert.subject.CN); + * console.log(' Certificate SHA256 fingerprint:', cert.fingerprint256); + * + * hash = crypto.createHash('sha256'); + * console.log(' Public key ping-sha256:', sha256(cert.pubkey)); + * + * lastprint256 = cert.fingerprint256; + * cert = cert.issuerCertificate; + * } while (cert.fingerprint256 !== lastprint256); + * + * }, + * }; + * + * options.agent = new https.Agent(options); + * const req = https.request(options, (res) => { + * console.log('All OK. Server matched our pinned cert or public key'); + * console.log('statusCode:', res.statusCode); + * // Print the HPKP values + * console.log('headers:', res.headers['public-key-pins']); + * + * res.on('data', (d) => {}); + * }); + * + * req.on('error', (e) => { + * console.error(e.message); + * }); + * req.end(); + * ``` + * + * Outputs for example: + * + * ```text + * Subject Common Name: github.com + * Certificate SHA256 fingerprint: 25:FE:39:32:D9:63:8C:8A:FC:A1:9A:29:87:D8:3E:4C:1D:98:DB:71:E4:1A:48:03:98:EA:22:6A:BD:8B:93:16 + * Public key ping-sha256: pL1+qb9HTMRZJmuC/bB/ZI9d302BYrrqiVuRyW+DGrU= + * Subject Common Name: DigiCert SHA2 Extended Validation Server CA + * Certificate SHA256 fingerprint: 40:3E:06:2A:26:53:05:91:13:28:5B:AF:80:A0:D4:AE:42:2C:84:8C:9F:78:FA:D0:1F:C9:4B:C5:B8:7F:EF:1A + * Public key ping-sha256: RRM1dGqnDFsCJXBTHky16vi1obOlCgFFn/yOhI/y+ho= + * Subject Common Name: DigiCert High Assurance EV Root CA + * Certificate SHA256 fingerprint: 74:31:E5:F4:C3:C1:CE:46:90:77:4F:0B:61:E0:54:40:88:3B:A9:A0:1E:D0:0B:A6:AB:D7:80:6E:D3:B1:18:CF + * Public key ping-sha256: WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18= + * All OK. Server matched our pinned cert or public key + * statusCode: 200 + * headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; pin-sha256="RRM1dGqnDFsCJXBTHky16vi1obOlCgFFn/yOhI/y+ho="; + * pin-sha256="k2v657xBsOVe1PQRwOsHsw3bsGT2VzIqz5K+59sNQws="; pin-sha256="K87oWBWM9UZfyddvDfoxL+8lpNyoUB2ptGtn0fv6G2Q="; pin-sha256="IQBnNBEiFuhj+8x6X8XLgh01V9Ic5/V3IRQLNFFc7v4="; + * pin-sha256="iie1VXtL7HzAMF+/PVPR9xzT80kQxdZeJ+zduCB3uj0="; pin-sha256="LvRiGEjRqfzurezaWuj8Wie2gyHMrW5Q06LspMnox7A="; includeSubDomains + * ``` + * @since v0.3.6 + * @param options Accepts all `options` from `request`, with some differences in default values: + */ + function request(options: RequestOptions | string | URL, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; + function request(url: string | URL, options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; + /** + * Like `http.get()` but for HTTPS. + * + * `options` can be an object, a string, or a `URL` object. If `options` is a + * string, it is automatically parsed with `new URL()`. If it is a `URL` object, it will be automatically converted to an ordinary `options` object. + * + * ```js + * const https = require('https'); + * + * https.get('https://encrypted.google.com/', (res) => { + * console.log('statusCode:', res.statusCode); + * console.log('headers:', res.headers); + * + * res.on('data', (d) => { + * process.stdout.write(d); + * }); + * + * }).on('error', (e) => { + * console.error(e); + * }); + * ``` + * @since v0.3.6 + * @param options Accepts the same `options` as {@link request}, with the `method` always set to `GET`. + */ + function get(options: RequestOptions | string | URL, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; + function get(url: string | URL, options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; + let globalAgent: Agent; +} +declare module 'node:https' { + export * from 'https'; +} diff --git a/node_modules/@types/node/index.d.ts b/node_modules/@types/node/index.d.ts new file mode 100755 index 00000000..5d2bcee6 --- /dev/null +++ b/node_modules/@types/node/index.d.ts @@ -0,0 +1,131 @@ +// Type definitions for non-npm package Node.js 16.11 +// Project: https://nodejs.org/ +// Definitions by: Microsoft TypeScript +// DefinitelyTyped +// Alberto Schiabel +// Alvis HT Tang +// Andrew Makarov +// Benjamin Toueg +// Chigozirim C. +// David Junger +// Deividas Bakanas +// Eugene Y. Q. Shen +// Hannes Magnusson +// Huw +// Kelvin Jin +// Klaus Meinhardt +// Lishude +// Mariusz Wiktorczyk +// Mohsen Azimi +// Nicolas Even +// Nikita Galkin +// Parambir Singh +// Sebastian Silbermann +// Seth Westphal +// Simon Schick +// Thomas den Hollander +// Wilco Bakker +// wwwy3y3 +// Samuel Ainsworth +// Kyle Uehlein +// Thanik Bhongbhibhat +// Marcin Kopacz +// Trivikram Kamat +// Junxiao Shi +// Ilia Baryshnikov +// ExE Boss +// Surasak Chaisurin +// Piotr Błażejewicz +// Anna Henningsen +// Victor Perin +// Yongsheng Zhang +// NodeJS Contributors +// Linus Unnebäck +// wafuwafu13 +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/** + * License for programmatically and manually incorporated + * documentation aka. `JSDoc` from https://github.com/nodejs/node/tree/master/doc + * + * Copyright Node.js contributors. All rights reserved. + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +// NOTE: These definitions support NodeJS and TypeScript 3.7+. + +// Reference required types from the default lib: +/// +/// +/// +/// + +// Base definitions for all NodeJS modules that are not specific to any version of TypeScript: +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// + +/// diff --git a/node_modules/@types/node/inspector.d.ts b/node_modules/@types/node/inspector.d.ts new file mode 100755 index 00000000..5e84a1a6 --- /dev/null +++ b/node_modules/@types/node/inspector.d.ts @@ -0,0 +1,2745 @@ +// tslint:disable-next-line:dt-header +// Type definitions for inspector + +// These definitions are auto-generated. +// Please see https://github.com/DefinitelyTyped/DefinitelyTyped/pull/19330 +// for more information. + +// tslint:disable:max-line-length + +/** + * The `inspector` module provides an API for interacting with the V8 inspector. + * + * It can be accessed using: + * + * ```js + * const inspector = require('inspector'); + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/inspector.js) + */ +declare module 'inspector' { + import EventEmitter = require('node:events'); + interface InspectorNotification { + method: string; + params: T; + } + namespace Schema { + /** + * Description of the protocol domain. + */ + interface Domain { + /** + * Domain name. + */ + name: string; + /** + * Domain version. + */ + version: string; + } + interface GetDomainsReturnType { + /** + * List of supported domains. + */ + domains: Domain[]; + } + } + namespace Runtime { + /** + * Unique script identifier. + */ + type ScriptId = string; + /** + * Unique object identifier. + */ + type RemoteObjectId = string; + /** + * Primitive value which cannot be JSON-stringified. + */ + type UnserializableValue = string; + /** + * Mirror object referencing original JavaScript object. + */ + interface RemoteObject { + /** + * Object type. + */ + type: string; + /** + * Object subtype hint. Specified for object type values only. + */ + subtype?: string | undefined; + /** + * Object class (constructor) name. Specified for object type values only. + */ + className?: string | undefined; + /** + * Remote object value in case of primitive values or JSON values (if it was requested). + */ + value?: any; + /** + * Primitive value which can not be JSON-stringified does not have value, but gets this property. + */ + unserializableValue?: UnserializableValue | undefined; + /** + * String representation of the object. + */ + description?: string | undefined; + /** + * Unique object identifier (for non-primitive values). + */ + objectId?: RemoteObjectId | undefined; + /** + * Preview containing abbreviated property values. Specified for object type values only. + * @experimental + */ + preview?: ObjectPreview | undefined; + /** + * @experimental + */ + customPreview?: CustomPreview | undefined; + } + /** + * @experimental + */ + interface CustomPreview { + header: string; + hasBody: boolean; + formatterObjectId: RemoteObjectId; + bindRemoteObjectFunctionId: RemoteObjectId; + configObjectId?: RemoteObjectId | undefined; + } + /** + * Object containing abbreviated remote object value. + * @experimental + */ + interface ObjectPreview { + /** + * Object type. + */ + type: string; + /** + * Object subtype hint. Specified for object type values only. + */ + subtype?: string | undefined; + /** + * String representation of the object. + */ + description?: string | undefined; + /** + * True iff some of the properties or entries of the original object did not fit. + */ + overflow: boolean; + /** + * List of the properties. + */ + properties: PropertyPreview[]; + /** + * List of the entries. Specified for map and set subtype values only. + */ + entries?: EntryPreview[] | undefined; + } + /** + * @experimental + */ + interface PropertyPreview { + /** + * Property name. + */ + name: string; + /** + * Object type. Accessor means that the property itself is an accessor property. + */ + type: string; + /** + * User-friendly property value string. + */ + value?: string | undefined; + /** + * Nested value preview. + */ + valuePreview?: ObjectPreview | undefined; + /** + * Object subtype hint. Specified for object type values only. + */ + subtype?: string | undefined; + } + /** + * @experimental + */ + interface EntryPreview { + /** + * Preview of the key. Specified for map-like collection entries. + */ + key?: ObjectPreview | undefined; + /** + * Preview of the value. + */ + value: ObjectPreview; + } + /** + * Object property descriptor. + */ + interface PropertyDescriptor { + /** + * Property name or symbol description. + */ + name: string; + /** + * The value associated with the property. + */ + value?: RemoteObject | undefined; + /** + * True if the value associated with the property may be changed (data descriptors only). + */ + writable?: boolean | undefined; + /** + * A function which serves as a getter for the property, or undefined if there is no getter (accessor descriptors only). + */ + get?: RemoteObject | undefined; + /** + * A function which serves as a setter for the property, or undefined if there is no setter (accessor descriptors only). + */ + set?: RemoteObject | undefined; + /** + * True if the type of this property descriptor may be changed and if the property may be deleted from the corresponding object. + */ + configurable: boolean; + /** + * True if this property shows up during enumeration of the properties on the corresponding object. + */ + enumerable: boolean; + /** + * True if the result was thrown during the evaluation. + */ + wasThrown?: boolean | undefined; + /** + * True if the property is owned for the object. + */ + isOwn?: boolean | undefined; + /** + * Property symbol object, if the property is of the symbol type. + */ + symbol?: RemoteObject | undefined; + } + /** + * Object internal property descriptor. This property isn't normally visible in JavaScript code. + */ + interface InternalPropertyDescriptor { + /** + * Conventional property name. + */ + name: string; + /** + * The value associated with the property. + */ + value?: RemoteObject | undefined; + } + /** + * Represents function call argument. Either remote object id objectId, primitive value, unserializable primitive value or neither of (for undefined) them should be specified. + */ + interface CallArgument { + /** + * Primitive value or serializable javascript object. + */ + value?: any; + /** + * Primitive value which can not be JSON-stringified. + */ + unserializableValue?: UnserializableValue | undefined; + /** + * Remote object handle. + */ + objectId?: RemoteObjectId | undefined; + } + /** + * Id of an execution context. + */ + type ExecutionContextId = number; + /** + * Description of an isolated world. + */ + interface ExecutionContextDescription { + /** + * Unique id of the execution context. It can be used to specify in which execution context script evaluation should be performed. + */ + id: ExecutionContextId; + /** + * Execution context origin. + */ + origin: string; + /** + * Human readable name describing given context. + */ + name: string; + /** + * Embedder-specific auxiliary data. + */ + auxData?: {} | undefined; + } + /** + * Detailed information about exception (or error) that was thrown during script compilation or execution. + */ + interface ExceptionDetails { + /** + * Exception id. + */ + exceptionId: number; + /** + * Exception text, which should be used together with exception object when available. + */ + text: string; + /** + * Line number of the exception location (0-based). + */ + lineNumber: number; + /** + * Column number of the exception location (0-based). + */ + columnNumber: number; + /** + * Script ID of the exception location. + */ + scriptId?: ScriptId | undefined; + /** + * URL of the exception location, to be used when the script was not reported. + */ + url?: string | undefined; + /** + * JavaScript stack trace if available. + */ + stackTrace?: StackTrace | undefined; + /** + * Exception object if available. + */ + exception?: RemoteObject | undefined; + /** + * Identifier of the context where exception happened. + */ + executionContextId?: ExecutionContextId | undefined; + } + /** + * Number of milliseconds since epoch. + */ + type Timestamp = number; + /** + * Stack entry for runtime errors and assertions. + */ + interface CallFrame { + /** + * JavaScript function name. + */ + functionName: string; + /** + * JavaScript script id. + */ + scriptId: ScriptId; + /** + * JavaScript script name or url. + */ + url: string; + /** + * JavaScript script line number (0-based). + */ + lineNumber: number; + /** + * JavaScript script column number (0-based). + */ + columnNumber: number; + } + /** + * Call frames for assertions or error messages. + */ + interface StackTrace { + /** + * String label of this stack trace. For async traces this may be a name of the function that initiated the async call. + */ + description?: string | undefined; + /** + * JavaScript function name. + */ + callFrames: CallFrame[]; + /** + * Asynchronous JavaScript stack trace that preceded this stack, if available. + */ + parent?: StackTrace | undefined; + /** + * Asynchronous JavaScript stack trace that preceded this stack, if available. + * @experimental + */ + parentId?: StackTraceId | undefined; + } + /** + * Unique identifier of current debugger. + * @experimental + */ + type UniqueDebuggerId = string; + /** + * If debuggerId is set stack trace comes from another debugger and can be resolved there. This allows to track cross-debugger calls. See Runtime.StackTrace and Debugger.paused for usages. + * @experimental + */ + interface StackTraceId { + id: string; + debuggerId?: UniqueDebuggerId | undefined; + } + interface EvaluateParameterType { + /** + * Expression to evaluate. + */ + expression: string; + /** + * Symbolic group name that can be used to release multiple objects. + */ + objectGroup?: string | undefined; + /** + * Determines whether Command Line API should be available during the evaluation. + */ + includeCommandLineAPI?: boolean | undefined; + /** + * In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state. + */ + silent?: boolean | undefined; + /** + * Specifies in which execution context to perform evaluation. If the parameter is omitted the evaluation will be performed in the context of the inspected page. + */ + contextId?: ExecutionContextId | undefined; + /** + * Whether the result is expected to be a JSON object that should be sent by value. + */ + returnByValue?: boolean | undefined; + /** + * Whether preview should be generated for the result. + * @experimental + */ + generatePreview?: boolean | undefined; + /** + * Whether execution should be treated as initiated by user in the UI. + */ + userGesture?: boolean | undefined; + /** + * Whether execution should await for resulting value and return once awaited promise is resolved. + */ + awaitPromise?: boolean | undefined; + } + interface AwaitPromiseParameterType { + /** + * Identifier of the promise. + */ + promiseObjectId: RemoteObjectId; + /** + * Whether the result is expected to be a JSON object that should be sent by value. + */ + returnByValue?: boolean | undefined; + /** + * Whether preview should be generated for the result. + */ + generatePreview?: boolean | undefined; + } + interface CallFunctionOnParameterType { + /** + * Declaration of the function to call. + */ + functionDeclaration: string; + /** + * Identifier of the object to call function on. Either objectId or executionContextId should be specified. + */ + objectId?: RemoteObjectId | undefined; + /** + * Call arguments. All call arguments must belong to the same JavaScript world as the target object. + */ + arguments?: CallArgument[] | undefined; + /** + * In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state. + */ + silent?: boolean | undefined; + /** + * Whether the result is expected to be a JSON object which should be sent by value. + */ + returnByValue?: boolean | undefined; + /** + * Whether preview should be generated for the result. + * @experimental + */ + generatePreview?: boolean | undefined; + /** + * Whether execution should be treated as initiated by user in the UI. + */ + userGesture?: boolean | undefined; + /** + * Whether execution should await for resulting value and return once awaited promise is resolved. + */ + awaitPromise?: boolean | undefined; + /** + * Specifies execution context which global object will be used to call function on. Either executionContextId or objectId should be specified. + */ + executionContextId?: ExecutionContextId | undefined; + /** + * Symbolic group name that can be used to release multiple objects. If objectGroup is not specified and objectId is, objectGroup will be inherited from object. + */ + objectGroup?: string | undefined; + } + interface GetPropertiesParameterType { + /** + * Identifier of the object to return properties for. + */ + objectId: RemoteObjectId; + /** + * If true, returns properties belonging only to the element itself, not to its prototype chain. + */ + ownProperties?: boolean | undefined; + /** + * If true, returns accessor properties (with getter/setter) only; internal properties are not returned either. + * @experimental + */ + accessorPropertiesOnly?: boolean | undefined; + /** + * Whether preview should be generated for the results. + * @experimental + */ + generatePreview?: boolean | undefined; + } + interface ReleaseObjectParameterType { + /** + * Identifier of the object to release. + */ + objectId: RemoteObjectId; + } + interface ReleaseObjectGroupParameterType { + /** + * Symbolic object group name. + */ + objectGroup: string; + } + interface SetCustomObjectFormatterEnabledParameterType { + enabled: boolean; + } + interface CompileScriptParameterType { + /** + * Expression to compile. + */ + expression: string; + /** + * Source url to be set for the script. + */ + sourceURL: string; + /** + * Specifies whether the compiled script should be persisted. + */ + persistScript: boolean; + /** + * Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page. + */ + executionContextId?: ExecutionContextId | undefined; + } + interface RunScriptParameterType { + /** + * Id of the script to run. + */ + scriptId: ScriptId; + /** + * Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page. + */ + executionContextId?: ExecutionContextId | undefined; + /** + * Symbolic group name that can be used to release multiple objects. + */ + objectGroup?: string | undefined; + /** + * In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state. + */ + silent?: boolean | undefined; + /** + * Determines whether Command Line API should be available during the evaluation. + */ + includeCommandLineAPI?: boolean | undefined; + /** + * Whether the result is expected to be a JSON object which should be sent by value. + */ + returnByValue?: boolean | undefined; + /** + * Whether preview should be generated for the result. + */ + generatePreview?: boolean | undefined; + /** + * Whether execution should await for resulting value and return once awaited promise is resolved. + */ + awaitPromise?: boolean | undefined; + } + interface QueryObjectsParameterType { + /** + * Identifier of the prototype to return objects for. + */ + prototypeObjectId: RemoteObjectId; + } + interface GlobalLexicalScopeNamesParameterType { + /** + * Specifies in which execution context to lookup global scope variables. + */ + executionContextId?: ExecutionContextId | undefined; + } + interface EvaluateReturnType { + /** + * Evaluation result. + */ + result: RemoteObject; + /** + * Exception details. + */ + exceptionDetails?: ExceptionDetails | undefined; + } + interface AwaitPromiseReturnType { + /** + * Promise result. Will contain rejected value if promise was rejected. + */ + result: RemoteObject; + /** + * Exception details if stack strace is available. + */ + exceptionDetails?: ExceptionDetails | undefined; + } + interface CallFunctionOnReturnType { + /** + * Call result. + */ + result: RemoteObject; + /** + * Exception details. + */ + exceptionDetails?: ExceptionDetails | undefined; + } + interface GetPropertiesReturnType { + /** + * Object properties. + */ + result: PropertyDescriptor[]; + /** + * Internal object properties (only of the element itself). + */ + internalProperties?: InternalPropertyDescriptor[] | undefined; + /** + * Exception details. + */ + exceptionDetails?: ExceptionDetails | undefined; + } + interface CompileScriptReturnType { + /** + * Id of the script. + */ + scriptId?: ScriptId | undefined; + /** + * Exception details. + */ + exceptionDetails?: ExceptionDetails | undefined; + } + interface RunScriptReturnType { + /** + * Run result. + */ + result: RemoteObject; + /** + * Exception details. + */ + exceptionDetails?: ExceptionDetails | undefined; + } + interface QueryObjectsReturnType { + /** + * Array with objects. + */ + objects: RemoteObject; + } + interface GlobalLexicalScopeNamesReturnType { + names: string[]; + } + interface ExecutionContextCreatedEventDataType { + /** + * A newly created execution context. + */ + context: ExecutionContextDescription; + } + interface ExecutionContextDestroyedEventDataType { + /** + * Id of the destroyed context + */ + executionContextId: ExecutionContextId; + } + interface ExceptionThrownEventDataType { + /** + * Timestamp of the exception. + */ + timestamp: Timestamp; + exceptionDetails: ExceptionDetails; + } + interface ExceptionRevokedEventDataType { + /** + * Reason describing why exception was revoked. + */ + reason: string; + /** + * The id of revoked exception, as reported in exceptionThrown. + */ + exceptionId: number; + } + interface ConsoleAPICalledEventDataType { + /** + * Type of the call. + */ + type: string; + /** + * Call arguments. + */ + args: RemoteObject[]; + /** + * Identifier of the context where the call was made. + */ + executionContextId: ExecutionContextId; + /** + * Call timestamp. + */ + timestamp: Timestamp; + /** + * Stack trace captured when the call was made. + */ + stackTrace?: StackTrace | undefined; + /** + * Console context descriptor for calls on non-default console context (not console.*): 'anonymous#unique-logger-id' for call on unnamed context, 'name#unique-logger-id' for call on named context. + * @experimental + */ + context?: string | undefined; + } + interface InspectRequestedEventDataType { + object: RemoteObject; + hints: {}; + } + } + namespace Debugger { + /** + * Breakpoint identifier. + */ + type BreakpointId = string; + /** + * Call frame identifier. + */ + type CallFrameId = string; + /** + * Location in the source code. + */ + interface Location { + /** + * Script identifier as reported in the Debugger.scriptParsed. + */ + scriptId: Runtime.ScriptId; + /** + * Line number in the script (0-based). + */ + lineNumber: number; + /** + * Column number in the script (0-based). + */ + columnNumber?: number | undefined; + } + /** + * Location in the source code. + * @experimental + */ + interface ScriptPosition { + lineNumber: number; + columnNumber: number; + } + /** + * JavaScript call frame. Array of call frames form the call stack. + */ + interface CallFrame { + /** + * Call frame identifier. This identifier is only valid while the virtual machine is paused. + */ + callFrameId: CallFrameId; + /** + * Name of the JavaScript function called on this call frame. + */ + functionName: string; + /** + * Location in the source code. + */ + functionLocation?: Location | undefined; + /** + * Location in the source code. + */ + location: Location; + /** + * JavaScript script name or url. + */ + url: string; + /** + * Scope chain for this call frame. + */ + scopeChain: Scope[]; + /** + * this object for this call frame. + */ + this: Runtime.RemoteObject; + /** + * The value being returned, if the function is at return point. + */ + returnValue?: Runtime.RemoteObject | undefined; + } + /** + * Scope description. + */ + interface Scope { + /** + * Scope type. + */ + type: string; + /** + * Object representing the scope. For global and with scopes it represents the actual object; for the rest of the scopes, it is artificial transient object enumerating scope variables as its properties. + */ + object: Runtime.RemoteObject; + name?: string | undefined; + /** + * Location in the source code where scope starts + */ + startLocation?: Location | undefined; + /** + * Location in the source code where scope ends + */ + endLocation?: Location | undefined; + } + /** + * Search match for resource. + */ + interface SearchMatch { + /** + * Line number in resource content. + */ + lineNumber: number; + /** + * Line with match content. + */ + lineContent: string; + } + interface BreakLocation { + /** + * Script identifier as reported in the Debugger.scriptParsed. + */ + scriptId: Runtime.ScriptId; + /** + * Line number in the script (0-based). + */ + lineNumber: number; + /** + * Column number in the script (0-based). + */ + columnNumber?: number | undefined; + type?: string | undefined; + } + interface SetBreakpointsActiveParameterType { + /** + * New value for breakpoints active state. + */ + active: boolean; + } + interface SetSkipAllPausesParameterType { + /** + * New value for skip pauses state. + */ + skip: boolean; + } + interface SetBreakpointByUrlParameterType { + /** + * Line number to set breakpoint at. + */ + lineNumber: number; + /** + * URL of the resources to set breakpoint on. + */ + url?: string | undefined; + /** + * Regex pattern for the URLs of the resources to set breakpoints on. Either url or urlRegex must be specified. + */ + urlRegex?: string | undefined; + /** + * Script hash of the resources to set breakpoint on. + */ + scriptHash?: string | undefined; + /** + * Offset in the line to set breakpoint at. + */ + columnNumber?: number | undefined; + /** + * Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true. + */ + condition?: string | undefined; + } + interface SetBreakpointParameterType { + /** + * Location to set breakpoint in. + */ + location: Location; + /** + * Expression to use as a breakpoint condition. When specified, debugger will only stop on the breakpoint if this expression evaluates to true. + */ + condition?: string | undefined; + } + interface RemoveBreakpointParameterType { + breakpointId: BreakpointId; + } + interface GetPossibleBreakpointsParameterType { + /** + * Start of range to search possible breakpoint locations in. + */ + start: Location; + /** + * End of range to search possible breakpoint locations in (excluding). When not specified, end of scripts is used as end of range. + */ + end?: Location | undefined; + /** + * Only consider locations which are in the same (non-nested) function as start. + */ + restrictToFunction?: boolean | undefined; + } + interface ContinueToLocationParameterType { + /** + * Location to continue to. + */ + location: Location; + targetCallFrames?: string | undefined; + } + interface PauseOnAsyncCallParameterType { + /** + * Debugger will pause when async call with given stack trace is started. + */ + parentStackTraceId: Runtime.StackTraceId; + } + interface StepIntoParameterType { + /** + * Debugger will issue additional Debugger.paused notification if any async task is scheduled before next pause. + * @experimental + */ + breakOnAsyncCall?: boolean | undefined; + } + interface GetStackTraceParameterType { + stackTraceId: Runtime.StackTraceId; + } + interface SearchInContentParameterType { + /** + * Id of the script to search in. + */ + scriptId: Runtime.ScriptId; + /** + * String to search for. + */ + query: string; + /** + * If true, search is case sensitive. + */ + caseSensitive?: boolean | undefined; + /** + * If true, treats string parameter as regex. + */ + isRegex?: boolean | undefined; + } + interface SetScriptSourceParameterType { + /** + * Id of the script to edit. + */ + scriptId: Runtime.ScriptId; + /** + * New content of the script. + */ + scriptSource: string; + /** + * If true the change will not actually be applied. Dry run may be used to get result description without actually modifying the code. + */ + dryRun?: boolean | undefined; + } + interface RestartFrameParameterType { + /** + * Call frame identifier to evaluate on. + */ + callFrameId: CallFrameId; + } + interface GetScriptSourceParameterType { + /** + * Id of the script to get source for. + */ + scriptId: Runtime.ScriptId; + } + interface SetPauseOnExceptionsParameterType { + /** + * Pause on exceptions mode. + */ + state: string; + } + interface EvaluateOnCallFrameParameterType { + /** + * Call frame identifier to evaluate on. + */ + callFrameId: CallFrameId; + /** + * Expression to evaluate. + */ + expression: string; + /** + * String object group name to put result into (allows rapid releasing resulting object handles using releaseObjectGroup). + */ + objectGroup?: string | undefined; + /** + * Specifies whether command line API should be available to the evaluated expression, defaults to false. + */ + includeCommandLineAPI?: boolean | undefined; + /** + * In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state. + */ + silent?: boolean | undefined; + /** + * Whether the result is expected to be a JSON object that should be sent by value. + */ + returnByValue?: boolean | undefined; + /** + * Whether preview should be generated for the result. + * @experimental + */ + generatePreview?: boolean | undefined; + /** + * Whether to throw an exception if side effect cannot be ruled out during evaluation. + */ + throwOnSideEffect?: boolean | undefined; + } + interface SetVariableValueParameterType { + /** + * 0-based number of scope as was listed in scope chain. Only 'local', 'closure' and 'catch' scope types are allowed. Other scopes could be manipulated manually. + */ + scopeNumber: number; + /** + * Variable name. + */ + variableName: string; + /** + * New variable value. + */ + newValue: Runtime.CallArgument; + /** + * Id of callframe that holds variable. + */ + callFrameId: CallFrameId; + } + interface SetReturnValueParameterType { + /** + * New return value. + */ + newValue: Runtime.CallArgument; + } + interface SetAsyncCallStackDepthParameterType { + /** + * Maximum depth of async call stacks. Setting to 0 will effectively disable collecting async call stacks (default). + */ + maxDepth: number; + } + interface SetBlackboxPatternsParameterType { + /** + * Array of regexps that will be used to check script url for blackbox state. + */ + patterns: string[]; + } + interface SetBlackboxedRangesParameterType { + /** + * Id of the script. + */ + scriptId: Runtime.ScriptId; + positions: ScriptPosition[]; + } + interface EnableReturnType { + /** + * Unique identifier of the debugger. + * @experimental + */ + debuggerId: Runtime.UniqueDebuggerId; + } + interface SetBreakpointByUrlReturnType { + /** + * Id of the created breakpoint for further reference. + */ + breakpointId: BreakpointId; + /** + * List of the locations this breakpoint resolved into upon addition. + */ + locations: Location[]; + } + interface SetBreakpointReturnType { + /** + * Id of the created breakpoint for further reference. + */ + breakpointId: BreakpointId; + /** + * Location this breakpoint resolved into. + */ + actualLocation: Location; + } + interface GetPossibleBreakpointsReturnType { + /** + * List of the possible breakpoint locations. + */ + locations: BreakLocation[]; + } + interface GetStackTraceReturnType { + stackTrace: Runtime.StackTrace; + } + interface SearchInContentReturnType { + /** + * List of search matches. + */ + result: SearchMatch[]; + } + interface SetScriptSourceReturnType { + /** + * New stack trace in case editing has happened while VM was stopped. + */ + callFrames?: CallFrame[] | undefined; + /** + * Whether current call stack was modified after applying the changes. + */ + stackChanged?: boolean | undefined; + /** + * Async stack trace, if any. + */ + asyncStackTrace?: Runtime.StackTrace | undefined; + /** + * Async stack trace, if any. + * @experimental + */ + asyncStackTraceId?: Runtime.StackTraceId | undefined; + /** + * Exception details if any. + */ + exceptionDetails?: Runtime.ExceptionDetails | undefined; + } + interface RestartFrameReturnType { + /** + * New stack trace. + */ + callFrames: CallFrame[]; + /** + * Async stack trace, if any. + */ + asyncStackTrace?: Runtime.StackTrace | undefined; + /** + * Async stack trace, if any. + * @experimental + */ + asyncStackTraceId?: Runtime.StackTraceId | undefined; + } + interface GetScriptSourceReturnType { + /** + * Script source. + */ + scriptSource: string; + } + interface EvaluateOnCallFrameReturnType { + /** + * Object wrapper for the evaluation result. + */ + result: Runtime.RemoteObject; + /** + * Exception details. + */ + exceptionDetails?: Runtime.ExceptionDetails | undefined; + } + interface ScriptParsedEventDataType { + /** + * Identifier of the script parsed. + */ + scriptId: Runtime.ScriptId; + /** + * URL or name of the script parsed (if any). + */ + url: string; + /** + * Line offset of the script within the resource with given URL (for script tags). + */ + startLine: number; + /** + * Column offset of the script within the resource with given URL. + */ + startColumn: number; + /** + * Last line of the script. + */ + endLine: number; + /** + * Length of the last line of the script. + */ + endColumn: number; + /** + * Specifies script creation context. + */ + executionContextId: Runtime.ExecutionContextId; + /** + * Content hash of the script. + */ + hash: string; + /** + * Embedder-specific auxiliary data. + */ + executionContextAuxData?: {} | undefined; + /** + * True, if this script is generated as a result of the live edit operation. + * @experimental + */ + isLiveEdit?: boolean | undefined; + /** + * URL of source map associated with script (if any). + */ + sourceMapURL?: string | undefined; + /** + * True, if this script has sourceURL. + */ + hasSourceURL?: boolean | undefined; + /** + * True, if this script is ES6 module. + */ + isModule?: boolean | undefined; + /** + * This script length. + */ + length?: number | undefined; + /** + * JavaScript top stack frame of where the script parsed event was triggered if available. + * @experimental + */ + stackTrace?: Runtime.StackTrace | undefined; + } + interface ScriptFailedToParseEventDataType { + /** + * Identifier of the script parsed. + */ + scriptId: Runtime.ScriptId; + /** + * URL or name of the script parsed (if any). + */ + url: string; + /** + * Line offset of the script within the resource with given URL (for script tags). + */ + startLine: number; + /** + * Column offset of the script within the resource with given URL. + */ + startColumn: number; + /** + * Last line of the script. + */ + endLine: number; + /** + * Length of the last line of the script. + */ + endColumn: number; + /** + * Specifies script creation context. + */ + executionContextId: Runtime.ExecutionContextId; + /** + * Content hash of the script. + */ + hash: string; + /** + * Embedder-specific auxiliary data. + */ + executionContextAuxData?: {} | undefined; + /** + * URL of source map associated with script (if any). + */ + sourceMapURL?: string | undefined; + /** + * True, if this script has sourceURL. + */ + hasSourceURL?: boolean | undefined; + /** + * True, if this script is ES6 module. + */ + isModule?: boolean | undefined; + /** + * This script length. + */ + length?: number | undefined; + /** + * JavaScript top stack frame of where the script parsed event was triggered if available. + * @experimental + */ + stackTrace?: Runtime.StackTrace | undefined; + } + interface BreakpointResolvedEventDataType { + /** + * Breakpoint unique identifier. + */ + breakpointId: BreakpointId; + /** + * Actual breakpoint location. + */ + location: Location; + } + interface PausedEventDataType { + /** + * Call stack the virtual machine stopped on. + */ + callFrames: CallFrame[]; + /** + * Pause reason. + */ + reason: string; + /** + * Object containing break-specific auxiliary properties. + */ + data?: {} | undefined; + /** + * Hit breakpoints IDs + */ + hitBreakpoints?: string[] | undefined; + /** + * Async stack trace, if any. + */ + asyncStackTrace?: Runtime.StackTrace | undefined; + /** + * Async stack trace, if any. + * @experimental + */ + asyncStackTraceId?: Runtime.StackTraceId | undefined; + /** + * Just scheduled async call will have this stack trace as parent stack during async execution. This field is available only after Debugger.stepInto call with breakOnAsynCall flag. + * @experimental + */ + asyncCallStackTraceId?: Runtime.StackTraceId | undefined; + } + } + namespace Console { + /** + * Console message. + */ + interface ConsoleMessage { + /** + * Message source. + */ + source: string; + /** + * Message severity. + */ + level: string; + /** + * Message text. + */ + text: string; + /** + * URL of the message origin. + */ + url?: string | undefined; + /** + * Line number in the resource that generated this message (1-based). + */ + line?: number | undefined; + /** + * Column number in the resource that generated this message (1-based). + */ + column?: number | undefined; + } + interface MessageAddedEventDataType { + /** + * Console message that has been added. + */ + message: ConsoleMessage; + } + } + namespace Profiler { + /** + * Profile node. Holds callsite information, execution statistics and child nodes. + */ + interface ProfileNode { + /** + * Unique id of the node. + */ + id: number; + /** + * Function location. + */ + callFrame: Runtime.CallFrame; + /** + * Number of samples where this node was on top of the call stack. + */ + hitCount?: number | undefined; + /** + * Child node ids. + */ + children?: number[] | undefined; + /** + * The reason of being not optimized. The function may be deoptimized or marked as don't optimize. + */ + deoptReason?: string | undefined; + /** + * An array of source position ticks. + */ + positionTicks?: PositionTickInfo[] | undefined; + } + /** + * Profile. + */ + interface Profile { + /** + * The list of profile nodes. First item is the root node. + */ + nodes: ProfileNode[]; + /** + * Profiling start timestamp in microseconds. + */ + startTime: number; + /** + * Profiling end timestamp in microseconds. + */ + endTime: number; + /** + * Ids of samples top nodes. + */ + samples?: number[] | undefined; + /** + * Time intervals between adjacent samples in microseconds. The first delta is relative to the profile startTime. + */ + timeDeltas?: number[] | undefined; + } + /** + * Specifies a number of samples attributed to a certain source position. + */ + interface PositionTickInfo { + /** + * Source line number (1-based). + */ + line: number; + /** + * Number of samples attributed to the source line. + */ + ticks: number; + } + /** + * Coverage data for a source range. + */ + interface CoverageRange { + /** + * JavaScript script source offset for the range start. + */ + startOffset: number; + /** + * JavaScript script source offset for the range end. + */ + endOffset: number; + /** + * Collected execution count of the source range. + */ + count: number; + } + /** + * Coverage data for a JavaScript function. + */ + interface FunctionCoverage { + /** + * JavaScript function name. + */ + functionName: string; + /** + * Source ranges inside the function with coverage data. + */ + ranges: CoverageRange[]; + /** + * Whether coverage data for this function has block granularity. + */ + isBlockCoverage: boolean; + } + /** + * Coverage data for a JavaScript script. + */ + interface ScriptCoverage { + /** + * JavaScript script id. + */ + scriptId: Runtime.ScriptId; + /** + * JavaScript script name or url. + */ + url: string; + /** + * Functions contained in the script that has coverage data. + */ + functions: FunctionCoverage[]; + } + /** + * Describes a type collected during runtime. + * @experimental + */ + interface TypeObject { + /** + * Name of a type collected with type profiling. + */ + name: string; + } + /** + * Source offset and types for a parameter or return value. + * @experimental + */ + interface TypeProfileEntry { + /** + * Source offset of the parameter or end of function for return values. + */ + offset: number; + /** + * The types for this parameter or return value. + */ + types: TypeObject[]; + } + /** + * Type profile data collected during runtime for a JavaScript script. + * @experimental + */ + interface ScriptTypeProfile { + /** + * JavaScript script id. + */ + scriptId: Runtime.ScriptId; + /** + * JavaScript script name or url. + */ + url: string; + /** + * Type profile entries for parameters and return values of the functions in the script. + */ + entries: TypeProfileEntry[]; + } + interface SetSamplingIntervalParameterType { + /** + * New sampling interval in microseconds. + */ + interval: number; + } + interface StartPreciseCoverageParameterType { + /** + * Collect accurate call counts beyond simple 'covered' or 'not covered'. + */ + callCount?: boolean | undefined; + /** + * Collect block-based coverage. + */ + detailed?: boolean | undefined; + } + interface StopReturnType { + /** + * Recorded profile. + */ + profile: Profile; + } + interface TakePreciseCoverageReturnType { + /** + * Coverage data for the current isolate. + */ + result: ScriptCoverage[]; + } + interface GetBestEffortCoverageReturnType { + /** + * Coverage data for the current isolate. + */ + result: ScriptCoverage[]; + } + interface TakeTypeProfileReturnType { + /** + * Type profile for all scripts since startTypeProfile() was turned on. + */ + result: ScriptTypeProfile[]; + } + interface ConsoleProfileStartedEventDataType { + id: string; + /** + * Location of console.profile(). + */ + location: Debugger.Location; + /** + * Profile title passed as an argument to console.profile(). + */ + title?: string | undefined; + } + interface ConsoleProfileFinishedEventDataType { + id: string; + /** + * Location of console.profileEnd(). + */ + location: Debugger.Location; + profile: Profile; + /** + * Profile title passed as an argument to console.profile(). + */ + title?: string | undefined; + } + } + namespace HeapProfiler { + /** + * Heap snapshot object id. + */ + type HeapSnapshotObjectId = string; + /** + * Sampling Heap Profile node. Holds callsite information, allocation statistics and child nodes. + */ + interface SamplingHeapProfileNode { + /** + * Function location. + */ + callFrame: Runtime.CallFrame; + /** + * Allocations size in bytes for the node excluding children. + */ + selfSize: number; + /** + * Child nodes. + */ + children: SamplingHeapProfileNode[]; + } + /** + * Profile. + */ + interface SamplingHeapProfile { + head: SamplingHeapProfileNode; + } + interface StartTrackingHeapObjectsParameterType { + trackAllocations?: boolean | undefined; + } + interface StopTrackingHeapObjectsParameterType { + /** + * If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken when the tracking is stopped. + */ + reportProgress?: boolean | undefined; + } + interface TakeHeapSnapshotParameterType { + /** + * If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken. + */ + reportProgress?: boolean | undefined; + } + interface GetObjectByHeapObjectIdParameterType { + objectId: HeapSnapshotObjectId; + /** + * Symbolic group name that can be used to release multiple objects. + */ + objectGroup?: string | undefined; + } + interface AddInspectedHeapObjectParameterType { + /** + * Heap snapshot object id to be accessible by means of $x command line API. + */ + heapObjectId: HeapSnapshotObjectId; + } + interface GetHeapObjectIdParameterType { + /** + * Identifier of the object to get heap object id for. + */ + objectId: Runtime.RemoteObjectId; + } + interface StartSamplingParameterType { + /** + * Average sample interval in bytes. Poisson distribution is used for the intervals. The default value is 32768 bytes. + */ + samplingInterval?: number | undefined; + } + interface GetObjectByHeapObjectIdReturnType { + /** + * Evaluation result. + */ + result: Runtime.RemoteObject; + } + interface GetHeapObjectIdReturnType { + /** + * Id of the heap snapshot object corresponding to the passed remote object id. + */ + heapSnapshotObjectId: HeapSnapshotObjectId; + } + interface StopSamplingReturnType { + /** + * Recorded sampling heap profile. + */ + profile: SamplingHeapProfile; + } + interface GetSamplingProfileReturnType { + /** + * Return the sampling profile being collected. + */ + profile: SamplingHeapProfile; + } + interface AddHeapSnapshotChunkEventDataType { + chunk: string; + } + interface ReportHeapSnapshotProgressEventDataType { + done: number; + total: number; + finished?: boolean | undefined; + } + interface LastSeenObjectIdEventDataType { + lastSeenObjectId: number; + timestamp: number; + } + interface HeapStatsUpdateEventDataType { + /** + * An array of triplets. Each triplet describes a fragment. The first integer is the fragment index, the second integer is a total count of objects for the fragment, the third integer is a total size of the objects for the fragment. + */ + statsUpdate: number[]; + } + } + namespace NodeTracing { + interface TraceConfig { + /** + * Controls how the trace buffer stores data. + */ + recordMode?: string; + /** + * Included category filters. + */ + includedCategories: string[]; + } + interface StartParameterType { + traceConfig: TraceConfig; + } + interface GetCategoriesReturnType { + /** + * A list of supported tracing categories. + */ + categories: string[]; + } + interface DataCollectedEventDataType { + value: Array<{}>; + } + } + namespace NodeWorker { + type WorkerID = string; + /** + * Unique identifier of attached debugging session. + */ + type SessionID = string; + interface WorkerInfo { + workerId: WorkerID; + type: string; + title: string; + url: string; + } + interface SendMessageToWorkerParameterType { + message: string; + /** + * Identifier of the session. + */ + sessionId: SessionID; + } + interface EnableParameterType { + /** + * Whether to new workers should be paused until the frontend sends `Runtime.runIfWaitingForDebugger` + * message to run them. + */ + waitForDebuggerOnStart: boolean; + } + interface DetachParameterType { + sessionId: SessionID; + } + interface AttachedToWorkerEventDataType { + /** + * Identifier assigned to the session used to send/receive messages. + */ + sessionId: SessionID; + workerInfo: WorkerInfo; + waitingForDebugger: boolean; + } + interface DetachedFromWorkerEventDataType { + /** + * Detached session identifier. + */ + sessionId: SessionID; + } + interface ReceivedMessageFromWorkerEventDataType { + /** + * Identifier of a session which sends a message. + */ + sessionId: SessionID; + message: string; + } + } + namespace NodeRuntime { + interface NotifyWhenWaitingForDisconnectParameterType { + enabled: boolean; + } + } + /** + * The `inspector.Session` is used for dispatching messages to the V8 inspector + * back-end and receiving message responses and notifications. + */ + class Session extends EventEmitter { + /** + * Create a new instance of the inspector.Session class. + * The inspector session needs to be connected through session.connect() before the messages can be dispatched to the inspector backend. + */ + constructor(); + /** + * Connects a session to the inspector back-end. + * @since v8.0.0 + */ + connect(): void; + /** + * Connects a session to the main thread inspector back-end. + * An exception will be thrown if this API was not called on a Worker + * thread. + * @since 12.11.0 + */ + connectToMainThread(): void; + /** + * Immediately close the session. All pending message callbacks will be called + * with an error. `session.connect()` will need to be called to be able to send + * messages again. Reconnected session will lose all inspector state, such as + * enabled agents or configured breakpoints. + * @since v8.0.0 + */ + disconnect(): void; + /** + * Posts a message to the inspector back-end. `callback` will be notified when + * a response is received. `callback` is a function that accepts two optional + * arguments: error and message-specific result. + * + * ```js + * session.post('Runtime.evaluate', { expression: '2 + 2' }, + * (error, { result }) => console.log(result)); + * // Output: { type: 'number', value: 4, description: '4' } + * ``` + * + * The latest version of the V8 inspector protocol is published on the [Chrome DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/v8/). + * + * Node.js inspector supports all the Chrome DevTools Protocol domains declared + * by V8\. Chrome DevTools Protocol domain provides an interface for interacting + * with one of the runtime agents used to inspect the application state and listen + * to the run-time events. + * + * ## Example usage + * + * Apart from the debugger, various V8 Profilers are available through the DevTools + * protocol. + * @since v8.0.0 + */ + post(method: string, params?: {}, callback?: (err: Error | null, params?: {}) => void): void; + post(method: string, callback?: (err: Error | null, params?: {}) => void): void; + /** + * Returns supported domains. + */ + post(method: 'Schema.getDomains', callback?: (err: Error | null, params: Schema.GetDomainsReturnType) => void): void; + /** + * Evaluates expression on global object. + */ + post(method: 'Runtime.evaluate', params?: Runtime.EvaluateParameterType, callback?: (err: Error | null, params: Runtime.EvaluateReturnType) => void): void; + post(method: 'Runtime.evaluate', callback?: (err: Error | null, params: Runtime.EvaluateReturnType) => void): void; + /** + * Add handler to promise with given promise object id. + */ + post(method: 'Runtime.awaitPromise', params?: Runtime.AwaitPromiseParameterType, callback?: (err: Error | null, params: Runtime.AwaitPromiseReturnType) => void): void; + post(method: 'Runtime.awaitPromise', callback?: (err: Error | null, params: Runtime.AwaitPromiseReturnType) => void): void; + /** + * Calls function with given declaration on the given object. Object group of the result is inherited from the target object. + */ + post(method: 'Runtime.callFunctionOn', params?: Runtime.CallFunctionOnParameterType, callback?: (err: Error | null, params: Runtime.CallFunctionOnReturnType) => void): void; + post(method: 'Runtime.callFunctionOn', callback?: (err: Error | null, params: Runtime.CallFunctionOnReturnType) => void): void; + /** + * Returns properties of a given object. Object group of the result is inherited from the target object. + */ + post(method: 'Runtime.getProperties', params?: Runtime.GetPropertiesParameterType, callback?: (err: Error | null, params: Runtime.GetPropertiesReturnType) => void): void; + post(method: 'Runtime.getProperties', callback?: (err: Error | null, params: Runtime.GetPropertiesReturnType) => void): void; + /** + * Releases remote object with given id. + */ + post(method: 'Runtime.releaseObject', params?: Runtime.ReleaseObjectParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Runtime.releaseObject', callback?: (err: Error | null) => void): void; + /** + * Releases all remote objects that belong to a given group. + */ + post(method: 'Runtime.releaseObjectGroup', params?: Runtime.ReleaseObjectGroupParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Runtime.releaseObjectGroup', callback?: (err: Error | null) => void): void; + /** + * Tells inspected instance to run if it was waiting for debugger to attach. + */ + post(method: 'Runtime.runIfWaitingForDebugger', callback?: (err: Error | null) => void): void; + /** + * Enables reporting of execution contexts creation by means of executionContextCreated event. When the reporting gets enabled the event will be sent immediately for each existing execution context. + */ + post(method: 'Runtime.enable', callback?: (err: Error | null) => void): void; + /** + * Disables reporting of execution contexts creation. + */ + post(method: 'Runtime.disable', callback?: (err: Error | null) => void): void; + /** + * Discards collected exceptions and console API calls. + */ + post(method: 'Runtime.discardConsoleEntries', callback?: (err: Error | null) => void): void; + /** + * @experimental + */ + post(method: 'Runtime.setCustomObjectFormatterEnabled', params?: Runtime.SetCustomObjectFormatterEnabledParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Runtime.setCustomObjectFormatterEnabled', callback?: (err: Error | null) => void): void; + /** + * Compiles expression. + */ + post(method: 'Runtime.compileScript', params?: Runtime.CompileScriptParameterType, callback?: (err: Error | null, params: Runtime.CompileScriptReturnType) => void): void; + post(method: 'Runtime.compileScript', callback?: (err: Error | null, params: Runtime.CompileScriptReturnType) => void): void; + /** + * Runs script with given id in a given context. + */ + post(method: 'Runtime.runScript', params?: Runtime.RunScriptParameterType, callback?: (err: Error | null, params: Runtime.RunScriptReturnType) => void): void; + post(method: 'Runtime.runScript', callback?: (err: Error | null, params: Runtime.RunScriptReturnType) => void): void; + post(method: 'Runtime.queryObjects', params?: Runtime.QueryObjectsParameterType, callback?: (err: Error | null, params: Runtime.QueryObjectsReturnType) => void): void; + post(method: 'Runtime.queryObjects', callback?: (err: Error | null, params: Runtime.QueryObjectsReturnType) => void): void; + /** + * Returns all let, const and class variables from global scope. + */ + post( + method: 'Runtime.globalLexicalScopeNames', + params?: Runtime.GlobalLexicalScopeNamesParameterType, + callback?: (err: Error | null, params: Runtime.GlobalLexicalScopeNamesReturnType) => void + ): void; + post(method: 'Runtime.globalLexicalScopeNames', callback?: (err: Error | null, params: Runtime.GlobalLexicalScopeNamesReturnType) => void): void; + /** + * Enables debugger for the given page. Clients should not assume that the debugging has been enabled until the result for this command is received. + */ + post(method: 'Debugger.enable', callback?: (err: Error | null, params: Debugger.EnableReturnType) => void): void; + /** + * Disables debugger for given page. + */ + post(method: 'Debugger.disable', callback?: (err: Error | null) => void): void; + /** + * Activates / deactivates all breakpoints on the page. + */ + post(method: 'Debugger.setBreakpointsActive', params?: Debugger.SetBreakpointsActiveParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Debugger.setBreakpointsActive', callback?: (err: Error | null) => void): void; + /** + * Makes page not interrupt on any pauses (breakpoint, exception, dom exception etc). + */ + post(method: 'Debugger.setSkipAllPauses', params?: Debugger.SetSkipAllPausesParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Debugger.setSkipAllPauses', callback?: (err: Error | null) => void): void; + /** + * Sets JavaScript breakpoint at given location specified either by URL or URL regex. Once this command is issued, all existing parsed scripts will have breakpoints resolved and returned in locations property. Further matching script parsing will result in subsequent breakpointResolved events issued. This logical breakpoint will survive page reloads. + */ + post(method: 'Debugger.setBreakpointByUrl', params?: Debugger.SetBreakpointByUrlParameterType, callback?: (err: Error | null, params: Debugger.SetBreakpointByUrlReturnType) => void): void; + post(method: 'Debugger.setBreakpointByUrl', callback?: (err: Error | null, params: Debugger.SetBreakpointByUrlReturnType) => void): void; + /** + * Sets JavaScript breakpoint at a given location. + */ + post(method: 'Debugger.setBreakpoint', params?: Debugger.SetBreakpointParameterType, callback?: (err: Error | null, params: Debugger.SetBreakpointReturnType) => void): void; + post(method: 'Debugger.setBreakpoint', callback?: (err: Error | null, params: Debugger.SetBreakpointReturnType) => void): void; + /** + * Removes JavaScript breakpoint. + */ + post(method: 'Debugger.removeBreakpoint', params?: Debugger.RemoveBreakpointParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Debugger.removeBreakpoint', callback?: (err: Error | null) => void): void; + /** + * Returns possible locations for breakpoint. scriptId in start and end range locations should be the same. + */ + post( + method: 'Debugger.getPossibleBreakpoints', + params?: Debugger.GetPossibleBreakpointsParameterType, + callback?: (err: Error | null, params: Debugger.GetPossibleBreakpointsReturnType) => void + ): void; + post(method: 'Debugger.getPossibleBreakpoints', callback?: (err: Error | null, params: Debugger.GetPossibleBreakpointsReturnType) => void): void; + /** + * Continues execution until specific location is reached. + */ + post(method: 'Debugger.continueToLocation', params?: Debugger.ContinueToLocationParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Debugger.continueToLocation', callback?: (err: Error | null) => void): void; + /** + * @experimental + */ + post(method: 'Debugger.pauseOnAsyncCall', params?: Debugger.PauseOnAsyncCallParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Debugger.pauseOnAsyncCall', callback?: (err: Error | null) => void): void; + /** + * Steps over the statement. + */ + post(method: 'Debugger.stepOver', callback?: (err: Error | null) => void): void; + /** + * Steps into the function call. + */ + post(method: 'Debugger.stepInto', params?: Debugger.StepIntoParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Debugger.stepInto', callback?: (err: Error | null) => void): void; + /** + * Steps out of the function call. + */ + post(method: 'Debugger.stepOut', callback?: (err: Error | null) => void): void; + /** + * Stops on the next JavaScript statement. + */ + post(method: 'Debugger.pause', callback?: (err: Error | null) => void): void; + /** + * This method is deprecated - use Debugger.stepInto with breakOnAsyncCall and Debugger.pauseOnAsyncTask instead. Steps into next scheduled async task if any is scheduled before next pause. Returns success when async task is actually scheduled, returns error if no task were scheduled or another scheduleStepIntoAsync was called. + * @experimental + */ + post(method: 'Debugger.scheduleStepIntoAsync', callback?: (err: Error | null) => void): void; + /** + * Resumes JavaScript execution. + */ + post(method: 'Debugger.resume', callback?: (err: Error | null) => void): void; + /** + * Returns stack trace with given stackTraceId. + * @experimental + */ + post(method: 'Debugger.getStackTrace', params?: Debugger.GetStackTraceParameterType, callback?: (err: Error | null, params: Debugger.GetStackTraceReturnType) => void): void; + post(method: 'Debugger.getStackTrace', callback?: (err: Error | null, params: Debugger.GetStackTraceReturnType) => void): void; + /** + * Searches for given string in script content. + */ + post(method: 'Debugger.searchInContent', params?: Debugger.SearchInContentParameterType, callback?: (err: Error | null, params: Debugger.SearchInContentReturnType) => void): void; + post(method: 'Debugger.searchInContent', callback?: (err: Error | null, params: Debugger.SearchInContentReturnType) => void): void; + /** + * Edits JavaScript source live. + */ + post(method: 'Debugger.setScriptSource', params?: Debugger.SetScriptSourceParameterType, callback?: (err: Error | null, params: Debugger.SetScriptSourceReturnType) => void): void; + post(method: 'Debugger.setScriptSource', callback?: (err: Error | null, params: Debugger.SetScriptSourceReturnType) => void): void; + /** + * Restarts particular call frame from the beginning. + */ + post(method: 'Debugger.restartFrame', params?: Debugger.RestartFrameParameterType, callback?: (err: Error | null, params: Debugger.RestartFrameReturnType) => void): void; + post(method: 'Debugger.restartFrame', callback?: (err: Error | null, params: Debugger.RestartFrameReturnType) => void): void; + /** + * Returns source for the script with given id. + */ + post(method: 'Debugger.getScriptSource', params?: Debugger.GetScriptSourceParameterType, callback?: (err: Error | null, params: Debugger.GetScriptSourceReturnType) => void): void; + post(method: 'Debugger.getScriptSource', callback?: (err: Error | null, params: Debugger.GetScriptSourceReturnType) => void): void; + /** + * Defines pause on exceptions state. Can be set to stop on all exceptions, uncaught exceptions or no exceptions. Initial pause on exceptions state is none. + */ + post(method: 'Debugger.setPauseOnExceptions', params?: Debugger.SetPauseOnExceptionsParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Debugger.setPauseOnExceptions', callback?: (err: Error | null) => void): void; + /** + * Evaluates expression on a given call frame. + */ + post(method: 'Debugger.evaluateOnCallFrame', params?: Debugger.EvaluateOnCallFrameParameterType, callback?: (err: Error | null, params: Debugger.EvaluateOnCallFrameReturnType) => void): void; + post(method: 'Debugger.evaluateOnCallFrame', callback?: (err: Error | null, params: Debugger.EvaluateOnCallFrameReturnType) => void): void; + /** + * Changes value of variable in a callframe. Object-based scopes are not supported and must be mutated manually. + */ + post(method: 'Debugger.setVariableValue', params?: Debugger.SetVariableValueParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Debugger.setVariableValue', callback?: (err: Error | null) => void): void; + /** + * Changes return value in top frame. Available only at return break position. + * @experimental + */ + post(method: 'Debugger.setReturnValue', params?: Debugger.SetReturnValueParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Debugger.setReturnValue', callback?: (err: Error | null) => void): void; + /** + * Enables or disables async call stacks tracking. + */ + post(method: 'Debugger.setAsyncCallStackDepth', params?: Debugger.SetAsyncCallStackDepthParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Debugger.setAsyncCallStackDepth', callback?: (err: Error | null) => void): void; + /** + * Replace previous blackbox patterns with passed ones. Forces backend to skip stepping/pausing in scripts with url matching one of the patterns. VM will try to leave blackboxed script by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. + * @experimental + */ + post(method: 'Debugger.setBlackboxPatterns', params?: Debugger.SetBlackboxPatternsParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Debugger.setBlackboxPatterns', callback?: (err: Error | null) => void): void; + /** + * Makes backend skip steps in the script in blackboxed ranges. VM will try leave blacklisted scripts by performing 'step in' several times, finally resorting to 'step out' if unsuccessful. Positions array contains positions where blackbox state is changed. First interval isn't blackboxed. Array should be sorted. + * @experimental + */ + post(method: 'Debugger.setBlackboxedRanges', params?: Debugger.SetBlackboxedRangesParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Debugger.setBlackboxedRanges', callback?: (err: Error | null) => void): void; + /** + * Enables console domain, sends the messages collected so far to the client by means of the messageAdded notification. + */ + post(method: 'Console.enable', callback?: (err: Error | null) => void): void; + /** + * Disables console domain, prevents further console messages from being reported to the client. + */ + post(method: 'Console.disable', callback?: (err: Error | null) => void): void; + /** + * Does nothing. + */ + post(method: 'Console.clearMessages', callback?: (err: Error | null) => void): void; + post(method: 'Profiler.enable', callback?: (err: Error | null) => void): void; + post(method: 'Profiler.disable', callback?: (err: Error | null) => void): void; + /** + * Changes CPU profiler sampling interval. Must be called before CPU profiles recording started. + */ + post(method: 'Profiler.setSamplingInterval', params?: Profiler.SetSamplingIntervalParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Profiler.setSamplingInterval', callback?: (err: Error | null) => void): void; + post(method: 'Profiler.start', callback?: (err: Error | null) => void): void; + post(method: 'Profiler.stop', callback?: (err: Error | null, params: Profiler.StopReturnType) => void): void; + /** + * Enable precise code coverage. Coverage data for JavaScript executed before enabling precise code coverage may be incomplete. Enabling prevents running optimized code and resets execution counters. + */ + post(method: 'Profiler.startPreciseCoverage', params?: Profiler.StartPreciseCoverageParameterType, callback?: (err: Error | null) => void): void; + post(method: 'Profiler.startPreciseCoverage', callback?: (err: Error | null) => void): void; + /** + * Disable precise code coverage. Disabling releases unnecessary execution count records and allows executing optimized code. + */ + post(method: 'Profiler.stopPreciseCoverage', callback?: (err: Error | null) => void): void; + /** + * Collect coverage data for the current isolate, and resets execution counters. Precise code coverage needs to have started. + */ + post(method: 'Profiler.takePreciseCoverage', callback?: (err: Error | null, params: Profiler.TakePreciseCoverageReturnType) => void): void; + /** + * Collect coverage data for the current isolate. The coverage data may be incomplete due to garbage collection. + */ + post(method: 'Profiler.getBestEffortCoverage', callback?: (err: Error | null, params: Profiler.GetBestEffortCoverageReturnType) => void): void; + /** + * Enable type profile. + * @experimental + */ + post(method: 'Profiler.startTypeProfile', callback?: (err: Error | null) => void): void; + /** + * Disable type profile. Disabling releases type profile data collected so far. + * @experimental + */ + post(method: 'Profiler.stopTypeProfile', callback?: (err: Error | null) => void): void; + /** + * Collect type profile. + * @experimental + */ + post(method: 'Profiler.takeTypeProfile', callback?: (err: Error | null, params: Profiler.TakeTypeProfileReturnType) => void): void; + post(method: 'HeapProfiler.enable', callback?: (err: Error | null) => void): void; + post(method: 'HeapProfiler.disable', callback?: (err: Error | null) => void): void; + post(method: 'HeapProfiler.startTrackingHeapObjects', params?: HeapProfiler.StartTrackingHeapObjectsParameterType, callback?: (err: Error | null) => void): void; + post(method: 'HeapProfiler.startTrackingHeapObjects', callback?: (err: Error | null) => void): void; + post(method: 'HeapProfiler.stopTrackingHeapObjects', params?: HeapProfiler.StopTrackingHeapObjectsParameterType, callback?: (err: Error | null) => void): void; + post(method: 'HeapProfiler.stopTrackingHeapObjects', callback?: (err: Error | null) => void): void; + post(method: 'HeapProfiler.takeHeapSnapshot', params?: HeapProfiler.TakeHeapSnapshotParameterType, callback?: (err: Error | null) => void): void; + post(method: 'HeapProfiler.takeHeapSnapshot', callback?: (err: Error | null) => void): void; + post(method: 'HeapProfiler.collectGarbage', callback?: (err: Error | null) => void): void; + post( + method: 'HeapProfiler.getObjectByHeapObjectId', + params?: HeapProfiler.GetObjectByHeapObjectIdParameterType, + callback?: (err: Error | null, params: HeapProfiler.GetObjectByHeapObjectIdReturnType) => void + ): void; + post(method: 'HeapProfiler.getObjectByHeapObjectId', callback?: (err: Error | null, params: HeapProfiler.GetObjectByHeapObjectIdReturnType) => void): void; + /** + * Enables console to refer to the node with given id via $x (see Command Line API for more details $x functions). + */ + post(method: 'HeapProfiler.addInspectedHeapObject', params?: HeapProfiler.AddInspectedHeapObjectParameterType, callback?: (err: Error | null) => void): void; + post(method: 'HeapProfiler.addInspectedHeapObject', callback?: (err: Error | null) => void): void; + post(method: 'HeapProfiler.getHeapObjectId', params?: HeapProfiler.GetHeapObjectIdParameterType, callback?: (err: Error | null, params: HeapProfiler.GetHeapObjectIdReturnType) => void): void; + post(method: 'HeapProfiler.getHeapObjectId', callback?: (err: Error | null, params: HeapProfiler.GetHeapObjectIdReturnType) => void): void; + post(method: 'HeapProfiler.startSampling', params?: HeapProfiler.StartSamplingParameterType, callback?: (err: Error | null) => void): void; + post(method: 'HeapProfiler.startSampling', callback?: (err: Error | null) => void): void; + post(method: 'HeapProfiler.stopSampling', callback?: (err: Error | null, params: HeapProfiler.StopSamplingReturnType) => void): void; + post(method: 'HeapProfiler.getSamplingProfile', callback?: (err: Error | null, params: HeapProfiler.GetSamplingProfileReturnType) => void): void; + /** + * Gets supported tracing categories. + */ + post(method: 'NodeTracing.getCategories', callback?: (err: Error | null, params: NodeTracing.GetCategoriesReturnType) => void): void; + /** + * Start trace events collection. + */ + post(method: 'NodeTracing.start', params?: NodeTracing.StartParameterType, callback?: (err: Error | null) => void): void; + post(method: 'NodeTracing.start', callback?: (err: Error | null) => void): void; + /** + * Stop trace events collection. Remaining collected events will be sent as a sequence of + * dataCollected events followed by tracingComplete event. + */ + post(method: 'NodeTracing.stop', callback?: (err: Error | null) => void): void; + /** + * Sends protocol message over session with given id. + */ + post(method: 'NodeWorker.sendMessageToWorker', params?: NodeWorker.SendMessageToWorkerParameterType, callback?: (err: Error | null) => void): void; + post(method: 'NodeWorker.sendMessageToWorker', callback?: (err: Error | null) => void): void; + /** + * Instructs the inspector to attach to running workers. Will also attach to new workers + * as they start + */ + post(method: 'NodeWorker.enable', params?: NodeWorker.EnableParameterType, callback?: (err: Error | null) => void): void; + post(method: 'NodeWorker.enable', callback?: (err: Error | null) => void): void; + /** + * Detaches from all running workers and disables attaching to new workers as they are started. + */ + post(method: 'NodeWorker.disable', callback?: (err: Error | null) => void): void; + /** + * Detached from the worker with given sessionId. + */ + post(method: 'NodeWorker.detach', params?: NodeWorker.DetachParameterType, callback?: (err: Error | null) => void): void; + post(method: 'NodeWorker.detach', callback?: (err: Error | null) => void): void; + /** + * Enable the `NodeRuntime.waitingForDisconnect`. + */ + post(method: 'NodeRuntime.notifyWhenWaitingForDisconnect', params?: NodeRuntime.NotifyWhenWaitingForDisconnectParameterType, callback?: (err: Error | null) => void): void; + post(method: 'NodeRuntime.notifyWhenWaitingForDisconnect', callback?: (err: Error | null) => void): void; + // Events + addListener(event: string, listener: (...args: any[]) => void): this; + /** + * Emitted when any notification from the V8 Inspector is received. + */ + addListener(event: 'inspectorNotification', listener: (message: InspectorNotification<{}>) => void): this; + /** + * Issued when new execution context is created. + */ + addListener(event: 'Runtime.executionContextCreated', listener: (message: InspectorNotification) => void): this; + /** + * Issued when execution context is destroyed. + */ + addListener(event: 'Runtime.executionContextDestroyed', listener: (message: InspectorNotification) => void): this; + /** + * Issued when all executionContexts were cleared in browser + */ + addListener(event: 'Runtime.executionContextsCleared', listener: () => void): this; + /** + * Issued when exception was thrown and unhandled. + */ + addListener(event: 'Runtime.exceptionThrown', listener: (message: InspectorNotification) => void): this; + /** + * Issued when unhandled exception was revoked. + */ + addListener(event: 'Runtime.exceptionRevoked', listener: (message: InspectorNotification) => void): this; + /** + * Issued when console API was called. + */ + addListener(event: 'Runtime.consoleAPICalled', listener: (message: InspectorNotification) => void): this; + /** + * Issued when object should be inspected (for example, as a result of inspect() command line API call). + */ + addListener(event: 'Runtime.inspectRequested', listener: (message: InspectorNotification) => void): this; + /** + * Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger. + */ + addListener(event: 'Debugger.scriptParsed', listener: (message: InspectorNotification) => void): this; + /** + * Fired when virtual machine fails to parse the script. + */ + addListener(event: 'Debugger.scriptFailedToParse', listener: (message: InspectorNotification) => void): this; + /** + * Fired when breakpoint is resolved to an actual script and location. + */ + addListener(event: 'Debugger.breakpointResolved', listener: (message: InspectorNotification) => void): this; + /** + * Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria. + */ + addListener(event: 'Debugger.paused', listener: (message: InspectorNotification) => void): this; + /** + * Fired when the virtual machine resumed execution. + */ + addListener(event: 'Debugger.resumed', listener: () => void): this; + /** + * Issued when new console message is added. + */ + addListener(event: 'Console.messageAdded', listener: (message: InspectorNotification) => void): this; + /** + * Sent when new profile recording is started using console.profile() call. + */ + addListener(event: 'Profiler.consoleProfileStarted', listener: (message: InspectorNotification) => void): this; + addListener(event: 'Profiler.consoleProfileFinished', listener: (message: InspectorNotification) => void): this; + addListener(event: 'HeapProfiler.addHeapSnapshotChunk', listener: (message: InspectorNotification) => void): this; + addListener(event: 'HeapProfiler.resetProfiles', listener: () => void): this; + addListener(event: 'HeapProfiler.reportHeapSnapshotProgress', listener: (message: InspectorNotification) => void): this; + /** + * If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event. + */ + addListener(event: 'HeapProfiler.lastSeenObjectId', listener: (message: InspectorNotification) => void): this; + /** + * If heap objects tracking has been started then backend may send update for one or more fragments + */ + addListener(event: 'HeapProfiler.heapStatsUpdate', listener: (message: InspectorNotification) => void): this; + /** + * Contains an bucket of collected trace events. + */ + addListener(event: 'NodeTracing.dataCollected', listener: (message: InspectorNotification) => void): this; + /** + * Signals that tracing is stopped and there is no trace buffers pending flush, all data were + * delivered via dataCollected events. + */ + addListener(event: 'NodeTracing.tracingComplete', listener: () => void): this; + /** + * Issued when attached to a worker. + */ + addListener(event: 'NodeWorker.attachedToWorker', listener: (message: InspectorNotification) => void): this; + /** + * Issued when detached from the worker. + */ + addListener(event: 'NodeWorker.detachedFromWorker', listener: (message: InspectorNotification) => void): this; + /** + * Notifies about a new protocol message received from the session + * (session ID is provided in attachedToWorker notification). + */ + addListener(event: 'NodeWorker.receivedMessageFromWorker', listener: (message: InspectorNotification) => void): this; + /** + * This event is fired instead of `Runtime.executionContextDestroyed` when + * enabled. + * It is fired when the Node process finished all code execution and is + * waiting for all frontends to disconnect. + */ + addListener(event: 'NodeRuntime.waitingForDisconnect', listener: () => void): this; + emit(event: string | symbol, ...args: any[]): boolean; + emit(event: 'inspectorNotification', message: InspectorNotification<{}>): boolean; + emit(event: 'Runtime.executionContextCreated', message: InspectorNotification): boolean; + emit(event: 'Runtime.executionContextDestroyed', message: InspectorNotification): boolean; + emit(event: 'Runtime.executionContextsCleared'): boolean; + emit(event: 'Runtime.exceptionThrown', message: InspectorNotification): boolean; + emit(event: 'Runtime.exceptionRevoked', message: InspectorNotification): boolean; + emit(event: 'Runtime.consoleAPICalled', message: InspectorNotification): boolean; + emit(event: 'Runtime.inspectRequested', message: InspectorNotification): boolean; + emit(event: 'Debugger.scriptParsed', message: InspectorNotification): boolean; + emit(event: 'Debugger.scriptFailedToParse', message: InspectorNotification): boolean; + emit(event: 'Debugger.breakpointResolved', message: InspectorNotification): boolean; + emit(event: 'Debugger.paused', message: InspectorNotification): boolean; + emit(event: 'Debugger.resumed'): boolean; + emit(event: 'Console.messageAdded', message: InspectorNotification): boolean; + emit(event: 'Profiler.consoleProfileStarted', message: InspectorNotification): boolean; + emit(event: 'Profiler.consoleProfileFinished', message: InspectorNotification): boolean; + emit(event: 'HeapProfiler.addHeapSnapshotChunk', message: InspectorNotification): boolean; + emit(event: 'HeapProfiler.resetProfiles'): boolean; + emit(event: 'HeapProfiler.reportHeapSnapshotProgress', message: InspectorNotification): boolean; + emit(event: 'HeapProfiler.lastSeenObjectId', message: InspectorNotification): boolean; + emit(event: 'HeapProfiler.heapStatsUpdate', message: InspectorNotification): boolean; + emit(event: 'NodeTracing.dataCollected', message: InspectorNotification): boolean; + emit(event: 'NodeTracing.tracingComplete'): boolean; + emit(event: 'NodeWorker.attachedToWorker', message: InspectorNotification): boolean; + emit(event: 'NodeWorker.detachedFromWorker', message: InspectorNotification): boolean; + emit(event: 'NodeWorker.receivedMessageFromWorker', message: InspectorNotification): boolean; + emit(event: 'NodeRuntime.waitingForDisconnect'): boolean; + on(event: string, listener: (...args: any[]) => void): this; + /** + * Emitted when any notification from the V8 Inspector is received. + */ + on(event: 'inspectorNotification', listener: (message: InspectorNotification<{}>) => void): this; + /** + * Issued when new execution context is created. + */ + on(event: 'Runtime.executionContextCreated', listener: (message: InspectorNotification) => void): this; + /** + * Issued when execution context is destroyed. + */ + on(event: 'Runtime.executionContextDestroyed', listener: (message: InspectorNotification) => void): this; + /** + * Issued when all executionContexts were cleared in browser + */ + on(event: 'Runtime.executionContextsCleared', listener: () => void): this; + /** + * Issued when exception was thrown and unhandled. + */ + on(event: 'Runtime.exceptionThrown', listener: (message: InspectorNotification) => void): this; + /** + * Issued when unhandled exception was revoked. + */ + on(event: 'Runtime.exceptionRevoked', listener: (message: InspectorNotification) => void): this; + /** + * Issued when console API was called. + */ + on(event: 'Runtime.consoleAPICalled', listener: (message: InspectorNotification) => void): this; + /** + * Issued when object should be inspected (for example, as a result of inspect() command line API call). + */ + on(event: 'Runtime.inspectRequested', listener: (message: InspectorNotification) => void): this; + /** + * Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger. + */ + on(event: 'Debugger.scriptParsed', listener: (message: InspectorNotification) => void): this; + /** + * Fired when virtual machine fails to parse the script. + */ + on(event: 'Debugger.scriptFailedToParse', listener: (message: InspectorNotification) => void): this; + /** + * Fired when breakpoint is resolved to an actual script and location. + */ + on(event: 'Debugger.breakpointResolved', listener: (message: InspectorNotification) => void): this; + /** + * Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria. + */ + on(event: 'Debugger.paused', listener: (message: InspectorNotification) => void): this; + /** + * Fired when the virtual machine resumed execution. + */ + on(event: 'Debugger.resumed', listener: () => void): this; + /** + * Issued when new console message is added. + */ + on(event: 'Console.messageAdded', listener: (message: InspectorNotification) => void): this; + /** + * Sent when new profile recording is started using console.profile() call. + */ + on(event: 'Profiler.consoleProfileStarted', listener: (message: InspectorNotification) => void): this; + on(event: 'Profiler.consoleProfileFinished', listener: (message: InspectorNotification) => void): this; + on(event: 'HeapProfiler.addHeapSnapshotChunk', listener: (message: InspectorNotification) => void): this; + on(event: 'HeapProfiler.resetProfiles', listener: () => void): this; + on(event: 'HeapProfiler.reportHeapSnapshotProgress', listener: (message: InspectorNotification) => void): this; + /** + * If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event. + */ + on(event: 'HeapProfiler.lastSeenObjectId', listener: (message: InspectorNotification) => void): this; + /** + * If heap objects tracking has been started then backend may send update for one or more fragments + */ + on(event: 'HeapProfiler.heapStatsUpdate', listener: (message: InspectorNotification) => void): this; + /** + * Contains an bucket of collected trace events. + */ + on(event: 'NodeTracing.dataCollected', listener: (message: InspectorNotification) => void): this; + /** + * Signals that tracing is stopped and there is no trace buffers pending flush, all data were + * delivered via dataCollected events. + */ + on(event: 'NodeTracing.tracingComplete', listener: () => void): this; + /** + * Issued when attached to a worker. + */ + on(event: 'NodeWorker.attachedToWorker', listener: (message: InspectorNotification) => void): this; + /** + * Issued when detached from the worker. + */ + on(event: 'NodeWorker.detachedFromWorker', listener: (message: InspectorNotification) => void): this; + /** + * Notifies about a new protocol message received from the session + * (session ID is provided in attachedToWorker notification). + */ + on(event: 'NodeWorker.receivedMessageFromWorker', listener: (message: InspectorNotification) => void): this; + /** + * This event is fired instead of `Runtime.executionContextDestroyed` when + * enabled. + * It is fired when the Node process finished all code execution and is + * waiting for all frontends to disconnect. + */ + on(event: 'NodeRuntime.waitingForDisconnect', listener: () => void): this; + once(event: string, listener: (...args: any[]) => void): this; + /** + * Emitted when any notification from the V8 Inspector is received. + */ + once(event: 'inspectorNotification', listener: (message: InspectorNotification<{}>) => void): this; + /** + * Issued when new execution context is created. + */ + once(event: 'Runtime.executionContextCreated', listener: (message: InspectorNotification) => void): this; + /** + * Issued when execution context is destroyed. + */ + once(event: 'Runtime.executionContextDestroyed', listener: (message: InspectorNotification) => void): this; + /** + * Issued when all executionContexts were cleared in browser + */ + once(event: 'Runtime.executionContextsCleared', listener: () => void): this; + /** + * Issued when exception was thrown and unhandled. + */ + once(event: 'Runtime.exceptionThrown', listener: (message: InspectorNotification) => void): this; + /** + * Issued when unhandled exception was revoked. + */ + once(event: 'Runtime.exceptionRevoked', listener: (message: InspectorNotification) => void): this; + /** + * Issued when console API was called. + */ + once(event: 'Runtime.consoleAPICalled', listener: (message: InspectorNotification) => void): this; + /** + * Issued when object should be inspected (for example, as a result of inspect() command line API call). + */ + once(event: 'Runtime.inspectRequested', listener: (message: InspectorNotification) => void): this; + /** + * Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger. + */ + once(event: 'Debugger.scriptParsed', listener: (message: InspectorNotification) => void): this; + /** + * Fired when virtual machine fails to parse the script. + */ + once(event: 'Debugger.scriptFailedToParse', listener: (message: InspectorNotification) => void): this; + /** + * Fired when breakpoint is resolved to an actual script and location. + */ + once(event: 'Debugger.breakpointResolved', listener: (message: InspectorNotification) => void): this; + /** + * Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria. + */ + once(event: 'Debugger.paused', listener: (message: InspectorNotification) => void): this; + /** + * Fired when the virtual machine resumed execution. + */ + once(event: 'Debugger.resumed', listener: () => void): this; + /** + * Issued when new console message is added. + */ + once(event: 'Console.messageAdded', listener: (message: InspectorNotification) => void): this; + /** + * Sent when new profile recording is started using console.profile() call. + */ + once(event: 'Profiler.consoleProfileStarted', listener: (message: InspectorNotification) => void): this; + once(event: 'Profiler.consoleProfileFinished', listener: (message: InspectorNotification) => void): this; + once(event: 'HeapProfiler.addHeapSnapshotChunk', listener: (message: InspectorNotification) => void): this; + once(event: 'HeapProfiler.resetProfiles', listener: () => void): this; + once(event: 'HeapProfiler.reportHeapSnapshotProgress', listener: (message: InspectorNotification) => void): this; + /** + * If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event. + */ + once(event: 'HeapProfiler.lastSeenObjectId', listener: (message: InspectorNotification) => void): this; + /** + * If heap objects tracking has been started then backend may send update for one or more fragments + */ + once(event: 'HeapProfiler.heapStatsUpdate', listener: (message: InspectorNotification) => void): this; + /** + * Contains an bucket of collected trace events. + */ + once(event: 'NodeTracing.dataCollected', listener: (message: InspectorNotification) => void): this; + /** + * Signals that tracing is stopped and there is no trace buffers pending flush, all data were + * delivered via dataCollected events. + */ + once(event: 'NodeTracing.tracingComplete', listener: () => void): this; + /** + * Issued when attached to a worker. + */ + once(event: 'NodeWorker.attachedToWorker', listener: (message: InspectorNotification) => void): this; + /** + * Issued when detached from the worker. + */ + once(event: 'NodeWorker.detachedFromWorker', listener: (message: InspectorNotification) => void): this; + /** + * Notifies about a new protocol message received from the session + * (session ID is provided in attachedToWorker notification). + */ + once(event: 'NodeWorker.receivedMessageFromWorker', listener: (message: InspectorNotification) => void): this; + /** + * This event is fired instead of `Runtime.executionContextDestroyed` when + * enabled. + * It is fired when the Node process finished all code execution and is + * waiting for all frontends to disconnect. + */ + once(event: 'NodeRuntime.waitingForDisconnect', listener: () => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + /** + * Emitted when any notification from the V8 Inspector is received. + */ + prependListener(event: 'inspectorNotification', listener: (message: InspectorNotification<{}>) => void): this; + /** + * Issued when new execution context is created. + */ + prependListener(event: 'Runtime.executionContextCreated', listener: (message: InspectorNotification) => void): this; + /** + * Issued when execution context is destroyed. + */ + prependListener(event: 'Runtime.executionContextDestroyed', listener: (message: InspectorNotification) => void): this; + /** + * Issued when all executionContexts were cleared in browser + */ + prependListener(event: 'Runtime.executionContextsCleared', listener: () => void): this; + /** + * Issued when exception was thrown and unhandled. + */ + prependListener(event: 'Runtime.exceptionThrown', listener: (message: InspectorNotification) => void): this; + /** + * Issued when unhandled exception was revoked. + */ + prependListener(event: 'Runtime.exceptionRevoked', listener: (message: InspectorNotification) => void): this; + /** + * Issued when console API was called. + */ + prependListener(event: 'Runtime.consoleAPICalled', listener: (message: InspectorNotification) => void): this; + /** + * Issued when object should be inspected (for example, as a result of inspect() command line API call). + */ + prependListener(event: 'Runtime.inspectRequested', listener: (message: InspectorNotification) => void): this; + /** + * Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger. + */ + prependListener(event: 'Debugger.scriptParsed', listener: (message: InspectorNotification) => void): this; + /** + * Fired when virtual machine fails to parse the script. + */ + prependListener(event: 'Debugger.scriptFailedToParse', listener: (message: InspectorNotification) => void): this; + /** + * Fired when breakpoint is resolved to an actual script and location. + */ + prependListener(event: 'Debugger.breakpointResolved', listener: (message: InspectorNotification) => void): this; + /** + * Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria. + */ + prependListener(event: 'Debugger.paused', listener: (message: InspectorNotification) => void): this; + /** + * Fired when the virtual machine resumed execution. + */ + prependListener(event: 'Debugger.resumed', listener: () => void): this; + /** + * Issued when new console message is added. + */ + prependListener(event: 'Console.messageAdded', listener: (message: InspectorNotification) => void): this; + /** + * Sent when new profile recording is started using console.profile() call. + */ + prependListener(event: 'Profiler.consoleProfileStarted', listener: (message: InspectorNotification) => void): this; + prependListener(event: 'Profiler.consoleProfileFinished', listener: (message: InspectorNotification) => void): this; + prependListener(event: 'HeapProfiler.addHeapSnapshotChunk', listener: (message: InspectorNotification) => void): this; + prependListener(event: 'HeapProfiler.resetProfiles', listener: () => void): this; + prependListener(event: 'HeapProfiler.reportHeapSnapshotProgress', listener: (message: InspectorNotification) => void): this; + /** + * If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event. + */ + prependListener(event: 'HeapProfiler.lastSeenObjectId', listener: (message: InspectorNotification) => void): this; + /** + * If heap objects tracking has been started then backend may send update for one or more fragments + */ + prependListener(event: 'HeapProfiler.heapStatsUpdate', listener: (message: InspectorNotification) => void): this; + /** + * Contains an bucket of collected trace events. + */ + prependListener(event: 'NodeTracing.dataCollected', listener: (message: InspectorNotification) => void): this; + /** + * Signals that tracing is stopped and there is no trace buffers pending flush, all data were + * delivered via dataCollected events. + */ + prependListener(event: 'NodeTracing.tracingComplete', listener: () => void): this; + /** + * Issued when attached to a worker. + */ + prependListener(event: 'NodeWorker.attachedToWorker', listener: (message: InspectorNotification) => void): this; + /** + * Issued when detached from the worker. + */ + prependListener(event: 'NodeWorker.detachedFromWorker', listener: (message: InspectorNotification) => void): this; + /** + * Notifies about a new protocol message received from the session + * (session ID is provided in attachedToWorker notification). + */ + prependListener(event: 'NodeWorker.receivedMessageFromWorker', listener: (message: InspectorNotification) => void): this; + /** + * This event is fired instead of `Runtime.executionContextDestroyed` when + * enabled. + * It is fired when the Node process finished all code execution and is + * waiting for all frontends to disconnect. + */ + prependListener(event: 'NodeRuntime.waitingForDisconnect', listener: () => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + /** + * Emitted when any notification from the V8 Inspector is received. + */ + prependOnceListener(event: 'inspectorNotification', listener: (message: InspectorNotification<{}>) => void): this; + /** + * Issued when new execution context is created. + */ + prependOnceListener(event: 'Runtime.executionContextCreated', listener: (message: InspectorNotification) => void): this; + /** + * Issued when execution context is destroyed. + */ + prependOnceListener(event: 'Runtime.executionContextDestroyed', listener: (message: InspectorNotification) => void): this; + /** + * Issued when all executionContexts were cleared in browser + */ + prependOnceListener(event: 'Runtime.executionContextsCleared', listener: () => void): this; + /** + * Issued when exception was thrown and unhandled. + */ + prependOnceListener(event: 'Runtime.exceptionThrown', listener: (message: InspectorNotification) => void): this; + /** + * Issued when unhandled exception was revoked. + */ + prependOnceListener(event: 'Runtime.exceptionRevoked', listener: (message: InspectorNotification) => void): this; + /** + * Issued when console API was called. + */ + prependOnceListener(event: 'Runtime.consoleAPICalled', listener: (message: InspectorNotification) => void): this; + /** + * Issued when object should be inspected (for example, as a result of inspect() command line API call). + */ + prependOnceListener(event: 'Runtime.inspectRequested', listener: (message: InspectorNotification) => void): this; + /** + * Fired when virtual machine parses script. This event is also fired for all known and uncollected scripts upon enabling debugger. + */ + prependOnceListener(event: 'Debugger.scriptParsed', listener: (message: InspectorNotification) => void): this; + /** + * Fired when virtual machine fails to parse the script. + */ + prependOnceListener(event: 'Debugger.scriptFailedToParse', listener: (message: InspectorNotification) => void): this; + /** + * Fired when breakpoint is resolved to an actual script and location. + */ + prependOnceListener(event: 'Debugger.breakpointResolved', listener: (message: InspectorNotification) => void): this; + /** + * Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria. + */ + prependOnceListener(event: 'Debugger.paused', listener: (message: InspectorNotification) => void): this; + /** + * Fired when the virtual machine resumed execution. + */ + prependOnceListener(event: 'Debugger.resumed', listener: () => void): this; + /** + * Issued when new console message is added. + */ + prependOnceListener(event: 'Console.messageAdded', listener: (message: InspectorNotification) => void): this; + /** + * Sent when new profile recording is started using console.profile() call. + */ + prependOnceListener(event: 'Profiler.consoleProfileStarted', listener: (message: InspectorNotification) => void): this; + prependOnceListener(event: 'Profiler.consoleProfileFinished', listener: (message: InspectorNotification) => void): this; + prependOnceListener(event: 'HeapProfiler.addHeapSnapshotChunk', listener: (message: InspectorNotification) => void): this; + prependOnceListener(event: 'HeapProfiler.resetProfiles', listener: () => void): this; + prependOnceListener(event: 'HeapProfiler.reportHeapSnapshotProgress', listener: (message: InspectorNotification) => void): this; + /** + * If heap objects tracking has been started then backend regularly sends a current value for last seen object id and corresponding timestamp. If the were changes in the heap since last event then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event. + */ + prependOnceListener(event: 'HeapProfiler.lastSeenObjectId', listener: (message: InspectorNotification) => void): this; + /** + * If heap objects tracking has been started then backend may send update for one or more fragments + */ + prependOnceListener(event: 'HeapProfiler.heapStatsUpdate', listener: (message: InspectorNotification) => void): this; + /** + * Contains an bucket of collected trace events. + */ + prependOnceListener(event: 'NodeTracing.dataCollected', listener: (message: InspectorNotification) => void): this; + /** + * Signals that tracing is stopped and there is no trace buffers pending flush, all data were + * delivered via dataCollected events. + */ + prependOnceListener(event: 'NodeTracing.tracingComplete', listener: () => void): this; + /** + * Issued when attached to a worker. + */ + prependOnceListener(event: 'NodeWorker.attachedToWorker', listener: (message: InspectorNotification) => void): this; + /** + * Issued when detached from the worker. + */ + prependOnceListener(event: 'NodeWorker.detachedFromWorker', listener: (message: InspectorNotification) => void): this; + /** + * Notifies about a new protocol message received from the session + * (session ID is provided in attachedToWorker notification). + */ + prependOnceListener(event: 'NodeWorker.receivedMessageFromWorker', listener: (message: InspectorNotification) => void): this; + /** + * This event is fired instead of `Runtime.executionContextDestroyed` when + * enabled. + * It is fired when the Node process finished all code execution and is + * waiting for all frontends to disconnect. + */ + prependOnceListener(event: 'NodeRuntime.waitingForDisconnect', listener: () => void): this; + } + /** + * Activate inspector on host and port. Equivalent to `node --inspect=[[host:]port]`, but can be done programmatically after node has + * started. + * + * If wait is `true`, will block until a client has connected to the inspect port + * and flow control has been passed to the debugger client. + * + * See the `security warning` regarding the `host`parameter usage. + * @param [port='what was specified on the CLI'] Port to listen on for inspector connections. Optional. + * @param [host='what was specified on the CLI'] Host to listen on for inspector connections. Optional. + * @param [wait=false] Block until a client has connected. Optional. + */ + function open(port?: number, host?: string, wait?: boolean): void; + /** + * Deactivate the inspector. Blocks until there are no active connections. + */ + function close(): void; + /** + * Return the URL of the active inspector, or `undefined` if there is none. + * + * ```console + * $ node --inspect -p 'inspector.url()' + * Debugger listening on ws://127.0.0.1:9229/166e272e-7a30-4d09-97ce-f1c012b43c34 + * For help see https://nodejs.org/en/docs/inspector + * ws://127.0.0.1:9229/166e272e-7a30-4d09-97ce-f1c012b43c34 + * + * $ node --inspect=localhost:3000 -p 'inspector.url()' + * Debugger listening on ws://localhost:3000/51cf8d0e-3c36-4c59-8efd-54519839e56a + * For help see https://nodejs.org/en/docs/inspector + * ws://localhost:3000/51cf8d0e-3c36-4c59-8efd-54519839e56a + * + * $ node -p 'inspector.url()' + * undefined + * ``` + */ + function url(): string | undefined; + /** + * Blocks until a client (existing or connected later) has sent`Runtime.runIfWaitingForDebugger` command. + * + * An exception will be thrown if there is no active inspector. + * @since v12.7.0 + */ + function waitForDebugger(): void; +} +declare module 'node:inspector' { + import EventEmitter = require('inspector'); + export = EventEmitter; +} diff --git a/node_modules/@types/node/module.d.ts b/node_modules/@types/node/module.d.ts new file mode 100755 index 00000000..d83aec94 --- /dev/null +++ b/node_modules/@types/node/module.d.ts @@ -0,0 +1,114 @@ +/** + * @since v0.3.7 + */ +declare module 'module' { + import { URL } from 'node:url'; + namespace Module { + /** + * The `module.syncBuiltinESMExports()` method updates all the live bindings for + * builtin `ES Modules` to match the properties of the `CommonJS` exports. It + * does not add or remove exported names from the `ES Modules`. + * + * ```js + * const fs = require('fs'); + * const assert = require('assert'); + * const { syncBuiltinESMExports } = require('module'); + * + * fs.readFile = newAPI; + * + * delete fs.readFileSync; + * + * function newAPI() { + * // ... + * } + * + * fs.newAPI = newAPI; + * + * syncBuiltinESMExports(); + * + * import('fs').then((esmFS) => { + * // It syncs the existing readFile property with the new value + * assert.strictEqual(esmFS.readFile, newAPI); + * // readFileSync has been deleted from the required fs + * assert.strictEqual('readFileSync' in fs, false); + * // syncBuiltinESMExports() does not remove readFileSync from esmFS + * assert.strictEqual('readFileSync' in esmFS, true); + * // syncBuiltinESMExports() does not add names + * assert.strictEqual(esmFS.newAPI, undefined); + * }); + * ``` + * @since v12.12.0 + */ + function syncBuiltinESMExports(): void; + /** + * `path` is the resolved path for the file for which a corresponding source map + * should be fetched. + * @since v13.7.0, v12.17.0 + */ + function findSourceMap(path: string, error?: Error): SourceMap; + interface SourceMapPayload { + file: string; + version: number; + sources: string[]; + sourcesContent: string[]; + names: string[]; + mappings: string; + sourceRoot: string; + } + interface SourceMapping { + generatedLine: number; + generatedColumn: number; + originalSource: string; + originalLine: number; + originalColumn: number; + } + /** + * @since v13.7.0, v12.17.0 + */ + class SourceMap { + /** + * Getter for the payload used to construct the `SourceMap` instance. + */ + readonly payload: SourceMapPayload; + constructor(payload: SourceMapPayload); + /** + * Given a line number and column number in the generated source file, returns + * an object representing the position in the original file. The object returned + * consists of the following keys: + */ + findEntry(line: number, column: number): SourceMapping; + } + } + interface Module extends NodeModule {} + class Module { + static runMain(): void; + static wrap(code: string): string; + static createRequire(path: string | URL): NodeRequire; + static builtinModules: string[]; + static Module: typeof Module; + constructor(id: string, parent?: Module); + } + global { + interface ImportMeta { + url: string; + /** + * @experimental + * This feature is only available with the `--experimental-import-meta-resolve` + * command flag enabled. + * + * Provides a module-relative resolution function scoped to each module, returning + * the URL string. + * + * @param specified The module specifier to resolve relative to `parent`. + * @param parent The absolute parent module URL to resolve from. If none + * is specified, the value of `import.meta.url` is used as the default. + */ + resolve?(specified: string, parent?: string | URL): Promise; + } + } + export = Module; +} +declare module 'node:module' { + import module = require('module'); + export = module; +} diff --git a/node_modules/@types/node/net.d.ts b/node_modules/@types/node/net.d.ts new file mode 100755 index 00000000..87064934 --- /dev/null +++ b/node_modules/@types/node/net.d.ts @@ -0,0 +1,783 @@ +/** + * > Stability: 2 - Stable + * + * The `net` module provides an asynchronous network API for creating stream-based + * TCP or `IPC` servers ({@link createServer}) and clients + * ({@link createConnection}). + * + * It can be accessed using: + * + * ```js + * const net = require('net'); + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/net.js) + */ +declare module 'net' { + import * as stream from 'node:stream'; + import { Abortable, EventEmitter } from 'node:events'; + import * as dns from 'node:dns'; + type LookupFunction = (hostname: string, options: dns.LookupOneOptions, callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void) => void; + interface AddressInfo { + address: string; + family: string; + port: number; + } + interface SocketConstructorOpts { + fd?: number | undefined; + allowHalfOpen?: boolean | undefined; + readable?: boolean | undefined; + writable?: boolean | undefined; + } + interface OnReadOpts { + buffer: Uint8Array | (() => Uint8Array); + /** + * This function is called for every chunk of incoming data. + * Two arguments are passed to it: the number of bytes written to buffer and a reference to buffer. + * Return false from this function to implicitly pause() the socket. + */ + callback(bytesWritten: number, buf: Uint8Array): boolean; + } + interface ConnectOpts { + /** + * If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. + * Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will + * still be emitted as normal and methods like pause() and resume() will also behave as expected. + */ + onread?: OnReadOpts | undefined; + } + interface TcpSocketConnectOpts extends ConnectOpts { + port: number; + host?: string | undefined; + localAddress?: string | undefined; + localPort?: number | undefined; + hints?: number | undefined; + family?: number | undefined; + lookup?: LookupFunction | undefined; + } + interface IpcSocketConnectOpts extends ConnectOpts { + path: string; + } + type SocketConnectOpts = TcpSocketConnectOpts | IpcSocketConnectOpts; + /** + * This class is an abstraction of a TCP socket or a streaming `IPC` endpoint + * (uses named pipes on Windows, and Unix domain sockets otherwise). It is also + * an `EventEmitter`. + * + * A `net.Socket` can be created by the user and used directly to interact with + * a server. For example, it is returned by {@link createConnection}, + * so the user can use it to talk to the server. + * + * It can also be created by Node.js and passed to the user when a connection + * is received. For example, it is passed to the listeners of a `'connection'` event emitted on a {@link Server}, so the user can use + * it to interact with the client. + * @since v0.3.4 + */ + class Socket extends stream.Duplex { + constructor(options?: SocketConstructorOpts); + /** + * Sends data on the socket. The second parameter specifies the encoding in the + * case of a string. It defaults to UTF8 encoding. + * + * Returns `true` if the entire data was flushed successfully to the kernel + * buffer. Returns `false` if all or part of the data was queued in user memory.`'drain'` will be emitted when the buffer is again free. + * + * The optional `callback` parameter will be executed when the data is finally + * written out, which may not be immediately. + * + * See `Writable` stream `write()` method for more + * information. + * @since v0.1.90 + * @param [encoding='utf8'] Only used when data is `string`. + */ + write(buffer: Uint8Array | string, cb?: (err?: Error) => void): boolean; + write(str: Uint8Array | string, encoding?: BufferEncoding, cb?: (err?: Error) => void): boolean; + /** + * Initiate a connection on a given socket. + * + * Possible signatures: + * + * * `socket.connect(options[, connectListener])` + * * `socket.connect(path[, connectListener])` for `IPC` connections. + * * `socket.connect(port[, host][, connectListener])` for TCP connections. + * * Returns: `net.Socket` The socket itself. + * + * This function is asynchronous. When the connection is established, the `'connect'` event will be emitted. If there is a problem connecting, + * instead of a `'connect'` event, an `'error'` event will be emitted with + * the error passed to the `'error'` listener. + * The last parameter `connectListener`, if supplied, will be added as a listener + * for the `'connect'` event **once**. + * + * This function should only be used for reconnecting a socket after`'close'` has been emitted or otherwise it may lead to undefined + * behavior. + */ + connect(options: SocketConnectOpts, connectionListener?: () => void): this; + connect(port: number, host: string, connectionListener?: () => void): this; + connect(port: number, connectionListener?: () => void): this; + connect(path: string, connectionListener?: () => void): this; + /** + * Set the encoding for the socket as a `Readable Stream`. See `readable.setEncoding()` for more information. + * @since v0.1.90 + * @return The socket itself. + */ + setEncoding(encoding?: BufferEncoding): this; + /** + * Pauses the reading of data. That is, `'data'` events will not be emitted. + * Useful to throttle back an upload. + * @return The socket itself. + */ + pause(): this; + /** + * Resumes reading after a call to `socket.pause()`. + * @return The socket itself. + */ + resume(): this; + /** + * Sets the socket to timeout after `timeout` milliseconds of inactivity on + * the socket. By default `net.Socket` do not have a timeout. + * + * When an idle timeout is triggered the socket will receive a `'timeout'` event but the connection will not be severed. The user must manually call `socket.end()` or `socket.destroy()` to + * end the connection. + * + * ```js + * socket.setTimeout(3000); + * socket.on('timeout', () => { + * console.log('socket timeout'); + * socket.end(); + * }); + * ``` + * + * If `timeout` is 0, then the existing idle timeout is disabled. + * + * The optional `callback` parameter will be added as a one-time listener for the `'timeout'` event. + * @since v0.1.90 + * @return The socket itself. + */ + setTimeout(timeout: number, callback?: () => void): this; + /** + * Enable/disable the use of Nagle's algorithm. + * + * When a TCP connection is created, it will have Nagle's algorithm enabled. + * + * Nagle's algorithm delays data before it is sent via the network. It attempts + * to optimize throughput at the expense of latency. + * + * Passing `true` for `noDelay` or not passing an argument will disable Nagle's + * algorithm for the socket. Passing `false` for `noDelay` will enable Nagle's + * algorithm. + * @since v0.1.90 + * @param [noDelay=true] + * @return The socket itself. + */ + setNoDelay(noDelay?: boolean): this; + /** + * Enable/disable keep-alive functionality, and optionally set the initial + * delay before the first keepalive probe is sent on an idle socket. + * + * Set `initialDelay` (in milliseconds) to set the delay between the last + * data packet received and the first keepalive probe. Setting `0` for`initialDelay` will leave the value unchanged from the default + * (or previous) setting. + * + * Enabling the keep-alive functionality will set the following socket options: + * + * * `SO_KEEPALIVE=1` + * * `TCP_KEEPIDLE=initialDelay` + * * `TCP_KEEPCNT=10` + * * `TCP_KEEPINTVL=1` + * @since v0.1.92 + * @param [enable=false] + * @param [initialDelay=0] + * @return The socket itself. + */ + setKeepAlive(enable?: boolean, initialDelay?: number): this; + /** + * Returns the bound `address`, the address `family` name and `port` of the + * socket as reported by the operating system:`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }` + * @since v0.1.90 + */ + address(): AddressInfo | {}; + /** + * Calling `unref()` on a socket will allow the program to exit if this is the only + * active socket in the event system. If the socket is already `unref`ed calling`unref()` again will have no effect. + * @since v0.9.1 + * @return The socket itself. + */ + unref(): this; + /** + * Opposite of `unref()`, calling `ref()` on a previously `unref`ed socket will_not_ let the program exit if it's the only socket left (the default behavior). + * If the socket is `ref`ed calling `ref` again will have no effect. + * @since v0.9.1 + * @return The socket itself. + */ + ref(): this; + /** + * This property shows the number of characters buffered for writing. The buffer + * may contain strings whose length after encoding is not yet known. So this number + * is only an approximation of the number of bytes in the buffer. + * + * `net.Socket` has the property that `socket.write()` always works. This is to + * help users get up and running quickly. The computer cannot always keep up + * with the amount of data that is written to a socket. The network connection + * simply might be too slow. Node.js will internally queue up the data written to a + * socket and send it out over the wire when it is possible. + * + * The consequence of this internal buffering is that memory may grow. + * Users who experience large or growing `bufferSize` should attempt to + * "throttle" the data flows in their program with `socket.pause()` and `socket.resume()`. + * @since v0.3.8 + * @deprecated Since v14.6.0 - Use `writableLength` instead. + */ + readonly bufferSize: number; + /** + * The amount of received bytes. + * @since v0.5.3 + */ + readonly bytesRead: number; + /** + * The amount of bytes sent. + * @since v0.5.3 + */ + readonly bytesWritten: number; + /** + * If `true`,`socket.connect(options[, connectListener])` was + * called and has not yet finished. It will stay `true` until the socket becomes + * connected, then it is set to `false` and the `'connect'` event is emitted. Note + * that the `socket.connect(options[, connectListener])` callback is a listener for the `'connect'` event. + * @since v6.1.0 + */ + readonly connecting: boolean; + /** + * See `writable.destroyed` for further details. + */ + readonly destroyed: boolean; + /** + * The string representation of the local IP address the remote client is + * connecting on. For example, in a server listening on `'0.0.0.0'`, if a client + * connects on `'192.168.1.1'`, the value of `socket.localAddress` would be`'192.168.1.1'`. + * @since v0.9.6 + */ + readonly localAddress?: string; + /** + * The numeric representation of the local port. For example, `80` or `21`. + * @since v0.9.6 + */ + readonly localPort?: number; + /** + * The string representation of the remote IP address. For example,`'74.125.127.100'` or `'2001:4860:a005::68'`. Value may be `undefined` if + * the socket is destroyed (for example, if the client disconnected). + * @since v0.5.10 + */ + readonly remoteAddress?: string | undefined; + /** + * The string representation of the remote IP family. `'IPv4'` or `'IPv6'`. + * @since v0.11.14 + */ + readonly remoteFamily?: string | undefined; + /** + * The numeric representation of the remote port. For example, `80` or `21`. + * @since v0.5.10 + */ + readonly remotePort?: number | undefined; + /** + * Half-closes the socket. i.e., it sends a FIN packet. It is possible the + * server will still send some data. + * + * See `writable.end()` for further details. + * @since v0.1.90 + * @param [encoding='utf8'] Only used when data is `string`. + * @param callback Optional callback for when the socket is finished. + * @return The socket itself. + */ + end(callback?: () => void): void; + end(buffer: Uint8Array | string, callback?: () => void): void; + end(str: Uint8Array | string, encoding?: BufferEncoding, callback?: () => void): void; + /** + * events.EventEmitter + * 1. close + * 2. connect + * 3. data + * 4. drain + * 5. end + * 6. error + * 7. lookup + * 8. timeout + */ + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'close', listener: (hadError: boolean) => void): this; + addListener(event: 'connect', listener: () => void): this; + addListener(event: 'data', listener: (data: Buffer) => void): this; + addListener(event: 'drain', listener: () => void): this; + addListener(event: 'end', listener: () => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'lookup', listener: (err: Error, address: string, family: string | number, host: string) => void): this; + addListener(event: 'ready', listener: () => void): this; + addListener(event: 'timeout', listener: () => void): this; + emit(event: string | symbol, ...args: any[]): boolean; + emit(event: 'close', hadError: boolean): boolean; + emit(event: 'connect'): boolean; + emit(event: 'data', data: Buffer): boolean; + emit(event: 'drain'): boolean; + emit(event: 'end'): boolean; + emit(event: 'error', err: Error): boolean; + emit(event: 'lookup', err: Error, address: string, family: string | number, host: string): boolean; + emit(event: 'ready'): boolean; + emit(event: 'timeout'): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'close', listener: (hadError: boolean) => void): this; + on(event: 'connect', listener: () => void): this; + on(event: 'data', listener: (data: Buffer) => void): this; + on(event: 'drain', listener: () => void): this; + on(event: 'end', listener: () => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'lookup', listener: (err: Error, address: string, family: string | number, host: string) => void): this; + on(event: 'ready', listener: () => void): this; + on(event: 'timeout', listener: () => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'close', listener: (hadError: boolean) => void): this; + once(event: 'connect', listener: () => void): this; + once(event: 'data', listener: (data: Buffer) => void): this; + once(event: 'drain', listener: () => void): this; + once(event: 'end', listener: () => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'lookup', listener: (err: Error, address: string, family: string | number, host: string) => void): this; + once(event: 'ready', listener: () => void): this; + once(event: 'timeout', listener: () => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: (hadError: boolean) => void): this; + prependListener(event: 'connect', listener: () => void): this; + prependListener(event: 'data', listener: (data: Buffer) => void): this; + prependListener(event: 'drain', listener: () => void): this; + prependListener(event: 'end', listener: () => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'lookup', listener: (err: Error, address: string, family: string | number, host: string) => void): this; + prependListener(event: 'ready', listener: () => void): this; + prependListener(event: 'timeout', listener: () => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: (hadError: boolean) => void): this; + prependOnceListener(event: 'connect', listener: () => void): this; + prependOnceListener(event: 'data', listener: (data: Buffer) => void): this; + prependOnceListener(event: 'drain', listener: () => void): this; + prependOnceListener(event: 'end', listener: () => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'lookup', listener: (err: Error, address: string, family: string | number, host: string) => void): this; + prependOnceListener(event: 'ready', listener: () => void): this; + prependOnceListener(event: 'timeout', listener: () => void): this; + } + interface ListenOptions extends Abortable { + port?: number | undefined; + host?: string | undefined; + backlog?: number | undefined; + path?: string | undefined; + exclusive?: boolean | undefined; + readableAll?: boolean | undefined; + writableAll?: boolean | undefined; + /** + * @default false + */ + ipv6Only?: boolean | undefined; + } + interface ServerOpts { + /** + * Indicates whether half-opened TCP connections are allowed. + * @default false + */ + allowHalfOpen?: boolean | undefined; + /** + * Indicates whether the socket should be paused on incoming connections. + * @default false + */ + pauseOnConnect?: boolean | undefined; + } + /** + * This class is used to create a TCP or `IPC` server. + * @since v0.1.90 + */ + class Server extends EventEmitter { + constructor(connectionListener?: (socket: Socket) => void); + constructor(options?: ServerOpts, connectionListener?: (socket: Socket) => void); + /** + * Start a server listening for connections. A `net.Server` can be a TCP or + * an `IPC` server depending on what it listens to. + * + * Possible signatures: + * + * * `server.listen(handle[, backlog][, callback])` + * * `server.listen(options[, callback])` + * * `server.listen(path[, backlog][, callback])` for `IPC` servers + * * `server.listen([port[, host[, backlog]]][, callback])` for TCP servers + * + * This function is asynchronous. When the server starts listening, the `'listening'` event will be emitted. The last parameter `callback`will be added as a listener for the `'listening'` + * event. + * + * All `listen()` methods can take a `backlog` parameter to specify the maximum + * length of the queue of pending connections. The actual length will be determined + * by the OS through sysctl settings such as `tcp_max_syn_backlog` and `somaxconn`on Linux. The default value of this parameter is 511 (not 512). + * + * All {@link Socket} are set to `SO_REUSEADDR` (see [`socket(7)`](https://man7.org/linux/man-pages/man7/socket.7.html) for + * details). + * + * The `server.listen()` method can be called again if and only if there was an + * error during the first `server.listen()` call or `server.close()` has been + * called. Otherwise, an `ERR_SERVER_ALREADY_LISTEN` error will be thrown. + * + * One of the most common errors raised when listening is `EADDRINUSE`. + * This happens when another server is already listening on the requested`port`/`path`/`handle`. One way to handle this would be to retry + * after a certain amount of time: + * + * ```js + * server.on('error', (e) => { + * if (e.code === 'EADDRINUSE') { + * console.log('Address in use, retrying...'); + * setTimeout(() => { + * server.close(); + * server.listen(PORT, HOST); + * }, 1000); + * } + * }); + * ``` + */ + listen(port?: number, hostname?: string, backlog?: number, listeningListener?: () => void): this; + listen(port?: number, hostname?: string, listeningListener?: () => void): this; + listen(port?: number, backlog?: number, listeningListener?: () => void): this; + listen(port?: number, listeningListener?: () => void): this; + listen(path: string, backlog?: number, listeningListener?: () => void): this; + listen(path: string, listeningListener?: () => void): this; + listen(options: ListenOptions, listeningListener?: () => void): this; + listen(handle: any, backlog?: number, listeningListener?: () => void): this; + listen(handle: any, listeningListener?: () => void): this; + /** + * Stops the server from accepting new connections and keeps existing + * connections. This function is asynchronous, the server is finally closed + * when all connections are ended and the server emits a `'close'` event. + * The optional `callback` will be called once the `'close'` event occurs. Unlike + * that event, it will be called with an `Error` as its only argument if the server + * was not open when it was closed. + * @since v0.1.90 + * @param callback Called when the server is closed. + */ + close(callback?: (err?: Error) => void): this; + /** + * Returns the bound `address`, the address `family` name, and `port` of the server + * as reported by the operating system if listening on an IP socket + * (useful to find which port was assigned when getting an OS-assigned address):`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`. + * + * For a server listening on a pipe or Unix domain socket, the name is returned + * as a string. + * + * ```js + * const server = net.createServer((socket) => { + * socket.end('goodbye\n'); + * }).on('error', (err) => { + * // Handle errors here. + * throw err; + * }); + * + * // Grab an arbitrary unused port. + * server.listen(() => { + * console.log('opened server on', server.address()); + * }); + * ``` + * + * `server.address()` returns `null` before the `'listening'` event has been + * emitted or after calling `server.close()`. + * @since v0.1.90 + */ + address(): AddressInfo | string | null; + /** + * Asynchronously get the number of concurrent connections on the server. Works + * when sockets were sent to forks. + * + * Callback should take two arguments `err` and `count`. + * @since v0.9.7 + */ + getConnections(cb: (error: Error | null, count: number) => void): void; + /** + * Opposite of `unref()`, calling `ref()` on a previously `unref`ed server will_not_ let the program exit if it's the only server left (the default behavior). + * If the server is `ref`ed calling `ref()` again will have no effect. + * @since v0.9.1 + */ + ref(): this; + /** + * Calling `unref()` on a server will allow the program to exit if this is the only + * active server in the event system. If the server is already `unref`ed calling`unref()` again will have no effect. + * @since v0.9.1 + */ + unref(): this; + /** + * Set this property to reject connections when the server's connection count gets + * high. + * + * It is not recommended to use this option once a socket has been sent to a child + * with `child_process.fork()`. + * @since v0.2.0 + */ + maxConnections: number; + connections: number; + /** + * Indicates whether or not the server is listening for connections. + * @since v5.7.0 + */ + listening: boolean; + /** + * events.EventEmitter + * 1. close + * 2. connection + * 3. error + * 4. listening + */ + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'close', listener: () => void): this; + addListener(event: 'connection', listener: (socket: Socket) => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'listening', listener: () => void): this; + emit(event: string | symbol, ...args: any[]): boolean; + emit(event: 'close'): boolean; + emit(event: 'connection', socket: Socket): boolean; + emit(event: 'error', err: Error): boolean; + emit(event: 'listening'): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'close', listener: () => void): this; + on(event: 'connection', listener: (socket: Socket) => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'listening', listener: () => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'connection', listener: (socket: Socket) => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'listening', listener: () => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'connection', listener: (socket: Socket) => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'listening', listener: () => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'connection', listener: (socket: Socket) => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'listening', listener: () => void): this; + } + type IPVersion = 'ipv4' | 'ipv6'; + /** + * The `BlockList` object can be used with some network APIs to specify rules for + * disabling inbound or outbound access to specific IP addresses, IP ranges, or + * IP subnets. + * @since v15.0.0 + */ + class BlockList { + /** + * Adds a rule to block the given IP address. + * @since v15.0.0 + * @param address An IPv4 or IPv6 address. + * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`. + */ + addAddress(address: string, type?: IPVersion): void; + addAddress(address: SocketAddress): void; + /** + * Adds a rule to block a range of IP addresses from `start` (inclusive) to`end` (inclusive). + * @since v15.0.0 + * @param start The starting IPv4 or IPv6 address in the range. + * @param end The ending IPv4 or IPv6 address in the range. + * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`. + */ + addRange(start: string, end: string, type?: IPVersion): void; + addRange(start: SocketAddress, end: SocketAddress): void; + /** + * Adds a rule to block a range of IP addresses specified as a subnet mask. + * @since v15.0.0 + * @param net The network IPv4 or IPv6 address. + * @param prefix The number of CIDR prefix bits. For IPv4, this must be a value between `0` and `32`. For IPv6, this must be between `0` and `128`. + * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`. + */ + addSubnet(net: SocketAddress, prefix: number): void; + addSubnet(net: string, prefix: number, type?: IPVersion): void; + /** + * Returns `true` if the given IP address matches any of the rules added to the`BlockList`. + * + * ```js + * const blockList = new net.BlockList(); + * blockList.addAddress('123.123.123.123'); + * blockList.addRange('10.0.0.1', '10.0.0.10'); + * blockList.addSubnet('8592:757c:efae:4e45::', 64, 'ipv6'); + * + * console.log(blockList.check('123.123.123.123')); // Prints: true + * console.log(blockList.check('10.0.0.3')); // Prints: true + * console.log(blockList.check('222.111.111.222')); // Prints: false + * + * // IPv6 notation for IPv4 addresses works: + * console.log(blockList.check('::ffff:7b7b:7b7b', 'ipv6')); // Prints: true + * console.log(blockList.check('::ffff:123.123.123.123', 'ipv6')); // Prints: true + * ``` + * @since v15.0.0 + * @param address The IP address to check + * @param [type='ipv4'] Either `'ipv4'` or `'ipv6'`. + */ + check(address: SocketAddress): boolean; + check(address: string, type?: IPVersion): boolean; + } + interface TcpNetConnectOpts extends TcpSocketConnectOpts, SocketConstructorOpts { + timeout?: number | undefined; + } + interface IpcNetConnectOpts extends IpcSocketConnectOpts, SocketConstructorOpts { + timeout?: number | undefined; + } + type NetConnectOpts = TcpNetConnectOpts | IpcNetConnectOpts; + /** + * Creates a new TCP or `IPC` server. + * + * If `allowHalfOpen` is set to `true`, when the other end of the socket + * signals the end of transmission, the server will only send back the end of + * transmission when `socket.end()` is explicitly called. For example, in the + * context of TCP, when a FIN packed is received, a FIN packed is sent + * back only when `socket.end()` is explicitly called. Until then the + * connection is half-closed (non-readable but still writable). See `'end'` event and [RFC 1122](https://tools.ietf.org/html/rfc1122) (section 4.2.2.13) for more information. + * + * If `pauseOnConnect` is set to `true`, then the socket associated with each + * incoming connection will be paused, and no data will be read from its handle. + * This allows connections to be passed between processes without any data being + * read by the original process. To begin reading data from a paused socket, call `socket.resume()`. + * + * The server can be a TCP server or an `IPC` server, depending on what it `listen()` to. + * + * Here is an example of an TCP echo server which listens for connections + * on port 8124: + * + * ```js + * const net = require('net'); + * const server = net.createServer((c) => { + * // 'connection' listener. + * console.log('client connected'); + * c.on('end', () => { + * console.log('client disconnected'); + * }); + * c.write('hello\r\n'); + * c.pipe(c); + * }); + * server.on('error', (err) => { + * throw err; + * }); + * server.listen(8124, () => { + * console.log('server bound'); + * }); + * ``` + * + * Test this by using `telnet`: + * + * ```console + * $ telnet localhost 8124 + * ``` + * + * To listen on the socket `/tmp/echo.sock`: + * + * ```js + * server.listen('/tmp/echo.sock', () => { + * console.log('server bound'); + * }); + * ``` + * + * Use `nc` to connect to a Unix domain socket server: + * + * ```console + * $ nc -U /tmp/echo.sock + * ``` + * @since v0.5.0 + * @param connectionListener Automatically set as a listener for the {@link 'connection'} event. + */ + function createServer(connectionListener?: (socket: Socket) => void): Server; + function createServer(options?: ServerOpts, connectionListener?: (socket: Socket) => void): Server; + /** + * Aliases to {@link createConnection}. + * + * Possible signatures: + * + * * {@link connect} + * * {@link connect} for `IPC` connections. + * * {@link connect} for TCP connections. + */ + function connect(options: NetConnectOpts, connectionListener?: () => void): Socket; + function connect(port: number, host?: string, connectionListener?: () => void): Socket; + function connect(path: string, connectionListener?: () => void): Socket; + /** + * A factory function, which creates a new {@link Socket}, + * immediately initiates connection with `socket.connect()`, + * then returns the `net.Socket` that starts the connection. + * + * When the connection is established, a `'connect'` event will be emitted + * on the returned socket. The last parameter `connectListener`, if supplied, + * will be added as a listener for the `'connect'` event **once**. + * + * Possible signatures: + * + * * {@link createConnection} + * * {@link createConnection} for `IPC` connections. + * * {@link createConnection} for TCP connections. + * + * The {@link connect} function is an alias to this function. + */ + function createConnection(options: NetConnectOpts, connectionListener?: () => void): Socket; + function createConnection(port: number, host?: string, connectionListener?: () => void): Socket; + function createConnection(path: string, connectionListener?: () => void): Socket; + /** + * Tests if input is an IP address. Returns `0` for invalid strings, + * returns `4` for IP version 4 addresses, and returns `6` for IP version 6 + * addresses. + * @since v0.3.0 + */ + function isIP(input: string): number; + /** + * Returns `true` if input is a version 4 IP address, otherwise returns `false`. + * @since v0.3.0 + */ + function isIPv4(input: string): boolean; + /** + * Returns `true` if input is a version 6 IP address, otherwise returns `false`. + * @since v0.3.0 + */ + function isIPv6(input: string): boolean; + interface SocketAddressInitOptions { + /** + * The network address as either an IPv4 or IPv6 string. + * @default 127.0.0.1 + */ + address?: string | undefined; + /** + * @default `'ipv4'` + */ + family?: IPVersion | undefined; + /** + * An IPv6 flow-label used only if `family` is `'ipv6'`. + * @default 0 + */ + flowlabel?: number | undefined; + /** + * An IP port. + * @default 0 + */ + port?: number | undefined; + } + /** + * @since v15.14.0 + */ + class SocketAddress { + constructor(options: SocketAddressInitOptions); + /** + * Either \`'ipv4'\` or \`'ipv6'\`. + * @since v15.14.0 + */ + readonly address: string; + /** + * Either \`'ipv4'\` or \`'ipv6'\`. + * @since v15.14.0 + */ + readonly family: IPVersion; + /** + * @since v15.14.0 + */ + readonly port: number; + /** + * @since v15.14.0 + */ + readonly flowlabel: number; + } +} +declare module 'node:net' { + export * from 'net'; +} diff --git a/node_modules/@types/node/os.d.ts b/node_modules/@types/node/os.d.ts new file mode 100755 index 00000000..f9cd2424 --- /dev/null +++ b/node_modules/@types/node/os.d.ts @@ -0,0 +1,455 @@ +/** + * The `os` module provides operating system-related utility methods and + * properties. It can be accessed using: + * + * ```js + * const os = require('os'); + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/os.js) + */ +declare module 'os' { + interface CpuInfo { + model: string; + speed: number; + times: { + user: number; + nice: number; + sys: number; + idle: number; + irq: number; + }; + } + interface NetworkInterfaceBase { + address: string; + netmask: string; + mac: string; + internal: boolean; + cidr: string | null; + } + interface NetworkInterfaceInfoIPv4 extends NetworkInterfaceBase { + family: 'IPv4'; + } + interface NetworkInterfaceInfoIPv6 extends NetworkInterfaceBase { + family: 'IPv6'; + scopeid: number; + } + interface UserInfo { + username: T; + uid: number; + gid: number; + shell: T; + homedir: T; + } + type NetworkInterfaceInfo = NetworkInterfaceInfoIPv4 | NetworkInterfaceInfoIPv6; + /** + * Returns the host name of the operating system as a string. + * @since v0.3.3 + */ + function hostname(): string; + /** + * Returns an array containing the 1, 5, and 15 minute load averages. + * + * The load average is a measure of system activity calculated by the operating + * system and expressed as a fractional number. + * + * The load average is a Unix-specific concept. On Windows, the return value is + * always `[0, 0, 0]`. + * @since v0.3.3 + */ + function loadavg(): number[]; + /** + * Returns the system uptime in number of seconds. + * @since v0.3.3 + */ + function uptime(): number; + /** + * Returns the amount of free system memory in bytes as an integer. + * @since v0.3.3 + */ + function freemem(): number; + /** + * Returns the total amount of system memory in bytes as an integer. + * @since v0.3.3 + */ + function totalmem(): number; + /** + * Returns an array of objects containing information about each logical CPU core. + * + * The properties included on each object include: + * + * ```js + * [ + * { + * model: 'Intel(R) Core(TM) i7 CPU 860 @ 2.80GHz', + * speed: 2926, + * times: { + * user: 252020, + * nice: 0, + * sys: 30340, + * idle: 1070356870, + * irq: 0 + * } + * }, + * { + * model: 'Intel(R) Core(TM) i7 CPU 860 @ 2.80GHz', + * speed: 2926, + * times: { + * user: 306960, + * nice: 0, + * sys: 26980, + * idle: 1071569080, + * irq: 0 + * } + * }, + * { + * model: 'Intel(R) Core(TM) i7 CPU 860 @ 2.80GHz', + * speed: 2926, + * times: { + * user: 248450, + * nice: 0, + * sys: 21750, + * idle: 1070919370, + * irq: 0 + * } + * }, + * { + * model: 'Intel(R) Core(TM) i7 CPU 860 @ 2.80GHz', + * speed: 2926, + * times: { + * user: 256880, + * nice: 0, + * sys: 19430, + * idle: 1070905480, + * irq: 20 + * } + * }, + * ] + * ``` + * + * `nice` values are POSIX-only. On Windows, the `nice` values of all processors + * are always 0. + * @since v0.3.3 + */ + function cpus(): CpuInfo[]; + /** + * Returns the operating system name as returned by [`uname(3)`](https://linux.die.net/man/3/uname). For example, it + * returns `'Linux'` on Linux, `'Darwin'` on macOS, and `'Windows_NT'` on Windows. + * + * See [https://en.wikipedia.org/wiki/Uname#Examples](https://en.wikipedia.org/wiki/Uname#Examples) for additional information + * about the output of running [`uname(3)`](https://linux.die.net/man/3/uname) on various operating systems. + * @since v0.3.3 + */ + function type(): string; + /** + * Returns the operating system as a string. + * + * On POSIX systems, the operating system release is determined by calling [`uname(3)`](https://linux.die.net/man/3/uname). On Windows, `GetVersionExW()` is used. See + * [https://en.wikipedia.org/wiki/Uname#Examples](https://en.wikipedia.org/wiki/Uname#Examples) for more information. + * @since v0.3.3 + */ + function release(): string; + /** + * Returns an object containing network interfaces that have been assigned a + * network address. + * + * Each key on the returned object identifies a network interface. The associated + * value is an array of objects that each describe an assigned network address. + * + * The properties available on the assigned network address object include: + * + * ```js + * { + * lo: [ + * { + * address: '127.0.0.1', + * netmask: '255.0.0.0', + * family: 'IPv4', + * mac: '00:00:00:00:00:00', + * internal: true, + * cidr: '127.0.0.1/8' + * }, + * { + * address: '::1', + * netmask: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff', + * family: 'IPv6', + * mac: '00:00:00:00:00:00', + * scopeid: 0, + * internal: true, + * cidr: '::1/128' + * } + * ], + * eth0: [ + * { + * address: '192.168.1.108', + * netmask: '255.255.255.0', + * family: 'IPv4', + * mac: '01:02:03:0a:0b:0c', + * internal: false, + * cidr: '192.168.1.108/24' + * }, + * { + * address: 'fe80::a00:27ff:fe4e:66a1', + * netmask: 'ffff:ffff:ffff:ffff::', + * family: 'IPv6', + * mac: '01:02:03:0a:0b:0c', + * scopeid: 1, + * internal: false, + * cidr: 'fe80::a00:27ff:fe4e:66a1/64' + * } + * ] + * } + * ``` + * @since v0.6.0 + */ + function networkInterfaces(): NodeJS.Dict; + /** + * Returns the string path of the current user's home directory. + * + * On POSIX, it uses the `$HOME` environment variable if defined. Otherwise it + * uses the [effective UID](https://en.wikipedia.org/wiki/User_identifier#Effective_user_ID) to look up the user's home directory. + * + * On Windows, it uses the `USERPROFILE` environment variable if defined. + * Otherwise it uses the path to the profile directory of the current user. + * @since v2.3.0 + */ + function homedir(): string; + /** + * Returns information about the currently effective user. On POSIX platforms, + * this is typically a subset of the password file. The returned object includes + * the `username`, `uid`, `gid`, `shell`, and `homedir`. On Windows, the `uid` and`gid` fields are `-1`, and `shell` is `null`. + * + * The value of `homedir` returned by `os.userInfo()` is provided by the operating + * system. This differs from the result of `os.homedir()`, which queries + * environment variables for the home directory before falling back to the + * operating system response. + * + * Throws a `SystemError` if a user has no `username` or `homedir`. + * @since v6.0.0 + */ + function userInfo(options: { encoding: 'buffer' }): UserInfo; + function userInfo(options?: { encoding: BufferEncoding }): UserInfo; + type SignalConstants = { + [key in NodeJS.Signals]: number; + }; + namespace constants { + const UV_UDP_REUSEADDR: number; + namespace signals {} + const signals: SignalConstants; + namespace errno { + const E2BIG: number; + const EACCES: number; + const EADDRINUSE: number; + const EADDRNOTAVAIL: number; + const EAFNOSUPPORT: number; + const EAGAIN: number; + const EALREADY: number; + const EBADF: number; + const EBADMSG: number; + const EBUSY: number; + const ECANCELED: number; + const ECHILD: number; + const ECONNABORTED: number; + const ECONNREFUSED: number; + const ECONNRESET: number; + const EDEADLK: number; + const EDESTADDRREQ: number; + const EDOM: number; + const EDQUOT: number; + const EEXIST: number; + const EFAULT: number; + const EFBIG: number; + const EHOSTUNREACH: number; + const EIDRM: number; + const EILSEQ: number; + const EINPROGRESS: number; + const EINTR: number; + const EINVAL: number; + const EIO: number; + const EISCONN: number; + const EISDIR: number; + const ELOOP: number; + const EMFILE: number; + const EMLINK: number; + const EMSGSIZE: number; + const EMULTIHOP: number; + const ENAMETOOLONG: number; + const ENETDOWN: number; + const ENETRESET: number; + const ENETUNREACH: number; + const ENFILE: number; + const ENOBUFS: number; + const ENODATA: number; + const ENODEV: number; + const ENOENT: number; + const ENOEXEC: number; + const ENOLCK: number; + const ENOLINK: number; + const ENOMEM: number; + const ENOMSG: number; + const ENOPROTOOPT: number; + const ENOSPC: number; + const ENOSR: number; + const ENOSTR: number; + const ENOSYS: number; + const ENOTCONN: number; + const ENOTDIR: number; + const ENOTEMPTY: number; + const ENOTSOCK: number; + const ENOTSUP: number; + const ENOTTY: number; + const ENXIO: number; + const EOPNOTSUPP: number; + const EOVERFLOW: number; + const EPERM: number; + const EPIPE: number; + const EPROTO: number; + const EPROTONOSUPPORT: number; + const EPROTOTYPE: number; + const ERANGE: number; + const EROFS: number; + const ESPIPE: number; + const ESRCH: number; + const ESTALE: number; + const ETIME: number; + const ETIMEDOUT: number; + const ETXTBSY: number; + const EWOULDBLOCK: number; + const EXDEV: number; + const WSAEINTR: number; + const WSAEBADF: number; + const WSAEACCES: number; + const WSAEFAULT: number; + const WSAEINVAL: number; + const WSAEMFILE: number; + const WSAEWOULDBLOCK: number; + const WSAEINPROGRESS: number; + const WSAEALREADY: number; + const WSAENOTSOCK: number; + const WSAEDESTADDRREQ: number; + const WSAEMSGSIZE: number; + const WSAEPROTOTYPE: number; + const WSAENOPROTOOPT: number; + const WSAEPROTONOSUPPORT: number; + const WSAESOCKTNOSUPPORT: number; + const WSAEOPNOTSUPP: number; + const WSAEPFNOSUPPORT: number; + const WSAEAFNOSUPPORT: number; + const WSAEADDRINUSE: number; + const WSAEADDRNOTAVAIL: number; + const WSAENETDOWN: number; + const WSAENETUNREACH: number; + const WSAENETRESET: number; + const WSAECONNABORTED: number; + const WSAECONNRESET: number; + const WSAENOBUFS: number; + const WSAEISCONN: number; + const WSAENOTCONN: number; + const WSAESHUTDOWN: number; + const WSAETOOMANYREFS: number; + const WSAETIMEDOUT: number; + const WSAECONNREFUSED: number; + const WSAELOOP: number; + const WSAENAMETOOLONG: number; + const WSAEHOSTDOWN: number; + const WSAEHOSTUNREACH: number; + const WSAENOTEMPTY: number; + const WSAEPROCLIM: number; + const WSAEUSERS: number; + const WSAEDQUOT: number; + const WSAESTALE: number; + const WSAEREMOTE: number; + const WSASYSNOTREADY: number; + const WSAVERNOTSUPPORTED: number; + const WSANOTINITIALISED: number; + const WSAEDISCON: number; + const WSAENOMORE: number; + const WSAECANCELLED: number; + const WSAEINVALIDPROCTABLE: number; + const WSAEINVALIDPROVIDER: number; + const WSAEPROVIDERFAILEDINIT: number; + const WSASYSCALLFAILURE: number; + const WSASERVICE_NOT_FOUND: number; + const WSATYPE_NOT_FOUND: number; + const WSA_E_NO_MORE: number; + const WSA_E_CANCELLED: number; + const WSAEREFUSED: number; + } + namespace priority { + const PRIORITY_LOW: number; + const PRIORITY_BELOW_NORMAL: number; + const PRIORITY_NORMAL: number; + const PRIORITY_ABOVE_NORMAL: number; + const PRIORITY_HIGH: number; + const PRIORITY_HIGHEST: number; + } + } + const devNull: string; + const EOL: string; + /** + * Returns the operating system CPU architecture for which the Node.js binary was + * compiled. Possible values are `'arm'`, `'arm64'`, `'ia32'`, `'mips'`,`'mipsel'`, `'ppc'`, `'ppc64'`, `'s390'`, `'s390x'`, `'x32'`, and `'x64'`. + * + * The return value is equivalent to `process.arch`. + * @since v0.5.0 + */ + function arch(): string; + /** + * Returns a string identifying the kernel version. + * + * On POSIX systems, the operating system release is determined by calling [`uname(3)`](https://linux.die.net/man/3/uname). On Windows, `RtlGetVersion()` is used, and if it is not + * available, `GetVersionExW()` will be used. See [https://en.wikipedia.org/wiki/Uname#Examples](https://en.wikipedia.org/wiki/Uname#Examples) for more information. + * @since v13.11.0, v12.17.0 + */ + function version(): string; + /** + * Returns a string identifying the operating system platform. The value is set + * at compile time. Possible values are `'aix'`, `'darwin'`, `'freebsd'`,`'linux'`, `'openbsd'`, `'sunos'`, and `'win32'`. + * + * The return value is equivalent to `process.platform`. + * + * The value `'android'` may also be returned if Node.js is built on the Android + * operating system. [Android support is experimental](https://github.com/nodejs/node/blob/HEAD/BUILDING.md#androidandroid-based-devices-eg-firefox-os). + * @since v0.5.0 + */ + function platform(): NodeJS.Platform; + /** + * Returns the operating system's default directory for temporary files as a + * string. + * @since v0.9.9 + */ + function tmpdir(): string; + /** + * Returns a string identifying the endianness of the CPU for which the Node.js + * binary was compiled. + * + * Possible values are `'BE'` for big endian and `'LE'` for little endian. + * @since v0.9.4 + */ + function endianness(): 'BE' | 'LE'; + /** + * Returns the scheduling priority for the process specified by `pid`. If `pid` is + * not provided or is `0`, the priority of the current process is returned. + * @since v10.10.0 + * @param [pid=0] The process ID to retrieve scheduling priority for. + */ + function getPriority(pid?: number): number; + /** + * Attempts to set the scheduling priority for the process specified by `pid`. If`pid` is not provided or is `0`, the process ID of the current process is used. + * + * The `priority` input must be an integer between `-20` (high priority) and `19`(low priority). Due to differences between Unix priority levels and Windows + * priority classes, `priority` is mapped to one of six priority constants in`os.constants.priority`. When retrieving a process priority level, this range + * mapping may cause the return value to be slightly different on Windows. To avoid + * confusion, set `priority` to one of the priority constants. + * + * On Windows, setting priority to `PRIORITY_HIGHEST` requires elevated user + * privileges. Otherwise the set priority will be silently reduced to`PRIORITY_HIGH`. + * @since v10.10.0 + * @param [pid=0] The process ID to set scheduling priority for. + * @param priority The scheduling priority to assign to the process. + */ + function setPriority(priority: number): void; + function setPriority(pid: number, priority: number): void; +} +declare module 'node:os' { + export * from 'os'; +} diff --git a/node_modules/@types/node/package.json b/node_modules/@types/node/package.json new file mode 100755 index 00000000..f954cd6f --- /dev/null +++ b/node_modules/@types/node/package.json @@ -0,0 +1,230 @@ +{ + "name": "@types/node", + "version": "16.11.10", + "description": "TypeScript definitions for Node.js", + "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node", + "license": "MIT", + "contributors": [ + { + "name": "Microsoft TypeScript", + "url": "https://github.com/Microsoft", + "githubUsername": "Microsoft" + }, + { + "name": "DefinitelyTyped", + "url": "https://github.com/DefinitelyTyped", + "githubUsername": "DefinitelyTyped" + }, + { + "name": "Alberto Schiabel", + "url": "https://github.com/jkomyno", + "githubUsername": "jkomyno" + }, + { + "name": "Alvis HT Tang", + "url": "https://github.com/alvis", + "githubUsername": "alvis" + }, + { + "name": "Andrew Makarov", + "url": "https://github.com/r3nya", + "githubUsername": "r3nya" + }, + { + "name": "Benjamin Toueg", + "url": "https://github.com/btoueg", + "githubUsername": "btoueg" + }, + { + "name": "Chigozirim C.", + "url": "https://github.com/smac89", + "githubUsername": "smac89" + }, + { + "name": "David Junger", + "url": "https://github.com/touffy", + "githubUsername": "touffy" + }, + { + "name": "Deividas Bakanas", + "url": "https://github.com/DeividasBakanas", + "githubUsername": "DeividasBakanas" + }, + { + "name": "Eugene Y. Q. Shen", + "url": "https://github.com/eyqs", + "githubUsername": "eyqs" + }, + { + "name": "Hannes Magnusson", + "url": "https://github.com/Hannes-Magnusson-CK", + "githubUsername": "Hannes-Magnusson-CK" + }, + { + "name": "Huw", + "url": "https://github.com/hoo29", + "githubUsername": "hoo29" + }, + { + "name": "Kelvin Jin", + "url": "https://github.com/kjin", + "githubUsername": "kjin" + }, + { + "name": "Klaus Meinhardt", + "url": "https://github.com/ajafff", + "githubUsername": "ajafff" + }, + { + "name": "Lishude", + "url": "https://github.com/islishude", + "githubUsername": "islishude" + }, + { + "name": "Mariusz Wiktorczyk", + "url": "https://github.com/mwiktorczyk", + "githubUsername": "mwiktorczyk" + }, + { + "name": "Mohsen Azimi", + "url": "https://github.com/mohsen1", + "githubUsername": "mohsen1" + }, + { + "name": "Nicolas Even", + "url": "https://github.com/n-e", + "githubUsername": "n-e" + }, + { + "name": "Nikita Galkin", + "url": "https://github.com/galkin", + "githubUsername": "galkin" + }, + { + "name": "Parambir Singh", + "url": "https://github.com/parambirs", + "githubUsername": "parambirs" + }, + { + "name": "Sebastian Silbermann", + "url": "https://github.com/eps1lon", + "githubUsername": "eps1lon" + }, + { + "name": "Seth Westphal", + "url": "https://github.com/westy92", + "githubUsername": "westy92" + }, + { + "name": "Simon Schick", + "url": "https://github.com/SimonSchick", + "githubUsername": "SimonSchick" + }, + { + "name": "Thomas den Hollander", + "url": "https://github.com/ThomasdenH", + "githubUsername": "ThomasdenH" + }, + { + "name": "Wilco Bakker", + "url": "https://github.com/WilcoBakker", + "githubUsername": "WilcoBakker" + }, + { + "name": "wwwy3y3", + "url": "https://github.com/wwwy3y3", + "githubUsername": "wwwy3y3" + }, + { + "name": "Samuel Ainsworth", + "url": "https://github.com/samuela", + "githubUsername": "samuela" + }, + { + "name": "Kyle Uehlein", + "url": "https://github.com/kuehlein", + "githubUsername": "kuehlein" + }, + { + "name": "Thanik Bhongbhibhat", + "url": "https://github.com/bhongy", + "githubUsername": "bhongy" + }, + { + "name": "Marcin Kopacz", + "url": "https://github.com/chyzwar", + "githubUsername": "chyzwar" + }, + { + "name": "Trivikram Kamat", + "url": "https://github.com/trivikr", + "githubUsername": "trivikr" + }, + { + "name": "Junxiao Shi", + "url": "https://github.com/yoursunny", + "githubUsername": "yoursunny" + }, + { + "name": "Ilia Baryshnikov", + "url": "https://github.com/qwelias", + "githubUsername": "qwelias" + }, + { + "name": "ExE Boss", + "url": "https://github.com/ExE-Boss", + "githubUsername": "ExE-Boss" + }, + { + "name": "Surasak Chaisurin", + "url": "https://github.com/Ryan-Willpower", + "githubUsername": "Ryan-Willpower" + }, + { + "name": "Piotr Błażejewicz", + "url": "https://github.com/peterblazejewicz", + "githubUsername": "peterblazejewicz" + }, + { + "name": "Anna Henningsen", + "url": "https://github.com/addaleax", + "githubUsername": "addaleax" + }, + { + "name": "Victor Perin", + "url": "https://github.com/victorperin", + "githubUsername": "victorperin" + }, + { + "name": "Yongsheng Zhang", + "url": "https://github.com/ZYSzys", + "githubUsername": "ZYSzys" + }, + { + "name": "NodeJS Contributors", + "url": "https://github.com/NodeJS", + "githubUsername": "NodeJS" + }, + { + "name": "Linus Unnebäck", + "url": "https://github.com/LinusU", + "githubUsername": "LinusU" + }, + { + "name": "wafuwafu13", + "url": "https://github.com/wafuwafu13", + "githubUsername": "wafuwafu13" + } + ], + "main": "", + "types": "index.d.ts", + "repository": { + "type": "git", + "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git", + "directory": "types/node" + }, + "scripts": {}, + "dependencies": {}, + "typesPublisherContentHash": "b24d5d157d742f1a54b5d70ed1c014862c87e0187063c31ed2038790f909f02d", + "typeScriptVersion": "3.8" +} \ No newline at end of file diff --git a/node_modules/@types/node/path.d.ts b/node_modules/@types/node/path.d.ts new file mode 100755 index 00000000..a58c0aab --- /dev/null +++ b/node_modules/@types/node/path.d.ts @@ -0,0 +1,172 @@ +declare module 'path/posix' { + import path = require('path'); + export = path; +} +declare module 'path/win32' { + import path = require('path'); + export = path; +} +/** + * The `path` module provides utilities for working with file and directory paths. + * It can be accessed using: + * + * ```js + * const path = require('path'); + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/path.js) + */ +declare module 'path' { + namespace path { + /** + * A parsed path object generated by path.parse() or consumed by path.format(). + */ + interface ParsedPath { + /** + * The root of the path such as '/' or 'c:\' + */ + root: string; + /** + * The full directory path such as '/home/user/dir' or 'c:\path\dir' + */ + dir: string; + /** + * The file name including extension (if any) such as 'index.html' + */ + base: string; + /** + * The file extension (if any) such as '.html' + */ + ext: string; + /** + * The file name without extension (if any) such as 'index' + */ + name: string; + } + interface FormatInputPathObject { + /** + * The root of the path such as '/' or 'c:\' + */ + root?: string | undefined; + /** + * The full directory path such as '/home/user/dir' or 'c:\path\dir' + */ + dir?: string | undefined; + /** + * The file name including extension (if any) such as 'index.html' + */ + base?: string | undefined; + /** + * The file extension (if any) such as '.html' + */ + ext?: string | undefined; + /** + * The file name without extension (if any) such as 'index' + */ + name?: string | undefined; + } + interface PlatformPath { + /** + * Normalize a string path, reducing '..' and '.' parts. + * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. + * + * @param p string path to normalize. + */ + normalize(p: string): string; + /** + * Join all arguments together and normalize the resulting path. + * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. + * + * @param paths paths to join. + */ + join(...paths: string[]): string; + /** + * The right-most parameter is considered {to}. Other parameters are considered an array of {from}. + * + * Starting from leftmost {from} parameter, resolves {to} to an absolute path. + * + * If {to} isn't already absolute, {from} arguments are prepended in right to left order, + * until an absolute path is found. If after using all {from} paths still no absolute path is found, + * the current working directory is used as well. The resulting path is normalized, + * and trailing slashes are removed unless the path gets resolved to the root directory. + * + * @param pathSegments string paths to join. Non-string arguments are ignored. + */ + resolve(...pathSegments: string[]): string; + /** + * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. + * + * @param path path to test. + */ + isAbsolute(p: string): boolean; + /** + * Solve the relative path from {from} to {to}. + * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve. + */ + relative(from: string, to: string): string; + /** + * Return the directory name of a path. Similar to the Unix dirname command. + * + * @param p the path to evaluate. + */ + dirname(p: string): string; + /** + * Return the last portion of a path. Similar to the Unix basename command. + * Often used to extract the file name from a fully qualified path. + * + * @param p the path to evaluate. + * @param ext optionally, an extension to remove from the result. + */ + basename(p: string, ext?: string): string; + /** + * Return the extension of the path, from the last '.' to end of string in the last portion of the path. + * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string + * + * @param p the path to evaluate. + */ + extname(p: string): string; + /** + * The platform-specific file separator. '\\' or '/'. + */ + readonly sep: string; + /** + * The platform-specific file delimiter. ';' or ':'. + */ + readonly delimiter: string; + /** + * Returns an object from a path string - the opposite of format(). + * + * @param pathString path to evaluate. + */ + parse(p: string): ParsedPath; + /** + * Returns a path string from an object - the opposite of parse(). + * + * @param pathString path to evaluate. + */ + format(pP: FormatInputPathObject): string; + /** + * On Windows systems only, returns an equivalent namespace-prefixed path for the given path. + * If path is not a string, path will be returned without modifications. + * This method is meaningful only on Windows system. + * On POSIX systems, the method is non-operational and always returns path without modifications. + */ + toNamespacedPath(path: string): string; + /** + * Posix specific pathing. + * Same as parent object on posix. + */ + readonly posix: PlatformPath; + /** + * Windows specific pathing. + * Same as parent object on windows + */ + readonly win32: PlatformPath; + } + } + const path: path.PlatformPath; + export = path; +} +declare module 'node:path' { + import path = require('path'); + export = path; +} diff --git a/node_modules/@types/node/perf_hooks.d.ts b/node_modules/@types/node/perf_hooks.d.ts new file mode 100755 index 00000000..0e4b48f9 --- /dev/null +++ b/node_modules/@types/node/perf_hooks.d.ts @@ -0,0 +1,555 @@ +/** + * This module provides an implementation of a subset of the W3C [Web Performance APIs](https://w3c.github.io/perf-timing-primer/) as well as additional APIs for + * Node.js-specific performance measurements. + * + * Node.js supports the following [Web Performance APIs](https://w3c.github.io/perf-timing-primer/): + * + * * [High Resolution Time](https://www.w3.org/TR/hr-time-2) + * * [Performance Timeline](https://w3c.github.io/performance-timeline/) + * * [User Timing](https://www.w3.org/TR/user-timing/) + * + * ```js + * const { PerformanceObserver, performance } = require('perf_hooks'); + * + * const obs = new PerformanceObserver((items) => { + * console.log(items.getEntries()[0].duration); + * performance.clearMarks(); + * }); + * obs.observe({ type: 'measure' }); + * performance.measure('Start to Now'); + * + * performance.mark('A'); + * doSomeLongRunningProcess(() => { + * performance.measure('A to Now', 'A'); + * + * performance.mark('B'); + * performance.measure('A to B', 'A', 'B'); + * }); + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/perf_hooks.js) + */ +declare module 'perf_hooks' { + import { AsyncResource } from 'node:async_hooks'; + type EntryType = 'node' | 'mark' | 'measure' | 'gc' | 'function' | 'http2' | 'http'; + interface NodeGCPerformanceDetail { + /** + * When `performanceEntry.entryType` is equal to 'gc', `the performance.kind` property identifies + * the type of garbage collection operation that occurred. + * See perf_hooks.constants for valid values. + */ + readonly kind?: number | undefined; + /** + * When `performanceEntry.entryType` is equal to 'gc', the `performance.flags` + * property contains additional information about garbage collection operation. + * See perf_hooks.constants for valid values. + */ + readonly flags?: number | undefined; + } + /** + * @since v8.5.0 + */ + class PerformanceEntry { + protected constructor(); + /** + * The total number of milliseconds elapsed for this entry. This value will not + * be meaningful for all Performance Entry types. + * @since v8.5.0 + */ + readonly duration: number; + /** + * The name of the performance entry. + * @since v8.5.0 + */ + readonly name: string; + /** + * The high resolution millisecond timestamp marking the starting time of the + * Performance Entry. + * @since v8.5.0 + */ + readonly startTime: number; + /** + * The type of the performance entry. It may be one of: + * + * * `'node'` (Node.js only) + * * `'mark'` (available on the Web) + * * `'measure'` (available on the Web) + * * `'gc'` (Node.js only) + * * `'function'` (Node.js only) + * * `'http2'` (Node.js only) + * * `'http'` (Node.js only) + * @since v8.5.0 + */ + readonly entryType: EntryType; + /** + * Additional detail specific to the `entryType`. + * @since v16.0.0 + */ + readonly detail?: NodeGCPerformanceDetail | unknown | undefined; // TODO: Narrow this based on entry type. + } + /** + * _This property is an extension by Node.js. It is not available in Web browsers._ + * + * Provides timing details for Node.js itself. The constructor of this class + * is not exposed to users. + * @since v8.5.0 + */ + class PerformanceNodeTiming extends PerformanceEntry { + /** + * The high resolution millisecond timestamp at which the Node.js process + * completed bootstrapping. If bootstrapping has not yet finished, the property + * has the value of -1. + * @since v8.5.0 + */ + readonly bootstrapComplete: number; + /** + * The high resolution millisecond timestamp at which the Node.js environment was + * initialized. + * @since v8.5.0 + */ + readonly environment: number; + /** + * The high resolution millisecond timestamp of the amount of time the event loop + * has been idle within the event loop's event provider (e.g. `epoll_wait`). This + * does not take CPU usage into consideration. If the event loop has not yet + * started (e.g., in the first tick of the main script), the property has the + * value of 0. + * @since v14.10.0, v12.19.0 + */ + readonly idleTime: number; + /** + * The high resolution millisecond timestamp at which the Node.js event loop + * exited. If the event loop has not yet exited, the property has the value of -1\. + * It can only have a value of not -1 in a handler of the `'exit'` event. + * @since v8.5.0 + */ + readonly loopExit: number; + /** + * The high resolution millisecond timestamp at which the Node.js event loop + * started. If the event loop has not yet started (e.g., in the first tick of the + * main script), the property has the value of -1. + * @since v8.5.0 + */ + readonly loopStart: number; + /** + * The high resolution millisecond timestamp at which the V8 platform was + * initialized. + * @since v8.5.0 + */ + readonly v8Start: number; + } + interface EventLoopUtilization { + idle: number; + active: number; + utilization: number; + } + /** + * @param util1 The result of a previous call to eventLoopUtilization() + * @param util2 The result of a previous call to eventLoopUtilization() prior to util1 + */ + type EventLoopUtilityFunction = (util1?: EventLoopUtilization, util2?: EventLoopUtilization) => EventLoopUtilization; + interface MarkOptions { + /** + * Additional optional detail to include with the mark. + */ + detail?: unknown | undefined; + /** + * An optional timestamp to be used as the mark time. + * @default `performance.now()`. + */ + startTime?: number | undefined; + } + interface MeasureOptions { + /** + * Additional optional detail to include with the mark. + */ + detail?: unknown | undefined; + /** + * Duration between start and end times. + */ + duration?: number | undefined; + /** + * Timestamp to be used as the end time, or a string identifying a previously recorded mark. + */ + end?: number | string | undefined; + /** + * Timestamp to be used as the start time, or a string identifying a previously recorded mark. + */ + start?: number | string | undefined; + } + interface TimerifyOptions { + /** + * A histogram object created using + * `perf_hooks.createHistogram()` that will record runtime durations in + * nanoseconds. + */ + histogram?: RecordableHistogram | undefined; + } + interface Performance { + /** + * If name is not provided, removes all PerformanceMark objects from the Performance Timeline. + * If name is provided, removes only the named mark. + * @param name + */ + clearMarks(name?: string): void; + /** + * Creates a new PerformanceMark entry in the Performance Timeline. + * A PerformanceMark is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'mark', + * and whose performanceEntry.duration is always 0. + * Performance marks are used to mark specific significant moments in the Performance Timeline. + * @param name + */ + mark(name?: string, options?: MarkOptions): void; + /** + * Creates a new PerformanceMeasure entry in the Performance Timeline. + * A PerformanceMeasure is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'measure', + * and whose performanceEntry.duration measures the number of milliseconds elapsed since startMark and endMark. + * + * The startMark argument may identify any existing PerformanceMark in the the Performance Timeline, or may identify + * any of the timestamp properties provided by the PerformanceNodeTiming class. If the named startMark does not exist, + * then startMark is set to timeOrigin by default. + * + * The endMark argument must identify any existing PerformanceMark in the the Performance Timeline or any of the timestamp + * properties provided by the PerformanceNodeTiming class. If the named endMark does not exist, an error will be thrown. + * @param name + * @param startMark + * @param endMark + */ + measure(name: string, startMark?: string, endMark?: string): void; + measure(name: string, options: MeasureOptions): void; + /** + * An instance of the PerformanceNodeTiming class that provides performance metrics for specific Node.js operational milestones. + */ + readonly nodeTiming: PerformanceNodeTiming; + /** + * @return the current high resolution millisecond timestamp + */ + now(): number; + /** + * The timeOrigin specifies the high resolution millisecond timestamp from which all performance metric durations are measured. + */ + readonly timeOrigin: number; + /** + * Wraps a function within a new function that measures the running time of the wrapped function. + * A PerformanceObserver must be subscribed to the 'function' event type in order for the timing details to be accessed. + * @param fn + */ + timerify any>(fn: T, options?: TimerifyOptions): T; + /** + * eventLoopUtilization is similar to CPU utilization except that it is calculated using high precision wall-clock time. + * It represents the percentage of time the event loop has spent outside the event loop's event provider (e.g. epoll_wait). + * No other CPU idle time is taken into consideration. + */ + eventLoopUtilization: EventLoopUtilityFunction; + } + interface PerformanceObserverEntryList { + /** + * Returns a list of `PerformanceEntry` objects in chronological order + * with respect to `performanceEntry.startTime`. + * + * ```js + * const { + * performance, + * PerformanceObserver + * } = require('perf_hooks'); + * + * const obs = new PerformanceObserver((perfObserverList, observer) => { + * console.log(perfObserverList.getEntries()); + * + * * [ + * * PerformanceEntry { + * * name: 'test', + * * entryType: 'mark', + * * startTime: 81.465639, + * * duration: 0 + * * }, + * * PerformanceEntry { + * * name: 'meow', + * * entryType: 'mark', + * * startTime: 81.860064, + * * duration: 0 + * * } + * * ] + * + * observer.disconnect(); + * }); + * obs.observe({ type: 'mark' }); + * + * performance.mark('test'); + * performance.mark('meow'); + * ``` + * @since v8.5.0 + */ + getEntries(): PerformanceEntry[]; + /** + * Returns a list of `PerformanceEntry` objects in chronological order + * with respect to `performanceEntry.startTime` whose `performanceEntry.name` is + * equal to `name`, and optionally, whose `performanceEntry.entryType` is equal to`type`. + * + * ```js + * const { + * performance, + * PerformanceObserver + * } = require('perf_hooks'); + * + * const obs = new PerformanceObserver((perfObserverList, observer) => { + * console.log(perfObserverList.getEntriesByName('meow')); + * + * * [ + * * PerformanceEntry { + * * name: 'meow', + * * entryType: 'mark', + * * startTime: 98.545991, + * * duration: 0 + * * } + * * ] + * + * console.log(perfObserverList.getEntriesByName('nope')); // [] + * + * console.log(perfObserverList.getEntriesByName('test', 'mark')); + * + * * [ + * * PerformanceEntry { + * * name: 'test', + * * entryType: 'mark', + * * startTime: 63.518931, + * * duration: 0 + * * } + * * ] + * + * console.log(perfObserverList.getEntriesByName('test', 'measure')); // [] + * observer.disconnect(); + * }); + * obs.observe({ entryTypes: ['mark', 'measure'] }); + * + * performance.mark('test'); + * performance.mark('meow'); + * ``` + * @since v8.5.0 + */ + getEntriesByName(name: string, type?: EntryType): PerformanceEntry[]; + /** + * Returns a list of `PerformanceEntry` objects in chronological order + * with respect to `performanceEntry.startTime` whose `performanceEntry.entryType`is equal to `type`. + * + * ```js + * const { + * performance, + * PerformanceObserver + * } = require('perf_hooks'); + * + * const obs = new PerformanceObserver((perfObserverList, observer) => { + * console.log(perfObserverList.getEntriesByType('mark')); + * + * * [ + * * PerformanceEntry { + * * name: 'test', + * * entryType: 'mark', + * * startTime: 55.897834, + * * duration: 0 + * * }, + * * PerformanceEntry { + * * name: 'meow', + * * entryType: 'mark', + * * startTime: 56.350146, + * * duration: 0 + * * } + * * ] + * + * observer.disconnect(); + * }); + * obs.observe({ type: 'mark' }); + * + * performance.mark('test'); + * performance.mark('meow'); + * ``` + * @since v8.5.0 + */ + getEntriesByType(type: EntryType): PerformanceEntry[]; + } + type PerformanceObserverCallback = (list: PerformanceObserverEntryList, observer: PerformanceObserver) => void; + class PerformanceObserver extends AsyncResource { + constructor(callback: PerformanceObserverCallback); + /** + * Disconnects the `PerformanceObserver` instance from all notifications. + * @since v8.5.0 + */ + disconnect(): void; + /** + * Subscribes the `PerformanceObserver` instance to notifications of new `PerformanceEntry` instances identified either by `options.entryTypes`or `options.type`: + * + * ```js + * const { + * performance, + * PerformanceObserver + * } = require('perf_hooks'); + * + * const obs = new PerformanceObserver((list, observer) => { + * // Called three times synchronously. `list` contains one item. + * }); + * obs.observe({ type: 'mark' }); + * + * for (let n = 0; n < 3; n++) + * performance.mark(`test${n}`); + * ``` + * @since v8.5.0 + */ + observe( + options: + | { + entryTypes: ReadonlyArray; + } + | { + type: EntryType; + } + ): void; + } + namespace constants { + const NODE_PERFORMANCE_GC_MAJOR: number; + const NODE_PERFORMANCE_GC_MINOR: number; + const NODE_PERFORMANCE_GC_INCREMENTAL: number; + const NODE_PERFORMANCE_GC_WEAKCB: number; + const NODE_PERFORMANCE_GC_FLAGS_NO: number; + const NODE_PERFORMANCE_GC_FLAGS_CONSTRUCT_RETAINED: number; + const NODE_PERFORMANCE_GC_FLAGS_FORCED: number; + const NODE_PERFORMANCE_GC_FLAGS_SYNCHRONOUS_PHANTOM_PROCESSING: number; + const NODE_PERFORMANCE_GC_FLAGS_ALL_AVAILABLE_GARBAGE: number; + const NODE_PERFORMANCE_GC_FLAGS_ALL_EXTERNAL_MEMORY: number; + const NODE_PERFORMANCE_GC_FLAGS_SCHEDULE_IDLE: number; + } + const performance: Performance; + interface EventLoopMonitorOptions { + /** + * The sampling rate in milliseconds. + * Must be greater than zero. + * @default 10 + */ + resolution?: number | undefined; + } + interface Histogram { + /** + * Returns a `Map` object detailing the accumulated percentile distribution. + * @since v11.10.0 + */ + readonly percentiles: Map; + /** + * The number of times the event loop delay exceeded the maximum 1 hour event + * loop delay threshold. + * @since v11.10.0 + */ + readonly exceeds: number; + /** + * The minimum recorded event loop delay. + * @since v11.10.0 + */ + readonly min: number; + /** + * The maximum recorded event loop delay. + * @since v11.10.0 + */ + readonly max: number; + /** + * The mean of the recorded event loop delays. + * @since v11.10.0 + */ + readonly mean: number; + /** + * The standard deviation of the recorded event loop delays. + * @since v11.10.0 + */ + readonly stddev: number; + /** + * Resets the collected histogram data. + * @since v11.10.0 + */ + reset(): void; + /** + * Returns the value at the given percentile. + * @since v11.10.0 + * @param percentile A percentile value in the range (0, 100]. + */ + percentile(percentile: number): number; + } + interface IntervalHistogram extends Histogram { + /** + * Enables the update interval timer. Returns `true` if the timer was + * started, `false` if it was already started. + * @since v11.10.0 + */ + enable(): boolean; + /** + * Disables the update interval timer. Returns `true` if the timer was + * stopped, `false` if it was already stopped. + * @since v11.10.0 + */ + disable(): boolean; + } + interface RecordableHistogram extends Histogram { + /** + * @since v15.9.0 + * @param val The amount to record in the histogram. + */ + record(val: number | bigint): void; + /** + * Calculates the amount of time (in nanoseconds) that has passed since the + * previous call to `recordDelta()` and records that amount in the histogram. + * + * ## Examples + * @since v15.9.0 + */ + recordDelta(): void; + } + /** + * _This property is an extension by Node.js. It is not available in Web browsers._ + * + * Creates an `IntervalHistogram` object that samples and reports the event loop + * delay over time. The delays will be reported in nanoseconds. + * + * Using a timer to detect approximate event loop delay works because the + * execution of timers is tied specifically to the lifecycle of the libuv + * event loop. That is, a delay in the loop will cause a delay in the execution + * of the timer, and those delays are specifically what this API is intended to + * detect. + * + * ```js + * const { monitorEventLoopDelay } = require('perf_hooks'); + * const h = monitorEventLoopDelay({ resolution: 20 }); + * h.enable(); + * // Do something. + * h.disable(); + * console.log(h.min); + * console.log(h.max); + * console.log(h.mean); + * console.log(h.stddev); + * console.log(h.percentiles); + * console.log(h.percentile(50)); + * console.log(h.percentile(99)); + * ``` + * @since v11.10.0 + */ + function monitorEventLoopDelay(options?: EventLoopMonitorOptions): IntervalHistogram; + interface CreateHistogramOptions { + /** + * The minimum recordable value. Must be an integer value greater than 0. + * @default 1 + */ + min?: number | bigint | undefined; + /** + * The maximum recordable value. Must be an integer value greater than min. + * @default Number.MAX_SAFE_INTEGER + */ + max?: number | bigint | undefined; + /** + * The number of accuracy digits. Must be a number between 1 and 5. + * @default 3 + */ + figures?: number | undefined; + } + /** + * Returns a `RecordableHistogram`. + * @since v15.9.0 + */ + function createHistogram(options?: CreateHistogramOptions): RecordableHistogram; +} +declare module 'node:perf_hooks' { + export * from 'perf_hooks'; +} diff --git a/node_modules/@types/node/process.d.ts b/node_modules/@types/node/process.d.ts new file mode 100755 index 00000000..30cca6d2 --- /dev/null +++ b/node_modules/@types/node/process.d.ts @@ -0,0 +1,1481 @@ +declare module 'process' { + import * as tty from 'node:tty'; + import { Worker } from 'node:worker_threads'; + global { + var process: NodeJS.Process; + namespace NodeJS { + // this namespace merge is here because these are specifically used + // as the type for process.stdin, process.stdout, and process.stderr. + // they can't live in tty.d.ts because we need to disambiguate the imported name. + interface ReadStream extends tty.ReadStream {} + interface WriteStream extends tty.WriteStream {} + interface MemoryUsageFn { + /** + * The `process.memoryUsage()` method iterate over each page to gather informations about memory + * usage which can be slow depending on the program memory allocations. + */ + (): MemoryUsage; + /** + * method returns an integer representing the Resident Set Size (RSS) in bytes. + */ + rss(): number; + } + interface MemoryUsage { + rss: number; + heapTotal: number; + heapUsed: number; + external: number; + arrayBuffers: number; + } + interface CpuUsage { + user: number; + system: number; + } + interface ProcessRelease { + name: string; + sourceUrl?: string | undefined; + headersUrl?: string | undefined; + libUrl?: string | undefined; + lts?: string | undefined; + } + interface ProcessVersions extends Dict { + http_parser: string; + node: string; + v8: string; + ares: string; + uv: string; + zlib: string; + modules: string; + openssl: string; + } + type Platform = 'aix' | 'android' | 'darwin' | 'freebsd' | 'haiku' | 'linux' | 'openbsd' | 'sunos' | 'win32' | 'cygwin' | 'netbsd'; + type Signals = + | 'SIGABRT' + | 'SIGALRM' + | 'SIGBUS' + | 'SIGCHLD' + | 'SIGCONT' + | 'SIGFPE' + | 'SIGHUP' + | 'SIGILL' + | 'SIGINT' + | 'SIGIO' + | 'SIGIOT' + | 'SIGKILL' + | 'SIGPIPE' + | 'SIGPOLL' + | 'SIGPROF' + | 'SIGPWR' + | 'SIGQUIT' + | 'SIGSEGV' + | 'SIGSTKFLT' + | 'SIGSTOP' + | 'SIGSYS' + | 'SIGTERM' + | 'SIGTRAP' + | 'SIGTSTP' + | 'SIGTTIN' + | 'SIGTTOU' + | 'SIGUNUSED' + | 'SIGURG' + | 'SIGUSR1' + | 'SIGUSR2' + | 'SIGVTALRM' + | 'SIGWINCH' + | 'SIGXCPU' + | 'SIGXFSZ' + | 'SIGBREAK' + | 'SIGLOST' + | 'SIGINFO'; + type UncaughtExceptionOrigin = 'uncaughtException' | 'unhandledRejection'; + type MultipleResolveType = 'resolve' | 'reject'; + type BeforeExitListener = (code: number) => void; + type DisconnectListener = () => void; + type ExitListener = (code: number) => void; + type RejectionHandledListener = (promise: Promise) => void; + type UncaughtExceptionListener = (error: Error, origin: UncaughtExceptionOrigin) => void; + /** + * Most of the time the unhandledRejection will be an Error, but this should not be relied upon + * as *anything* can be thrown/rejected, it is therefore unsafe to assume the the value is an Error. + */ + type UnhandledRejectionListener = (reason: unknown, promise: Promise) => void; + type WarningListener = (warning: Error) => void; + type MessageListener = (message: unknown, sendHandle: unknown) => void; + type SignalsListener = (signal: Signals) => void; + type MultipleResolveListener = (type: MultipleResolveType, promise: Promise, value: unknown) => void; + type WorkerListener = (worker: Worker) => void; + interface Socket extends ReadWriteStream { + isTTY?: true | undefined; + } + // Alias for compatibility + interface ProcessEnv extends Dict { + /** + * Can be used to change the default timezone at runtime + */ + TZ?: string; + } + interface HRTime { + (time?: [number, number]): [number, number]; + bigint(): bigint; + } + interface ProcessReport { + /** + * Directory where the report is written. + * working directory of the Node.js process. + * @default '' indicating that reports are written to the current + */ + directory: string; + /** + * Filename where the report is written. + * The default value is the empty string. + * @default '' the output filename will be comprised of a timestamp, + * PID, and sequence number. + */ + filename: string; + /** + * Returns a JSON-formatted diagnostic report for the running process. + * The report's JavaScript stack trace is taken from err, if present. + */ + getReport(err?: Error): string; + /** + * If true, a diagnostic report is generated on fatal errors, + * such as out of memory errors or failed C++ assertions. + * @default false + */ + reportOnFatalError: boolean; + /** + * If true, a diagnostic report is generated when the process + * receives the signal specified by process.report.signal. + * @defaul false + */ + reportOnSignal: boolean; + /** + * If true, a diagnostic report is generated on uncaught exception. + * @default false + */ + reportOnUncaughtException: boolean; + /** + * The signal used to trigger the creation of a diagnostic report. + * @default 'SIGUSR2' + */ + signal: Signals; + /** + * Writes a diagnostic report to a file. If filename is not provided, the default filename + * includes the date, time, PID, and a sequence number. + * The report's JavaScript stack trace is taken from err, if present. + * + * @param fileName Name of the file where the report is written. + * This should be a relative path, that will be appended to the directory specified in + * `process.report.directory`, or the current working directory of the Node.js process, + * if unspecified. + * @param error A custom error used for reporting the JavaScript stack. + * @return Filename of the generated report. + */ + writeReport(fileName?: string): string; + writeReport(error?: Error): string; + writeReport(fileName?: string, err?: Error): string; + } + interface ResourceUsage { + fsRead: number; + fsWrite: number; + involuntaryContextSwitches: number; + ipcReceived: number; + ipcSent: number; + majorPageFault: number; + maxRSS: number; + minorPageFault: number; + sharedMemorySize: number; + signalsCount: number; + swappedOut: number; + systemCPUTime: number; + unsharedDataSize: number; + unsharedStackSize: number; + userCPUTime: number; + voluntaryContextSwitches: number; + } + interface EmitWarningOptions { + /** + * When `warning` is a `string`, `type` is the name to use for the _type_ of warning being emitted. + * + * @default 'Warning' + */ + type?: string | undefined; + /** + * A unique identifier for the warning instance being emitted. + */ + code?: string | undefined; + /** + * When `warning` is a `string`, `ctor` is an optional function used to limit the generated stack trace. + * + * @default process.emitWarning + */ + ctor?: Function | undefined; + /** + * Additional text to include with the error. + */ + detail?: string | undefined; + } + interface ProcessConfig { + readonly target_defaults: { + readonly cflags: any[]; + readonly default_configuration: string; + readonly defines: string[]; + readonly include_dirs: string[]; + readonly libraries: string[]; + }; + readonly variables: { + readonly clang: number; + readonly host_arch: string; + readonly node_install_npm: boolean; + readonly node_install_waf: boolean; + readonly node_prefix: string; + readonly node_shared_openssl: boolean; + readonly node_shared_v8: boolean; + readonly node_shared_zlib: boolean; + readonly node_use_dtrace: boolean; + readonly node_use_etw: boolean; + readonly node_use_openssl: boolean; + readonly target_arch: string; + readonly v8_no_strict_aliasing: number; + readonly v8_use_snapshot: boolean; + readonly visibility: string; + }; + } + interface Process extends EventEmitter { + /** + * The `process.stdout` property returns a stream connected to`stdout` (fd `1`). It is a `net.Socket` (which is a `Duplex` stream) unless fd `1` refers to a file, in which case it is + * a `Writable` stream. + * + * For example, to copy `process.stdin` to `process.stdout`: + * + * ```js + * import { stdin, stdout } from 'process'; + * + * stdin.pipe(stdout); + * ``` + * + * `process.stdout` differs from other Node.js streams in important ways. See `note on process I/O` for more information. + */ + stdout: WriteStream & { + fd: 1; + }; + /** + * The `process.stderr` property returns a stream connected to`stderr` (fd `2`). It is a `net.Socket` (which is a `Duplex` stream) unless fd `2` refers to a file, in which case it is + * a `Writable` stream. + * + * `process.stderr` differs from other Node.js streams in important ways. See `note on process I/O` for more information. + */ + stderr: WriteStream & { + fd: 2; + }; + /** + * The `process.stdin` property returns a stream connected to`stdin` (fd `0`). It is a `net.Socket` (which is a `Duplex` stream) unless fd `0` refers to a file, in which case it is + * a `Readable` stream. + * + * For details of how to read from `stdin` see `readable.read()`. + * + * As a `Duplex` stream, `process.stdin` can also be used in "old" mode that + * is compatible with scripts written for Node.js prior to v0.10\. + * For more information see `Stream compatibility`. + * + * In "old" streams mode the `stdin` stream is paused by default, so one + * must call `process.stdin.resume()` to read from it. Note also that calling`process.stdin.resume()` itself would switch stream to "old" mode. + */ + stdin: ReadStream & { + fd: 0; + }; + openStdin(): Socket; + /** + * The `process.argv` property returns an array containing the command-line + * arguments passed when the Node.js process was launched. The first element will + * be {@link execPath}. See `process.argv0` if access to the original value + * of `argv[0]` is needed. The second element will be the path to the JavaScript + * file being executed. The remaining elements will be any additional command-line + * arguments. + * + * For example, assuming the following script for `process-args.js`: + * + * ```js + * import { argv } from 'process'; + * + * // print process.argv + * argv.forEach((val, index) => { + * console.log(`${index}: ${val}`); + * }); + * ``` + * + * Launching the Node.js process as: + * + * ```console + * $ node process-args.js one two=three four + * ``` + * + * Would generate the output: + * + * ```text + * 0: /usr/local/bin/node + * 1: /Users/mjr/work/node/process-args.js + * 2: one + * 3: two=three + * 4: four + * ``` + * @since v0.1.27 + */ + argv: string[]; + /** + * The `process.argv0` property stores a read-only copy of the original value of`argv[0]` passed when Node.js starts. + * + * ```console + * $ bash -c 'exec -a customArgv0 ./node' + * > process.argv[0] + * '/Volumes/code/external/node/out/Release/node' + * > process.argv0 + * 'customArgv0' + * ``` + * @since v6.4.0 + */ + argv0: string; + /** + * The `process.execArgv` property returns the set of Node.js-specific command-line + * options passed when the Node.js process was launched. These options do not + * appear in the array returned by the {@link argv} property, and do not + * include the Node.js executable, the name of the script, or any options following + * the script name. These options are useful in order to spawn child processes with + * the same execution environment as the parent. + * + * ```console + * $ node --harmony script.js --version + * ``` + * + * Results in `process.execArgv`: + * + * ```js + * ['--harmony'] + * ``` + * + * And `process.argv`: + * + * ```js + * ['/usr/local/bin/node', 'script.js', '--version'] + * ``` + * + * Refer to `Worker constructor` for the detailed behavior of worker + * threads with this property. + * @since v0.7.7 + */ + execArgv: string[]; + /** + * The `process.execPath` property returns the absolute pathname of the executable + * that started the Node.js process. Symbolic links, if any, are resolved. + * + * ```js + * '/usr/local/bin/node' + * ``` + * @since v0.1.100 + */ + execPath: string; + /** + * The `process.abort()` method causes the Node.js process to exit immediately and + * generate a core file. + * + * This feature is not available in `Worker` threads. + * @since v0.7.0 + */ + abort(): never; + /** + * The `process.chdir()` method changes the current working directory of the + * Node.js process or throws an exception if doing so fails (for instance, if + * the specified `directory` does not exist). + * + * ```js + * import { chdir, cwd } from 'process'; + * + * console.log(`Starting directory: ${cwd()}`); + * try { + * chdir('/tmp'); + * console.log(`New directory: ${cwd()}`); + * } catch (err) { + * console.error(`chdir: ${err}`); + * } + * ``` + * + * This feature is not available in `Worker` threads. + * @since v0.1.17 + */ + chdir(directory: string): void; + /** + * The `process.cwd()` method returns the current working directory of the Node.js + * process. + * + * ```js + * import { cwd } from 'process'; + * + * console.log(`Current directory: ${cwd()}`); + * ``` + * @since v0.1.8 + */ + cwd(): string; + /** + * The port used by the Node.js debugger when enabled. + * + * ```js + * import process from 'process'; + * + * process.debugPort = 5858; + * ``` + * @since v0.7.2 + */ + debugPort: number; + /** + * The `process.emitWarning()` method can be used to emit custom or application + * specific process warnings. These can be listened for by adding a handler to the `'warning'` event. + * + * ```js + * import { emitWarning } from 'process'; + * + * // Emit a warning with a code and additional detail. + * emitWarning('Something happened!', { + * code: 'MY_WARNING', + * detail: 'This is some additional information' + * }); + * // Emits: + * // (node:56338) [MY_WARNING] Warning: Something happened! + * // This is some additional information + * ``` + * + * In this example, an `Error` object is generated internally by`process.emitWarning()` and passed through to the `'warning'` handler. + * + * ```js + * import process from 'process'; + * + * process.on('warning', (warning) => { + * console.warn(warning.name); // 'Warning' + * console.warn(warning.message); // 'Something happened!' + * console.warn(warning.code); // 'MY_WARNING' + * console.warn(warning.stack); // Stack trace + * console.warn(warning.detail); // 'This is some additional information' + * }); + * ``` + * + * If `warning` is passed as an `Error` object, the `options` argument is ignored. + * @since v8.0.0 + * @param warning The warning to emit. + */ + emitWarning(warning: string | Error, ctor?: Function): void; + emitWarning(warning: string | Error, type?: string, ctor?: Function): void; + emitWarning(warning: string | Error, type?: string, code?: string, ctor?: Function): void; + emitWarning(warning: string | Error, options?: EmitWarningOptions): void; + /** + * The `process.env` property returns an object containing the user environment. + * See [`environ(7)`](http://man7.org/linux/man-pages/man7/environ.7.html). + * + * An example of this object looks like: + * + * ```js + * { + * TERM: 'xterm-256color', + * SHELL: '/usr/local/bin/bash', + * USER: 'maciej', + * PATH: '~/.bin/:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin', + * PWD: '/Users/maciej', + * EDITOR: 'vim', + * SHLVL: '1', + * HOME: '/Users/maciej', + * LOGNAME: 'maciej', + * _: '/usr/local/bin/node' + * } + * ``` + * + * It is possible to modify this object, but such modifications will not be + * reflected outside the Node.js process, or (unless explicitly requested) + * to other `Worker` threads. + * In other words, the following example would not work: + * + * ```console + * $ node -e 'process.env.foo = "bar"' && echo $foo + * ``` + * + * While the following will: + * + * ```js + * import { env } from 'process'; + * + * env.foo = 'bar'; + * console.log(env.foo); + * ``` + * + * Assigning a property on `process.env` will implicitly convert the value + * to a string. **This behavior is deprecated.** Future versions of Node.js may + * throw an error when the value is not a string, number, or boolean. + * + * ```js + * import { env } from 'process'; + * + * env.test = null; + * console.log(env.test); + * // => 'null' + * env.test = undefined; + * console.log(env.test); + * // => 'undefined' + * ``` + * + * Use `delete` to delete a property from `process.env`. + * + * ```js + * import { env } from 'process'; + * + * env.TEST = 1; + * delete env.TEST; + * console.log(env.TEST); + * // => undefined + * ``` + * + * On Windows operating systems, environment variables are case-insensitive. + * + * ```js + * import { env } from 'process'; + * + * env.TEST = 1; + * console.log(env.test); + * // => 1 + * ``` + * + * Unless explicitly specified when creating a `Worker` instance, + * each `Worker` thread has its own copy of `process.env`, based on its + * parent thread’s `process.env`, or whatever was specified as the `env` option + * to the `Worker` constructor. Changes to `process.env` will not be visible + * across `Worker` threads, and only the main thread can make changes that + * are visible to the operating system or to native add-ons. + * @since v0.1.27 + */ + env: ProcessEnv; + /** + * The `process.exit()` method instructs Node.js to terminate the process + * synchronously with an exit status of `code`. If `code` is omitted, exit uses + * either the 'success' code `0` or the value of `process.exitCode` if it has been + * set. Node.js will not terminate until all the `'exit'` event listeners are + * called. + * + * To exit with a 'failure' code: + * + * ```js + * import { exit } from 'process'; + * + * exit(1); + * ``` + * + * The shell that executed Node.js should see the exit code as `1`. + * + * Calling `process.exit()` will force the process to exit as quickly as possible + * even if there are still asynchronous operations pending that have not yet + * completed fully, including I/O operations to `process.stdout` and`process.stderr`. + * + * In most situations, it is not actually necessary to call `process.exit()`explicitly. The Node.js process will exit on its own _if there is no additional_ + * _work pending_ in the event loop. The `process.exitCode` property can be set to + * tell the process which exit code to use when the process exits gracefully. + * + * For instance, the following example illustrates a _misuse_ of the`process.exit()` method that could lead to data printed to stdout being + * truncated and lost: + * + * ```js + * import { exit } from 'process'; + * + * // This is an example of what *not* to do: + * if (someConditionNotMet()) { + * printUsageToStdout(); + * exit(1); + * } + * ``` + * + * The reason this is problematic is because writes to `process.stdout` in Node.js + * are sometimes _asynchronous_ and may occur over multiple ticks of the Node.js + * event loop. Calling `process.exit()`, however, forces the process to exit_before_ those additional writes to `stdout` can be performed. + * + * Rather than calling `process.exit()` directly, the code _should_ set the`process.exitCode` and allow the process to exit naturally by avoiding + * scheduling any additional work for the event loop: + * + * ```js + * import process from 'process'; + * + * // How to properly set the exit code while letting + * // the process exit gracefully. + * if (someConditionNotMet()) { + * printUsageToStdout(); + * process.exitCode = 1; + * } + * ``` + * + * If it is necessary to terminate the Node.js process due to an error condition, + * throwing an _uncaught_ error and allowing the process to terminate accordingly + * is safer than calling `process.exit()`. + * + * In `Worker` threads, this function stops the current thread rather + * than the current process. + * @since v0.1.13 + * @param [code=0] The exit code. + */ + exit(code?: number): never; + /** + * A number which will be the process exit code, when the process either + * exits gracefully, or is exited via {@link exit} without specifying + * a code. + * + * Specifying a code to {@link exit} will override any + * previous setting of `process.exitCode`. + * @since v0.11.8 + */ + exitCode?: number | undefined; + /** + * The `process.getgid()` method returns the numerical group identity of the + * process. (See [`getgid(2)`](http://man7.org/linux/man-pages/man2/getgid.2.html).) + * + * ```js + * import process from 'process'; + * + * if (process.getgid) { + * console.log(`Current gid: ${process.getgid()}`); + * } + * ``` + * + * This function is only available on POSIX platforms (i.e. not Windows or + * Android). + * @since v0.1.31 + */ + getgid(): number; + /** + * The `process.setgid()` method sets the group identity of the process. (See [`setgid(2)`](http://man7.org/linux/man-pages/man2/setgid.2.html).) The `id` can be passed as either a + * numeric ID or a group name + * string. If a group name is specified, this method blocks while resolving the + * associated numeric ID. + * + * ```js + * import process from 'process'; + * + * if (process.getgid && process.setgid) { + * console.log(`Current gid: ${process.getgid()}`); + * try { + * process.setgid(501); + * console.log(`New gid: ${process.getgid()}`); + * } catch (err) { + * console.log(`Failed to set gid: ${err}`); + * } + * } + * ``` + * + * This function is only available on POSIX platforms (i.e. not Windows or + * Android). + * This feature is not available in `Worker` threads. + * @since v0.1.31 + * @param id The group name or ID + */ + setgid(id: number | string): void; + /** + * The `process.getuid()` method returns the numeric user identity of the process. + * (See [`getuid(2)`](http://man7.org/linux/man-pages/man2/getuid.2.html).) + * + * ```js + * import process from 'process'; + * + * if (process.getuid) { + * console.log(`Current uid: ${process.getuid()}`); + * } + * ``` + * + * This function is only available on POSIX platforms (i.e. not Windows or + * Android). + * @since v0.1.28 + */ + getuid(): number; + /** + * The `process.setuid(id)` method sets the user identity of the process. (See [`setuid(2)`](http://man7.org/linux/man-pages/man2/setuid.2.html).) The `id` can be passed as either a + * numeric ID or a username string. + * If a username is specified, the method blocks while resolving the associated + * numeric ID. + * + * ```js + * import process from 'process'; + * + * if (process.getuid && process.setuid) { + * console.log(`Current uid: ${process.getuid()}`); + * try { + * process.setuid(501); + * console.log(`New uid: ${process.getuid()}`); + * } catch (err) { + * console.log(`Failed to set uid: ${err}`); + * } + * } + * ``` + * + * This function is only available on POSIX platforms (i.e. not Windows or + * Android). + * This feature is not available in `Worker` threads. + * @since v0.1.28 + */ + setuid(id: number | string): void; + /** + * The `process.geteuid()` method returns the numerical effective user identity of + * the process. (See [`geteuid(2)`](http://man7.org/linux/man-pages/man2/geteuid.2.html).) + * + * ```js + * import process from 'process'; + * + * if (process.geteuid) { + * console.log(`Current uid: ${process.geteuid()}`); + * } + * ``` + * + * This function is only available on POSIX platforms (i.e. not Windows or + * Android). + * @since v2.0.0 + */ + geteuid(): number; + /** + * The `process.seteuid()` method sets the effective user identity of the process. + * (See [`seteuid(2)`](http://man7.org/linux/man-pages/man2/seteuid.2.html).) The `id` can be passed as either a numeric ID or a username + * string. If a username is specified, the method blocks while resolving the + * associated numeric ID. + * + * ```js + * import process from 'process'; + * + * if (process.geteuid && process.seteuid) { + * console.log(`Current uid: ${process.geteuid()}`); + * try { + * process.seteuid(501); + * console.log(`New uid: ${process.geteuid()}`); + * } catch (err) { + * console.log(`Failed to set uid: ${err}`); + * } + * } + * ``` + * + * This function is only available on POSIX platforms (i.e. not Windows or + * Android). + * This feature is not available in `Worker` threads. + * @since v2.0.0 + * @param id A user name or ID + */ + seteuid(id: number | string): void; + /** + * The `process.getegid()` method returns the numerical effective group identity + * of the Node.js process. (See [`getegid(2)`](http://man7.org/linux/man-pages/man2/getegid.2.html).) + * + * ```js + * import process from 'process'; + * + * if (process.getegid) { + * console.log(`Current gid: ${process.getegid()}`); + * } + * ``` + * + * This function is only available on POSIX platforms (i.e. not Windows or + * Android). + * @since v2.0.0 + */ + getegid(): number; + /** + * The `process.setegid()` method sets the effective group identity of the process. + * (See [`setegid(2)`](http://man7.org/linux/man-pages/man2/setegid.2.html).) The `id` can be passed as either a numeric ID or a group + * name string. If a group name is specified, this method blocks while resolving + * the associated a numeric ID. + * + * ```js + * import process from 'process'; + * + * if (process.getegid && process.setegid) { + * console.log(`Current gid: ${process.getegid()}`); + * try { + * process.setegid(501); + * console.log(`New gid: ${process.getegid()}`); + * } catch (err) { + * console.log(`Failed to set gid: ${err}`); + * } + * } + * ``` + * + * This function is only available on POSIX platforms (i.e. not Windows or + * Android). + * This feature is not available in `Worker` threads. + * @since v2.0.0 + * @param id A group name or ID + */ + setegid(id: number | string): void; + /** + * The `process.getgroups()` method returns an array with the supplementary group + * IDs. POSIX leaves it unspecified if the effective group ID is included but + * Node.js ensures it always is. + * + * ```js + * import process from 'process'; + * + * if (process.getgroups) { + * console.log(process.getgroups()); // [ 16, 21, 297 ] + * } + * ``` + * + * This function is only available on POSIX platforms (i.e. not Windows or + * Android). + * @since v0.9.4 + */ + getgroups(): number[]; + /** + * The `process.setgroups()` method sets the supplementary group IDs for the + * Node.js process. This is a privileged operation that requires the Node.js + * process to have `root` or the `CAP_SETGID` capability. + * + * The `groups` array can contain numeric group IDs, group names, or both. + * + * ```js + * import process from 'process'; + * + * if (process.getgroups && process.setgroups) { + * try { + * process.setgroups([501]); + * console.log(process.getgroups()); // new groups + * } catch (err) { + * console.log(`Failed to set groups: ${err}`); + * } + * } + * ``` + * + * This function is only available on POSIX platforms (i.e. not Windows or + * Android). + * This feature is not available in `Worker` threads. + * @since v0.9.4 + */ + setgroups(groups: ReadonlyArray): void; + /** + * The `process.setUncaughtExceptionCaptureCallback()` function sets a function + * that will be invoked when an uncaught exception occurs, which will receive the + * exception value itself as its first argument. + * + * If such a function is set, the `'uncaughtException'` event will + * not be emitted. If `--abort-on-uncaught-exception` was passed from the + * command line or set through `v8.setFlagsFromString()`, the process will + * not abort. Actions configured to take place on exceptions such as report + * generations will be affected too + * + * To unset the capture function,`process.setUncaughtExceptionCaptureCallback(null)` may be used. Calling this + * method with a non-`null` argument while another capture function is set will + * throw an error. + * + * Using this function is mutually exclusive with using the deprecated `domain` built-in module. + * @since v9.3.0 + */ + setUncaughtExceptionCaptureCallback(cb: ((err: Error) => void) | null): void; + /** + * Indicates whether a callback has been set using {@link setUncaughtExceptionCaptureCallback}. + * @since v9.3.0 + */ + hasUncaughtExceptionCaptureCallback(): boolean; + /** + * The `process.version` property contains the Node.js version string. + * + * ```js + * import { version } from 'process'; + * + * console.log(`Version: ${version}`); + * // Version: v14.8.0 + * ``` + * + * To get the version string without the prepended _v_, use`process.versions.node`. + * @since v0.1.3 + */ + readonly version: string; + /** + * The `process.versions` property returns an object listing the version strings of + * Node.js and its dependencies. `process.versions.modules` indicates the current + * ABI version, which is increased whenever a C++ API changes. Node.js will refuse + * to load modules that were compiled against a different module ABI version. + * + * ```js + * import { versions } from 'process'; + * + * console.log(versions); + * ``` + * + * Will generate an object similar to: + * + * ```console + * { node: '11.13.0', + * v8: '7.0.276.38-node.18', + * uv: '1.27.0', + * zlib: '1.2.11', + * brotli: '1.0.7', + * ares: '1.15.0', + * modules: '67', + * nghttp2: '1.34.0', + * napi: '4', + * llhttp: '1.1.1', + * openssl: '1.1.1b', + * cldr: '34.0', + * icu: '63.1', + * tz: '2018e', + * unicode: '11.0' } + * ``` + * @since v0.2.0 + */ + readonly versions: ProcessVersions; + /** + * The `process.config` property returns an `Object` containing the JavaScript + * representation of the configure options used to compile the current Node.js + * executable. This is the same as the `config.gypi` file that was produced when + * running the `./configure` script. + * + * An example of the possible output looks like: + * + * ```js + * { + * target_defaults: + * { cflags: [], + * default_configuration: 'Release', + * defines: [], + * include_dirs: [], + * libraries: [] }, + * variables: + * { + * host_arch: 'x64', + * napi_build_version: 5, + * node_install_npm: 'true', + * node_prefix: '', + * node_shared_cares: 'false', + * node_shared_http_parser: 'false', + * node_shared_libuv: 'false', + * node_shared_zlib: 'false', + * node_use_dtrace: 'false', + * node_use_openssl: 'true', + * node_shared_openssl: 'false', + * strict_aliasing: 'true', + * target_arch: 'x64', + * v8_use_snapshot: 1 + * } + * } + * ``` + * + * The `process.config` property is **not** read-only and there are existing + * modules in the ecosystem that are known to extend, modify, or entirely replace + * the value of `process.config`. + * + * Modifying the `process.config` property, or any child-property of the`process.config` object has been deprecated. The `process.config` will be made + * read-only in a future release. + * @since v0.7.7 + */ + readonly config: ProcessConfig; + /** + * The `process.kill()` method sends the `signal` to the process identified by`pid`. + * + * Signal names are strings such as `'SIGINT'` or `'SIGHUP'`. See `Signal Events` and [`kill(2)`](http://man7.org/linux/man-pages/man2/kill.2.html) for more information. + * + * This method will throw an error if the target `pid` does not exist. As a special + * case, a signal of `0` can be used to test for the existence of a process. + * Windows platforms will throw an error if the `pid` is used to kill a process + * group. + * + * Even though the name of this function is `process.kill()`, it is really just a + * signal sender, like the `kill` system call. The signal sent may do something + * other than kill the target process. + * + * ```js + * import process, { kill } from 'process'; + * + * process.on('SIGHUP', () => { + * console.log('Got SIGHUP signal.'); + * }); + * + * setTimeout(() => { + * console.log('Exiting.'); + * process.exit(0); + * }, 100); + * + * kill(process.pid, 'SIGHUP'); + * ``` + * + * When `SIGUSR1` is received by a Node.js process, Node.js will start the + * debugger. See `Signal Events`. + * @since v0.0.6 + * @param pid A process ID + * @param [signal='SIGTERM'] The signal to send, either as a string or number. + */ + kill(pid: number, signal?: string | number): true; + /** + * The `process.pid` property returns the PID of the process. + * + * ```js + * import { pid } from 'process'; + * + * console.log(`This process is pid ${pid}`); + * ``` + * @since v0.1.15 + */ + readonly pid: number; + /** + * The `process.ppid` property returns the PID of the parent of the + * current process. + * + * ```js + * import { ppid } from 'process'; + * + * console.log(`The parent process is pid ${ppid}`); + * ``` + * @since v9.2.0, v8.10.0, v6.13.0 + */ + readonly ppid: number; + /** + * The `process.title` property returns the current process title (i.e. returns + * the current value of `ps`). Assigning a new value to `process.title` modifies + * the current value of `ps`. + * + * When a new value is assigned, different platforms will impose different maximum + * length restrictions on the title. Usually such restrictions are quite limited. + * For instance, on Linux and macOS, `process.title` is limited to the size of the + * binary name plus the length of the command-line arguments because setting the`process.title` overwrites the `argv` memory of the process. Node.js v0.8 + * allowed for longer process title strings by also overwriting the `environ`memory but that was potentially insecure and confusing in some (rather obscure) + * cases. + * + * Assigning a value to `process.title` might not result in an accurate label + * within process manager applications such as macOS Activity Monitor or Windows + * Services Manager. + * @since v0.1.104 + */ + title: string; + /** + * The operating system CPU architecture for which the Node.js binary was compiled. + * Possible values are: `'arm'`, `'arm64'`, `'ia32'`, `'mips'`,`'mipsel'`, `'ppc'`,`'ppc64'`, `'s390'`, `'s390x'`, `'x32'`, and `'x64'`. + * + * ```js + * import { arch } from 'process'; + * + * console.log(`This processor architecture is ${arch}`); + * ``` + * @since v0.5.0 + */ + readonly arch: string; + /** + * The `process.platform` property returns a string identifying the operating + * system platform on which the Node.js process is running. + * + * Currently possible values are: + * + * * `'aix'` + * * `'darwin'` + * * `'freebsd'` + * * `'linux'` + * * `'openbsd'` + * * `'sunos'` + * * `'win32'` + * + * ```js + * import { platform } from 'process'; + * + * console.log(`This platform is ${platform}`); + * ``` + * + * The value `'android'` may also be returned if the Node.js is built on the + * Android operating system. However, Android support in Node.js [is experimental](https://github.com/nodejs/node/blob/HEAD/BUILDING.md#androidandroid-based-devices-eg-firefox-os). + * @since v0.1.16 + */ + readonly platform: Platform; + /** + * The `process.mainModule` property provides an alternative way of retrieving `require.main`. The difference is that if the main module changes at + * runtime, `require.main` may still refer to the original main module in + * modules that were required before the change occurred. Generally, it's + * safe to assume that the two refer to the same module. + * + * As with `require.main`, `process.mainModule` will be `undefined` if there + * is no entry script. + * @since v0.1.17 + * @deprecated Since v14.0.0 - Use `main` instead. + */ + mainModule?: Module | undefined; + memoryUsage: MemoryUsageFn; + /** + * The `process.cpuUsage()` method returns the user and system CPU time usage of + * the current process, in an object with properties `user` and `system`, whose + * values are microsecond values (millionth of a second). These values measure time + * spent in user and system code respectively, and may end up being greater than + * actual elapsed time if multiple CPU cores are performing work for this process. + * + * The result of a previous call to `process.cpuUsage()` can be passed as the + * argument to the function, to get a diff reading. + * + * ```js + * import { cpuUsage } from 'process'; + * + * const startUsage = cpuUsage(); + * // { user: 38579, system: 6986 } + * + * // spin the CPU for 500 milliseconds + * const now = Date.now(); + * while (Date.now() - now < 500); + * + * console.log(cpuUsage(startUsage)); + * // { user: 514883, system: 11226 } + * ``` + * @since v6.1.0 + * @param previousValue A previous return value from calling `process.cpuUsage()` + */ + cpuUsage(previousValue?: CpuUsage): CpuUsage; + /** + * `process.nextTick()` adds `callback` to the "next tick queue". This queue is + * fully drained after the current operation on the JavaScript stack runs to + * completion and before the event loop is allowed to continue. It's possible to + * create an infinite loop if one were to recursively call `process.nextTick()`. + * See the [Event Loop](https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/#process-nexttick) guide for more background. + * + * ```js + * import { nextTick } from 'process'; + * + * console.log('start'); + * nextTick(() => { + * console.log('nextTick callback'); + * }); + * console.log('scheduled'); + * // Output: + * // start + * // scheduled + * // nextTick callback + * ``` + * + * This is important when developing APIs in order to give users the opportunity + * to assign event handlers _after_ an object has been constructed but before any + * I/O has occurred: + * + * ```js + * import { nextTick } from 'process'; + * + * function MyThing(options) { + * this.setupOptions(options); + * + * nextTick(() => { + * this.startDoingStuff(); + * }); + * } + * + * const thing = new MyThing(); + * thing.getReadyForStuff(); + * + * // thing.startDoingStuff() gets called now, not before. + * ``` + * + * It is very important for APIs to be either 100% synchronous or 100% + * asynchronous. Consider this example: + * + * ```js + * // WARNING! DO NOT USE! BAD UNSAFE HAZARD! + * function maybeSync(arg, cb) { + * if (arg) { + * cb(); + * return; + * } + * + * fs.stat('file', cb); + * } + * ``` + * + * This API is hazardous because in the following case: + * + * ```js + * const maybeTrue = Math.random() > 0.5; + * + * maybeSync(maybeTrue, () => { + * foo(); + * }); + * + * bar(); + * ``` + * + * It is not clear whether `foo()` or `bar()` will be called first. + * + * The following approach is much better: + * + * ```js + * import { nextTick } from 'process'; + * + * function definitelyAsync(arg, cb) { + * if (arg) { + * nextTick(cb); + * return; + * } + * + * fs.stat('file', cb); + * } + * ``` + * @since v0.1.26 + * @param args Additional arguments to pass when invoking the `callback` + */ + nextTick(callback: Function, ...args: any[]): void; + /** + * The `process.release` property returns an `Object` containing metadata related + * to the current release, including URLs for the source tarball and headers-only + * tarball. + * + * `process.release` contains the following properties: + * + * ```js + * { + * name: 'node', + * lts: 'Erbium', + * sourceUrl: 'https://nodejs.org/download/release/v12.18.1/node-v12.18.1.tar.gz', + * headersUrl: 'https://nodejs.org/download/release/v12.18.1/node-v12.18.1-headers.tar.gz', + * libUrl: 'https://nodejs.org/download/release/v12.18.1/win-x64/node.lib' + * } + * ``` + * + * In custom builds from non-release versions of the source tree, only the`name` property may be present. The additional properties should not be + * relied upon to exist. + * @since v3.0.0 + */ + readonly release: ProcessRelease; + features: { + inspector: boolean; + debug: boolean; + uv: boolean; + ipv6: boolean; + tls_alpn: boolean; + tls_sni: boolean; + tls_ocsp: boolean; + tls: boolean; + }; + /** + * `process.umask()` returns the Node.js process's file mode creation mask. Child + * processes inherit the mask from the parent process. + * @since v0.1.19 + * @deprecated Calling `process.umask()` with no argument causes the process-wide umask to be written twice. This introduces a race condition between threads, and is a potential * + * security vulnerability. There is no safe, cross-platform alternative API. + */ + umask(): number; + /** + * Can only be set if not in worker thread. + */ + umask(mask: string | number): number; + /** + * The `process.uptime()` method returns the number of seconds the current Node.js + * process has been running. + * + * The return value includes fractions of a second. Use `Math.floor()` to get whole + * seconds. + * @since v0.5.0 + */ + uptime(): number; + hrtime: HRTime; + /** + * If Node.js is spawned with an IPC channel, the `process.send()` method can be + * used to send messages to the parent process. Messages will be received as a `'message'` event on the parent's `ChildProcess` object. + * + * If Node.js was not spawned with an IPC channel, `process.send` will be`undefined`. + * + * The message goes through serialization and parsing. The resulting message might + * not be the same as what is originally sent. + * @since v0.5.9 + * @param options used to parameterize the sending of certain types of handles.`options` supports the following properties: + */ + send?( + message: any, + sendHandle?: any, + options?: { + swallowErrors?: boolean | undefined; + }, + callback?: (error: Error | null) => void + ): boolean; + /** + * If the Node.js process is spawned with an IPC channel (see the `Child Process` and `Cluster` documentation), the `process.disconnect()` method will close the + * IPC channel to the parent process, allowing the child process to exit gracefully + * once there are no other connections keeping it alive. + * + * The effect of calling `process.disconnect()` is the same as calling `ChildProcess.disconnect()` from the parent process. + * + * If the Node.js process was not spawned with an IPC channel,`process.disconnect()` will be `undefined`. + * @since v0.7.2 + */ + disconnect(): void; + /** + * If the Node.js process is spawned with an IPC channel (see the `Child Process` and `Cluster` documentation), the `process.connected` property will return`true` so long as the IPC + * channel is connected and will return `false` after`process.disconnect()` is called. + * + * Once `process.connected` is `false`, it is no longer possible to send messages + * over the IPC channel using `process.send()`. + * @since v0.7.2 + */ + connected: boolean; + /** + * The `process.allowedNodeEnvironmentFlags` property is a special, + * read-only `Set` of flags allowable within the `NODE_OPTIONS` environment variable. + * + * `process.allowedNodeEnvironmentFlags` extends `Set`, but overrides`Set.prototype.has` to recognize several different possible flag + * representations. `process.allowedNodeEnvironmentFlags.has()` will + * return `true` in the following cases: + * + * * Flags may omit leading single (`-`) or double (`--`) dashes; e.g.,`inspect-brk` for `--inspect-brk`, or `r` for `-r`. + * * Flags passed through to V8 (as listed in `--v8-options`) may replace + * one or more _non-leading_ dashes for an underscore, or vice-versa; + * e.g., `--perf_basic_prof`, `--perf-basic-prof`, `--perf_basic-prof`, + * etc. + * * Flags may contain one or more equals (`=`) characters; all + * characters after and including the first equals will be ignored; + * e.g., `--stack-trace-limit=100`. + * * Flags _must_ be allowable within `NODE_OPTIONS`. + * + * When iterating over `process.allowedNodeEnvironmentFlags`, flags will + * appear only _once_; each will begin with one or more dashes. Flags + * passed through to V8 will contain underscores instead of non-leading + * dashes: + * + * ```js + * import { allowedNodeEnvironmentFlags } from 'process'; + * + * allowedNodeEnvironmentFlags.forEach((flag) => { + * // -r + * // --inspect-brk + * // --abort_on_uncaught_exception + * // ... + * }); + * ``` + * + * The methods `add()`, `clear()`, and `delete()` of`process.allowedNodeEnvironmentFlags` do nothing, and will fail + * silently. + * + * If Node.js was compiled _without_ `NODE_OPTIONS` support (shown in {@link config}), `process.allowedNodeEnvironmentFlags` will + * contain what _would have_ been allowable. + * @since v10.10.0 + */ + allowedNodeEnvironmentFlags: ReadonlySet; + /** + * `process.report` is an object whose methods are used to generate diagnostic + * reports for the current process. Additional documentation is available in the `report documentation`. + * @since v11.8.0 + */ + report?: ProcessReport | undefined; + /** + * ```js + * import { resourceUsage } from 'process'; + * + * console.log(resourceUsage()); + * /* + * Will output: + * { + * userCPUTime: 82872, + * systemCPUTime: 4143, + * maxRSS: 33164, + * sharedMemorySize: 0, + * unsharedDataSize: 0, + * unsharedStackSize: 0, + * minorPageFault: 2469, + * majorPageFault: 0, + * swappedOut: 0, + * fsRead: 0, + * fsWrite: 8, + * ipcSent: 0, + * ipcReceived: 0, + * signalsCount: 0, + * voluntaryContextSwitches: 79, + * involuntaryContextSwitches: 1 + * } + * + * ``` + * @since v12.6.0 + * @return the resource usage for the current process. All of these values come from the `uv_getrusage` call which returns a [`uv_rusage_t` struct][uv_rusage_t]. + */ + resourceUsage(): ResourceUsage; + /** + * The `process.traceDeprecation` property indicates whether the`--trace-deprecation` flag is set on the current Node.js process. See the + * documentation for the `'warning' event` and the `emitWarning() method` for more information about this + * flag's behavior. + * @since v0.8.0 + */ + traceDeprecation: boolean; + /* EventEmitter */ + addListener(event: 'beforeExit', listener: BeforeExitListener): this; + addListener(event: 'disconnect', listener: DisconnectListener): this; + addListener(event: 'exit', listener: ExitListener): this; + addListener(event: 'rejectionHandled', listener: RejectionHandledListener): this; + addListener(event: 'uncaughtException', listener: UncaughtExceptionListener): this; + addListener(event: 'uncaughtExceptionMonitor', listener: UncaughtExceptionListener): this; + addListener(event: 'unhandledRejection', listener: UnhandledRejectionListener): this; + addListener(event: 'warning', listener: WarningListener): this; + addListener(event: 'message', listener: MessageListener): this; + addListener(event: Signals, listener: SignalsListener): this; + addListener(event: 'multipleResolves', listener: MultipleResolveListener): this; + addListener(event: 'worker', listener: WorkerListener): this; + emit(event: 'beforeExit', code: number): boolean; + emit(event: 'disconnect'): boolean; + emit(event: 'exit', code: number): boolean; + emit(event: 'rejectionHandled', promise: Promise): boolean; + emit(event: 'uncaughtException', error: Error): boolean; + emit(event: 'uncaughtExceptionMonitor', error: Error): boolean; + emit(event: 'unhandledRejection', reason: unknown, promise: Promise): boolean; + emit(event: 'warning', warning: Error): boolean; + emit(event: 'message', message: unknown, sendHandle: unknown): this; + emit(event: Signals, signal: Signals): boolean; + emit(event: 'multipleResolves', type: MultipleResolveType, promise: Promise, value: unknown): this; + emit(event: 'worker', listener: WorkerListener): this; + on(event: 'beforeExit', listener: BeforeExitListener): this; + on(event: 'disconnect', listener: DisconnectListener): this; + on(event: 'exit', listener: ExitListener): this; + on(event: 'rejectionHandled', listener: RejectionHandledListener): this; + on(event: 'uncaughtException', listener: UncaughtExceptionListener): this; + on(event: 'uncaughtExceptionMonitor', listener: UncaughtExceptionListener): this; + on(event: 'unhandledRejection', listener: UnhandledRejectionListener): this; + on(event: 'warning', listener: WarningListener): this; + on(event: 'message', listener: MessageListener): this; + on(event: Signals, listener: SignalsListener): this; + on(event: 'multipleResolves', listener: MultipleResolveListener): this; + on(event: 'worker', listener: WorkerListener): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'beforeExit', listener: BeforeExitListener): this; + once(event: 'disconnect', listener: DisconnectListener): this; + once(event: 'exit', listener: ExitListener): this; + once(event: 'rejectionHandled', listener: RejectionHandledListener): this; + once(event: 'uncaughtException', listener: UncaughtExceptionListener): this; + once(event: 'uncaughtExceptionMonitor', listener: UncaughtExceptionListener): this; + once(event: 'unhandledRejection', listener: UnhandledRejectionListener): this; + once(event: 'warning', listener: WarningListener): this; + once(event: 'message', listener: MessageListener): this; + once(event: Signals, listener: SignalsListener): this; + once(event: 'multipleResolves', listener: MultipleResolveListener): this; + once(event: 'worker', listener: WorkerListener): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'beforeExit', listener: BeforeExitListener): this; + prependListener(event: 'disconnect', listener: DisconnectListener): this; + prependListener(event: 'exit', listener: ExitListener): this; + prependListener(event: 'rejectionHandled', listener: RejectionHandledListener): this; + prependListener(event: 'uncaughtException', listener: UncaughtExceptionListener): this; + prependListener(event: 'uncaughtExceptionMonitor', listener: UncaughtExceptionListener): this; + prependListener(event: 'unhandledRejection', listener: UnhandledRejectionListener): this; + prependListener(event: 'warning', listener: WarningListener): this; + prependListener(event: 'message', listener: MessageListener): this; + prependListener(event: Signals, listener: SignalsListener): this; + prependListener(event: 'multipleResolves', listener: MultipleResolveListener): this; + prependListener(event: 'worker', listener: WorkerListener): this; + prependOnceListener(event: 'beforeExit', listener: BeforeExitListener): this; + prependOnceListener(event: 'disconnect', listener: DisconnectListener): this; + prependOnceListener(event: 'exit', listener: ExitListener): this; + prependOnceListener(event: 'rejectionHandled', listener: RejectionHandledListener): this; + prependOnceListener(event: 'uncaughtException', listener: UncaughtExceptionListener): this; + prependOnceListener(event: 'uncaughtExceptionMonitor', listener: UncaughtExceptionListener): this; + prependOnceListener(event: 'unhandledRejection', listener: UnhandledRejectionListener): this; + prependOnceListener(event: 'warning', listener: WarningListener): this; + prependOnceListener(event: 'message', listener: MessageListener): this; + prependOnceListener(event: Signals, listener: SignalsListener): this; + prependOnceListener(event: 'multipleResolves', listener: MultipleResolveListener): this; + prependOnceListener(event: 'worker', listener: WorkerListener): this; + listeners(event: 'beforeExit'): BeforeExitListener[]; + listeners(event: 'disconnect'): DisconnectListener[]; + listeners(event: 'exit'): ExitListener[]; + listeners(event: 'rejectionHandled'): RejectionHandledListener[]; + listeners(event: 'uncaughtException'): UncaughtExceptionListener[]; + listeners(event: 'uncaughtExceptionMonitor'): UncaughtExceptionListener[]; + listeners(event: 'unhandledRejection'): UnhandledRejectionListener[]; + listeners(event: 'warning'): WarningListener[]; + listeners(event: 'message'): MessageListener[]; + listeners(event: Signals): SignalsListener[]; + listeners(event: 'multipleResolves'): MultipleResolveListener[]; + listeners(event: 'worker'): WorkerListener[]; + } + } + } + export = process; +} +declare module 'node:process' { + import process = require('process'); + export = process; +} diff --git a/node_modules/@types/node/punycode.d.ts b/node_modules/@types/node/punycode.d.ts new file mode 100755 index 00000000..345af531 --- /dev/null +++ b/node_modules/@types/node/punycode.d.ts @@ -0,0 +1,117 @@ +/** + * **The version of the punycode module bundled in Node.js is being deprecated.**In a future major version of Node.js this module will be removed. Users + * currently depending on the `punycode` module should switch to using the + * userland-provided [Punycode.js](https://github.com/bestiejs/punycode.js) module instead. For punycode-based URL + * encoding, see `url.domainToASCII` or, more generally, the `WHATWG URL API`. + * + * The `punycode` module is a bundled version of the [Punycode.js](https://github.com/bestiejs/punycode.js) module. It + * can be accessed using: + * + * ```js + * const punycode = require('punycode'); + * ``` + * + * [Punycode](https://tools.ietf.org/html/rfc3492) is a character encoding scheme defined by RFC 3492 that is + * primarily intended for use in Internationalized Domain Names. Because host + * names in URLs are limited to ASCII characters only, Domain Names that contain + * non-ASCII characters must be converted into ASCII using the Punycode scheme. + * For instance, the Japanese character that translates into the English word,`'example'` is `'例'`. The Internationalized Domain Name, `'例.com'` (equivalent + * to `'example.com'`) is represented by Punycode as the ASCII string`'xn--fsq.com'`. + * + * The `punycode` module provides a simple implementation of the Punycode standard. + * + * The `punycode` module is a third-party dependency used by Node.js and + * made available to developers as a convenience. Fixes or other modifications to + * the module must be directed to the [Punycode.js](https://github.com/bestiejs/punycode.js) project. + * @deprecated Since v7.0.0 - Deprecated + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/punycode.js) + */ +declare module 'punycode' { + /** + * The `punycode.decode()` method converts a [Punycode](https://tools.ietf.org/html/rfc3492) string of ASCII-only + * characters to the equivalent string of Unicode codepoints. + * + * ```js + * punycode.decode('maana-pta'); // 'mañana' + * punycode.decode('--dqo34k'); // '☃-⌘' + * ``` + * @since v0.5.1 + */ + function decode(string: string): string; + /** + * The `punycode.encode()` method converts a string of Unicode codepoints to a [Punycode](https://tools.ietf.org/html/rfc3492) string of ASCII-only characters. + * + * ```js + * punycode.encode('mañana'); // 'maana-pta' + * punycode.encode('☃-⌘'); // '--dqo34k' + * ``` + * @since v0.5.1 + */ + function encode(string: string): string; + /** + * The `punycode.toUnicode()` method converts a string representing a domain name + * containing [Punycode](https://tools.ietf.org/html/rfc3492) encoded characters into Unicode. Only the [Punycode](https://tools.ietf.org/html/rfc3492) encoded parts of the domain name are be + * converted. + * + * ```js + * // decode domain names + * punycode.toUnicode('xn--maana-pta.com'); // 'mañana.com' + * punycode.toUnicode('xn----dqo34k.com'); // '☃-⌘.com' + * punycode.toUnicode('example.com'); // 'example.com' + * ``` + * @since v0.6.1 + */ + function toUnicode(domain: string): string; + /** + * The `punycode.toASCII()` method converts a Unicode string representing an + * Internationalized Domain Name to [Punycode](https://tools.ietf.org/html/rfc3492). Only the non-ASCII parts of the + * domain name will be converted. Calling `punycode.toASCII()` on a string that + * already only contains ASCII characters will have no effect. + * + * ```js + * // encode domain names + * punycode.toASCII('mañana.com'); // 'xn--maana-pta.com' + * punycode.toASCII('☃-⌘.com'); // 'xn----dqo34k.com' + * punycode.toASCII('example.com'); // 'example.com' + * ``` + * @since v0.6.1 + */ + function toASCII(domain: string): string; + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ + const ucs2: ucs2; + interface ucs2 { + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ + decode(string: string): number[]; + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ + encode(codePoints: ReadonlyArray): string; + } + /** + * @deprecated since v7.0.0 + * The version of the punycode module bundled in Node.js is being deprecated. + * In a future major version of Node.js this module will be removed. + * Users currently depending on the punycode module should switch to using + * the userland-provided Punycode.js module instead. + */ + const version: string; +} +declare module 'node:punycode' { + export * from 'punycode'; +} diff --git a/node_modules/@types/node/querystring.d.ts b/node_modules/@types/node/querystring.d.ts new file mode 100755 index 00000000..892440b7 --- /dev/null +++ b/node_modules/@types/node/querystring.d.ts @@ -0,0 +1,131 @@ +/** + * The `querystring` module provides utilities for parsing and formatting URL + * query strings. It can be accessed using: + * + * ```js + * const querystring = require('querystring'); + * ``` + * + * The `querystring` API is considered Legacy. While it is still maintained, + * new code should use the `URLSearchParams` API instead. + * @deprecated Legacy + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/querystring.js) + */ +declare module 'querystring' { + interface StringifyOptions { + encodeURIComponent?: ((str: string) => string) | undefined; + } + interface ParseOptions { + maxKeys?: number | undefined; + decodeURIComponent?: ((str: string) => string) | undefined; + } + interface ParsedUrlQuery extends NodeJS.Dict {} + interface ParsedUrlQueryInput extends NodeJS.Dict | ReadonlyArray | ReadonlyArray | null> {} + /** + * The `querystring.stringify()` method produces a URL query string from a + * given `obj` by iterating through the object's "own properties". + * + * It serializes the following types of values passed in `obj`:[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) | + * [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) | + * [bigint](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) | + * [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) | + * [string\[\]](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) | + * [number\[\]](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) | + * [bigint\[\]](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) | + * [boolean\[\]](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) The numeric values must be finite. Any other input values will be coerced to + * empty strings. + * + * ```js + * querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' }); + * // Returns 'foo=bar&baz=qux&baz=quux&corge=' + * + * querystring.stringify({ foo: 'bar', baz: 'qux' }, ';', ':'); + * // Returns 'foo:bar;baz:qux' + * ``` + * + * By default, characters requiring percent-encoding within the query string will + * be encoded as UTF-8\. If an alternative encoding is required, then an alternative`encodeURIComponent` option will need to be specified: + * + * ```js + * // Assuming gbkEncodeURIComponent function already exists, + * + * querystring.stringify({ w: '中文', foo: 'bar' }, null, null, + * { encodeURIComponent: gbkEncodeURIComponent }); + * ``` + * @since v0.1.25 + * @param obj The object to serialize into a URL query string + * @param [sep='&'] The substring used to delimit key and value pairs in the query string. + * @param [eq='='] . The substring used to delimit keys and values in the query string. + */ + function stringify(obj?: ParsedUrlQueryInput, sep?: string, eq?: string, options?: StringifyOptions): string; + /** + * The `querystring.parse()` method parses a URL query string (`str`) into a + * collection of key and value pairs. + * + * For example, the query string `'foo=bar&abc=xyz&abc=123'` is parsed into: + * + * ```js + * { + * foo: 'bar', + * abc: ['xyz', '123'] + * } + * ``` + * + * The object returned by the `querystring.parse()` method _does not_prototypically inherit from the JavaScript `Object`. This means that typical`Object` methods such as `obj.toString()`, + * `obj.hasOwnProperty()`, and others + * are not defined and _will not work_. + * + * By default, percent-encoded characters within the query string will be assumed + * to use UTF-8 encoding. If an alternative character encoding is used, then an + * alternative `decodeURIComponent` option will need to be specified: + * + * ```js + * // Assuming gbkDecodeURIComponent function already exists... + * + * querystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null, + * { decodeURIComponent: gbkDecodeURIComponent }); + * ``` + * @since v0.1.25 + * @param str The URL query string to parse + * @param [sep='&'] The substring used to delimit key and value pairs in the query string. + * @param [eq='='] . The substring used to delimit keys and values in the query string. + */ + function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): ParsedUrlQuery; + /** + * The querystring.encode() function is an alias for querystring.stringify(). + */ + const encode: typeof stringify; + /** + * The querystring.decode() function is an alias for querystring.parse(). + */ + const decode: typeof parse; + /** + * The `querystring.escape()` method performs URL percent-encoding on the given`str` in a manner that is optimized for the specific requirements of URL + * query strings. + * + * The `querystring.escape()` method is used by `querystring.stringify()` and is + * generally not expected to be used directly. It is exported primarily to allow + * application code to provide a replacement percent-encoding implementation if + * necessary by assigning `querystring.escape` to an alternative function. + * @since v0.1.25 + */ + function escape(str: string): string; + /** + * The `querystring.unescape()` method performs decoding of URL percent-encoded + * characters on the given `str`. + * + * The `querystring.unescape()` method is used by `querystring.parse()` and is + * generally not expected to be used directly. It is exported primarily to allow + * application code to provide a replacement decoding implementation if + * necessary by assigning `querystring.unescape` to an alternative function. + * + * By default, the `querystring.unescape()` method will attempt to use the + * JavaScript built-in `decodeURIComponent()` method to decode. If that fails, + * a safer equivalent that does not throw on malformed URLs will be used. + * @since v0.1.25 + */ + function unescape(str: string): string; +} +declare module 'node:querystring' { + export * from 'querystring'; +} diff --git a/node_modules/@types/node/readline.d.ts b/node_modules/@types/node/readline.d.ts new file mode 100755 index 00000000..f1545fab --- /dev/null +++ b/node_modules/@types/node/readline.d.ts @@ -0,0 +1,543 @@ +/** + * The `readline` module provides an interface for reading data from a `Readable` stream (such as `process.stdin`) one line at a time. It can be accessed + * using: + * + * ```js + * const readline = require('readline'); + * ``` + * + * The following simple example illustrates the basic use of the `readline` module. + * + * ```js + * const readline = require('readline'); + * + * const rl = readline.createInterface({ + * input: process.stdin, + * output: process.stdout + * }); + * + * rl.question('What do you think of Node.js? ', (answer) => { + * // TODO: Log the answer in a database + * console.log(`Thank you for your valuable feedback: ${answer}`); + * + * rl.close(); + * }); + * ``` + * + * Once this code is invoked, the Node.js application will not terminate until the`readline.Interface` is closed because the interface waits for data to be + * received on the `input` stream. + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/readline.js) + */ +declare module 'readline' { + import { Abortable, EventEmitter } from 'node:events'; + interface Key { + sequence?: string | undefined; + name?: string | undefined; + ctrl?: boolean | undefined; + meta?: boolean | undefined; + shift?: boolean | undefined; + } + /** + * Instances of the `readline.Interface` class are constructed using the`readline.createInterface()` method. Every instance is associated with a + * single `input` `Readable` stream and a single `output` `Writable` stream. + * The `output` stream is used to print prompts for user input that arrives on, + * and is read from, the `input` stream. + * @since v0.1.104 + */ + class Interface extends EventEmitter { + readonly terminal: boolean; + /** + * The current input data being processed by node. + * + * This can be used when collecting input from a TTY stream to retrieve the + * current value that has been processed thus far, prior to the `line` event + * being emitted. Once the `line` event has been emitted, this property will + * be an empty string. + * + * Be aware that modifying the value during the instance runtime may have + * unintended consequences if `rl.cursor` is not also controlled. + * + * **If not using a TTY stream for input, use the `'line'` event.** + * + * One possible use case would be as follows: + * + * ```js + * const values = ['lorem ipsum', 'dolor sit amet']; + * const rl = readline.createInterface(process.stdin); + * const showResults = debounce(() => { + * console.log( + * '\n', + * values.filter((val) => val.startsWith(rl.line)).join(' ') + * ); + * }, 300); + * process.stdin.on('keypress', (c, k) => { + * showResults(); + * }); + * ``` + * @since v0.1.98 + */ + readonly line: string; + /** + * The cursor position relative to `rl.line`. + * + * This will track where the current cursor lands in the input string, when + * reading input from a TTY stream. The position of cursor determines the + * portion of the input string that will be modified as input is processed, + * as well as the column where the terminal caret will be rendered. + * @since v0.1.98 + */ + readonly cursor: number; + /** + * NOTE: According to the documentation: + * + * > Instances of the `readline.Interface` class are constructed using the + * > `readline.createInterface()` method. + * + * @see https://nodejs.org/dist/latest-v10.x/docs/api/readline.html#readline_class_interface + */ + protected constructor(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean); + /** + * NOTE: According to the documentation: + * + * > Instances of the `readline.Interface` class are constructed using the + * > `readline.createInterface()` method. + * + * @see https://nodejs.org/dist/latest-v10.x/docs/api/readline.html#readline_class_interface + */ + protected constructor(options: ReadLineOptions); + /** + * The `rl.getPrompt()` method returns the current prompt used by `rl.prompt()`. + * @since v15.3.0 + * @return the current prompt string + */ + getPrompt(): string; + /** + * The `rl.setPrompt()` method sets the prompt that will be written to `output`whenever `rl.prompt()` is called. + * @since v0.1.98 + */ + setPrompt(prompt: string): void; + /** + * The `rl.prompt()` method writes the `readline.Interface` instances configured`prompt` to a new line in `output` in order to provide a user with a new + * location at which to provide input. + * + * When called, `rl.prompt()` will resume the `input` stream if it has been + * paused. + * + * If the `readline.Interface` was created with `output` set to `null` or`undefined` the prompt is not written. + * @since v0.1.98 + * @param preserveCursor If `true`, prevents the cursor placement from being reset to `0`. + */ + prompt(preserveCursor?: boolean): void; + /** + * The `rl.question()` method displays the `query` by writing it to the `output`, + * waits for user input to be provided on `input`, then invokes the `callback`function passing the provided input as the first argument. + * + * When called, `rl.question()` will resume the `input` stream if it has been + * paused. + * + * If the `readline.Interface` was created with `output` set to `null` or`undefined` the `query` is not written. + * + * The `callback` function passed to `rl.question()` does not follow the typical + * pattern of accepting an `Error` object or `null` as the first argument. + * The `callback` is called with the provided answer as the only argument. + * + * Example usage: + * + * ```js + * rl.question('What is your favorite food? ', (answer) => { + * console.log(`Oh, so your favorite food is ${answer}`); + * }); + * ``` + * + * Using an `AbortController` to cancel a question. + * + * ```js + * const ac = new AbortController(); + * const signal = ac.signal; + * + * rl.question('What is your favorite food? ', { signal }, (answer) => { + * console.log(`Oh, so your favorite food is ${answer}`); + * }); + * + * signal.addEventListener('abort', () => { + * console.log('The food question timed out'); + * }, { once: true }); + * + * setTimeout(() => ac.abort(), 10000); + * ``` + * + * If this method is invoked as it's util.promisify()ed version, it returns a + * Promise that fulfills with the answer. If the question is canceled using + * an `AbortController` it will reject with an `AbortError`. + * + * ```js + * const util = require('util'); + * const question = util.promisify(rl.question).bind(rl); + * + * async function questionExample() { + * try { + * const answer = await question('What is you favorite food? '); + * console.log(`Oh, so your favorite food is ${answer}`); + * } catch (err) { + * console.error('Question rejected', err); + * } + * } + * questionExample(); + * ``` + * @since v0.3.3 + * @param query A statement or query to write to `output`, prepended to the prompt. + * @param callback A callback function that is invoked with the user's input in response to the `query`. + */ + question(query: string, callback: (answer: string) => void): void; + question(query: string, options: Abortable, callback: (answer: string) => void): void; + /** + * The `rl.pause()` method pauses the `input` stream, allowing it to be resumed + * later if necessary. + * + * Calling `rl.pause()` does not immediately pause other events (including`'line'`) from being emitted by the `readline.Interface` instance. + * @since v0.3.4 + */ + pause(): this; + /** + * The `rl.resume()` method resumes the `input` stream if it has been paused. + * @since v0.3.4 + */ + resume(): this; + /** + * The `rl.close()` method closes the `readline.Interface` instance and + * relinquishes control over the `input` and `output` streams. When called, + * the `'close'` event will be emitted. + * + * Calling `rl.close()` does not immediately stop other events (including `'line'`) + * from being emitted by the `readline.Interface` instance. + * @since v0.1.98 + */ + close(): void; + /** + * The `rl.write()` method will write either `data` or a key sequence identified + * by `key` to the `output`. The `key` argument is supported only if `output` is + * a `TTY` text terminal. See `TTY keybindings` for a list of key + * combinations. + * + * If `key` is specified, `data` is ignored. + * + * When called, `rl.write()` will resume the `input` stream if it has been + * paused. + * + * If the `readline.Interface` was created with `output` set to `null` or`undefined` the `data` and `key` are not written. + * + * ```js + * rl.write('Delete this!'); + * // Simulate Ctrl+U to delete the line written previously + * rl.write(null, { ctrl: true, name: 'u' }); + * ``` + * + * The `rl.write()` method will write the data to the `readline` `Interface`'s`input`_as if it were provided by the user_. + * @since v0.1.98 + */ + write(data: string | Buffer, key?: Key): void; + write(data: undefined | null | string | Buffer, key: Key): void; + /** + * Returns the real position of the cursor in relation to the input + * prompt + string. Long input (wrapping) strings, as well as multiple + * line prompts are included in the calculations. + * @since v13.5.0, v12.16.0 + */ + getCursorPos(): CursorPos; + /** + * events.EventEmitter + * 1. close + * 2. line + * 3. pause + * 4. resume + * 5. SIGCONT + * 6. SIGINT + * 7. SIGTSTP + * 8. history + */ + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'close', listener: () => void): this; + addListener(event: 'line', listener: (input: string) => void): this; + addListener(event: 'pause', listener: () => void): this; + addListener(event: 'resume', listener: () => void): this; + addListener(event: 'SIGCONT', listener: () => void): this; + addListener(event: 'SIGINT', listener: () => void): this; + addListener(event: 'SIGTSTP', listener: () => void): this; + addListener(event: 'history', listener: (history: string[]) => void): this; + emit(event: string | symbol, ...args: any[]): boolean; + emit(event: 'close'): boolean; + emit(event: 'line', input: string): boolean; + emit(event: 'pause'): boolean; + emit(event: 'resume'): boolean; + emit(event: 'SIGCONT'): boolean; + emit(event: 'SIGINT'): boolean; + emit(event: 'SIGTSTP'): boolean; + emit(event: 'history', history: string[]): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'close', listener: () => void): this; + on(event: 'line', listener: (input: string) => void): this; + on(event: 'pause', listener: () => void): this; + on(event: 'resume', listener: () => void): this; + on(event: 'SIGCONT', listener: () => void): this; + on(event: 'SIGINT', listener: () => void): this; + on(event: 'SIGTSTP', listener: () => void): this; + on(event: 'history', listener: (history: string[]) => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'line', listener: (input: string) => void): this; + once(event: 'pause', listener: () => void): this; + once(event: 'resume', listener: () => void): this; + once(event: 'SIGCONT', listener: () => void): this; + once(event: 'SIGINT', listener: () => void): this; + once(event: 'SIGTSTP', listener: () => void): this; + once(event: 'history', listener: (history: string[]) => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'line', listener: (input: string) => void): this; + prependListener(event: 'pause', listener: () => void): this; + prependListener(event: 'resume', listener: () => void): this; + prependListener(event: 'SIGCONT', listener: () => void): this; + prependListener(event: 'SIGINT', listener: () => void): this; + prependListener(event: 'SIGTSTP', listener: () => void): this; + prependListener(event: 'history', listener: (history: string[]) => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'line', listener: (input: string) => void): this; + prependOnceListener(event: 'pause', listener: () => void): this; + prependOnceListener(event: 'resume', listener: () => void): this; + prependOnceListener(event: 'SIGCONT', listener: () => void): this; + prependOnceListener(event: 'SIGINT', listener: () => void): this; + prependOnceListener(event: 'SIGTSTP', listener: () => void): this; + prependOnceListener(event: 'history', listener: (history: string[]) => void): this; + [Symbol.asyncIterator](): AsyncIterableIterator; + } + type ReadLine = Interface; // type forwarded for backwards compatibility + type Completer = (line: string) => CompleterResult; + type AsyncCompleter = (line: string, callback: (err?: null | Error, result?: CompleterResult) => void) => void; + type CompleterResult = [string[], string]; + interface ReadLineOptions { + input: NodeJS.ReadableStream; + output?: NodeJS.WritableStream | undefined; + completer?: Completer | AsyncCompleter | undefined; + terminal?: boolean | undefined; + /** + * Initial list of history lines. This option makes sense + * only if `terminal` is set to `true` by the user or by an internal `output` + * check, otherwise the history caching mechanism is not initialized at all. + * @default [] + */ + history?: string[] | undefined; + historySize?: number | undefined; + prompt?: string | undefined; + crlfDelay?: number | undefined; + /** + * If `true`, when a new input line added + * to the history list duplicates an older one, this removes the older line + * from the list. + * @default false + */ + removeHistoryDuplicates?: boolean | undefined; + escapeCodeTimeout?: number | undefined; + tabSize?: number | undefined; + } + /** + * The `readline.createInterface()` method creates a new `readline.Interface`instance. + * + * ```js + * const readline = require('readline'); + * const rl = readline.createInterface({ + * input: process.stdin, + * output: process.stdout + * }); + * ``` + * + * Once the `readline.Interface` instance is created, the most common case is to + * listen for the `'line'` event: + * + * ```js + * rl.on('line', (line) => { + * console.log(`Received: ${line}`); + * }); + * ``` + * + * If `terminal` is `true` for this instance then the `output` stream will get + * the best compatibility if it defines an `output.columns` property and emits + * a `'resize'` event on the `output` if or when the columns ever change + * (`process.stdout` does this automatically when it is a TTY). + * + * When creating a `readline.Interface` using `stdin` as input, the program + * will not terminate until it receives `EOF` (Ctrl+D on + * Linux/macOS, Ctrl+Z followed by Return on + * Windows). + * If you want your application to exit without waiting for user input, you can `unref()` the standard input stream: + * + * ```js + * process.stdin.unref(); + * ``` + * @since v0.1.98 + */ + function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean): Interface; + function createInterface(options: ReadLineOptions): Interface; + /** + * The `readline.emitKeypressEvents()` method causes the given `Readable` stream to begin emitting `'keypress'` events corresponding to received input. + * + * Optionally, `interface` specifies a `readline.Interface` instance for which + * autocompletion is disabled when copy-pasted input is detected. + * + * If the `stream` is a `TTY`, then it must be in raw mode. + * + * This is automatically called by any readline instance on its `input` if the`input` is a terminal. Closing the `readline` instance does not stop + * the `input` from emitting `'keypress'` events. + * + * ```js + * readline.emitKeypressEvents(process.stdin); + * if (process.stdin.isTTY) + * process.stdin.setRawMode(true); + * ``` + * @since v0.7.7 + */ + function emitKeypressEvents(stream: NodeJS.ReadableStream, readlineInterface?: Interface): void; + type Direction = -1 | 0 | 1; + interface CursorPos { + rows: number; + cols: number; + } + /** + * The `readline.clearLine()` method clears current line of given `TTY` stream + * in a specified direction identified by `dir`. + * @since v0.7.7 + * @param callback Invoked once the operation completes. + * @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + */ + function clearLine(stream: NodeJS.WritableStream, dir: Direction, callback?: () => void): boolean; + /** + * The `readline.clearScreenDown()` method clears the given `TTY` stream from + * the current position of the cursor down. + * @since v0.7.7 + * @param callback Invoked once the operation completes. + * @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + */ + function clearScreenDown(stream: NodeJS.WritableStream, callback?: () => void): boolean; + /** + * The `readline.cursorTo()` method moves cursor to the specified position in a + * given `TTY` `stream`. + * @since v0.7.7 + * @param callback Invoked once the operation completes. + * @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + */ + function cursorTo(stream: NodeJS.WritableStream, x: number, y?: number, callback?: () => void): boolean; + /** + * The `readline.moveCursor()` method moves the cursor _relative_ to its current + * position in a given `TTY` `stream`. + * + * ## Example: Tiny CLI + * + * The following example illustrates the use of `readline.Interface` class to + * implement a small command-line interface: + * + * ```js + * const readline = require('readline'); + * const rl = readline.createInterface({ + * input: process.stdin, + * output: process.stdout, + * prompt: 'OHAI> ' + * }); + * + * rl.prompt(); + * + * rl.on('line', (line) => { + * switch (line.trim()) { + * case 'hello': + * console.log('world!'); + * break; + * default: + * console.log(`Say what? I might have heard '${line.trim()}'`); + * break; + * } + * rl.prompt(); + * }).on('close', () => { + * console.log('Have a great day!'); + * process.exit(0); + * }); + * ``` + * + * ## Example: Read file stream line-by-Line + * + * A common use case for `readline` is to consume an input file one line at a + * time. The easiest way to do so is leveraging the `fs.ReadStream` API as + * well as a `for await...of` loop: + * + * ```js + * const fs = require('fs'); + * const readline = require('readline'); + * + * async function processLineByLine() { + * const fileStream = fs.createReadStream('input.txt'); + * + * const rl = readline.createInterface({ + * input: fileStream, + * crlfDelay: Infinity + * }); + * // Note: we use the crlfDelay option to recognize all instances of CR LF + * // ('\r\n') in input.txt as a single line break. + * + * for await (const line of rl) { + * // Each line in input.txt will be successively available here as `line`. + * console.log(`Line from file: ${line}`); + * } + * } + * + * processLineByLine(); + * ``` + * + * Alternatively, one could use the `'line'` event: + * + * ```js + * const fs = require('fs'); + * const readline = require('readline'); + * + * const rl = readline.createInterface({ + * input: fs.createReadStream('sample.txt'), + * crlfDelay: Infinity + * }); + * + * rl.on('line', (line) => { + * console.log(`Line from file: ${line}`); + * }); + * ``` + * + * Currently, `for await...of` loop can be a bit slower. If `async` / `await`flow and speed are both essential, a mixed approach can be applied: + * + * ```js + * const { once } = require('events'); + * const { createReadStream } = require('fs'); + * const { createInterface } = require('readline'); + * + * (async function processLineByLine() { + * try { + * const rl = createInterface({ + * input: createReadStream('big-file.txt'), + * crlfDelay: Infinity + * }); + * + * rl.on('line', (line) => { + * // Process the line. + * }); + * + * await once(rl, 'close'); + * + * console.log('File processed.'); + * } catch (err) { + * console.error(err); + * } + * })(); + * ``` + * @since v0.7.7 + * @param callback Invoked once the operation completes. + * @return `false` if `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + */ + function moveCursor(stream: NodeJS.WritableStream, dx: number, dy: number, callback?: () => void): boolean; +} +declare module 'node:readline' { + export * from 'readline'; +} diff --git a/node_modules/@types/node/repl.d.ts b/node_modules/@types/node/repl.d.ts new file mode 100755 index 00000000..04f64e18 --- /dev/null +++ b/node_modules/@types/node/repl.d.ts @@ -0,0 +1,424 @@ +/** + * The `repl` module provides a Read-Eval-Print-Loop (REPL) implementation that + * is available both as a standalone program or includible in other applications. + * It can be accessed using: + * + * ```js + * const repl = require('repl'); + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/repl.js) + */ +declare module 'repl' { + import { Interface, Completer, AsyncCompleter } from 'node:readline'; + import { Context } from 'node:vm'; + import { InspectOptions } from 'node:util'; + interface ReplOptions { + /** + * The input prompt to display. + * @default "> " + */ + prompt?: string | undefined; + /** + * The `Readable` stream from which REPL input will be read. + * @default process.stdin + */ + input?: NodeJS.ReadableStream | undefined; + /** + * The `Writable` stream to which REPL output will be written. + * @default process.stdout + */ + output?: NodeJS.WritableStream | undefined; + /** + * If `true`, specifies that the output should be treated as a TTY terminal, and have + * ANSI/VT100 escape codes written to it. + * Default: checking the value of the `isTTY` property on the output stream upon + * instantiation. + */ + terminal?: boolean | undefined; + /** + * The function to be used when evaluating each given line of input. + * Default: an async wrapper for the JavaScript `eval()` function. An `eval` function can + * error with `repl.Recoverable` to indicate the input was incomplete and prompt for + * additional lines. + * + * @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_default_evaluation + * @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_custom_evaluation_functions + */ + eval?: REPLEval | undefined; + /** + * Defines if the repl prints output previews or not. + * @default `true` Always `false` in case `terminal` is falsy. + */ + preview?: boolean | undefined; + /** + * If `true`, specifies that the default `writer` function should include ANSI color + * styling to REPL output. If a custom `writer` function is provided then this has no + * effect. + * Default: the REPL instance's `terminal` value. + */ + useColors?: boolean | undefined; + /** + * If `true`, specifies that the default evaluation function will use the JavaScript + * `global` as the context as opposed to creating a new separate context for the REPL + * instance. The node CLI REPL sets this value to `true`. + * Default: `false`. + */ + useGlobal?: boolean | undefined; + /** + * If `true`, specifies that the default writer will not output the return value of a + * command if it evaluates to `undefined`. + * Default: `false`. + */ + ignoreUndefined?: boolean | undefined; + /** + * The function to invoke to format the output of each command before writing to `output`. + * Default: a wrapper for `util.inspect`. + * + * @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_customizing_repl_output + */ + writer?: REPLWriter | undefined; + /** + * An optional function used for custom Tab auto completion. + * + * @see https://nodejs.org/dist/latest-v11.x/docs/api/readline.html#readline_use_of_the_completer_function + */ + completer?: Completer | AsyncCompleter | undefined; + /** + * A flag that specifies whether the default evaluator executes all JavaScript commands in + * strict mode or default (sloppy) mode. + * Accepted values are: + * - `repl.REPL_MODE_SLOPPY` - evaluates expressions in sloppy mode. + * - `repl.REPL_MODE_STRICT` - evaluates expressions in strict mode. This is equivalent to + * prefacing every repl statement with `'use strict'`. + */ + replMode?: typeof REPL_MODE_SLOPPY | typeof REPL_MODE_STRICT | undefined; + /** + * Stop evaluating the current piece of code when `SIGINT` is received, i.e. `Ctrl+C` is + * pressed. This cannot be used together with a custom `eval` function. + * Default: `false`. + */ + breakEvalOnSigint?: boolean | undefined; + } + type REPLEval = (this: REPLServer, evalCmd: string, context: Context, file: string, cb: (err: Error | null, result: any) => void) => void; + type REPLWriter = (this: REPLServer, obj: any) => string; + /** + * This is the default "writer" value, if none is passed in the REPL options, + * and it can be overridden by custom print functions. + */ + const writer: REPLWriter & { + options: InspectOptions; + }; + type REPLCommandAction = (this: REPLServer, text: string) => void; + interface REPLCommand { + /** + * Help text to be displayed when `.help` is entered. + */ + help?: string | undefined; + /** + * The function to execute, optionally accepting a single string argument. + */ + action: REPLCommandAction; + } + /** + * Instances of `repl.REPLServer` are created using the {@link start} method + * or directly using the JavaScript `new` keyword. + * + * ```js + * const repl = require('repl'); + * + * const options = { useColors: true }; + * + * const firstInstance = repl.start(options); + * const secondInstance = new repl.REPLServer(options); + * ``` + * @since v0.1.91 + */ + class REPLServer extends Interface { + /** + * The `vm.Context` provided to the `eval` function to be used for JavaScript + * evaluation. + */ + readonly context: Context; + /** + * @deprecated since v14.3.0 - Use `input` instead. + */ + readonly inputStream: NodeJS.ReadableStream; + /** + * @deprecated since v14.3.0 - Use `output` instead. + */ + readonly outputStream: NodeJS.WritableStream; + /** + * The `Readable` stream from which REPL input will be read. + */ + readonly input: NodeJS.ReadableStream; + /** + * The `Writable` stream to which REPL output will be written. + */ + readonly output: NodeJS.WritableStream; + /** + * The commands registered via `replServer.defineCommand()`. + */ + readonly commands: NodeJS.ReadOnlyDict; + /** + * A value indicating whether the REPL is currently in "editor mode". + * + * @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_commands_and_special_keys + */ + readonly editorMode: boolean; + /** + * A value indicating whether the `_` variable has been assigned. + * + * @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable + */ + readonly underscoreAssigned: boolean; + /** + * The last evaluation result from the REPL (assigned to the `_` variable inside of the REPL). + * + * @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable + */ + readonly last: any; + /** + * A value indicating whether the `_error` variable has been assigned. + * + * @since v9.8.0 + * @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable + */ + readonly underscoreErrAssigned: boolean; + /** + * The last error raised inside the REPL (assigned to the `_error` variable inside of the REPL). + * + * @since v9.8.0 + * @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable + */ + readonly lastError: any; + /** + * Specified in the REPL options, this is the function to be used when evaluating each + * given line of input. If not specified in the REPL options, this is an async wrapper + * for the JavaScript `eval()` function. + */ + readonly eval: REPLEval; + /** + * Specified in the REPL options, this is a value indicating whether the default + * `writer` function should include ANSI color styling to REPL output. + */ + readonly useColors: boolean; + /** + * Specified in the REPL options, this is a value indicating whether the default `eval` + * function will use the JavaScript `global` as the context as opposed to creating a new + * separate context for the REPL instance. + */ + readonly useGlobal: boolean; + /** + * Specified in the REPL options, this is a value indicating whether the default `writer` + * function should output the result of a command if it evaluates to `undefined`. + */ + readonly ignoreUndefined: boolean; + /** + * Specified in the REPL options, this is the function to invoke to format the output of + * each command before writing to `outputStream`. If not specified in the REPL options, + * this will be a wrapper for `util.inspect`. + */ + readonly writer: REPLWriter; + /** + * Specified in the REPL options, this is the function to use for custom Tab auto-completion. + */ + readonly completer: Completer | AsyncCompleter; + /** + * Specified in the REPL options, this is a flag that specifies whether the default `eval` + * function should execute all JavaScript commands in strict mode or default (sloppy) mode. + * Possible values are: + * - `repl.REPL_MODE_SLOPPY` - evaluates expressions in sloppy mode. + * - `repl.REPL_MODE_STRICT` - evaluates expressions in strict mode. This is equivalent to + * prefacing every repl statement with `'use strict'`. + */ + readonly replMode: typeof REPL_MODE_SLOPPY | typeof REPL_MODE_STRICT; + /** + * NOTE: According to the documentation: + * + * > Instances of `repl.REPLServer` are created using the `repl.start()` method and + * > _should not_ be created directly using the JavaScript `new` keyword. + * + * `REPLServer` cannot be subclassed due to implementation specifics in NodeJS. + * + * @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_class_replserver + */ + private constructor(); + /** + * The `replServer.defineCommand()` method is used to add new `.`\-prefixed commands + * to the REPL instance. Such commands are invoked by typing a `.` followed by the`keyword`. The `cmd` is either a `Function` or an `Object` with the following + * properties: + * + * The following example shows two new commands added to the REPL instance: + * + * ```js + * const repl = require('repl'); + * + * const replServer = repl.start({ prompt: '> ' }); + * replServer.defineCommand('sayhello', { + * help: 'Say hello', + * action(name) { + * this.clearBufferedCommand(); + * console.log(`Hello, ${name}!`); + * this.displayPrompt(); + * } + * }); + * replServer.defineCommand('saybye', function saybye() { + * console.log('Goodbye!'); + * this.close(); + * }); + * ``` + * + * The new commands can then be used from within the REPL instance: + * + * ```console + * > .sayhello Node.js User + * Hello, Node.js User! + * > .saybye + * Goodbye! + * ``` + * @since v0.3.0 + * @param keyword The command keyword (*without* a leading `.` character). + * @param cmd The function to invoke when the command is processed. + */ + defineCommand(keyword: string, cmd: REPLCommandAction | REPLCommand): void; + /** + * The `replServer.displayPrompt()` method readies the REPL instance for input + * from the user, printing the configured `prompt` to a new line in the `output`and resuming the `input` to accept new input. + * + * When multi-line input is being entered, an ellipsis is printed rather than the + * 'prompt'. + * + * When `preserveCursor` is `true`, the cursor placement will not be reset to `0`. + * + * The `replServer.displayPrompt` method is primarily intended to be called from + * within the action function for commands registered using the`replServer.defineCommand()` method. + * @since v0.1.91 + */ + displayPrompt(preserveCursor?: boolean): void; + /** + * The `replServer.clearBufferedCommand()` method clears any command that has been + * buffered but not yet executed. This method is primarily intended to be + * called from within the action function for commands registered using the`replServer.defineCommand()` method. + * @since v9.0.0 + */ + clearBufferedCommand(): void; + /** + * Initializes a history log file for the REPL instance. When executing the + * Node.js binary and using the command-line REPL, a history file is initialized + * by default. However, this is not the case when creating a REPL + * programmatically. Use this method to initialize a history log file when working + * with REPL instances programmatically. + * @since v11.10.0 + * @param historyPath the path to the history file + * @param callback called when history writes are ready or upon error + */ + setupHistory(path: string, callback: (err: Error | null, repl: this) => void): void; + /** + * events.EventEmitter + * 1. close - inherited from `readline.Interface` + * 2. line - inherited from `readline.Interface` + * 3. pause - inherited from `readline.Interface` + * 4. resume - inherited from `readline.Interface` + * 5. SIGCONT - inherited from `readline.Interface` + * 6. SIGINT - inherited from `readline.Interface` + * 7. SIGTSTP - inherited from `readline.Interface` + * 8. exit + * 9. reset + */ + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'close', listener: () => void): this; + addListener(event: 'line', listener: (input: string) => void): this; + addListener(event: 'pause', listener: () => void): this; + addListener(event: 'resume', listener: () => void): this; + addListener(event: 'SIGCONT', listener: () => void): this; + addListener(event: 'SIGINT', listener: () => void): this; + addListener(event: 'SIGTSTP', listener: () => void): this; + addListener(event: 'exit', listener: () => void): this; + addListener(event: 'reset', listener: (context: Context) => void): this; + emit(event: string | symbol, ...args: any[]): boolean; + emit(event: 'close'): boolean; + emit(event: 'line', input: string): boolean; + emit(event: 'pause'): boolean; + emit(event: 'resume'): boolean; + emit(event: 'SIGCONT'): boolean; + emit(event: 'SIGINT'): boolean; + emit(event: 'SIGTSTP'): boolean; + emit(event: 'exit'): boolean; + emit(event: 'reset', context: Context): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'close', listener: () => void): this; + on(event: 'line', listener: (input: string) => void): this; + on(event: 'pause', listener: () => void): this; + on(event: 'resume', listener: () => void): this; + on(event: 'SIGCONT', listener: () => void): this; + on(event: 'SIGINT', listener: () => void): this; + on(event: 'SIGTSTP', listener: () => void): this; + on(event: 'exit', listener: () => void): this; + on(event: 'reset', listener: (context: Context) => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'line', listener: (input: string) => void): this; + once(event: 'pause', listener: () => void): this; + once(event: 'resume', listener: () => void): this; + once(event: 'SIGCONT', listener: () => void): this; + once(event: 'SIGINT', listener: () => void): this; + once(event: 'SIGTSTP', listener: () => void): this; + once(event: 'exit', listener: () => void): this; + once(event: 'reset', listener: (context: Context) => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'line', listener: (input: string) => void): this; + prependListener(event: 'pause', listener: () => void): this; + prependListener(event: 'resume', listener: () => void): this; + prependListener(event: 'SIGCONT', listener: () => void): this; + prependListener(event: 'SIGINT', listener: () => void): this; + prependListener(event: 'SIGTSTP', listener: () => void): this; + prependListener(event: 'exit', listener: () => void): this; + prependListener(event: 'reset', listener: (context: Context) => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'line', listener: (input: string) => void): this; + prependOnceListener(event: 'pause', listener: () => void): this; + prependOnceListener(event: 'resume', listener: () => void): this; + prependOnceListener(event: 'SIGCONT', listener: () => void): this; + prependOnceListener(event: 'SIGINT', listener: () => void): this; + prependOnceListener(event: 'SIGTSTP', listener: () => void): this; + prependOnceListener(event: 'exit', listener: () => void): this; + prependOnceListener(event: 'reset', listener: (context: Context) => void): this; + } + /** + * A flag passed in the REPL options. Evaluates expressions in sloppy mode. + */ + const REPL_MODE_SLOPPY: unique symbol; + /** + * A flag passed in the REPL options. Evaluates expressions in strict mode. + * This is equivalent to prefacing every repl statement with `'use strict'`. + */ + const REPL_MODE_STRICT: unique symbol; + /** + * The `repl.start()` method creates and starts a {@link REPLServer} instance. + * + * If `options` is a string, then it specifies the input prompt: + * + * ```js + * const repl = require('repl'); + * + * // a Unix style prompt + * repl.start('$ '); + * ``` + * @since v0.1.91 + */ + function start(options?: string | ReplOptions): REPLServer; + /** + * Indicates a recoverable error that a `REPLServer` can use to support multi-line input. + * + * @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_recoverable_errors + */ + class Recoverable extends SyntaxError { + err: Error; + constructor(err: Error); + } +} +declare module 'node:repl' { + export * from 'repl'; +} diff --git a/node_modules/@types/node/stream.d.ts b/node_modules/@types/node/stream.d.ts new file mode 100755 index 00000000..3927144a --- /dev/null +++ b/node_modules/@types/node/stream.d.ts @@ -0,0 +1,1249 @@ +/** + * A stream is an abstract interface for working with streaming data in Node.js. + * The `stream` module provides an API for implementing the stream interface. + * + * There are many stream objects provided by Node.js. For instance, a `request to an HTTP server` and `process.stdout` are both stream instances. + * + * Streams can be readable, writable, or both. All streams are instances of `EventEmitter`. + * + * To access the `stream` module: + * + * ```js + * const stream = require('stream'); + * ``` + * + * The `stream` module is useful for creating new types of stream instances. It is + * usually not necessary to use the `stream` module to consume streams. + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/stream.js) + */ +declare module 'stream' { + import { EventEmitter, Abortable } from 'node:events'; + import * as streamPromises from 'node:stream/promises'; + import * as streamConsumers from 'node:stream/consumers'; + class internal extends EventEmitter { + pipe( + destination: T, + options?: { + end?: boolean | undefined; + } + ): T; + } + namespace internal { + class Stream extends internal { + constructor(opts?: ReadableOptions); + } + interface StreamOptions extends Abortable { + emitClose?: boolean | undefined; + highWaterMark?: number | undefined; + objectMode?: boolean | undefined; + construct?(this: T, callback: (error?: Error | null) => void): void; + destroy?(this: T, error: Error | null, callback: (error: Error | null) => void): void; + autoDestroy?: boolean | undefined; + } + interface ReadableOptions extends StreamOptions { + encoding?: BufferEncoding | undefined; + read?(this: Readable, size: number): void; + } + /** + * @since v0.9.4 + */ + class Readable extends Stream implements NodeJS.ReadableStream { + /** + * A utility method for creating Readable Streams out of iterators. + */ + static from(iterable: Iterable | AsyncIterable, options?: ReadableOptions): Readable; + /** + * Returns whether the stream has been read from or cancelled. + * @since v16.8.0 + */ + static isDisturbed(stream: Readable | NodeJS.ReadableStream): boolean; + /** + * Returns whether the stream was destroyed or errored before emitting `'end'`. + * @since v16.8.0 + * @experimental + */ + readonly readableAborted: boolean; + /** + * Is `true` if it is safe to call `readable.read()`, which means + * the stream has not been destroyed or emitted `'error'` or `'end'`. + * @since v11.4.0 + */ + readable: boolean; + /** + * Returns whether `'data'` has been emitted. + * @since v16.7.0 + * @experimental + */ + readonly readableDidRead: boolean; + /** + * Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method. + * @since v12.7.0 + */ + readonly readableEncoding: BufferEncoding | null; + /** + * Becomes `true` when `'end'` event is emitted. + * @since v12.9.0 + */ + readonly readableEnded: boolean; + /** + * This property reflects the current state of a `Readable` stream as described + * in the `Three states` section. + * @since v9.4.0 + */ + readonly readableFlowing: boolean | null; + /** + * Returns the value of `highWaterMark` passed when creating this `Readable`. + * @since v9.3.0 + */ + readonly readableHighWaterMark: number; + /** + * This property contains the number of bytes (or objects) in the queue + * ready to be read. The value provides introspection data regarding + * the status of the `highWaterMark`. + * @since v9.4.0 + */ + readonly readableLength: number; + /** + * Getter for the property `objectMode` of a given `Readable` stream. + * @since v12.3.0 + */ + readonly readableObjectMode: boolean; + /** + * Is `true` after `readable.destroy()` has been called. + * @since v8.0.0 + */ + destroyed: boolean; + constructor(opts?: ReadableOptions); + _construct?(callback: (error?: Error | null) => void): void; + _read(size: number): void; + /** + * The `readable.read()` method pulls some data out of the internal buffer and + * returns it. If no data available to be read, `null` is returned. By default, + * the data will be returned as a `Buffer` object unless an encoding has been + * specified using the `readable.setEncoding()` method or the stream is operating + * in object mode. + * + * The optional `size` argument specifies a specific number of bytes to read. If`size` bytes are not available to be read, `null` will be returned _unless_the stream has ended, in which + * case all of the data remaining in the internal + * buffer will be returned. + * + * If the `size` argument is not specified, all of the data contained in the + * internal buffer will be returned. + * + * The `size` argument must be less than or equal to 1 GiB. + * + * The `readable.read()` method should only be called on `Readable` streams + * operating in paused mode. In flowing mode, `readable.read()` is called + * automatically until the internal buffer is fully drained. + * + * ```js + * const readable = getReadableStreamSomehow(); + * + * // 'readable' may be triggered multiple times as data is buffered in + * readable.on('readable', () => { + * let chunk; + * console.log('Stream is readable (new data received in buffer)'); + * // Use a loop to make sure we read all currently available data + * while (null !== (chunk = readable.read())) { + * console.log(`Read ${chunk.length} bytes of data...`); + * } + * }); + * + * // 'end' will be triggered once when there is no more data available + * readable.on('end', () => { + * console.log('Reached end of stream.'); + * }); + * ``` + * + * Each call to `readable.read()` returns a chunk of data, or `null`. The chunks + * are not concatenated. A `while` loop is necessary to consume all data + * currently in the buffer. When reading a large file `.read()` may return `null`, + * having consumed all buffered content so far, but there is still more data to + * come not yet buffered. In this case a new `'readable'` event will be emitted + * when there is more data in the buffer. Finally the `'end'` event will be + * emitted when there is no more data to come. + * + * Therefore to read a file's whole contents from a `readable`, it is necessary + * to collect chunks across multiple `'readable'` events: + * + * ```js + * const chunks = []; + * + * readable.on('readable', () => { + * let chunk; + * while (null !== (chunk = readable.read())) { + * chunks.push(chunk); + * } + * }); + * + * readable.on('end', () => { + * const content = chunks.join(''); + * }); + * ``` + * + * A `Readable` stream in object mode will always return a single item from + * a call to `readable.read(size)`, regardless of the value of the`size` argument. + * + * If the `readable.read()` method returns a chunk of data, a `'data'` event will + * also be emitted. + * + * Calling {@link read} after the `'end'` event has + * been emitted will return `null`. No runtime error will be raised. + * @since v0.9.4 + * @param size Optional argument to specify how much data to read. + */ + read(size?: number): any; + /** + * The `readable.setEncoding()` method sets the character encoding for + * data read from the `Readable` stream. + * + * By default, no encoding is assigned and stream data will be returned as`Buffer` objects. Setting an encoding causes the stream data + * to be returned as strings of the specified encoding rather than as `Buffer`objects. For instance, calling `readable.setEncoding('utf8')` will cause the + * output data to be interpreted as UTF-8 data, and passed as strings. Calling`readable.setEncoding('hex')` will cause the data to be encoded in hexadecimal + * string format. + * + * The `Readable` stream will properly handle multi-byte characters delivered + * through the stream that would otherwise become improperly decoded if simply + * pulled from the stream as `Buffer` objects. + * + * ```js + * const readable = getReadableStreamSomehow(); + * readable.setEncoding('utf8'); + * readable.on('data', (chunk) => { + * assert.equal(typeof chunk, 'string'); + * console.log('Got %d characters of string data:', chunk.length); + * }); + * ``` + * @since v0.9.4 + * @param encoding The encoding to use. + */ + setEncoding(encoding: BufferEncoding): this; + /** + * The `readable.pause()` method will cause a stream in flowing mode to stop + * emitting `'data'` events, switching out of flowing mode. Any data that + * becomes available will remain in the internal buffer. + * + * ```js + * const readable = getReadableStreamSomehow(); + * readable.on('data', (chunk) => { + * console.log(`Received ${chunk.length} bytes of data.`); + * readable.pause(); + * console.log('There will be no additional data for 1 second.'); + * setTimeout(() => { + * console.log('Now data will start flowing again.'); + * readable.resume(); + * }, 1000); + * }); + * ``` + * + * The `readable.pause()` method has no effect if there is a `'readable'`event listener. + * @since v0.9.4 + */ + pause(): this; + /** + * The `readable.resume()` method causes an explicitly paused `Readable` stream to + * resume emitting `'data'` events, switching the stream into flowing mode. + * + * The `readable.resume()` method can be used to fully consume the data from a + * stream without actually processing any of that data: + * + * ```js + * getReadableStreamSomehow() + * .resume() + * .on('end', () => { + * console.log('Reached the end, but did not read anything.'); + * }); + * ``` + * + * The `readable.resume()` method has no effect if there is a `'readable'`event listener. + * @since v0.9.4 + */ + resume(): this; + /** + * The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most + * typical cases, there will be no reason to + * use this method directly. + * + * ```js + * const readable = new stream.Readable(); + * + * readable.isPaused(); // === false + * readable.pause(); + * readable.isPaused(); // === true + * readable.resume(); + * readable.isPaused(); // === false + * ``` + * @since v0.11.14 + */ + isPaused(): boolean; + /** + * The `readable.unpipe()` method detaches a `Writable` stream previously attached + * using the {@link pipe} method. + * + * If the `destination` is not specified, then _all_ pipes are detached. + * + * If the `destination` is specified, but no pipe is set up for it, then + * the method does nothing. + * + * ```js + * const fs = require('fs'); + * const readable = getReadableStreamSomehow(); + * const writable = fs.createWriteStream('file.txt'); + * // All the data from readable goes into 'file.txt', + * // but only for the first second. + * readable.pipe(writable); + * setTimeout(() => { + * console.log('Stop writing to file.txt.'); + * readable.unpipe(writable); + * console.log('Manually close the file stream.'); + * writable.end(); + * }, 1000); + * ``` + * @since v0.9.4 + * @param destination Optional specific stream to unpipe + */ + unpipe(destination?: NodeJS.WritableStream): this; + /** + * Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the + * same as `readable.push(null)`, after which no more data can be written. The EOF + * signal is put at the end of the buffer and any buffered data will still be + * flushed. + * + * The `readable.unshift()` method pushes a chunk of data back into the internal + * buffer. This is useful in certain situations where a stream is being consumed by + * code that needs to "un-consume" some amount of data that it has optimistically + * pulled out of the source, so that the data can be passed on to some other party. + * + * The `stream.unshift(chunk)` method cannot be called after the `'end'` event + * has been emitted or a runtime error will be thrown. + * + * Developers using `stream.unshift()` often should consider switching to + * use of a `Transform` stream instead. See the `API for stream implementers` section for more information. + * + * ```js + * // Pull off a header delimited by \n\n. + * // Use unshift() if we get too much. + * // Call the callback with (error, header, stream). + * const { StringDecoder } = require('string_decoder'); + * function parseHeader(stream, callback) { + * stream.on('error', callback); + * stream.on('readable', onReadable); + * const decoder = new StringDecoder('utf8'); + * let header = ''; + * function onReadable() { + * let chunk; + * while (null !== (chunk = stream.read())) { + * const str = decoder.write(chunk); + * if (str.match(/\n\n/)) { + * // Found the header boundary. + * const split = str.split(/\n\n/); + * header += split.shift(); + * const remaining = split.join('\n\n'); + * const buf = Buffer.from(remaining, 'utf8'); + * stream.removeListener('error', callback); + * // Remove the 'readable' listener before unshifting. + * stream.removeListener('readable', onReadable); + * if (buf.length) + * stream.unshift(buf); + * // Now the body of the message can be read from the stream. + * callback(null, header, stream); + * } else { + * // Still reading the header. + * header += str; + * } + * } + * } + * } + * ``` + * + * Unlike {@link push}, `stream.unshift(chunk)` will not + * end the reading process by resetting the internal reading state of the stream. + * This can cause unexpected results if `readable.unshift()` is called during a + * read (i.e. from within a {@link _read} implementation on a + * custom stream). Following the call to `readable.unshift()` with an immediate {@link push} will reset the reading state appropriately, + * however it is best to simply avoid calling `readable.unshift()` while in the + * process of performing a read. + * @since v0.9.11 + * @param chunk Chunk of data to unshift onto the read queue. For streams not operating in object mode, `chunk` must be a string, `Buffer`, `Uint8Array` or `null`. For object mode + * streams, `chunk` may be any JavaScript value. + * @param encoding Encoding of string chunks. Must be a valid `Buffer` encoding, such as `'utf8'` or `'ascii'`. + */ + unshift(chunk: any, encoding?: BufferEncoding): void; + /** + * Prior to Node.js 0.10, streams did not implement the entire `stream` module API + * as it is currently defined. (See `Compatibility` for more information.) + * + * When using an older Node.js library that emits `'data'` events and has a {@link pause} method that is advisory only, the`readable.wrap()` method can be used to create a `Readable` + * stream that uses + * the old stream as its data source. + * + * It will rarely be necessary to use `readable.wrap()` but the method has been + * provided as a convenience for interacting with older Node.js applications and + * libraries. + * + * ```js + * const { OldReader } = require('./old-api-module.js'); + * const { Readable } = require('stream'); + * const oreader = new OldReader(); + * const myReader = new Readable().wrap(oreader); + * + * myReader.on('readable', () => { + * myReader.read(); // etc. + * }); + * ``` + * @since v0.9.4 + * @param stream An "old style" readable stream + */ + wrap(stream: NodeJS.ReadableStream): this; + push(chunk: any, encoding?: BufferEncoding): boolean; + _destroy(error: Error | null, callback: (error?: Error | null) => void): void; + /** + * Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable + * stream will release any internal resources and subsequent calls to `push()`will be ignored. + * + * Once `destroy()` has been called any further calls will be a no-op and no + * further errors except from `_destroy()` may be emitted as `'error'`. + * + * Implementors should not override this method, but instead implement `readable._destroy()`. + * @since v8.0.0 + * @param error Error which will be passed as payload in `'error'` event + */ + destroy(error?: Error): void; + /** + * Event emitter + * The defined events on documents including: + * 1. close + * 2. data + * 3. end + * 4. error + * 5. pause + * 6. readable + * 7. resume + */ + addListener(event: 'close', listener: () => void): this; + addListener(event: 'data', listener: (chunk: any) => void): this; + addListener(event: 'end', listener: () => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'pause', listener: () => void): this; + addListener(event: 'readable', listener: () => void): this; + addListener(event: 'resume', listener: () => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + emit(event: 'close'): boolean; + emit(event: 'data', chunk: any): boolean; + emit(event: 'end'): boolean; + emit(event: 'error', err: Error): boolean; + emit(event: 'pause'): boolean; + emit(event: 'readable'): boolean; + emit(event: 'resume'): boolean; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'close', listener: () => void): this; + on(event: 'data', listener: (chunk: any) => void): this; + on(event: 'end', listener: () => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'pause', listener: () => void): this; + on(event: 'readable', listener: () => void): this; + on(event: 'resume', listener: () => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'data', listener: (chunk: any) => void): this; + once(event: 'end', listener: () => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'pause', listener: () => void): this; + once(event: 'readable', listener: () => void): this; + once(event: 'resume', listener: () => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'data', listener: (chunk: any) => void): this; + prependListener(event: 'end', listener: () => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'pause', listener: () => void): this; + prependListener(event: 'readable', listener: () => void): this; + prependListener(event: 'resume', listener: () => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'data', listener: (chunk: any) => void): this; + prependOnceListener(event: 'end', listener: () => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'pause', listener: () => void): this; + prependOnceListener(event: 'readable', listener: () => void): this; + prependOnceListener(event: 'resume', listener: () => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + removeListener(event: 'close', listener: () => void): this; + removeListener(event: 'data', listener: (chunk: any) => void): this; + removeListener(event: 'end', listener: () => void): this; + removeListener(event: 'error', listener: (err: Error) => void): this; + removeListener(event: 'pause', listener: () => void): this; + removeListener(event: 'readable', listener: () => void): this; + removeListener(event: 'resume', listener: () => void): this; + removeListener(event: string | symbol, listener: (...args: any[]) => void): this; + [Symbol.asyncIterator](): AsyncIterableIterator; + } + interface WritableOptions extends StreamOptions { + decodeStrings?: boolean | undefined; + defaultEncoding?: BufferEncoding | undefined; + write?(this: Writable, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + writev?( + this: Writable, + chunks: Array<{ + chunk: any; + encoding: BufferEncoding; + }>, + callback: (error?: Error | null) => void + ): void; + final?(this: Writable, callback: (error?: Error | null) => void): void; + } + /** + * @since v0.9.4 + */ + class Writable extends Stream implements NodeJS.WritableStream { + /** + * Is `true` if it is safe to call `writable.write()`, which means + * the stream has not been destroyed, errored or ended. + * @since v11.4.0 + */ + readonly writable: boolean; + /** + * Is `true` after `writable.end()` has been called. This property + * does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead. + * @since v12.9.0 + */ + readonly writableEnded: boolean; + /** + * Is set to `true` immediately before the `'finish'` event is emitted. + * @since v12.6.0 + */ + readonly writableFinished: boolean; + /** + * Return the value of `highWaterMark` passed when creating this `Writable`. + * @since v9.3.0 + */ + readonly writableHighWaterMark: number; + /** + * This property contains the number of bytes (or objects) in the queue + * ready to be written. The value provides introspection data regarding + * the status of the `highWaterMark`. + * @since v9.4.0 + */ + readonly writableLength: number; + /** + * Getter for the property `objectMode` of a given `Writable` stream. + * @since v12.3.0 + */ + readonly writableObjectMode: boolean; + /** + * Number of times `writable.uncork()` needs to be + * called in order to fully uncork the stream. + * @since v13.2.0, v12.16.0 + */ + readonly writableCorked: number; + /** + * Is `true` after `writable.destroy()` has been called. + * @since v8.0.0 + */ + destroyed: boolean; + constructor(opts?: WritableOptions); + _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + _writev?( + chunks: Array<{ + chunk: any; + encoding: BufferEncoding; + }>, + callback: (error?: Error | null) => void + ): void; + _construct?(callback: (error?: Error | null) => void): void; + _destroy(error: Error | null, callback: (error?: Error | null) => void): void; + _final(callback: (error?: Error | null) => void): void; + /** + * The `writable.write()` method writes some data to the stream, and calls the + * supplied `callback` once the data has been fully handled. If an error + * occurs, the `callback` will be called with the error as its + * first argument. The `callback` is called asynchronously and before `'error'` is + * emitted. + * + * The return value is `true` if the internal buffer is less than the`highWaterMark` configured when the stream was created after admitting `chunk`. + * If `false` is returned, further attempts to write data to the stream should + * stop until the `'drain'` event is emitted. + * + * While a stream is not draining, calls to `write()` will buffer `chunk`, and + * return false. Once all currently buffered chunks are drained (accepted for + * delivery by the operating system), the `'drain'` event will be emitted. + * It is recommended that once `write()` returns false, no more chunks be written + * until the `'drain'` event is emitted. While calling `write()` on a stream that + * is not draining is allowed, Node.js will buffer all written chunks until + * maximum memory usage occurs, at which point it will abort unconditionally. + * Even before it aborts, high memory usage will cause poor garbage collector + * performance and high RSS (which is not typically released back to the system, + * even after the memory is no longer required). Since TCP sockets may never + * drain if the remote peer does not read the data, writing a socket that is + * not draining may lead to a remotely exploitable vulnerability. + * + * Writing data while the stream is not draining is particularly + * problematic for a `Transform`, because the `Transform` streams are paused + * by default until they are piped or a `'data'` or `'readable'` event handler + * is added. + * + * If the data to be written can be generated or fetched on demand, it is + * recommended to encapsulate the logic into a `Readable` and use {@link pipe}. However, if calling `write()` is preferred, it is + * possible to respect backpressure and avoid memory issues using the `'drain'` event: + * + * ```js + * function write(data, cb) { + * if (!stream.write(data)) { + * stream.once('drain', cb); + * } else { + * process.nextTick(cb); + * } + * } + * + * // Wait for cb to be called before doing any other write. + * write('hello', () => { + * console.log('Write completed, do more writes now.'); + * }); + * ``` + * + * A `Writable` stream in object mode will always ignore the `encoding` argument. + * @since v0.9.4 + * @param chunk Optional data to write. For streams not operating in object mode, `chunk` must be a string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be any + * JavaScript value other than `null`. + * @param [encoding='utf8'] The encoding, if `chunk` is a string. + * @param callback Callback for when this chunk of data is flushed. + * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + */ + write(chunk: any, callback?: (error: Error | null | undefined) => void): boolean; + write(chunk: any, encoding: BufferEncoding, callback?: (error: Error | null | undefined) => void): boolean; + /** + * The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream. + * @since v0.11.15 + * @param encoding The new default encoding + */ + setDefaultEncoding(encoding: BufferEncoding): this; + /** + * Calling the `writable.end()` method signals that no more data will be written + * to the `Writable`. The optional `chunk` and `encoding` arguments allow one + * final additional chunk of data to be written immediately before closing the + * stream. + * + * Calling the {@link write} method after calling {@link end} will raise an error. + * + * ```js + * // Write 'hello, ' and then end with 'world!'. + * const fs = require('fs'); + * const file = fs.createWriteStream('example.txt'); + * file.write('hello, '); + * file.end('world!'); + * // Writing more now is not allowed! + * ``` + * @since v0.9.4 + * @param chunk Optional data to write. For streams not operating in object mode, `chunk` must be a string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be any + * JavaScript value other than `null`. + * @param encoding The encoding if `chunk` is a string + * @param callback Callback for when the stream is finished. + */ + end(cb?: () => void): void; + end(chunk: any, cb?: () => void): void; + end(chunk: any, encoding: BufferEncoding, cb?: () => void): void; + /** + * The `writable.cork()` method forces all written data to be buffered in memory. + * The buffered data will be flushed when either the {@link uncork} or {@link end} methods are called. + * + * The primary intent of `writable.cork()` is to accommodate a situation in which + * several small chunks are written to the stream in rapid succession. Instead of + * immediately forwarding them to the underlying destination, `writable.cork()`buffers all the chunks until `writable.uncork()` is called, which will pass them + * all to `writable._writev()`, if present. This prevents a head-of-line blocking + * situation where data is being buffered while waiting for the first small chunk + * to be processed. However, use of `writable.cork()` without implementing`writable._writev()` may have an adverse effect on throughput. + * + * See also: `writable.uncork()`, `writable._writev()`. + * @since v0.11.2 + */ + cork(): void; + /** + * The `writable.uncork()` method flushes all data buffered since {@link cork} was called. + * + * When using `writable.cork()` and `writable.uncork()` to manage the buffering + * of writes to a stream, it is recommended that calls to `writable.uncork()` be + * deferred using `process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event loop phase. + * + * ```js + * stream.cork(); + * stream.write('some '); + * stream.write('data '); + * process.nextTick(() => stream.uncork()); + * ``` + * + * If the `writable.cork()` method is called multiple times on a stream, the + * same number of calls to `writable.uncork()` must be called to flush the buffered + * data. + * + * ```js + * stream.cork(); + * stream.write('some '); + * stream.cork(); + * stream.write('data '); + * process.nextTick(() => { + * stream.uncork(); + * // The data will not be flushed until uncork() is called a second time. + * stream.uncork(); + * }); + * ``` + * + * See also: `writable.cork()`. + * @since v0.11.2 + */ + uncork(): void; + /** + * Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the writable + * stream has ended and subsequent calls to `write()` or `end()` will result in + * an `ERR_STREAM_DESTROYED` error. + * This is a destructive and immediate way to destroy a stream. Previous calls to`write()` may not have drained, and may trigger an `ERR_STREAM_DESTROYED` error. + * Use `end()` instead of destroy if data should flush before close, or wait for + * the `'drain'` event before destroying the stream. + * + * Once `destroy()` has been called any further calls will be a no-op and no + * further errors except from `_destroy()` may be emitted as `'error'`. + * + * Implementors should not override this method, + * but instead implement `writable._destroy()`. + * @since v8.0.0 + * @param error Optional, an error to emit with `'error'` event. + */ + destroy(error?: Error): void; + /** + * Event emitter + * The defined events on documents including: + * 1. close + * 2. drain + * 3. error + * 4. finish + * 5. pipe + * 6. unpipe + */ + addListener(event: 'close', listener: () => void): this; + addListener(event: 'drain', listener: () => void): this; + addListener(event: 'error', listener: (err: Error) => void): this; + addListener(event: 'finish', listener: () => void): this; + addListener(event: 'pipe', listener: (src: Readable) => void): this; + addListener(event: 'unpipe', listener: (src: Readable) => void): this; + addListener(event: string | symbol, listener: (...args: any[]) => void): this; + emit(event: 'close'): boolean; + emit(event: 'drain'): boolean; + emit(event: 'error', err: Error): boolean; + emit(event: 'finish'): boolean; + emit(event: 'pipe', src: Readable): boolean; + emit(event: 'unpipe', src: Readable): boolean; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'close', listener: () => void): this; + on(event: 'drain', listener: () => void): this; + on(event: 'error', listener: (err: Error) => void): this; + on(event: 'finish', listener: () => void): this; + on(event: 'pipe', listener: (src: Readable) => void): this; + on(event: 'unpipe', listener: (src: Readable) => void): this; + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: 'close', listener: () => void): this; + once(event: 'drain', listener: () => void): this; + once(event: 'error', listener: (err: Error) => void): this; + once(event: 'finish', listener: () => void): this; + once(event: 'pipe', listener: (src: Readable) => void): this; + once(event: 'unpipe', listener: (src: Readable) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; + prependListener(event: 'close', listener: () => void): this; + prependListener(event: 'drain', listener: () => void): this; + prependListener(event: 'error', listener: (err: Error) => void): this; + prependListener(event: 'finish', listener: () => void): this; + prependListener(event: 'pipe', listener: (src: Readable) => void): this; + prependListener(event: 'unpipe', listener: (src: Readable) => void): this; + prependListener(event: string | symbol, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'close', listener: () => void): this; + prependOnceListener(event: 'drain', listener: () => void): this; + prependOnceListener(event: 'error', listener: (err: Error) => void): this; + prependOnceListener(event: 'finish', listener: () => void): this; + prependOnceListener(event: 'pipe', listener: (src: Readable) => void): this; + prependOnceListener(event: 'unpipe', listener: (src: Readable) => void): this; + prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; + removeListener(event: 'close', listener: () => void): this; + removeListener(event: 'drain', listener: () => void): this; + removeListener(event: 'error', listener: (err: Error) => void): this; + removeListener(event: 'finish', listener: () => void): this; + removeListener(event: 'pipe', listener: (src: Readable) => void): this; + removeListener(event: 'unpipe', listener: (src: Readable) => void): this; + removeListener(event: string | symbol, listener: (...args: any[]) => void): this; + } + interface DuplexOptions extends ReadableOptions, WritableOptions { + allowHalfOpen?: boolean | undefined; + readableObjectMode?: boolean | undefined; + writableObjectMode?: boolean | undefined; + readableHighWaterMark?: number | undefined; + writableHighWaterMark?: number | undefined; + writableCorked?: number | undefined; + construct?(this: Duplex, callback: (error?: Error | null) => void): void; + read?(this: Duplex, size: number): void; + write?(this: Duplex, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + writev?( + this: Duplex, + chunks: Array<{ + chunk: any; + encoding: BufferEncoding; + }>, + callback: (error?: Error | null) => void + ): void; + final?(this: Duplex, callback: (error?: Error | null) => void): void; + destroy?(this: Duplex, error: Error | null, callback: (error: Error | null) => void): void; + } + /** + * Duplex streams are streams that implement both the `Readable` and `Writable` interfaces. + * + * Examples of `Duplex` streams include: + * + * * `TCP sockets` + * * `zlib streams` + * * `crypto streams` + * @since v0.9.4 + */ + class Duplex extends Readable implements Writable { + readonly writable: boolean; + readonly writableEnded: boolean; + readonly writableFinished: boolean; + readonly writableHighWaterMark: number; + readonly writableLength: number; + readonly writableObjectMode: boolean; + readonly writableCorked: number; + /** + * If `false` then the stream will automatically end the writable side when the + * readable side ends. Set initially by the `allowHalfOpen` constructor option, + * which defaults to `false`. + * + * This can be changed manually to change the half-open behavior of an existing`Duplex` stream instance, but must be changed before the `'end'` event is + * emitted. + * @since v0.9.4 + */ + allowHalfOpen: boolean; + constructor(opts?: DuplexOptions); + /** + * A utility method for creating duplex streams. + * + * - `Stream` converts writable stream into writable `Duplex` and readable stream + * to `Duplex`. + * - `Blob` converts into readable `Duplex`. + * - `string` converts into readable `Duplex`. + * - `ArrayBuffer` converts into readable `Duplex`. + * - `AsyncIterable` converts into a readable `Duplex`. Cannot yield `null`. + * - `AsyncGeneratorFunction` converts into a readable/writable transform + * `Duplex`. Must take a source `AsyncIterable` as first parameter. Cannot yield + * `null`. + * - `AsyncFunction` converts into a writable `Duplex`. Must return + * either `null` or `undefined` + * - `Object ({ writable, readable })` converts `readable` and + * `writable` into `Stream` and then combines them into `Duplex` where the + * `Duplex` will write to the `writable` and read from the `readable`. + * - `Promise` converts into readable `Duplex`. Value `null` is ignored. + * + * @since v16.8.0 + */ + static from(src: Stream | Blob | ArrayBuffer | string | Iterable | AsyncIterable | AsyncGeneratorFunction | Promise | Object): Duplex; + _write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + _writev?( + chunks: Array<{ + chunk: any; + encoding: BufferEncoding; + }>, + callback: (error?: Error | null) => void + ): void; + _destroy(error: Error | null, callback: (error: Error | null) => void): void; + _final(callback: (error?: Error | null) => void): void; + write(chunk: any, encoding?: BufferEncoding, cb?: (error: Error | null | undefined) => void): boolean; + write(chunk: any, cb?: (error: Error | null | undefined) => void): boolean; + setDefaultEncoding(encoding: BufferEncoding): this; + end(cb?: () => void): void; + end(chunk: any, cb?: () => void): void; + end(chunk: any, encoding?: BufferEncoding, cb?: () => void): void; + cork(): void; + uncork(): void; + } + type TransformCallback = (error?: Error | null, data?: any) => void; + interface TransformOptions extends DuplexOptions { + construct?(this: Transform, callback: (error?: Error | null) => void): void; + read?(this: Transform, size: number): void; + write?(this: Transform, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; + writev?( + this: Transform, + chunks: Array<{ + chunk: any; + encoding: BufferEncoding; + }>, + callback: (error?: Error | null) => void + ): void; + final?(this: Transform, callback: (error?: Error | null) => void): void; + destroy?(this: Transform, error: Error | null, callback: (error: Error | null) => void): void; + transform?(this: Transform, chunk: any, encoding: BufferEncoding, callback: TransformCallback): void; + flush?(this: Transform, callback: TransformCallback): void; + } + /** + * Transform streams are `Duplex` streams where the output is in some way + * related to the input. Like all `Duplex` streams, `Transform` streams + * implement both the `Readable` and `Writable` interfaces. + * + * Examples of `Transform` streams include: + * + * * `zlib streams` + * * `crypto streams` + * @since v0.9.4 + */ + class Transform extends Duplex { + constructor(opts?: TransformOptions); + _transform(chunk: any, encoding: BufferEncoding, callback: TransformCallback): void; + _flush(callback: TransformCallback): void; + } + /** + * The `stream.PassThrough` class is a trivial implementation of a `Transform` stream that simply passes the input bytes across to the output. Its purpose is + * primarily for examples and testing, but there are some use cases where`stream.PassThrough` is useful as a building block for novel sorts of streams. + */ + class PassThrough extends Transform {} + /** + * Attaches an AbortSignal to a readable or writeable stream. This lets code + * control stream destruction using an `AbortController`. + * + * Calling `abort` on the `AbortController` corresponding to the passed`AbortSignal` will behave the same way as calling `.destroy(new AbortError())`on the stream. + * + * ```js + * const fs = require('fs'); + * + * const controller = new AbortController(); + * const read = addAbortSignal( + * controller.signal, + * fs.createReadStream(('object.json')) + * ); + * // Later, abort the operation closing the stream + * controller.abort(); + * ``` + * + * Or using an `AbortSignal` with a readable stream as an async iterable: + * + * ```js + * const controller = new AbortController(); + * setTimeout(() => controller.abort(), 10_000); // set a timeout + * const stream = addAbortSignal( + * controller.signal, + * fs.createReadStream(('object.json')) + * ); + * (async () => { + * try { + * for await (const chunk of stream) { + * await process(chunk); + * } + * } catch (e) { + * if (e.name === 'AbortError') { + * // The operation was cancelled + * } else { + * throw e; + * } + * } + * })(); + * ``` + * @since v15.4.0 + * @param signal A signal representing possible cancellation + * @param stream a stream to attach a signal to + */ + function addAbortSignal(signal: AbortSignal, stream: T): T; + interface FinishedOptions extends Abortable { + error?: boolean | undefined; + readable?: boolean | undefined; + writable?: boolean | undefined; + } + /** + * A function to get notified when a stream is no longer readable, writable + * or has experienced an error or a premature close event. + * + * ```js + * const { finished } = require('stream'); + * + * const rs = fs.createReadStream('archive.tar'); + * + * finished(rs, (err) => { + * if (err) { + * console.error('Stream failed.', err); + * } else { + * console.log('Stream is done reading.'); + * } + * }); + * + * rs.resume(); // Drain the stream. + * ``` + * + * Especially useful in error handling scenarios where a stream is destroyed + * prematurely (like an aborted HTTP request), and will not emit `'end'`or `'finish'`. + * + * The `finished` API provides promise version: + * + * ```js + * const { finished } = require('stream/promises'); + * + * const rs = fs.createReadStream('archive.tar'); + * + * async function run() { + * await finished(rs); + * console.log('Stream is done reading.'); + * } + * + * run().catch(console.error); + * rs.resume(); // Drain the stream. + * ``` + * + * `stream.finished()` leaves dangling event listeners (in particular`'error'`, `'end'`, `'finish'` and `'close'`) after `callback` has been + * invoked. The reason for this is so that unexpected `'error'` events (due to + * incorrect stream implementations) do not cause unexpected crashes. + * If this is unwanted behavior then the returned cleanup function needs to be + * invoked in the callback: + * + * ```js + * const cleanup = finished(rs, (err) => { + * cleanup(); + * // ... + * }); + * ``` + * @since v10.0.0 + * @param stream A readable and/or writable stream. + * @param callback A callback function that takes an optional error argument. + * @return A cleanup function which removes all registered listeners. + */ + function finished(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, options: FinishedOptions, callback: (err?: NodeJS.ErrnoException | null) => void): () => void; + function finished(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, callback: (err?: NodeJS.ErrnoException | null) => void): () => void; + namespace finished { + function __promisify__(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, options?: FinishedOptions): Promise; + } + type PipelineSourceFunction = () => Iterable | AsyncIterable; + type PipelineSource = Iterable | AsyncIterable | NodeJS.ReadableStream | PipelineSourceFunction; + type PipelineTransform, U> = + | NodeJS.ReadWriteStream + | ((source: S extends (...args: any[]) => Iterable | AsyncIterable ? AsyncIterable : S) => AsyncIterable); + type PipelineTransformSource = PipelineSource | PipelineTransform; + type PipelineDestinationIterableFunction = (source: AsyncIterable) => AsyncIterable; + type PipelineDestinationPromiseFunction = (source: AsyncIterable) => Promise

; + type PipelineDestination, P> = S extends PipelineTransformSource + ? NodeJS.WritableStream | PipelineDestinationIterableFunction | PipelineDestinationPromiseFunction + : never; + type PipelineCallback> = S extends PipelineDestinationPromiseFunction + ? (err: NodeJS.ErrnoException | null, value: P) => void + : (err: NodeJS.ErrnoException | null) => void; + type PipelinePromise> = S extends PipelineDestinationPromiseFunction ? Promise

: Promise; + interface PipelineOptions { + signal: AbortSignal; + } + /** + * A module method to pipe between streams and generators forwarding errors and + * properly cleaning up and provide a callback when the pipeline is complete. + * + * ```js + * const { pipeline } = require('stream'); + * const fs = require('fs'); + * const zlib = require('zlib'); + * + * // Use the pipeline API to easily pipe a series of streams + * // together and get notified when the pipeline is fully done. + * + * // A pipeline to gzip a potentially huge tar file efficiently: + * + * pipeline( + * fs.createReadStream('archive.tar'), + * zlib.createGzip(), + * fs.createWriteStream('archive.tar.gz'), + * (err) => { + * if (err) { + * console.error('Pipeline failed.', err); + * } else { + * console.log('Pipeline succeeded.'); + * } + * } + * ); + * ``` + * + * The `pipeline` API provides a promise version, which can also + * receive an options argument as the last parameter with a`signal` `AbortSignal` property. When the signal is aborted,`destroy` will be called on the underlying pipeline, with + * an`AbortError`. + * + * ```js + * const { pipeline } = require('stream/promises'); + * + * async function run() { + * await pipeline( + * fs.createReadStream('archive.tar'), + * zlib.createGzip(), + * fs.createWriteStream('archive.tar.gz') + * ); + * console.log('Pipeline succeeded.'); + * } + * + * run().catch(console.error); + * ``` + * + * To use an `AbortSignal`, pass it inside an options object, + * as the last argument: + * + * ```js + * const { pipeline } = require('stream/promises'); + * + * async function run() { + * const ac = new AbortController(); + * const signal = ac.signal; + * + * setTimeout(() => ac.abort(), 1); + * await pipeline( + * fs.createReadStream('archive.tar'), + * zlib.createGzip(), + * fs.createWriteStream('archive.tar.gz'), + * { signal }, + * ); + * } + * + * run().catch(console.error); // AbortError + * ``` + * + * The `pipeline` API also supports async generators: + * + * ```js + * const { pipeline } = require('stream/promises'); + * const fs = require('fs'); + * + * async function run() { + * await pipeline( + * fs.createReadStream('lowercase.txt'), + * async function* (source, signal) { + * source.setEncoding('utf8'); // Work with strings rather than `Buffer`s. + * for await (const chunk of source) { + * yield await processChunk(chunk, { signal }); + * } + * }, + * fs.createWriteStream('uppercase.txt') + * ); + * console.log('Pipeline succeeded.'); + * } + * + * run().catch(console.error); + * ``` + * + * Remember to handle the `signal` argument passed into the async generator. + * Especially in the case where the async generator is the source for the + * pipeline (i.e. first argument) or the pipeline will never complete. + * + * ```js + * const { pipeline } = require('stream/promises'); + * const fs = require('fs'); + * + * async function run() { + * await pipeline( + * async function * (signal) { + * await someLongRunningfn({ signal }); + * yield 'asd'; + * }, + * fs.createWriteStream('uppercase.txt') + * ); + * console.log('Pipeline succeeded.'); + * } + * + * run().catch(console.error); + * ``` + * + * `stream.pipeline()` will call `stream.destroy(err)` on all streams except: + * + * * `Readable` streams which have emitted `'end'` or `'close'`. + * * `Writable` streams which have emitted `'finish'` or `'close'`. + * + * `stream.pipeline()` leaves dangling event listeners on the streams + * after the `callback` has been invoked. In the case of reuse of streams after + * failure, this can cause event listener leaks and swallowed errors. + * @since v10.0.0 + * @param callback Called when the pipeline is fully done. + */ + function pipeline, B extends PipelineDestination>( + source: A, + destination: B, + callback?: PipelineCallback + ): B extends NodeJS.WritableStream ? B : NodeJS.WritableStream; + function pipeline, T1 extends PipelineTransform, B extends PipelineDestination>( + source: A, + transform1: T1, + destination: B, + callback?: PipelineCallback + ): B extends NodeJS.WritableStream ? B : NodeJS.WritableStream; + function pipeline, T1 extends PipelineTransform, T2 extends PipelineTransform, B extends PipelineDestination>( + source: A, + transform1: T1, + transform2: T2, + destination: B, + callback?: PipelineCallback + ): B extends NodeJS.WritableStream ? B : NodeJS.WritableStream; + function pipeline< + A extends PipelineSource, + T1 extends PipelineTransform, + T2 extends PipelineTransform, + T3 extends PipelineTransform, + B extends PipelineDestination + >(source: A, transform1: T1, transform2: T2, transform3: T3, destination: B, callback?: PipelineCallback): B extends NodeJS.WritableStream ? B : NodeJS.WritableStream; + function pipeline< + A extends PipelineSource, + T1 extends PipelineTransform, + T2 extends PipelineTransform, + T3 extends PipelineTransform, + T4 extends PipelineTransform, + B extends PipelineDestination + >(source: A, transform1: T1, transform2: T2, transform3: T3, transform4: T4, destination: B, callback?: PipelineCallback): B extends NodeJS.WritableStream ? B : NodeJS.WritableStream; + function pipeline( + streams: ReadonlyArray, + callback?: (err: NodeJS.ErrnoException | null) => void + ): NodeJS.WritableStream; + function pipeline( + stream1: NodeJS.ReadableStream, + stream2: NodeJS.ReadWriteStream | NodeJS.WritableStream, + ...streams: Array void)> + ): NodeJS.WritableStream; + namespace pipeline { + function __promisify__, B extends PipelineDestination>(source: A, destination: B, options?: PipelineOptions): PipelinePromise; + function __promisify__, T1 extends PipelineTransform, B extends PipelineDestination>( + source: A, + transform1: T1, + destination: B, + options?: PipelineOptions + ): PipelinePromise; + function __promisify__, T1 extends PipelineTransform, T2 extends PipelineTransform, B extends PipelineDestination>( + source: A, + transform1: T1, + transform2: T2, + destination: B, + options?: PipelineOptions + ): PipelinePromise; + function __promisify__< + A extends PipelineSource, + T1 extends PipelineTransform, + T2 extends PipelineTransform, + T3 extends PipelineTransform, + B extends PipelineDestination + >(source: A, transform1: T1, transform2: T2, transform3: T3, destination: B, options?: PipelineOptions): PipelinePromise; + function __promisify__< + A extends PipelineSource, + T1 extends PipelineTransform, + T2 extends PipelineTransform, + T3 extends PipelineTransform, + T4 extends PipelineTransform, + B extends PipelineDestination + >(source: A, transform1: T1, transform2: T2, transform3: T3, transform4: T4, destination: B, options?: PipelineOptions): PipelinePromise; + function __promisify__(streams: ReadonlyArray, options?: PipelineOptions): Promise; + function __promisify__( + stream1: NodeJS.ReadableStream, + stream2: NodeJS.ReadWriteStream | NodeJS.WritableStream, + ...streams: Array + ): Promise; + } + interface Pipe { + close(): void; + hasRef(): boolean; + ref(): void; + unref(): void; + } + const promises: typeof streamPromises; + const consumers: typeof streamConsumers; + } + export = internal; +} +declare module 'node:stream' { + import stream = require('stream'); + export = stream; +} diff --git a/node_modules/@types/node/stream/consumers.d.ts b/node_modules/@types/node/stream/consumers.d.ts new file mode 100755 index 00000000..ce6c9bb7 --- /dev/null +++ b/node_modules/@types/node/stream/consumers.d.ts @@ -0,0 +1,24 @@ +// Duplicates of interface in lib.dom.ts. +// Duplicated here rather than referencing lib.dom.ts because doing so causes lib.dom.ts to be loaded for "test-all" +// Which in turn causes tests to pass that shouldn't pass. +// +// This interface is not, and should not be, exported. +interface Blob { + readonly size: number; + readonly type: string; + arrayBuffer(): Promise; + slice(start?: number, end?: number, contentType?: string): Blob; + stream(): NodeJS.ReadableStream; + text(): Promise; +} +declare module 'stream/consumers' { + import { Readable } from 'node:stream'; + function buffer(stream: NodeJS.ReadableStream | Readable | AsyncIterator): Promise; + function text(stream: NodeJS.ReadableStream | Readable | AsyncIterator): Promise; + function arrayBuffer(stream: NodeJS.ReadableStream | Readable | AsyncIterator): Promise; + function blob(stream: NodeJS.ReadableStream | Readable | AsyncIterator): Promise; + function json(stream: NodeJS.ReadableStream | Readable | AsyncIterator): Promise; +} +declare module 'node:stream/consumers' { + export * from 'stream/consumers'; +} diff --git a/node_modules/@types/node/stream/promises.d.ts b/node_modules/@types/node/stream/promises.d.ts new file mode 100755 index 00000000..b427073d --- /dev/null +++ b/node_modules/@types/node/stream/promises.d.ts @@ -0,0 +1,42 @@ +declare module 'stream/promises' { + import { FinishedOptions, PipelineSource, PipelineTransform, PipelineDestination, PipelinePromise, PipelineOptions } from 'node:stream'; + function finished(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, options?: FinishedOptions): Promise; + function pipeline, B extends PipelineDestination>(source: A, destination: B, options?: PipelineOptions): PipelinePromise; + function pipeline, T1 extends PipelineTransform, B extends PipelineDestination>( + source: A, + transform1: T1, + destination: B, + options?: PipelineOptions + ): PipelinePromise; + function pipeline, T1 extends PipelineTransform, T2 extends PipelineTransform, B extends PipelineDestination>( + source: A, + transform1: T1, + transform2: T2, + destination: B, + options?: PipelineOptions + ): PipelinePromise; + function pipeline< + A extends PipelineSource, + T1 extends PipelineTransform, + T2 extends PipelineTransform, + T3 extends PipelineTransform, + B extends PipelineDestination + >(source: A, transform1: T1, transform2: T2, transform3: T3, destination: B, options?: PipelineOptions): PipelinePromise; + function pipeline< + A extends PipelineSource, + T1 extends PipelineTransform, + T2 extends PipelineTransform, + T3 extends PipelineTransform, + T4 extends PipelineTransform, + B extends PipelineDestination + >(source: A, transform1: T1, transform2: T2, transform3: T3, transform4: T4, destination: B, options?: PipelineOptions): PipelinePromise; + function pipeline(streams: ReadonlyArray, options?: PipelineOptions): Promise; + function pipeline( + stream1: NodeJS.ReadableStream, + stream2: NodeJS.ReadWriteStream | NodeJS.WritableStream, + ...streams: Array + ): Promise; +} +declare module 'node:stream/promises' { + export * from 'stream/promises'; +} diff --git a/node_modules/@types/node/stream/web.d.ts b/node_modules/@types/node/stream/web.d.ts new file mode 100755 index 00000000..a9d75c19 --- /dev/null +++ b/node_modules/@types/node/stream/web.d.ts @@ -0,0 +1,6 @@ +declare module 'stream/web' { + // stub module, pending copy&paste from .d.ts or manual impl +} +declare module 'node:stream/web' { + export * from 'stream/web'; +} diff --git a/node_modules/@types/node/string_decoder.d.ts b/node_modules/@types/node/string_decoder.d.ts new file mode 100755 index 00000000..584e0c5d --- /dev/null +++ b/node_modules/@types/node/string_decoder.d.ts @@ -0,0 +1,67 @@ +/** + * The `string_decoder` module provides an API for decoding `Buffer` objects into + * strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16 + * characters. It can be accessed using: + * + * ```js + * const { StringDecoder } = require('string_decoder'); + * ``` + * + * The following example shows the basic use of the `StringDecoder` class. + * + * ```js + * const { StringDecoder } = require('string_decoder'); + * const decoder = new StringDecoder('utf8'); + * + * const cent = Buffer.from([0xC2, 0xA2]); + * console.log(decoder.write(cent)); + * + * const euro = Buffer.from([0xE2, 0x82, 0xAC]); + * console.log(decoder.write(euro)); + * ``` + * + * When a `Buffer` instance is written to the `StringDecoder` instance, an + * internal buffer is used to ensure that the decoded string does not contain + * any incomplete multibyte characters. These are held in the buffer until the + * next call to `stringDecoder.write()` or until `stringDecoder.end()` is called. + * + * In the following example, the three UTF-8 encoded bytes of the European Euro + * symbol (`€`) are written over three separate operations: + * + * ```js + * const { StringDecoder } = require('string_decoder'); + * const decoder = new StringDecoder('utf8'); + * + * decoder.write(Buffer.from([0xE2])); + * decoder.write(Buffer.from([0x82])); + * console.log(decoder.end(Buffer.from([0xAC]))); + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/string_decoder.js) + */ +declare module 'string_decoder' { + class StringDecoder { + constructor(encoding?: BufferEncoding); + /** + * Returns a decoded string, ensuring that any incomplete multibyte characters at + * the end of the `Buffer`, or `TypedArray`, or `DataView` are omitted from the + * returned string and stored in an internal buffer for the next call to`stringDecoder.write()` or `stringDecoder.end()`. + * @since v0.1.99 + * @param buffer A `Buffer`, or `TypedArray`, or `DataView` containing the bytes to decode. + */ + write(buffer: Buffer): string; + /** + * Returns any remaining input stored in the internal buffer as a string. Bytes + * representing incomplete UTF-8 and UTF-16 characters will be replaced with + * substitution characters appropriate for the character encoding. + * + * If the `buffer` argument is provided, one final call to `stringDecoder.write()`is performed before returning the remaining input. + * After `end()` is called, the `stringDecoder` object can be reused for new input. + * @since v0.9.3 + * @param buffer A `Buffer`, or `TypedArray`, or `DataView` containing the bytes to decode. + */ + end(buffer?: Buffer): string; + } +} +declare module 'node:string_decoder' { + export * from 'string_decoder'; +} diff --git a/node_modules/@types/node/timers.d.ts b/node_modules/@types/node/timers.d.ts new file mode 100755 index 00000000..1768d7fb --- /dev/null +++ b/node_modules/@types/node/timers.d.ts @@ -0,0 +1,94 @@ +/** + * The `timer` module exposes a global API for scheduling functions to + * be called at some future period of time. Because the timer functions are + * globals, there is no need to call `require('timers')` to use the API. + * + * The timer functions within Node.js implement a similar API as the timers API + * provided by Web Browsers but use a different internal implementation that is + * built around the Node.js [Event Loop](https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/#setimmediate-vs-settimeout). + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/timers.js) + */ +declare module 'timers' { + import { Abortable } from 'node:events'; + import { setTimeout as setTimeoutPromise, setImmediate as setImmediatePromise, setInterval as setIntervalPromise } from 'node:timers/promises'; + interface TimerOptions extends Abortable { + /** + * Set to `false` to indicate that the scheduled `Timeout` + * should not require the Node.js event loop to remain active. + * @default true + */ + ref?: boolean | undefined; + } + let setTimeout: typeof global.setTimeout; + let clearTimeout: typeof global.clearTimeout; + let setInterval: typeof global.setInterval; + let clearInterval: typeof global.clearInterval; + let setImmediate: typeof global.setImmediate; + let clearImmediate: typeof global.clearImmediate; + global { + namespace NodeJS { + // compatibility with older typings + interface Timer extends RefCounted { + hasRef(): boolean; + refresh(): this; + [Symbol.toPrimitive](): number; + } + interface Immediate extends RefCounted { + /** + * If true, the `Immediate` object will keep the Node.js event loop active. + * @since v11.0.0 + */ + hasRef(): boolean; + _onImmediate: Function; // to distinguish it from the Timeout class + } + interface Timeout extends Timer { + /** + * If true, the `Timeout` object will keep the Node.js event loop active. + * @since v11.0.0 + */ + hasRef(): boolean; + /** + * Sets the timer's start time to the current time, and reschedules the timer to + * call its callback at the previously specified duration adjusted to the current + * time. This is useful for refreshing a timer without allocating a new + * JavaScript object. + * + * Using this on a timer that has already called its callback will reactivate the + * timer. + * @since v10.2.0 + * @return a reference to `timeout` + */ + refresh(): this; + [Symbol.toPrimitive](): number; + } + } + function setTimeout(callback: (...args: TArgs) => void, ms?: number, ...args: TArgs): NodeJS.Timeout; + // util.promisify no rest args compability + // tslint:disable-next-line void-return + function setTimeout(callback: (args: void) => void, ms?: number): NodeJS.Timeout; + namespace setTimeout { + const __promisify__: typeof setTimeoutPromise; + } + function clearTimeout(timeoutId: NodeJS.Timeout): void; + function setInterval(callback: (...args: TArgs) => void, ms?: number, ...args: TArgs): NodeJS.Timer; + // util.promisify no rest args compability + // tslint:disable-next-line void-return + function setInterval(callback: (args: void) => void, ms?: number): NodeJS.Timer; + namespace setInterval { + const __promisify__: typeof setIntervalPromise; + } + function clearInterval(intervalId: NodeJS.Timeout): void; + function setImmediate(callback: (...args: TArgs) => void, ...args: TArgs): NodeJS.Immediate; + // util.promisify no rest args compability + // tslint:disable-next-line void-return + function setImmediate(callback: (args: void) => void): NodeJS.Immediate; + namespace setImmediate { + const __promisify__: typeof setImmediatePromise; + } + function clearImmediate(immediateId: NodeJS.Immediate): void; + function queueMicrotask(callback: () => void): void; + } +} +declare module 'node:timers' { + export * from 'timers'; +} diff --git a/node_modules/@types/node/timers/promises.d.ts b/node_modules/@types/node/timers/promises.d.ts new file mode 100755 index 00000000..fd778880 --- /dev/null +++ b/node_modules/@types/node/timers/promises.d.ts @@ -0,0 +1,68 @@ +/** + * The `timers/promises` API provides an alternative set of timer functions + * that return `Promise` objects. The API is accessible via`require('timers/promises')`. + * + * ```js + * import { + * setTimeout, + * setImmediate, + * setInterval, + * } from 'timers/promises'; + * ``` + * @since v15.0.0 + */ +declare module 'timers/promises' { + import { TimerOptions } from 'node:timers'; + /** + * ```js + * import { + * setTimeout, + * } from 'timers/promises'; + * + * const res = await setTimeout(100, 'result'); + * + * console.log(res); // Prints 'result' + * ``` + * @since v15.0.0 + * @param [delay=1] The number of milliseconds to wait before fulfilling the promise. + * @param value A value with which the promise is fulfilled. + */ + function setTimeout(delay?: number, value?: T, options?: TimerOptions): Promise; + /** + * ```js + * import { + * setImmediate, + * } from 'timers/promises'; + * + * const res = await setImmediate('result'); + * + * console.log(res); // Prints 'result' + * ``` + * @since v15.0.0 + * @param value A value with which the promise is fulfilled. + */ + function setImmediate(value?: T, options?: TimerOptions): Promise; + /** + * Returns an async iterator that generates values in an interval of `delay` ms. + * + * ```js + * import { + * setInterval, + * } from 'timers/promises'; + * + * const interval = 100; + * for await (const startTime of setInterval(interval, Date.now())) { + * const now = Date.now(); + * console.log(now); + * if ((now - startTime) > 1000) + * break; + * } + * console.log(Date.now()); + * ``` + * @since v15.9.0 + */ + function setInterval(delay?: number, value?: T, options?: TimerOptions): AsyncIterable; +} +declare module 'node:timers/promises' { + export * from 'timers/promises'; +} diff --git a/node_modules/@types/node/tls.d.ts b/node_modules/@types/node/tls.d.ts new file mode 100755 index 00000000..b1f4c870 --- /dev/null +++ b/node_modules/@types/node/tls.d.ts @@ -0,0 +1,1019 @@ +/** + * The `tls` module provides an implementation of the Transport Layer Security + * (TLS) and Secure Socket Layer (SSL) protocols that is built on top of OpenSSL. + * The module can be accessed using: + * + * ```js + * const tls = require('tls'); + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/tls.js) + */ +declare module 'tls' { + import { X509Certificate } from 'node:crypto'; + import * as net from 'node:net'; + const CLIENT_RENEG_LIMIT: number; + const CLIENT_RENEG_WINDOW: number; + interface Certificate { + /** + * Country code. + */ + C: string; + /** + * Street. + */ + ST: string; + /** + * Locality. + */ + L: string; + /** + * Organization. + */ + O: string; + /** + * Organizational unit. + */ + OU: string; + /** + * Common name. + */ + CN: string; + } + interface PeerCertificate { + subject: Certificate; + issuer: Certificate; + subjectaltname: string; + infoAccess: NodeJS.Dict; + modulus: string; + exponent: string; + valid_from: string; + valid_to: string; + fingerprint: string; + fingerprint256: string; + ext_key_usage: string[]; + serialNumber: string; + raw: Buffer; + } + interface DetailedPeerCertificate extends PeerCertificate { + issuerCertificate: DetailedPeerCertificate; + } + interface CipherNameAndProtocol { + /** + * The cipher name. + */ + name: string; + /** + * SSL/TLS protocol version. + */ + version: string; + /** + * IETF name for the cipher suite. + */ + standardName: string; + } + interface EphemeralKeyInfo { + /** + * The supported types are 'DH' and 'ECDH'. + */ + type: string; + /** + * The name property is available only when type is 'ECDH'. + */ + name?: string | undefined; + /** + * The size of parameter of an ephemeral key exchange. + */ + size: number; + } + interface KeyObject { + /** + * Private keys in PEM format. + */ + pem: string | Buffer; + /** + * Optional passphrase. + */ + passphrase?: string | undefined; + } + interface PxfObject { + /** + * PFX or PKCS12 encoded private key and certificate chain. + */ + buf: string | Buffer; + /** + * Optional passphrase. + */ + passphrase?: string | undefined; + } + interface TLSSocketOptions extends SecureContextOptions, CommonConnectionOptions { + /** + * If true the TLS socket will be instantiated in server-mode. + * Defaults to false. + */ + isServer?: boolean | undefined; + /** + * An optional net.Server instance. + */ + server?: net.Server | undefined; + /** + * An optional Buffer instance containing a TLS session. + */ + session?: Buffer | undefined; + /** + * If true, specifies that the OCSP status request extension will be + * added to the client hello and an 'OCSPResponse' event will be + * emitted on the socket before establishing a secure communication + */ + requestOCSP?: boolean | undefined; + } + /** + * Performs transparent encryption of written data and all required TLS + * negotiation. + * + * Instances of `tls.TLSSocket` implement the duplex `Stream` interface. + * + * Methods that return TLS connection metadata (e.g.{@link TLSSocket.getPeerCertificate} will only return data while the + * connection is open. + * @since v0.11.4 + */ + class TLSSocket extends net.Socket { + /** + * Construct a new tls.TLSSocket object from an existing TCP socket. + */ + constructor(socket: net.Socket, options?: TLSSocketOptions); + /** + * Returns `true` if the peer certificate was signed by one of the CAs specified + * when creating the `tls.TLSSocket` instance, otherwise `false`. + * @since v0.11.4 + */ + authorized: boolean; + /** + * Returns the reason why the peer's certificate was not been verified. This + * property is set only when `tlsSocket.authorized === false`. + * @since v0.11.4 + */ + authorizationError: Error; + /** + * Always returns `true`. This may be used to distinguish TLS sockets from regular`net.Socket` instances. + * @since v0.11.4 + */ + encrypted: boolean; + /** + * String containing the selected ALPN protocol. + * Before a handshake has completed, this value is always null. + * When a handshake is completed but not ALPN protocol was selected, tlsSocket.alpnProtocol equals false. + */ + alpnProtocol: string | false | null; + /** + * Returns an object representing the local certificate. The returned object has + * some properties corresponding to the fields of the certificate. + * + * See {@link TLSSocket.getPeerCertificate} for an example of the certificate + * structure. + * + * If there is no local certificate, an empty object will be returned. If the + * socket has been destroyed, `null` will be returned. + * @since v11.2.0 + */ + getCertificate(): PeerCertificate | object | null; + /** + * Returns an object containing information on the negotiated cipher suite. + * + * For example: + * + * ```json + * { + * "name": "AES128-SHA256", + * "standardName": "TLS_RSA_WITH_AES_128_CBC_SHA256", + * "version": "TLSv1.2" + * } + * ``` + * + * See [SSL\_CIPHER\_get\_name](https://www.openssl.org/docs/man1.1.1/man3/SSL_CIPHER_get_name.html) for more information. + * @since v0.11.4 + */ + getCipher(): CipherNameAndProtocol; + /** + * Returns an object representing the type, name, and size of parameter of + * an ephemeral key exchange in `perfect forward secrecy` on a client + * connection. It returns an empty object when the key exchange is not + * ephemeral. As this is only supported on a client socket; `null` is returned + * if called on a server socket. The supported types are `'DH'` and `'ECDH'`. The`name` property is available only when type is `'ECDH'`. + * + * For example: `{ type: 'ECDH', name: 'prime256v1', size: 256 }`. + * @since v5.0.0 + */ + getEphemeralKeyInfo(): EphemeralKeyInfo | object | null; + /** + * As the `Finished` messages are message digests of the complete handshake + * (with a total of 192 bits for TLS 1.0 and more for SSL 3.0), they can + * be used for external authentication procedures when the authentication + * provided by SSL/TLS is not desired or is not enough. + * + * Corresponds to the `SSL_get_finished` routine in OpenSSL and may be used + * to implement the `tls-unique` channel binding from [RFC 5929](https://tools.ietf.org/html/rfc5929). + * @since v9.9.0 + * @return The latest `Finished` message that has been sent to the socket as part of a SSL/TLS handshake, or `undefined` if no `Finished` message has been sent yet. + */ + getFinished(): Buffer | undefined; + /** + * Returns an object representing the peer's certificate. If the peer does not + * provide a certificate, an empty object will be returned. If the socket has been + * destroyed, `null` will be returned. + * + * If the full certificate chain was requested, each certificate will include an`issuerCertificate` property containing an object representing its issuer's + * certificate. + * @since v0.11.4 + * @param detailed Include the full certificate chain if `true`, otherwise include just the peer's certificate. + * @return A certificate object. + */ + getPeerCertificate(detailed: true): DetailedPeerCertificate; + getPeerCertificate(detailed?: false): PeerCertificate; + getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate; + /** + * As the `Finished` messages are message digests of the complete handshake + * (with a total of 192 bits for TLS 1.0 and more for SSL 3.0), they can + * be used for external authentication procedures when the authentication + * provided by SSL/TLS is not desired or is not enough. + * + * Corresponds to the `SSL_get_peer_finished` routine in OpenSSL and may be used + * to implement the `tls-unique` channel binding from [RFC 5929](https://tools.ietf.org/html/rfc5929). + * @since v9.9.0 + * @return The latest `Finished` message that is expected or has actually been received from the socket as part of a SSL/TLS handshake, or `undefined` if there is no `Finished` message so + * far. + */ + getPeerFinished(): Buffer | undefined; + /** + * Returns a string containing the negotiated SSL/TLS protocol version of the + * current connection. The value `'unknown'` will be returned for connected + * sockets that have not completed the handshaking process. The value `null` will + * be returned for server sockets or disconnected client sockets. + * + * Protocol versions are: + * + * * `'SSLv3'` + * * `'TLSv1'` + * * `'TLSv1.1'` + * * `'TLSv1.2'` + * * `'TLSv1.3'` + * + * See the OpenSSL [`SSL_get_version`](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html) documentation for more information. + * @since v5.7.0 + */ + getProtocol(): string | null; + /** + * Returns the TLS session data or `undefined` if no session was + * negotiated. On the client, the data can be provided to the `session` option of {@link connect} to resume the connection. On the server, it may be useful + * for debugging. + * + * See `Session Resumption` for more information. + * + * Note: `getSession()` works only for TLSv1.2 and below. For TLSv1.3, applications + * must use the `'session'` event (it also works for TLSv1.2 and below). + * @since v0.11.4 + */ + getSession(): Buffer | undefined; + /** + * See [SSL\_get\_shared\_sigalgs](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_shared_sigalgs.html) for more information. + * @since v12.11.0 + * @return List of signature algorithms shared between the server and the client in the order of decreasing preference. + */ + getSharedSigalgs(): string[]; + /** + * For a client, returns the TLS session ticket if one is available, or`undefined`. For a server, always returns `undefined`. + * + * It may be useful for debugging. + * + * See `Session Resumption` for more information. + * @since v0.11.4 + */ + getTLSTicket(): Buffer | undefined; + /** + * See `Session Resumption` for more information. + * @since v0.5.6 + * @return `true` if the session was reused, `false` otherwise. + */ + isSessionReused(): boolean; + /** + * The `tlsSocket.renegotiate()` method initiates a TLS renegotiation process. + * Upon completion, the `callback` function will be passed a single argument + * that is either an `Error` (if the request failed) or `null`. + * + * This method can be used to request a peer's certificate after the secure + * connection has been established. + * + * When running as the server, the socket will be destroyed with an error after`handshakeTimeout` timeout. + * + * For TLSv1.3, renegotiation cannot be initiated, it is not supported by the + * protocol. + * @since v0.11.8 + * @param callback If `renegotiate()` returned `true`, callback is attached once to the `'secure'` event. If `renegotiate()` returned `false`, `callback` will be called in the next tick with + * an error, unless the `tlsSocket` has been destroyed, in which case `callback` will not be called at all. + * @return `true` if renegotiation was initiated, `false` otherwise. + */ + renegotiate( + options: { + rejectUnauthorized?: boolean | undefined; + requestCert?: boolean | undefined; + }, + callback: (err: Error | null) => void + ): undefined | boolean; + /** + * The `tlsSocket.setMaxSendFragment()` method sets the maximum TLS fragment size. + * Returns `true` if setting the limit succeeded; `false` otherwise. + * + * Smaller fragment sizes decrease the buffering latency on the client: larger + * fragments are buffered by the TLS layer until the entire fragment is received + * and its integrity is verified; large fragments can span multiple roundtrips + * and their processing can be delayed due to packet loss or reordering. However, + * smaller fragments add extra TLS framing bytes and CPU overhead, which may + * decrease overall server throughput. + * @since v0.11.11 + * @param [size=16384] The maximum TLS fragment size. The maximum value is `16384`. + */ + setMaxSendFragment(size: number): boolean; + /** + * Disables TLS renegotiation for this `TLSSocket` instance. Once called, attempts + * to renegotiate will trigger an `'error'` event on the `TLSSocket`. + * @since v8.4.0 + */ + disableRenegotiation(): void; + /** + * When enabled, TLS packet trace information is written to `stderr`. This can be + * used to debug TLS connection problems. + * + * Note: The format of the output is identical to the output of `openssl s_client -trace` or `openssl s_server -trace`. While it is produced by OpenSSL's`SSL_trace()` function, the format is + * undocumented, can change without notice, + * and should not be relied on. + * @since v12.2.0 + */ + enableTrace(): void; + /** + * Returns the peer certificate as an `X509Certificate` object. + * + * If there is no peer certificate, or the socket has been destroyed,`undefined` will be returned. + * @since v15.9.0 + */ + getPeerX509Certificate(): X509Certificate | undefined; + /** + * Returns the local certificate as an `X509Certificate` object. + * + * If there is no local certificate, or the socket has been destroyed,`undefined` will be returned. + * @since v15.9.0 + */ + getX509Certificate(): X509Certificate | undefined; + /** + * Keying material is used for validations to prevent different kind of attacks in + * network protocols, for example in the specifications of IEEE 802.1X. + * + * Example + * + * ```js + * const keyingMaterial = tlsSocket.exportKeyingMaterial( + * 128, + * 'client finished'); + * + * + * Example return value of keyingMaterial: + * + * + * ``` + * + * See the OpenSSL [`SSL_export_keying_material`](https://www.openssl.org/docs/man1.1.1/man3/SSL_export_keying_material.html) documentation for more + * information. + * @since v13.10.0, v12.17.0 + * @param length number of bytes to retrieve from keying material + * @param label an application specific label, typically this will be a value from the [IANA Exporter Label + * Registry](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#exporter-labels). + * @param context Optionally provide a context. + * @return requested bytes of the keying material + */ + exportKeyingMaterial(length: number, label: string, context: Buffer): Buffer; + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'OCSPResponse', listener: (response: Buffer) => void): this; + addListener(event: 'secureConnect', listener: () => void): this; + addListener(event: 'session', listener: (session: Buffer) => void): this; + addListener(event: 'keylog', listener: (line: Buffer) => void): this; + emit(event: string | symbol, ...args: any[]): boolean; + emit(event: 'OCSPResponse', response: Buffer): boolean; + emit(event: 'secureConnect'): boolean; + emit(event: 'session', session: Buffer): boolean; + emit(event: 'keylog', line: Buffer): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'OCSPResponse', listener: (response: Buffer) => void): this; + on(event: 'secureConnect', listener: () => void): this; + on(event: 'session', listener: (session: Buffer) => void): this; + on(event: 'keylog', listener: (line: Buffer) => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'OCSPResponse', listener: (response: Buffer) => void): this; + once(event: 'secureConnect', listener: () => void): this; + once(event: 'session', listener: (session: Buffer) => void): this; + once(event: 'keylog', listener: (line: Buffer) => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'OCSPResponse', listener: (response: Buffer) => void): this; + prependListener(event: 'secureConnect', listener: () => void): this; + prependListener(event: 'session', listener: (session: Buffer) => void): this; + prependListener(event: 'keylog', listener: (line: Buffer) => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'OCSPResponse', listener: (response: Buffer) => void): this; + prependOnceListener(event: 'secureConnect', listener: () => void): this; + prependOnceListener(event: 'session', listener: (session: Buffer) => void): this; + prependOnceListener(event: 'keylog', listener: (line: Buffer) => void): this; + } + interface CommonConnectionOptions { + /** + * An optional TLS context object from tls.createSecureContext() + */ + secureContext?: SecureContext | undefined; + /** + * When enabled, TLS packet trace information is written to `stderr`. This can be + * used to debug TLS connection problems. + * @default false + */ + enableTrace?: boolean | undefined; + /** + * If true the server will request a certificate from clients that + * connect and attempt to verify that certificate. Defaults to + * false. + */ + requestCert?: boolean | undefined; + /** + * An array of strings or a Buffer naming possible ALPN protocols. + * (Protocols should be ordered by their priority.) + */ + ALPNProtocols?: string[] | Uint8Array[] | Uint8Array | undefined; + /** + * SNICallback(servername, cb) A function that will be + * called if the client supports SNI TLS extension. Two arguments + * will be passed when called: servername and cb. SNICallback should + * invoke cb(null, ctx), where ctx is a SecureContext instance. + * (tls.createSecureContext(...) can be used to get a proper + * SecureContext.) If SNICallback wasn't provided the default callback + * with high-level API will be used (see below). + */ + SNICallback?: ((servername: string, cb: (err: Error | null, ctx?: SecureContext) => void) => void) | undefined; + /** + * If true the server will reject any connection which is not + * authorized with the list of supplied CAs. This option only has an + * effect if requestCert is true. + * @default true + */ + rejectUnauthorized?: boolean | undefined; + } + interface TlsOptions extends SecureContextOptions, CommonConnectionOptions, net.ServerOpts { + /** + * Abort the connection if the SSL/TLS handshake does not finish in the + * specified number of milliseconds. A 'tlsClientError' is emitted on + * the tls.Server object whenever a handshake times out. Default: + * 120000 (120 seconds). + */ + handshakeTimeout?: number | undefined; + /** + * The number of seconds after which a TLS session created by the + * server will no longer be resumable. See Session Resumption for more + * information. Default: 300. + */ + sessionTimeout?: number | undefined; + /** + * 48-bytes of cryptographically strong pseudo-random data. + */ + ticketKeys?: Buffer | undefined; + /** + * + * @param socket + * @param identity identity parameter sent from the client. + * @return pre-shared key that must either be + * a buffer or `null` to stop the negotiation process. Returned PSK must be + * compatible with the selected cipher's digest. + * + * When negotiating TLS-PSK (pre-shared keys), this function is called + * with the identity provided by the client. + * If the return value is `null` the negotiation process will stop and an + * "unknown_psk_identity" alert message will be sent to the other party. + * If the server wishes to hide the fact that the PSK identity was not known, + * the callback must provide some random data as `psk` to make the connection + * fail with "decrypt_error" before negotiation is finished. + * PSK ciphers are disabled by default, and using TLS-PSK thus + * requires explicitly specifying a cipher suite with the `ciphers` option. + * More information can be found in the RFC 4279. + */ + pskCallback?(socket: TLSSocket, identity: string): DataView | NodeJS.TypedArray | null; + /** + * hint to send to a client to help + * with selecting the identity during TLS-PSK negotiation. Will be ignored + * in TLS 1.3. Upon failing to set pskIdentityHint `tlsClientError` will be + * emitted with `ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED` code. + */ + pskIdentityHint?: string | undefined; + } + interface PSKCallbackNegotation { + psk: DataView | NodeJS.TypedArray; + identity: string; + } + interface ConnectionOptions extends SecureContextOptions, CommonConnectionOptions { + host?: string | undefined; + port?: number | undefined; + path?: string | undefined; // Creates unix socket connection to path. If this option is specified, `host` and `port` are ignored. + socket?: net.Socket | undefined; // Establish secure connection on a given socket rather than creating a new socket + checkServerIdentity?: typeof checkServerIdentity | undefined; + servername?: string | undefined; // SNI TLS Extension + session?: Buffer | undefined; + minDHSize?: number | undefined; + lookup?: net.LookupFunction | undefined; + timeout?: number | undefined; + /** + * When negotiating TLS-PSK (pre-shared keys), this function is called + * with optional identity `hint` provided by the server or `null` + * in case of TLS 1.3 where `hint` was removed. + * It will be necessary to provide a custom `tls.checkServerIdentity()` + * for the connection as the default one will try to check hostname/IP + * of the server against the certificate but that's not applicable for PSK + * because there won't be a certificate present. + * More information can be found in the RFC 4279. + * + * @param hint message sent from the server to help client + * decide which identity to use during negotiation. + * Always `null` if TLS 1.3 is used. + * @returns Return `null` to stop the negotiation process. `psk` must be + * compatible with the selected cipher's digest. + * `identity` must use UTF-8 encoding. + */ + pskCallback?(hint: string | null): PSKCallbackNegotation | null; + } + /** + * Accepts encrypted connections using TLS or SSL. + * @since v0.3.2 + */ + class Server extends net.Server { + constructor(secureConnectionListener?: (socket: TLSSocket) => void); + constructor(options: TlsOptions, secureConnectionListener?: (socket: TLSSocket) => void); + /** + * The `server.addContext()` method adds a secure context that will be used if + * the client request's SNI name matches the supplied `hostname` (or wildcard). + * + * When there are multiple matching contexts, the most recently added one is + * used. + * @since v0.5.3 + * @param hostname A SNI host name or wildcard (e.g. `'*'`) + * @param context An object containing any of the possible properties from the {@link createSecureContext} `options` arguments (e.g. `key`, `cert`, `ca`, etc). + */ + addContext(hostname: string, context: SecureContextOptions): void; + /** + * Returns the session ticket keys. + * + * See `Session Resumption` for more information. + * @since v3.0.0 + * @return A 48-byte buffer containing the session ticket keys. + */ + getTicketKeys(): Buffer; + /** + * The `server.setSecureContext()` method replaces the secure context of an + * existing server. Existing connections to the server are not interrupted. + * @since v11.0.0 + * @param options An object containing any of the possible properties from the {@link createSecureContext} `options` arguments (e.g. `key`, `cert`, `ca`, etc). + */ + setSecureContext(options: SecureContextOptions): void; + /** + * Sets the session ticket keys. + * + * Changes to the ticket keys are effective only for future server connections. + * Existing or currently pending server connections will use the previous keys. + * + * See `Session Resumption` for more information. + * @since v3.0.0 + * @param keys A 48-byte buffer containing the session ticket keys. + */ + setTicketKeys(keys: Buffer): void; + /** + * events.EventEmitter + * 1. tlsClientError + * 2. newSession + * 3. OCSPRequest + * 4. resumeSession + * 5. secureConnection + * 6. keylog + */ + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'tlsClientError', listener: (err: Error, tlsSocket: TLSSocket) => void): this; + addListener(event: 'newSession', listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; + addListener(event: 'OCSPRequest', listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; + addListener(event: 'resumeSession', listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; + addListener(event: 'secureConnection', listener: (tlsSocket: TLSSocket) => void): this; + addListener(event: 'keylog', listener: (line: Buffer, tlsSocket: TLSSocket) => void): this; + emit(event: string | symbol, ...args: any[]): boolean; + emit(event: 'tlsClientError', err: Error, tlsSocket: TLSSocket): boolean; + emit(event: 'newSession', sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void): boolean; + emit(event: 'OCSPRequest', certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void): boolean; + emit(event: 'resumeSession', sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void): boolean; + emit(event: 'secureConnection', tlsSocket: TLSSocket): boolean; + emit(event: 'keylog', line: Buffer, tlsSocket: TLSSocket): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'tlsClientError', listener: (err: Error, tlsSocket: TLSSocket) => void): this; + on(event: 'newSession', listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; + on(event: 'OCSPRequest', listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; + on(event: 'resumeSession', listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; + on(event: 'secureConnection', listener: (tlsSocket: TLSSocket) => void): this; + on(event: 'keylog', listener: (line: Buffer, tlsSocket: TLSSocket) => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'tlsClientError', listener: (err: Error, tlsSocket: TLSSocket) => void): this; + once(event: 'newSession', listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; + once(event: 'OCSPRequest', listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; + once(event: 'resumeSession', listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; + once(event: 'secureConnection', listener: (tlsSocket: TLSSocket) => void): this; + once(event: 'keylog', listener: (line: Buffer, tlsSocket: TLSSocket) => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'tlsClientError', listener: (err: Error, tlsSocket: TLSSocket) => void): this; + prependListener(event: 'newSession', listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; + prependListener(event: 'OCSPRequest', listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; + prependListener(event: 'resumeSession', listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; + prependListener(event: 'secureConnection', listener: (tlsSocket: TLSSocket) => void): this; + prependListener(event: 'keylog', listener: (line: Buffer, tlsSocket: TLSSocket) => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'tlsClientError', listener: (err: Error, tlsSocket: TLSSocket) => void): this; + prependOnceListener(event: 'newSession', listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; + prependOnceListener(event: 'OCSPRequest', listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; + prependOnceListener(event: 'resumeSession', listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; + prependOnceListener(event: 'secureConnection', listener: (tlsSocket: TLSSocket) => void): this; + prependOnceListener(event: 'keylog', listener: (line: Buffer, tlsSocket: TLSSocket) => void): this; + } + /** + * @deprecated since v0.11.3 Use `tls.TLSSocket` instead. + */ + interface SecurePair { + encrypted: TLSSocket; + cleartext: TLSSocket; + } + type SecureVersion = 'TLSv1.3' | 'TLSv1.2' | 'TLSv1.1' | 'TLSv1'; + interface SecureContextOptions { + /** + * Optionally override the trusted CA certificates. Default is to trust + * the well-known CAs curated by Mozilla. Mozilla's CAs are completely + * replaced when CAs are explicitly specified using this option. + */ + ca?: string | Buffer | Array | undefined; + /** + * Cert chains in PEM format. One cert chain should be provided per + * private key. Each cert chain should consist of the PEM formatted + * certificate for a provided private key, followed by the PEM + * formatted intermediate certificates (if any), in order, and not + * including the root CA (the root CA must be pre-known to the peer, + * see ca). When providing multiple cert chains, they do not have to + * be in the same order as their private keys in key. If the + * intermediate certificates are not provided, the peer will not be + * able to validate the certificate, and the handshake will fail. + */ + cert?: string | Buffer | Array | undefined; + /** + * Colon-separated list of supported signature algorithms. The list + * can contain digest algorithms (SHA256, MD5 etc.), public key + * algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g + * 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512). + */ + sigalgs?: string | undefined; + /** + * Cipher suite specification, replacing the default. For more + * information, see modifying the default cipher suite. Permitted + * ciphers can be obtained via tls.getCiphers(). Cipher names must be + * uppercased in order for OpenSSL to accept them. + */ + ciphers?: string | undefined; + /** + * Name of an OpenSSL engine which can provide the client certificate. + */ + clientCertEngine?: string | undefined; + /** + * PEM formatted CRLs (Certificate Revocation Lists). + */ + crl?: string | Buffer | Array | undefined; + /** + * Diffie Hellman parameters, required for Perfect Forward Secrecy. Use + * openssl dhparam to create the parameters. The key length must be + * greater than or equal to 1024 bits or else an error will be thrown. + * Although 1024 bits is permissible, use 2048 bits or larger for + * stronger security. If omitted or invalid, the parameters are + * silently discarded and DHE ciphers will not be available. + */ + dhparam?: string | Buffer | undefined; + /** + * A string describing a named curve or a colon separated list of curve + * NIDs or names, for example P-521:P-384:P-256, to use for ECDH key + * agreement. Set to auto to select the curve automatically. Use + * crypto.getCurves() to obtain a list of available curve names. On + * recent releases, openssl ecparam -list_curves will also display the + * name and description of each available elliptic curve. Default: + * tls.DEFAULT_ECDH_CURVE. + */ + ecdhCurve?: string | undefined; + /** + * Attempt to use the server's cipher suite preferences instead of the + * client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be + * set in secureOptions + */ + honorCipherOrder?: boolean | undefined; + /** + * Private keys in PEM format. PEM allows the option of private keys + * being encrypted. Encrypted keys will be decrypted with + * options.passphrase. Multiple keys using different algorithms can be + * provided either as an array of unencrypted key strings or buffers, + * or an array of objects in the form {pem: [, + * passphrase: ]}. The object form can only occur in an array. + * object.passphrase is optional. Encrypted keys will be decrypted with + * object.passphrase if provided, or options.passphrase if it is not. + */ + key?: string | Buffer | Array | undefined; + /** + * Name of an OpenSSL engine to get private key from. Should be used + * together with privateKeyIdentifier. + */ + privateKeyEngine?: string | undefined; + /** + * Identifier of a private key managed by an OpenSSL engine. Should be + * used together with privateKeyEngine. Should not be set together with + * key, because both options define a private key in different ways. + */ + privateKeyIdentifier?: string | undefined; + /** + * Optionally set the maximum TLS version to allow. One + * of `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the + * `secureProtocol` option, use one or the other. + * **Default:** `'TLSv1.3'`, unless changed using CLI options. Using + * `--tls-max-v1.2` sets the default to `'TLSv1.2'`. Using `--tls-max-v1.3` sets the default to + * `'TLSv1.3'`. If multiple of the options are provided, the highest maximum is used. + */ + maxVersion?: SecureVersion | undefined; + /** + * Optionally set the minimum TLS version to allow. One + * of `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the + * `secureProtocol` option, use one or the other. It is not recommended to use + * less than TLSv1.2, but it may be required for interoperability. + * **Default:** `'TLSv1.2'`, unless changed using CLI options. Using + * `--tls-v1.0` sets the default to `'TLSv1'`. Using `--tls-v1.1` sets the default to + * `'TLSv1.1'`. Using `--tls-min-v1.3` sets the default to + * 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used. + */ + minVersion?: SecureVersion | undefined; + /** + * Shared passphrase used for a single private key and/or a PFX. + */ + passphrase?: string | undefined; + /** + * PFX or PKCS12 encoded private key and certificate chain. pfx is an + * alternative to providing key and cert individually. PFX is usually + * encrypted, if it is, passphrase will be used to decrypt it. Multiple + * PFX can be provided either as an array of unencrypted PFX buffers, + * or an array of objects in the form {buf: [, + * passphrase: ]}. The object form can only occur in an array. + * object.passphrase is optional. Encrypted PFX will be decrypted with + * object.passphrase if provided, or options.passphrase if it is not. + */ + pfx?: string | Buffer | Array | undefined; + /** + * Optionally affect the OpenSSL protocol behavior, which is not + * usually necessary. This should be used carefully if at all! Value is + * a numeric bitmask of the SSL_OP_* options from OpenSSL Options + */ + secureOptions?: number | undefined; // Value is a numeric bitmask of the `SSL_OP_*` options + /** + * Legacy mechanism to select the TLS protocol version to use, it does + * not support independent control of the minimum and maximum version, + * and does not support limiting the protocol to TLSv1.3. Use + * minVersion and maxVersion instead. The possible values are listed as + * SSL_METHODS, use the function names as strings. For example, use + * 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow + * any TLS protocol version up to TLSv1.3. It is not recommended to use + * TLS versions less than 1.2, but it may be required for + * interoperability. Default: none, see minVersion. + */ + secureProtocol?: string | undefined; + /** + * Opaque identifier used by servers to ensure session state is not + * shared between applications. Unused by clients. + */ + sessionIdContext?: string | undefined; + /** + * 48-bytes of cryptographically strong pseudo-random data. + * See Session Resumption for more information. + */ + ticketKeys?: Buffer | undefined; + /** + * The number of seconds after which a TLS session created by the + * server will no longer be resumable. See Session Resumption for more + * information. Default: 300. + */ + sessionTimeout?: number | undefined; + } + interface SecureContext { + context: any; + } + /** + * Verifies the certificate `cert` is issued to `hostname`. + * + * Returns [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object, populating it with `reason`, `host`, and `cert` on + * failure. On success, returns [undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Undefined_type). + * + * This function can be overwritten by providing alternative function as part of + * the `options.checkServerIdentity` option passed to `tls.connect()`. The + * overwriting function can call `tls.checkServerIdentity()` of course, to augment + * the checks done with additional verification. + * + * This function is only called if the certificate passed all other checks, such as + * being issued by trusted CA (`options.ca`). + * @since v0.8.4 + * @param hostname The host name or IP address to verify the certificate against. + * @param cert A `certificate object` representing the peer's certificate. + */ + function checkServerIdentity(hostname: string, cert: PeerCertificate): Error | undefined; + /** + * Creates a new {@link Server}. The `secureConnectionListener`, if provided, is + * automatically set as a listener for the `'secureConnection'` event. + * + * The `ticketKeys` options is automatically shared between `cluster` module + * workers. + * + * The following illustrates a simple echo server: + * + * ```js + * const tls = require('tls'); + * const fs = require('fs'); + * + * const options = { + * key: fs.readFileSync('server-key.pem'), + * cert: fs.readFileSync('server-cert.pem'), + * + * // This is necessary only if using client certificate authentication. + * requestCert: true, + * + * // This is necessary only if the client uses a self-signed certificate. + * ca: [ fs.readFileSync('client-cert.pem') ] + * }; + * + * const server = tls.createServer(options, (socket) => { + * console.log('server connected', + * socket.authorized ? 'authorized' : 'unauthorized'); + * socket.write('welcome!\n'); + * socket.setEncoding('utf8'); + * socket.pipe(socket); + * }); + * server.listen(8000, () => { + * console.log('server bound'); + * }); + * ``` + * + * The server can be tested by connecting to it using the example client from {@link connect}. + * @since v0.3.2 + */ + function createServer(secureConnectionListener?: (socket: TLSSocket) => void): Server; + function createServer(options: TlsOptions, secureConnectionListener?: (socket: TLSSocket) => void): Server; + /** + * The `callback` function, if specified, will be added as a listener for the `'secureConnect'` event. + * + * `tls.connect()` returns a {@link TLSSocket} object. + * + * Unlike the `https` API, `tls.connect()` does not enable the + * SNI (Server Name Indication) extension by default, which may cause some + * servers to return an incorrect certificate or reject the connection + * altogether. To enable SNI, set the `servername` option in addition + * to `host`. + * + * The following illustrates a client for the echo server example from {@link createServer}: + * + * ```js + * // Assumes an echo server that is listening on port 8000. + * const tls = require('tls'); + * const fs = require('fs'); + * + * const options = { + * // Necessary only if the server requires client certificate authentication. + * key: fs.readFileSync('client-key.pem'), + * cert: fs.readFileSync('client-cert.pem'), + * + * // Necessary only if the server uses a self-signed certificate. + * ca: [ fs.readFileSync('server-cert.pem') ], + * + * // Necessary only if the server's cert isn't for "localhost". + * checkServerIdentity: () => { return null; }, + * }; + * + * const socket = tls.connect(8000, options, () => { + * console.log('client connected', + * socket.authorized ? 'authorized' : 'unauthorized'); + * process.stdin.pipe(socket); + * process.stdin.resume(); + * }); + * socket.setEncoding('utf8'); + * socket.on('data', (data) => { + * console.log(data); + * }); + * socket.on('end', () => { + * console.log('server ends connection'); + * }); + * ``` + * @since v0.11.3 + */ + function connect(options: ConnectionOptions, secureConnectListener?: () => void): TLSSocket; + function connect(port: number, host?: string, options?: ConnectionOptions, secureConnectListener?: () => void): TLSSocket; + function connect(port: number, options?: ConnectionOptions, secureConnectListener?: () => void): TLSSocket; + /** + * Creates a new secure pair object with two streams, one of which reads and writes + * the encrypted data and the other of which reads and writes the cleartext data. + * Generally, the encrypted stream is piped to/from an incoming encrypted data + * stream and the cleartext one is used as a replacement for the initial encrypted + * stream. + * + * `tls.createSecurePair()` returns a `tls.SecurePair` object with `cleartext` and`encrypted` stream properties. + * + * Using `cleartext` has the same API as {@link TLSSocket}. + * + * The `tls.createSecurePair()` method is now deprecated in favor of`tls.TLSSocket()`. For example, the code: + * + * ```js + * pair = tls.createSecurePair(// ... ); + * pair.encrypted.pipe(socket); + * socket.pipe(pair.encrypted); + * ``` + * + * can be replaced by: + * + * ```js + * secureSocket = tls.TLSSocket(socket, options); + * ``` + * + * where `secureSocket` has the same API as `pair.cleartext`. + * @since v0.3.2 + * @deprecated Since v0.11.3 - Use {@link TLSSocket} instead. + * @param context A secure context object as returned by `tls.createSecureContext()` + * @param isServer `true` to specify that this TLS connection should be opened as a server. + * @param requestCert `true` to specify whether a server should request a certificate from a connecting client. Only applies when `isServer` is `true`. + * @param rejectUnauthorized If not `false` a server automatically reject clients with invalid certificates. Only applies when `isServer` is `true`. + */ + function createSecurePair(context?: SecureContext, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair; + /** + * {@link createServer} sets the default value of the `honorCipherOrder` option + * to `true`, other APIs that create secure contexts leave it unset. + * + * {@link createServer} uses a 128 bit truncated SHA1 hash value generated + * from `process.argv` as the default value of the `sessionIdContext` option, other + * APIs that create secure contexts have no default value. + * + * The `tls.createSecureContext()` method creates a `SecureContext` object. It is + * usable as an argument to several `tls` APIs, such as {@link createServer} and `server.addContext()`, but has no public methods. + * + * A key is _required_ for ciphers that use certificates. Either `key` or`pfx` can be used to provide it. + * + * If the `ca` option is not given, then Node.js will default to using [Mozilla's publicly trusted list of + * CAs](https://hg.mozilla.org/mozilla-central/raw-file/tip/security/nss/lib/ckfw/builtins/certdata.txt). + * @since v0.11.13 + */ + function createSecureContext(options?: SecureContextOptions): SecureContext; + /** + * Returns an array with the names of the supported TLS ciphers. The names are + * lower-case for historical reasons, but must be uppercased to be used in + * the `ciphers` option of {@link createSecureContext}. + * + * Cipher names that start with `'tls_'` are for TLSv1.3, all the others are for + * TLSv1.2 and below. + * + * ```js + * console.log(tls.getCiphers()); // ['aes128-gcm-sha256', 'aes128-sha', ...] + * ``` + * @since v0.10.2 + */ + function getCiphers(): string[]; + /** + * The default curve name to use for ECDH key agreement in a tls server. + * The default value is 'auto'. See tls.createSecureContext() for further + * information. + */ + let DEFAULT_ECDH_CURVE: string; + /** + * The default value of the maxVersion option of + * tls.createSecureContext(). It can be assigned any of the supported TLS + * protocol versions, 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Default: + * 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets + * the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to + * 'TLSv1.3'. If multiple of the options are provided, the highest maximum + * is used. + */ + let DEFAULT_MAX_VERSION: SecureVersion; + /** + * The default value of the minVersion option of tls.createSecureContext(). + * It can be assigned any of the supported TLS protocol versions, + * 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Default: 'TLSv1.2', unless + * changed using CLI options. Using --tls-min-v1.0 sets the default to + * 'TLSv1'. Using --tls-min-v1.1 sets the default to 'TLSv1.1'. Using + * --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options + * are provided, the lowest minimum is used. + */ + let DEFAULT_MIN_VERSION: SecureVersion; + /** + * An immutable array of strings representing the root certificates (in PEM + * format) used for verifying peer certificates. This is the default value + * of the ca option to tls.createSecureContext(). + */ + const rootCertificates: ReadonlyArray; +} +declare module 'node:tls' { + export * from 'tls'; +} diff --git a/node_modules/@types/node/trace_events.d.ts b/node_modules/@types/node/trace_events.d.ts new file mode 100755 index 00000000..2976eb6e --- /dev/null +++ b/node_modules/@types/node/trace_events.d.ts @@ -0,0 +1,161 @@ +/** + * The `trace_events` module provides a mechanism to centralize tracing information + * generated by V8, Node.js core, and userspace code. + * + * Tracing can be enabled with the `--trace-event-categories` command-line flag + * or by using the `trace_events` module. The `--trace-event-categories` flag + * accepts a list of comma-separated category names. + * + * The available categories are: + * + * * `node`: An empty placeholder. + * * `node.async_hooks`: Enables capture of detailed `async_hooks` trace data. + * The `async_hooks` events have a unique `asyncId` and a special `triggerId` `triggerAsyncId` property. + * * `node.bootstrap`: Enables capture of Node.js bootstrap milestones. + * * `node.console`: Enables capture of `console.time()` and `console.count()`output. + * * `node.dns.native`: Enables capture of trace data for DNS queries. + * * `node.environment`: Enables capture of Node.js Environment milestones. + * * `node.fs.sync`: Enables capture of trace data for file system sync methods. + * * `node.perf`: Enables capture of `Performance API` measurements. + * * `node.perf.usertiming`: Enables capture of only Performance API User Timing + * measures and marks. + * * `node.perf.timerify`: Enables capture of only Performance API timerify + * measurements. + * * `node.promises.rejections`: Enables capture of trace data tracking the number + * of unhandled Promise rejections and handled-after-rejections. + * * `node.vm.script`: Enables capture of trace data for the `vm` module's`runInNewContext()`, `runInContext()`, and `runInThisContext()` methods. + * * `v8`: The `V8` events are GC, compiling, and execution related. + * + * By default the `node`, `node.async_hooks`, and `v8` categories are enabled. + * + * ```bash + * node --trace-event-categories v8,node,node.async_hooks server.js + * ``` + * + * Prior versions of Node.js required the use of the `--trace-events-enabled`flag to enable trace events. This requirement has been removed. However, the`--trace-events-enabled` flag _may_ still be + * used and will enable the`node`, `node.async_hooks`, and `v8` trace event categories by default. + * + * ```bash + * node --trace-events-enabled + * + * # is equivalent to + * + * node --trace-event-categories v8,node,node.async_hooks + * ``` + * + * Alternatively, trace events may be enabled using the `trace_events` module: + * + * ```js + * const trace_events = require('trace_events'); + * const tracing = trace_events.createTracing({ categories: ['node.perf'] }); + * tracing.enable(); // Enable trace event capture for the 'node.perf' category + * + * // do work + * + * tracing.disable(); // Disable trace event capture for the 'node.perf' category + * ``` + * + * Running Node.js with tracing enabled will produce log files that can be opened + * in the [`chrome://tracing`](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) tab of Chrome. + * + * The logging file is by default called `node_trace.${rotation}.log`, where`${rotation}` is an incrementing log-rotation id. The filepath pattern can + * be specified with `--trace-event-file-pattern` that accepts a template + * string that supports `${rotation}` and `${pid}`: + * + * ```bash + * node --trace-event-categories v8 --trace-event-file-pattern '${pid}-${rotation}.log' server.js + * ``` + * + * The tracing system uses the same time source + * as the one used by `process.hrtime()`. + * However the trace-event timestamps are expressed in microseconds, + * unlike `process.hrtime()` which returns nanoseconds. + * + * The features from this module are not available in `Worker` threads. + * @experimental + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/trace_events.js) + */ +declare module 'trace_events' { + /** + * The `Tracing` object is used to enable or disable tracing for sets of + * categories. Instances are created using the + * `trace_events.createTracing()` method. + * + * When created, the `Tracing` object is disabled. Calling the + * `tracing.enable()` method adds the categories to the set of enabled trace + * event categories. Calling `tracing.disable()` will remove the categories + * from the set of enabled trace event categories. + */ + interface Tracing { + /** + * A comma-separated list of the trace event categories covered by this + * `Tracing` object. + */ + readonly categories: string; + /** + * Disables this `Tracing` object. + * + * Only trace event categories _not_ covered by other enabled `Tracing` + * objects and _not_ specified by the `--trace-event-categories` flag + * will be disabled. + */ + disable(): void; + /** + * Enables this `Tracing` object for the set of categories covered by + * the `Tracing` object. + */ + enable(): void; + /** + * `true` only if the `Tracing` object has been enabled. + */ + readonly enabled: boolean; + } + interface CreateTracingOptions { + /** + * An array of trace category names. Values included in the array are + * coerced to a string when possible. An error will be thrown if the + * value cannot be coerced. + */ + categories: string[]; + } + /** + * Creates and returns a `Tracing` object for the given set of `categories`. + * + * ```js + * const trace_events = require('trace_events'); + * const categories = ['node.perf', 'node.async_hooks']; + * const tracing = trace_events.createTracing({ categories }); + * tracing.enable(); + * // do stuff + * tracing.disable(); + * ``` + * @since v10.0.0 + * @return . + */ + function createTracing(options: CreateTracingOptions): Tracing; + /** + * Returns a comma-separated list of all currently-enabled trace event + * categories. The current set of enabled trace event categories is determined + * by the _union_ of all currently-enabled `Tracing` objects and any categories + * enabled using the `--trace-event-categories` flag. + * + * Given the file `test.js` below, the command`node --trace-event-categories node.perf test.js` will print`'node.async_hooks,node.perf'` to the console. + * + * ```js + * const trace_events = require('trace_events'); + * const t1 = trace_events.createTracing({ categories: ['node.async_hooks'] }); + * const t2 = trace_events.createTracing({ categories: ['node.perf'] }); + * const t3 = trace_events.createTracing({ categories: ['v8'] }); + * + * t1.enable(); + * t2.enable(); + * + * console.log(trace_events.getEnabledCategories()); + * ``` + * @since v10.0.0 + */ + function getEnabledCategories(): string | undefined; +} +declare module 'node:trace_events' { + export * from 'trace_events'; +} diff --git a/node_modules/@types/node/tty.d.ts b/node_modules/@types/node/tty.d.ts new file mode 100755 index 00000000..3bce2d36 --- /dev/null +++ b/node_modules/@types/node/tty.d.ts @@ -0,0 +1,204 @@ +/** + * The `tty` module provides the `tty.ReadStream` and `tty.WriteStream` classes. + * In most cases, it will not be necessary or possible to use this module directly. + * However, it can be accessed using: + * + * ```js + * const tty = require('tty'); + * ``` + * + * When Node.js detects that it is being run with a text terminal ("TTY") + * attached, `process.stdin` will, by default, be initialized as an instance of`tty.ReadStream` and both `process.stdout` and `process.stderr` will, by + * default, be instances of `tty.WriteStream`. The preferred method of determining + * whether Node.js is being run within a TTY context is to check that the value of + * the `process.stdout.isTTY` property is `true`: + * + * ```console + * $ node -p -e "Boolean(process.stdout.isTTY)" + * true + * $ node -p -e "Boolean(process.stdout.isTTY)" | cat + * false + * ``` + * + * In most cases, there should be little to no reason for an application to + * manually create instances of the `tty.ReadStream` and `tty.WriteStream`classes. + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/tty.js) + */ +declare module 'tty' { + import * as net from 'node:net'; + /** + * The `tty.isatty()` method returns `true` if the given `fd` is associated with + * a TTY and `false` if it is not, including whenever `fd` is not a non-negative + * integer. + * @since v0.5.8 + * @param fd A numeric file descriptor + */ + function isatty(fd: number): boolean; + /** + * Represents the readable side of a TTY. In normal circumstances `process.stdin` will be the only `tty.ReadStream` instance in a Node.js + * process and there should be no reason to create additional instances. + * @since v0.5.8 + */ + class ReadStream extends net.Socket { + constructor(fd: number, options?: net.SocketConstructorOpts); + /** + * A `boolean` that is `true` if the TTY is currently configured to operate as a + * raw device. Defaults to `false`. + * @since v0.7.7 + */ + isRaw: boolean; + /** + * Allows configuration of `tty.ReadStream` so that it operates as a raw device. + * + * When in raw mode, input is always available character-by-character, not + * including modifiers. Additionally, all special processing of characters by the + * terminal is disabled, including echoing input characters.Ctrl+C will no longer cause a `SIGINT` when in this mode. + * @since v0.7.7 + * @param mode If `true`, configures the `tty.ReadStream` to operate as a raw device. If `false`, configures the `tty.ReadStream` to operate in its default mode. The `readStream.isRaw` + * property will be set to the resulting mode. + * @return The read stream instance. + */ + setRawMode(mode: boolean): this; + /** + * A `boolean` that is always `true` for `tty.ReadStream` instances. + * @since v0.5.8 + */ + isTTY: boolean; + } + /** + * -1 - to the left from cursor + * 0 - the entire line + * 1 - to the right from cursor + */ + type Direction = -1 | 0 | 1; + /** + * Represents the writable side of a TTY. In normal circumstances,`process.stdout` and `process.stderr` will be the only`tty.WriteStream` instances created for a Node.js process and there + * should be no reason to create additional instances. + * @since v0.5.8 + */ + class WriteStream extends net.Socket { + constructor(fd: number); + addListener(event: string, listener: (...args: any[]) => void): this; + addListener(event: 'resize', listener: () => void): this; + emit(event: string | symbol, ...args: any[]): boolean; + emit(event: 'resize'): boolean; + on(event: string, listener: (...args: any[]) => void): this; + on(event: 'resize', listener: () => void): this; + once(event: string, listener: (...args: any[]) => void): this; + once(event: 'resize', listener: () => void): this; + prependListener(event: string, listener: (...args: any[]) => void): this; + prependListener(event: 'resize', listener: () => void): this; + prependOnceListener(event: string, listener: (...args: any[]) => void): this; + prependOnceListener(event: 'resize', listener: () => void): this; + /** + * `writeStream.clearLine()` clears the current line of this `WriteStream` in a + * direction identified by `dir`. + * @since v0.7.7 + * @param callback Invoked once the operation completes. + * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + */ + clearLine(dir: Direction, callback?: () => void): boolean; + /** + * `writeStream.clearScreenDown()` clears this `WriteStream` from the current + * cursor down. + * @since v0.7.7 + * @param callback Invoked once the operation completes. + * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + */ + clearScreenDown(callback?: () => void): boolean; + /** + * `writeStream.cursorTo()` moves this `WriteStream`'s cursor to the specified + * position. + * @since v0.7.7 + * @param callback Invoked once the operation completes. + * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + */ + cursorTo(x: number, y?: number, callback?: () => void): boolean; + cursorTo(x: number, callback: () => void): boolean; + /** + * `writeStream.moveCursor()` moves this `WriteStream`'s cursor _relative_ to its + * current position. + * @since v0.7.7 + * @param callback Invoked once the operation completes. + * @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + */ + moveCursor(dx: number, dy: number, callback?: () => void): boolean; + /** + * Returns: + * + * * `1` for 2, + * * `4` for 16, + * * `8` for 256, + * * `24` for 16,777,216 colors supported. + * + * Use this to determine what colors the terminal supports. Due to the nature of + * colors in terminals it is possible to either have false positives or false + * negatives. It depends on process information and the environment variables that + * may lie about what terminal is used. + * It is possible to pass in an `env` object to simulate the usage of a specific + * terminal. This can be useful to check how specific environment settings behave. + * + * To enforce a specific color support, use one of the below environment settings. + * + * * 2 colors: `FORCE_COLOR = 0` (Disables colors) + * * 16 colors: `FORCE_COLOR = 1` + * * 256 colors: `FORCE_COLOR = 2` + * * 16,777,216 colors: `FORCE_COLOR = 3` + * + * Disabling color support is also possible by using the `NO_COLOR` and`NODE_DISABLE_COLORS` environment variables. + * @since v9.9.0 + * @param [env=process.env] An object containing the environment variables to check. This enables simulating the usage of a specific terminal. + */ + getColorDepth(env?: object): number; + /** + * Returns `true` if the `writeStream` supports at least as many colors as provided + * in `count`. Minimum support is 2 (black and white). + * + * This has the same false positives and negatives as described in `writeStream.getColorDepth()`. + * + * ```js + * process.stdout.hasColors(); + * // Returns true or false depending on if `stdout` supports at least 16 colors. + * process.stdout.hasColors(256); + * // Returns true or false depending on if `stdout` supports at least 256 colors. + * process.stdout.hasColors({ TMUX: '1' }); + * // Returns true. + * process.stdout.hasColors(2 ** 24, { TMUX: '1' }); + * // Returns false (the environment setting pretends to support 2 ** 8 colors). + * ``` + * @since v11.13.0, v10.16.0 + * @param [count=16] The number of colors that are requested (minimum 2). + * @param [env=process.env] An object containing the environment variables to check. This enables simulating the usage of a specific terminal. + */ + hasColors(count?: number): boolean; + hasColors(env?: object): boolean; + hasColors(count: number, env?: object): boolean; + /** + * `writeStream.getWindowSize()` returns the size of the TTY + * corresponding to this `WriteStream`. The array is of the type`[numColumns, numRows]` where `numColumns` and `numRows` represent the number + * of columns and rows in the corresponding TTY. + * @since v0.7.7 + */ + getWindowSize(): [number, number]; + /** + * A `number` specifying the number of columns the TTY currently has. This property + * is updated whenever the `'resize'` event is emitted. + * @since v0.7.7 + */ + columns: number; + /** + * A `number` specifying the number of rows the TTY currently has. This property + * is updated whenever the `'resize'` event is emitted. + * @since v0.7.7 + */ + rows: number; + /** + * A `boolean` that is always `true`. + * @since v0.5.8 + */ + isTTY: boolean; + } +} +declare module 'node:tty' { + export * from 'tty'; +} diff --git a/node_modules/@types/node/url.d.ts b/node_modules/@types/node/url.d.ts new file mode 100755 index 00000000..602fca03 --- /dev/null +++ b/node_modules/@types/node/url.d.ts @@ -0,0 +1,821 @@ +/** + * The `url` module provides utilities for URL resolution and parsing. It can be + * accessed using: + * + * ```js + * import url from 'url'; + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/url.js) + */ +declare module 'url' { + import { Blob } from 'node:buffer'; + import { ClientRequestArgs } from 'node:http'; + import { ParsedUrlQuery, ParsedUrlQueryInput } from 'node:querystring'; + // Input to `url.format` + interface UrlObject { + auth?: string | null | undefined; + hash?: string | null | undefined; + host?: string | null | undefined; + hostname?: string | null | undefined; + href?: string | null | undefined; + pathname?: string | null | undefined; + protocol?: string | null | undefined; + search?: string | null | undefined; + slashes?: boolean | null | undefined; + port?: string | number | null | undefined; + query?: string | null | ParsedUrlQueryInput | undefined; + } + // Output of `url.parse` + interface Url { + auth: string | null; + hash: string | null; + host: string | null; + hostname: string | null; + href: string; + path: string | null; + pathname: string | null; + protocol: string | null; + search: string | null; + slashes: boolean | null; + port: string | null; + query: string | null | ParsedUrlQuery; + } + interface UrlWithParsedQuery extends Url { + query: ParsedUrlQuery; + } + interface UrlWithStringQuery extends Url { + query: string | null; + } + /** + * The `url.parse()` method takes a URL string, parses it, and returns a URL + * object. + * + * A `TypeError` is thrown if `urlString` is not a string. + * + * A `URIError` is thrown if the `auth` property is present but cannot be decoded. + * + * Use of the legacy `url.parse()` method is discouraged. Users should + * use the WHATWG `URL` API. Because the `url.parse()` method uses a + * lenient, non-standard algorithm for parsing URL strings, security + * issues can be introduced. Specifically, issues with [host name spoofing](https://hackerone.com/reports/678487) and + * incorrect handling of usernames and passwords have been identified. + * @since v0.1.25 + * @deprecated Legacy: Use the WHATWG URL API instead. + * @param urlString The URL string to parse. + * @param [parseQueryString=false] If `true`, the `query` property will always be set to an object returned by the {@link querystring} module's `parse()` method. If `false`, the `query` property + * on the returned URL object will be an unparsed, undecoded string. + * @param [slashesDenoteHost=false] If `true`, the first token after the literal string `//` and preceding the next `/` will be interpreted as the `host`. For instance, given `//foo/bar`, the + * result would be `{host: 'foo', pathname: '/bar'}` rather than `{pathname: '//foo/bar'}`. + */ + function parse(urlString: string): UrlWithStringQuery; + function parse(urlString: string, parseQueryString: false | undefined, slashesDenoteHost?: boolean): UrlWithStringQuery; + function parse(urlString: string, parseQueryString: true, slashesDenoteHost?: boolean): UrlWithParsedQuery; + function parse(urlString: string, parseQueryString: boolean, slashesDenoteHost?: boolean): Url; + /** + * The URL object has both a `toString()` method and `href` property that return string serializations of the URL. + * These are not, however, customizable in any way. The `url.format(URL[, options])` method allows for basic + * customization of the output. + * Returns a customizable serialization of a URL `String` representation of a `WHATWG URL` object. + * + * ```js + * import url from 'url'; + * const myURL = new URL('https://a:b@測試?abc#foo'); + * + * console.log(myURL.href); + * // Prints https://a:b@xn--g6w251d/?abc#foo + * + * console.log(myURL.toString()); + * // Prints https://a:b@xn--g6w251d/?abc#foo + * + * console.log(url.format(myURL, { fragment: false, unicode: true, auth: false })); + * // Prints 'https://測試/?abc' + * ``` + * @since v7.6.0 + * @param urlObject A `WHATWG URL` object + * @param options + */ + function format(urlObject: URL, options?: URLFormatOptions): string; + /** + * The `url.format()` method returns a formatted URL string derived from`urlObject`. + * + * ```js + * const url = require('url'); + * url.format({ + * protocol: 'https', + * hostname: 'example.com', + * pathname: '/some/path', + * query: { + * page: 1, + * format: 'json' + * } + * }); + * + * // => 'https://example.com/some/path?page=1&format=json' + * ``` + * + * If `urlObject` is not an object or a string, `url.format()` will throw a `TypeError`. + * + * The formatting process operates as follows: + * + * * A new empty string `result` is created. + * * If `urlObject.protocol` is a string, it is appended as-is to `result`. + * * Otherwise, if `urlObject.protocol` is not `undefined` and is not a string, an `Error` is thrown. + * * For all string values of `urlObject.protocol` that _do not end_ with an ASCII + * colon (`:`) character, the literal string `:` will be appended to `result`. + * * If either of the following conditions is true, then the literal string `//`will be appended to `result`: + * * `urlObject.slashes` property is true; + * * `urlObject.protocol` begins with `http`, `https`, `ftp`, `gopher`, or`file`; + * * If the value of the `urlObject.auth` property is truthy, and either`urlObject.host` or `urlObject.hostname` are not `undefined`, the value of`urlObject.auth` will be coerced into a string + * and appended to `result`followed by the literal string `@`. + * * If the `urlObject.host` property is `undefined` then: + * * If the `urlObject.hostname` is a string, it is appended to `result`. + * * Otherwise, if `urlObject.hostname` is not `undefined` and is not a string, + * an `Error` is thrown. + * * If the `urlObject.port` property value is truthy, and `urlObject.hostname`is not `undefined`: + * * The literal string `:` is appended to `result`, and + * * The value of `urlObject.port` is coerced to a string and appended to`result`. + * * Otherwise, if the `urlObject.host` property value is truthy, the value of`urlObject.host` is coerced to a string and appended to `result`. + * * If the `urlObject.pathname` property is a string that is not an empty string: + * * If the `urlObject.pathname`_does not start_ with an ASCII forward slash + * (`/`), then the literal string `'/'` is appended to `result`. + * * The value of `urlObject.pathname` is appended to `result`. + * * Otherwise, if `urlObject.pathname` is not `undefined` and is not a string, an `Error` is thrown. + * * If the `urlObject.search` property is `undefined` and if the `urlObject.query`property is an `Object`, the literal string `?` is appended to `result`followed by the output of calling the + * `querystring` module's `stringify()`method passing the value of `urlObject.query`. + * * Otherwise, if `urlObject.search` is a string: + * * If the value of `urlObject.search`_does not start_ with the ASCII question + * mark (`?`) character, the literal string `?` is appended to `result`. + * * The value of `urlObject.search` is appended to `result`. + * * Otherwise, if `urlObject.search` is not `undefined` and is not a string, an `Error` is thrown. + * * If the `urlObject.hash` property is a string: + * * If the value of `urlObject.hash`_does not start_ with the ASCII hash (`#`) + * character, the literal string `#` is appended to `result`. + * * The value of `urlObject.hash` is appended to `result`. + * * Otherwise, if the `urlObject.hash` property is not `undefined` and is not a + * string, an `Error` is thrown. + * * `result` is returned. + * @since v0.1.25 + * @deprecated Legacy: Use the WHATWG URL API instead. + * @param urlObject A URL object (as returned by `url.parse()` or constructed otherwise). If a string, it is converted to an object by passing it to `url.parse()`. + */ + function format(urlObject: UrlObject | string): string; + /** + * The `url.resolve()` method resolves a target URL relative to a base URL in a + * manner similar to that of a Web browser resolving an anchor tag HREF. + * + * ```js + * const url = require('url'); + * url.resolve('/one/two/three', 'four'); // '/one/two/four' + * url.resolve('http://example.com/', '/one'); // 'http://example.com/one' + * url.resolve('http://example.com/one', '/two'); // 'http://example.com/two' + * ``` + * + * You can achieve the same result using the WHATWG URL API: + * + * ```js + * function resolve(from, to) { + * const resolvedUrl = new URL(to, new URL(from, 'resolve://')); + * if (resolvedUrl.protocol === 'resolve:') { + * // `from` is a relative URL. + * const { pathname, search, hash } = resolvedUrl; + * return pathname + search + hash; + * } + * return resolvedUrl.toString(); + * } + * + * resolve('/one/two/three', 'four'); // '/one/two/four' + * resolve('http://example.com/', '/one'); // 'http://example.com/one' + * resolve('http://example.com/one', '/two'); // 'http://example.com/two' + * ``` + * @since v0.1.25 + * @deprecated Legacy: Use the WHATWG URL API instead. + * @param from The Base URL being resolved against. + * @param to The HREF URL being resolved. + */ + function resolve(from: string, to: string): string; + /** + * Returns the [Punycode](https://tools.ietf.org/html/rfc5891#section-4.4) ASCII serialization of the `domain`. If `domain` is an + * invalid domain, the empty string is returned. + * + * It performs the inverse operation to {@link domainToUnicode}. + * + * This feature is only available if the `node` executable was compiled with `ICU` enabled. If not, the domain names are passed through unchanged. + * + * ```js + * import url from 'url'; + * + * console.log(url.domainToASCII('español.com')); + * // Prints xn--espaol-zwa.com + * console.log(url.domainToASCII('中文.com')); + * // Prints xn--fiq228c.com + * console.log(url.domainToASCII('xn--iñvalid.com')); + * // Prints an empty string + * ``` + * @since v7.4.0, v6.13.0 + */ + function domainToASCII(domain: string): string; + /** + * Returns the Unicode serialization of the `domain`. If `domain` is an invalid + * domain, the empty string is returned. + * + * It performs the inverse operation to {@link domainToASCII}. + * + * This feature is only available if the `node` executable was compiled with `ICU` enabled. If not, the domain names are passed through unchanged. + * + * ```js + * import url from 'url'; + * + * console.log(url.domainToUnicode('xn--espaol-zwa.com')); + * // Prints español.com + * console.log(url.domainToUnicode('xn--fiq228c.com')); + * // Prints 中文.com + * console.log(url.domainToUnicode('xn--iñvalid.com')); + * // Prints an empty string + * ``` + * @since v7.4.0, v6.13.0 + */ + function domainToUnicode(domain: string): string; + /** + * This function ensures the correct decodings of percent-encoded characters as + * well as ensuring a cross-platform valid absolute path string. + * + * ```js + * import { fileURLToPath } from 'url'; + * + * const __filename = fileURLToPath(import.meta.url); + * + * new URL('file:///C:/path/').pathname; // Incorrect: /C:/path/ + * fileURLToPath('file:///C:/path/'); // Correct: C:\path\ (Windows) + * + * new URL('file://nas/foo.txt').pathname; // Incorrect: /foo.txt + * fileURLToPath('file://nas/foo.txt'); // Correct: \\nas\foo.txt (Windows) + * + * new URL('file:///你好.txt').pathname; // Incorrect: /%E4%BD%A0%E5%A5%BD.txt + * fileURLToPath('file:///你好.txt'); // Correct: /你好.txt (POSIX) + * + * new URL('file:///hello world').pathname; // Incorrect: /hello%20world + * fileURLToPath('file:///hello world'); // Correct: /hello world (POSIX) + * ``` + * @since v10.12.0 + * @param url The file URL string or URL object to convert to a path. + * @return The fully-resolved platform-specific Node.js file path. + */ + function fileURLToPath(url: string | URL): string; + /** + * This function ensures that `path` is resolved absolutely, and that the URL + * control characters are correctly encoded when converting into a File URL. + * + * ```js + * import { pathToFileURL } from 'url'; + * + * new URL('/foo#1', 'file:'); // Incorrect: file:///foo#1 + * pathToFileURL('/foo#1'); // Correct: file:///foo%231 (POSIX) + * + * new URL('/some/path%.c', 'file:'); // Incorrect: file:///some/path%.c + * pathToFileURL('/some/path%.c'); // Correct: file:///some/path%25.c (POSIX) + * ``` + * @since v10.12.0 + * @param path The path to convert to a File URL. + * @return The file URL object. + */ + function pathToFileURL(path: string): URL; + /** + * This utility function converts a URL object into an ordinary options object as + * expected by the `http.request()` and `https.request()` APIs. + * + * ```js + * import { urlToHttpOptions } from 'url'; + * const myURL = new URL('https://a:b@測試?abc#foo'); + * + * console.log(urlToHttpOptions(myURL)); + * + * { + * protocol: 'https:', + * hostname: 'xn--g6w251d', + * hash: '#foo', + * search: '?abc', + * pathname: '/', + * path: '/?abc', + * href: 'https://a:b@xn--g6w251d/?abc#foo', + * auth: 'a:b' + * } + * + * ``` + * @since v15.7.0 + * @param url The `WHATWG URL` object to convert to an options object. + * @return Options object + */ + function urlToHttpOptions(url: URL): ClientRequestArgs; + interface URLFormatOptions { + auth?: boolean | undefined; + fragment?: boolean | undefined; + search?: boolean | undefined; + unicode?: boolean | undefined; + } + /** + * Browser-compatible `URL` class, implemented by following the WHATWG URL + * Standard. [Examples of parsed URLs](https://url.spec.whatwg.org/#example-url-parsing) may be found in the Standard itself. + * The `URL` class is also available on the global object. + * + * In accordance with browser conventions, all properties of `URL` objects + * are implemented as getters and setters on the class prototype, rather than as + * data properties on the object itself. Thus, unlike `legacy urlObject` s, + * using the `delete` keyword on any properties of `URL` objects (e.g. `delete myURL.protocol`, `delete myURL.pathname`, etc) has no effect but will still + * return `true`. + * @since v7.0.0, v6.13.0 + */ + class URL { + /** + * Creates a `'blob:nodedata:...'` URL string that represents the given `Blob` object and can be used to retrieve the `Blob` later. + * + * ```js + * const { + * Blob, + * resolveObjectURL, + * } = require('buffer'); + * + * const blob = new Blob(['hello']); + * const id = URL.createObjectURL(blob); + * + * // later... + * + * const otherBlob = resolveObjectURL(id); + * console.log(otherBlob.size); + * ``` + * + * The data stored by the registered `Blob` will be retained in memory until`URL.revokeObjectURL()` is called to remove it. + * + * `Blob` objects are registered within the current thread. If using Worker + * Threads, `Blob` objects registered within one Worker will not be available + * to other workers or the main thread. + * @since v16.7.0 + * @experimental + */ + static createObjectURL(blob: Blob): string; + /** + * Removes the stored `Blob` identified by the given ID. + * @since v16.7.0 + * @experimental + * @param id A `'blob:nodedata:...` URL string returned by a prior call to `URL.createObjectURL()`. + */ + static revokeObjectURL(objectUrl: string): void; + constructor(input: string, base?: string | URL); + /** + * Gets and sets the fragment portion of the URL. + * + * ```js + * const myURL = new URL('https://example.org/foo#bar'); + * console.log(myURL.hash); + * // Prints #bar + * + * myURL.hash = 'baz'; + * console.log(myURL.href); + * // Prints https://example.org/foo#baz + * ``` + * + * Invalid URL characters included in the value assigned to the `hash` property + * are `percent-encoded`. The selection of which characters to + * percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. + */ + hash: string; + /** + * Gets and sets the host portion of the URL. + * + * ```js + * const myURL = new URL('https://example.org:81/foo'); + * console.log(myURL.host); + * // Prints example.org:81 + * + * myURL.host = 'example.com:82'; + * console.log(myURL.href); + * // Prints https://example.com:82/foo + * ``` + * + * Invalid host values assigned to the `host` property are ignored. + */ + host: string; + /** + * Gets and sets the host name portion of the URL. The key difference between`url.host` and `url.hostname` is that `url.hostname` does _not_ include the + * port. + * + * ```js + * const myURL = new URL('https://example.org:81/foo'); + * console.log(myURL.hostname); + * // Prints example.org + * + * // Setting the hostname does not change the port + * myURL.hostname = 'example.com:82'; + * console.log(myURL.href); + * // Prints https://example.com:81/foo + * + * // Use myURL.host to change the hostname and port + * myURL.host = 'example.org:82'; + * console.log(myURL.href); + * // Prints https://example.org:82/foo + * ``` + * + * Invalid host name values assigned to the `hostname` property are ignored. + */ + hostname: string; + /** + * Gets and sets the serialized URL. + * + * ```js + * const myURL = new URL('https://example.org/foo'); + * console.log(myURL.href); + * // Prints https://example.org/foo + * + * myURL.href = 'https://example.com/bar'; + * console.log(myURL.href); + * // Prints https://example.com/bar + * ``` + * + * Getting the value of the `href` property is equivalent to calling {@link toString}. + * + * Setting the value of this property to a new value is equivalent to creating a + * new `URL` object using `new URL(value)`. Each of the `URL`object's properties will be modified. + * + * If the value assigned to the `href` property is not a valid URL, a `TypeError`will be thrown. + */ + href: string; + /** + * Gets the read-only serialization of the URL's origin. + * + * ```js + * const myURL = new URL('https://example.org/foo/bar?baz'); + * console.log(myURL.origin); + * // Prints https://example.org + * ``` + * + * ```js + * const idnURL = new URL('https://測試'); + * console.log(idnURL.origin); + * // Prints https://xn--g6w251d + * + * console.log(idnURL.hostname); + * // Prints xn--g6w251d + * ``` + */ + readonly origin: string; + /** + * Gets and sets the password portion of the URL. + * + * ```js + * const myURL = new URL('https://abc:xyz@example.com'); + * console.log(myURL.password); + * // Prints xyz + * + * myURL.password = '123'; + * console.log(myURL.href); + * // Prints https://abc:123@example.com + * ``` + * + * Invalid URL characters included in the value assigned to the `password` property + * are `percent-encoded`. The selection of which characters to + * percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. + */ + password: string; + /** + * Gets and sets the path portion of the URL. + * + * ```js + * const myURL = new URL('https://example.org/abc/xyz?123'); + * console.log(myURL.pathname); + * // Prints /abc/xyz + * + * myURL.pathname = '/abcdef'; + * console.log(myURL.href); + * // Prints https://example.org/abcdef?123 + * ``` + * + * Invalid URL characters included in the value assigned to the `pathname`property are `percent-encoded`. The selection of which characters + * to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. + */ + pathname: string; + /** + * Gets and sets the port portion of the URL. + * + * The port value may be a number or a string containing a number in the range`0` to `65535` (inclusive). Setting the value to the default port of the`URL` objects given `protocol` will + * result in the `port` value becoming + * the empty string (`''`). + * + * The port value can be an empty string in which case the port depends on + * the protocol/scheme: + * + * + * + * Upon assigning a value to the port, the value will first be converted to a + * string using `.toString()`. + * + * If that string is invalid but it begins with a number, the leading number is + * assigned to `port`. + * If the number lies outside the range denoted above, it is ignored. + * + * ```js + * const myURL = new URL('https://example.org:8888'); + * console.log(myURL.port); + * // Prints 8888 + * + * // Default ports are automatically transformed to the empty string + * // (HTTPS protocol's default port is 443) + * myURL.port = '443'; + * console.log(myURL.port); + * // Prints the empty string + * console.log(myURL.href); + * // Prints https://example.org/ + * + * myURL.port = 1234; + * console.log(myURL.port); + * // Prints 1234 + * console.log(myURL.href); + * // Prints https://example.org:1234/ + * + * // Completely invalid port strings are ignored + * myURL.port = 'abcd'; + * console.log(myURL.port); + * // Prints 1234 + * + * // Leading numbers are treated as a port number + * myURL.port = '5678abcd'; + * console.log(myURL.port); + * // Prints 5678 + * + * // Non-integers are truncated + * myURL.port = 1234.5678; + * console.log(myURL.port); + * // Prints 1234 + * + * // Out-of-range numbers which are not represented in scientific notation + * // will be ignored. + * myURL.port = 1e10; // 10000000000, will be range-checked as described below + * console.log(myURL.port); + * // Prints 1234 + * ``` + * + * Numbers which contain a decimal point, + * such as floating-point numbers or numbers in scientific notation, + * are not an exception to this rule. + * Leading numbers up to the decimal point will be set as the URL's port, + * assuming they are valid: + * + * ```js + * myURL.port = 4.567e21; + * console.log(myURL.port); + * // Prints 4 (because it is the leading number in the string '4.567e21') + * ``` + */ + port: string; + /** + * Gets and sets the protocol portion of the URL. + * + * ```js + * const myURL = new URL('https://example.org'); + * console.log(myURL.protocol); + * // Prints https: + * + * myURL.protocol = 'ftp'; + * console.log(myURL.href); + * // Prints ftp://example.org/ + * ``` + * + * Invalid URL protocol values assigned to the `protocol` property are ignored. + */ + protocol: string; + /** + * Gets and sets the serialized query portion of the URL. + * + * ```js + * const myURL = new URL('https://example.org/abc?123'); + * console.log(myURL.search); + * // Prints ?123 + * + * myURL.search = 'abc=xyz'; + * console.log(myURL.href); + * // Prints https://example.org/abc?abc=xyz + * ``` + * + * Any invalid URL characters appearing in the value assigned the `search`property will be `percent-encoded`. The selection of which + * characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. + */ + search: string; + /** + * Gets the `URLSearchParams` object representing the query parameters of the + * URL. This property is read-only but the `URLSearchParams` object it provides + * can be used to mutate the URL instance; to replace the entirety of query + * parameters of the URL, use the {@link search} setter. See `URLSearchParams` documentation for details. + * + * Use care when using `.searchParams` to modify the `URL` because, + * per the WHATWG specification, the `URLSearchParams` object uses + * different rules to determine which characters to percent-encode. For + * instance, the `URL` object will not percent encode the ASCII tilde (`~`) + * character, while `URLSearchParams` will always encode it: + * + * ```js + * const myUrl = new URL('https://example.org/abc?foo=~bar'); + * + * console.log(myUrl.search); // prints ?foo=~bar + * + * // Modify the URL via searchParams... + * myUrl.searchParams.sort(); + * + * console.log(myUrl.search); // prints ?foo=%7Ebar + * ``` + */ + readonly searchParams: URLSearchParams; + /** + * Gets and sets the username portion of the URL. + * + * ```js + * const myURL = new URL('https://abc:xyz@example.com'); + * console.log(myURL.username); + * // Prints abc + * + * myURL.username = '123'; + * console.log(myURL.href); + * // Prints https://123:xyz@example.com/ + * ``` + * + * Any invalid URL characters appearing in the value assigned the `username`property will be `percent-encoded`. The selection of which + * characters to percent-encode may vary somewhat from what the {@link parse} and {@link format} methods would produce. + */ + username: string; + /** + * The `toString()` method on the `URL` object returns the serialized URL. The + * value returned is equivalent to that of {@link href} and {@link toJSON}. + */ + toString(): string; + /** + * The `toJSON()` method on the `URL` object returns the serialized URL. The + * value returned is equivalent to that of {@link href} and {@link toString}. + * + * This method is automatically called when an `URL` object is serialized + * with [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify). + * + * ```js + * const myURLs = [ + * new URL('https://www.example.com'), + * new URL('https://test.example.org'), + * ]; + * console.log(JSON.stringify(myURLs)); + * // Prints ["https://www.example.com/","https://test.example.org/"] + * ``` + */ + toJSON(): string; + } + /** + * The `URLSearchParams` API provides read and write access to the query of a`URL`. The `URLSearchParams` class can also be used standalone with one of the + * four following constructors. + * The `URLSearchParams` class is also available on the global object. + * + * The WHATWG `URLSearchParams` interface and the `querystring` module have + * similar purpose, but the purpose of the `querystring` module is more + * general, as it allows the customization of delimiter characters (`&` and `=`). + * On the other hand, this API is designed purely for URL query strings. + * + * ```js + * const myURL = new URL('https://example.org/?abc=123'); + * console.log(myURL.searchParams.get('abc')); + * // Prints 123 + * + * myURL.searchParams.append('abc', 'xyz'); + * console.log(myURL.href); + * // Prints https://example.org/?abc=123&abc=xyz + * + * myURL.searchParams.delete('abc'); + * myURL.searchParams.set('a', 'b'); + * console.log(myURL.href); + * // Prints https://example.org/?a=b + * + * const newSearchParams = new URLSearchParams(myURL.searchParams); + * // The above is equivalent to + * // const newSearchParams = new URLSearchParams(myURL.search); + * + * newSearchParams.append('a', 'c'); + * console.log(myURL.href); + * // Prints https://example.org/?a=b + * console.log(newSearchParams.toString()); + * // Prints a=b&a=c + * + * // newSearchParams.toString() is implicitly called + * myURL.search = newSearchParams; + * console.log(myURL.href); + * // Prints https://example.org/?a=b&a=c + * newSearchParams.delete('a'); + * console.log(myURL.href); + * // Prints https://example.org/?a=b&a=c + * ``` + * @since v7.5.0, v6.13.0 + */ + class URLSearchParams implements Iterable<[string, string]> { + constructor(init?: URLSearchParams | string | Record> | Iterable<[string, string]> | ReadonlyArray<[string, string]>); + /** + * Append a new name-value pair to the query string. + */ + append(name: string, value: string): void; + /** + * Remove all name-value pairs whose name is `name`. + */ + delete(name: string): void; + /** + * Returns an ES6 `Iterator` over each of the name-value pairs in the query. + * Each item of the iterator is a JavaScript `Array`. The first item of the `Array`is the `name`, the second item of the `Array` is the `value`. + * + * Alias for `urlSearchParams[@@iterator]()`. + */ + entries(): IterableIterator<[string, string]>; + /** + * Iterates over each name-value pair in the query and invokes the given function. + * + * ```js + * const myURL = new URL('https://example.org/?a=b&c=d'); + * myURL.searchParams.forEach((value, name, searchParams) => { + * console.log(name, value, myURL.searchParams === searchParams); + * }); + * // Prints: + * // a b true + * // c d true + * ``` + * @param fn Invoked for each name-value pair in the query + * @param thisArg To be used as `this` value for when `fn` is called + */ + forEach(callback: (this: TThis, value: string, name: string, searchParams: this) => void, thisArg?: TThis): void; + /** + * Returns the value of the first name-value pair whose name is `name`. If there + * are no such pairs, `null` is returned. + * @return or `null` if there is no name-value pair with the given `name`. + */ + get(name: string): string | null; + /** + * Returns the values of all name-value pairs whose name is `name`. If there are + * no such pairs, an empty array is returned. + */ + getAll(name: string): string[]; + /** + * Returns `true` if there is at least one name-value pair whose name is `name`. + */ + has(name: string): boolean; + /** + * Returns an ES6 `Iterator` over the names of each name-value pair. + * + * ```js + * const params = new URLSearchParams('foo=bar&foo=baz'); + * for (const name of params.keys()) { + * console.log(name); + * } + * // Prints: + * // foo + * // foo + * ``` + */ + keys(): IterableIterator; + /** + * Sets the value in the `URLSearchParams` object associated with `name` to`value`. If there are any pre-existing name-value pairs whose names are `name`, + * set the first such pair's value to `value` and remove all others. If not, + * append the name-value pair to the query string. + * + * ```js + * const params = new URLSearchParams(); + * params.append('foo', 'bar'); + * params.append('foo', 'baz'); + * params.append('abc', 'def'); + * console.log(params.toString()); + * // Prints foo=bar&foo=baz&abc=def + * + * params.set('foo', 'def'); + * params.set('xyz', 'opq'); + * console.log(params.toString()); + * // Prints foo=def&abc=def&xyz=opq + * ``` + */ + set(name: string, value: string): void; + /** + * Sort all existing name-value pairs in-place by their names. Sorting is done + * with a [stable sorting algorithm](https://en.wikipedia.org/wiki/Sorting_algorithm#Stability), so relative order between name-value pairs + * with the same name is preserved. + * + * This method can be used, in particular, to increase cache hits. + * + * ```js + * const params = new URLSearchParams('query[]=abc&type=search&query[]=123'); + * params.sort(); + * console.log(params.toString()); + * // Prints query%5B%5D=abc&query%5B%5D=123&type=search + * ``` + * @since v7.7.0, v6.13.0 + */ + sort(): void; + /** + * Returns the search parameters serialized as a string, with characters + * percent-encoded where necessary. + */ + toString(): string; + /** + * Returns an ES6 `Iterator` over the values of each name-value pair. + */ + values(): IterableIterator; + [Symbol.iterator](): IterableIterator<[string, string]>; + } +} +declare module 'node:url' { + export * from 'url'; +} diff --git a/node_modules/@types/node/util.d.ts b/node_modules/@types/node/util.d.ts new file mode 100755 index 00000000..d0f4c176 --- /dev/null +++ b/node_modules/@types/node/util.d.ts @@ -0,0 +1,1594 @@ +/** + * The `util` module supports the needs of Node.js internal APIs. Many of the + * utilities are useful for application and module developers as well. To access + * it: + * + * ```js + * const util = require('util'); + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/util.js) + */ +declare module 'util' { + import * as types from 'node:util/types'; + export interface InspectOptions { + /** + * If set to `true`, getters are going to be + * inspected as well. If set to `'get'` only getters without setter are going + * to be inspected. If set to `'set'` only getters having a corresponding + * setter are going to be inspected. This might cause side effects depending on + * the getter function. + * @default `false` + */ + getters?: 'get' | 'set' | boolean | undefined; + showHidden?: boolean | undefined; + /** + * @default 2 + */ + depth?: number | null | undefined; + colors?: boolean | undefined; + customInspect?: boolean | undefined; + showProxy?: boolean | undefined; + maxArrayLength?: number | null | undefined; + /** + * Specifies the maximum number of characters to + * include when formatting. Set to `null` or `Infinity` to show all elements. + * Set to `0` or negative to show no characters. + * @default 10000 + */ + maxStringLength?: number | null | undefined; + breakLength?: number | undefined; + /** + * Setting this to `false` causes each object key + * to be displayed on a new line. It will also add new lines to text that is + * longer than `breakLength`. If set to a number, the most `n` inner elements + * are united on a single line as long as all properties fit into + * `breakLength`. Short array elements are also grouped together. Note that no + * text will be reduced below 16 characters, no matter the `breakLength` size. + * For more information, see the example below. + * @default `true` + */ + compact?: boolean | number | undefined; + sorted?: boolean | ((a: string, b: string) => number) | undefined; + } + export type Style = 'special' | 'number' | 'bigint' | 'boolean' | 'undefined' | 'null' | 'string' | 'symbol' | 'date' | 'regexp' | 'module'; + export type CustomInspectFunction = (depth: number, options: InspectOptionsStylized) => string; + export interface InspectOptionsStylized extends InspectOptions { + stylize(text: string, styleType: Style): string; + } + /** + * The `util.format()` method returns a formatted string using the first argument + * as a `printf`\-like format string which can contain zero or more format + * specifiers. Each specifier is replaced with the converted value from the + * corresponding argument. Supported specifiers are: + * + * If a specifier does not have a corresponding argument, it is not replaced: + * + * ```js + * util.format('%s:%s', 'foo'); + * // Returns: 'foo:%s' + * ``` + * + * Values that are not part of the format string are formatted using`util.inspect()` if their type is not `string`. + * + * If there are more arguments passed to the `util.format()` method than the + * number of specifiers, the extra arguments are concatenated to the returned + * string, separated by spaces: + * + * ```js + * util.format('%s:%s', 'foo', 'bar', 'baz'); + * // Returns: 'foo:bar baz' + * ``` + * + * If the first argument does not contain a valid format specifier, `util.format()`returns a string that is the concatenation of all arguments separated by spaces: + * + * ```js + * util.format(1, 2, 3); + * // Returns: '1 2 3' + * ``` + * + * If only one argument is passed to `util.format()`, it is returned as it is + * without any formatting: + * + * ```js + * util.format('%% %s'); + * // Returns: '%% %s' + * ``` + * + * `util.format()` is a synchronous method that is intended as a debugging tool. + * Some input values can have a significant performance overhead that can block the + * event loop. Use this function with care and never in a hot code path. + * @since v0.5.3 + * @param format A `printf`-like format string. + */ + export function format(format?: any, ...param: any[]): string; + /** + * This function is identical to {@link format}, except in that it takes + * an `inspectOptions` argument which specifies options that are passed along to {@link inspect}. + * + * ```js + * util.formatWithOptions({ colors: true }, 'See object %O', { foo: 42 }); + * // Returns 'See object { foo: 42 }', where `42` is colored as a number + * // when printed to a terminal. + * ``` + * @since v10.0.0 + */ + export function formatWithOptions(inspectOptions: InspectOptions, format?: any, ...param: any[]): string; + /** + * Returns the string name for a numeric error code that comes from a Node.js API. + * The mapping between error codes and error names is platform-dependent. + * See `Common System Errors` for the names of common errors. + * + * ```js + * fs.access('file/that/does/not/exist', (err) => { + * const name = util.getSystemErrorName(err.errno); + * console.error(name); // ENOENT + * }); + * ``` + * @since v9.7.0 + */ + export function getSystemErrorName(err: number): string; + /** + * Returns a Map of all system error codes available from the Node.js API. + * The mapping between error codes and error names is platform-dependent. + * See `Common System Errors` for the names of common errors. + * + * ```js + * fs.access('file/that/does/not/exist', (err) => { + * const errorMap = util.getSystemErrorMap(); + * const name = errorMap.get(err.errno); + * console.error(name); // ENOENT + * }); + * ``` + * @since v16.0.0 + */ + export function getSystemErrorMap(): Map; + /** + * The `util.log()` method prints the given `string` to `stdout` with an included + * timestamp. + * + * ```js + * const util = require('util'); + * + * util.log('Timestamped message.'); + * ``` + * @since v0.3.0 + * @deprecated Since v6.0.0 - Use a third party module instead. + */ + export function log(string: string): void; + /** + * Returns the `string` after replacing any surrogate code points + * (or equivalently, any unpaired surrogate code units) with the + * Unicode "replacement character" U+FFFD. + * @since v16.8.0 + */ + export function toUSVString(string: string): string; + /** + * The `util.inspect()` method returns a string representation of `object` that is + * intended for debugging. The output of `util.inspect` may change at any time + * and should not be depended upon programmatically. Additional `options` may be + * passed that alter the result.`util.inspect()` will use the constructor's name and/or `@@toStringTag` to make + * an identifiable tag for an inspected value. + * + * ```js + * class Foo { + * get [Symbol.toStringTag]() { + * return 'bar'; + * } + * } + * + * class Bar {} + * + * const baz = Object.create(null, { [Symbol.toStringTag]: { value: 'foo' } }); + * + * util.inspect(new Foo()); // 'Foo [bar] {}' + * util.inspect(new Bar()); // 'Bar {}' + * util.inspect(baz); // '[foo] {}' + * ``` + * + * Circular references point to their anchor by using a reference index: + * + * ```js + * const { inspect } = require('util'); + * + * const obj = {}; + * obj.a = [obj]; + * obj.b = {}; + * obj.b.inner = obj.b; + * obj.b.obj = obj; + * + * console.log(inspect(obj)); + * // { + * // a: [ [Circular *1] ], + * // b: { inner: [Circular *2], obj: [Circular *1] } + * // } + * ``` + * + * The following example inspects all properties of the `util` object: + * + * ```js + * const util = require('util'); + * + * console.log(util.inspect(util, { showHidden: true, depth: null })); + * ``` + * + * The following example highlights the effect of the `compact` option: + * + * ```js + * const util = require('util'); + * + * const o = { + * a: [1, 2, [[ + * 'Lorem ipsum dolor sit amet,\nconsectetur adipiscing elit, sed do ' + + * 'eiusmod \ntempor incididunt ut labore et dolore magna aliqua.', + * 'test', + * 'foo']], 4], + * b: new Map([['za', 1], ['zb', 'test']]) + * }; + * console.log(util.inspect(o, { compact: true, depth: 5, breakLength: 80 })); + * + * // { a: + * // [ 1, + * // 2, + * // [ [ 'Lorem ipsum dolor sit amet,\nconsectetur [...]', // A long line + * // 'test', + * // 'foo' ] ], + * // 4 ], + * // b: Map(2) { 'za' => 1, 'zb' => 'test' } } + * + * // Setting `compact` to false or an integer creates more reader friendly output. + * console.log(util.inspect(o, { compact: false, depth: 5, breakLength: 80 })); + * + * // { + * // a: [ + * // 1, + * // 2, + * // [ + * // [ + * // 'Lorem ipsum dolor sit amet,\n' + + * // 'consectetur adipiscing elit, sed do eiusmod \n' + + * // 'tempor incididunt ut labore et dolore magna aliqua.', + * // 'test', + * // 'foo' + * // ] + * // ], + * // 4 + * // ], + * // b: Map(2) { + * // 'za' => 1, + * // 'zb' => 'test' + * // } + * // } + * + * // Setting `breakLength` to e.g. 150 will print the "Lorem ipsum" text in a + * // single line. + * ``` + * + * The `showHidden` option allows [`WeakMap`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap) and + * [`WeakSet`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet) entries to be + * inspected. If there are more entries than `maxArrayLength`, there is no + * guarantee which entries are displayed. That means retrieving the same [`WeakSet`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet) entries twice may + * result in different output. Furthermore, entries + * with no remaining strong references may be garbage collected at any time. + * + * ```js + * const { inspect } = require('util'); + * + * const obj = { a: 1 }; + * const obj2 = { b: 2 }; + * const weakSet = new WeakSet([obj, obj2]); + * + * console.log(inspect(weakSet, { showHidden: true })); + * // WeakSet { { a: 1 }, { b: 2 } } + * ``` + * + * The `sorted` option ensures that an object's property insertion order does not + * impact the result of `util.inspect()`. + * + * ```js + * const { inspect } = require('util'); + * const assert = require('assert'); + * + * const o1 = { + * b: [2, 3, 1], + * a: '`a` comes before `b`', + * c: new Set([2, 3, 1]) + * }; + * console.log(inspect(o1, { sorted: true })); + * // { a: '`a` comes before `b`', b: [ 2, 3, 1 ], c: Set(3) { 1, 2, 3 } } + * console.log(inspect(o1, { sorted: (a, b) => b.localeCompare(a) })); + * // { c: Set(3) { 3, 2, 1 }, b: [ 2, 3, 1 ], a: '`a` comes before `b`' } + * + * const o2 = { + * c: new Set([2, 1, 3]), + * a: '`a` comes before `b`', + * b: [2, 3, 1] + * }; + * assert.strict.equal( + * inspect(o1, { sorted: true }), + * inspect(o2, { sorted: true }) + * ); + * ``` + * + * `util.inspect()` is a synchronous method intended for debugging. Its maximum + * output length is approximately 128 MB. Inputs that result in longer output will + * be truncated. + * @since v0.3.0 + * @param object Any JavaScript primitive or `Object`. + * @return The representation of `object`. + */ + export function inspect(object: any, showHidden?: boolean, depth?: number | null, color?: boolean): string; + export function inspect(object: any, options: InspectOptions): string; + export namespace inspect { + let colors: NodeJS.Dict<[number, number]>; + let styles: { + [K in Style]: string; + }; + let defaultOptions: InspectOptions; + /** + * Allows changing inspect settings from the repl. + */ + let replDefaults: InspectOptions; + /** + * That can be used to declare custom inspect functions. + */ + const custom: unique symbol; + } + /** + * Alias for [`Array.isArray()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray). + * + * Returns `true` if the given `object` is an `Array`. Otherwise, returns `false`. + * + * ```js + * const util = require('util'); + * + * util.isArray([]); + * // Returns: true + * util.isArray(new Array()); + * // Returns: true + * util.isArray({}); + * // Returns: false + * ``` + * @since v0.6.0 + * @deprecated Since v4.0.0 - Use `isArray` instead. + */ + export function isArray(object: unknown): object is unknown[]; + /** + * Returns `true` if the given `object` is a `RegExp`. Otherwise, returns `false`. + * + * ```js + * const util = require('util'); + * + * util.isRegExp(/some regexp/); + * // Returns: true + * util.isRegExp(new RegExp('another regexp')); + * // Returns: true + * util.isRegExp({}); + * // Returns: false + * ``` + * @since v0.6.0 + * @deprecated Since v4.0.0 - Deprecated + */ + export function isRegExp(object: unknown): object is RegExp; + /** + * Returns `true` if the given `object` is a `Date`. Otherwise, returns `false`. + * + * ```js + * const util = require('util'); + * + * util.isDate(new Date()); + * // Returns: true + * util.isDate(Date()); + * // false (without 'new' returns a String) + * util.isDate({}); + * // Returns: false + * ``` + * @since v0.6.0 + * @deprecated Since v4.0.0 - Use {@link types.isDate} instead. + */ + export function isDate(object: unknown): object is Date; + /** + * Returns `true` if the given `object` is an `Error`. Otherwise, returns`false`. + * + * ```js + * const util = require('util'); + * + * util.isError(new Error()); + * // Returns: true + * util.isError(new TypeError()); + * // Returns: true + * util.isError({ name: 'Error', message: 'an error occurred' }); + * // Returns: false + * ``` + * + * This method relies on `Object.prototype.toString()` behavior. It is + * possible to obtain an incorrect result when the `object` argument manipulates`@@toStringTag`. + * + * ```js + * const util = require('util'); + * const obj = { name: 'Error', message: 'an error occurred' }; + * + * util.isError(obj); + * // Returns: false + * obj[Symbol.toStringTag] = 'Error'; + * util.isError(obj); + * // Returns: true + * ``` + * @since v0.6.0 + * @deprecated Since v4.0.0 - Use {@link types.isNativeError} instead. + */ + export function isError(object: unknown): object is Error; + /** + * Usage of `util.inherits()` is discouraged. Please use the ES6 `class` and`extends` keywords to get language level inheritance support. Also note + * that the two styles are [semantically incompatible](https://github.com/nodejs/node/issues/4179). + * + * Inherit the prototype methods from one [constructor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/constructor) into another. The + * prototype of `constructor` will be set to a new object created from`superConstructor`. + * + * This mainly adds some input validation on top of`Object.setPrototypeOf(constructor.prototype, superConstructor.prototype)`. + * As an additional convenience, `superConstructor` will be accessible + * through the `constructor.super_` property. + * + * ```js + * const util = require('util'); + * const EventEmitter = require('events'); + * + * function MyStream() { + * EventEmitter.call(this); + * } + * + * util.inherits(MyStream, EventEmitter); + * + * MyStream.prototype.write = function(data) { + * this.emit('data', data); + * }; + * + * const stream = new MyStream(); + * + * console.log(stream instanceof EventEmitter); // true + * console.log(MyStream.super_ === EventEmitter); // true + * + * stream.on('data', (data) => { + * console.log(`Received data: "${data}"`); + * }); + * stream.write('It works!'); // Received data: "It works!" + * ``` + * + * ES6 example using `class` and `extends`: + * + * ```js + * const EventEmitter = require('events'); + * + * class MyStream extends EventEmitter { + * write(data) { + * this.emit('data', data); + * } + * } + * + * const stream = new MyStream(); + * + * stream.on('data', (data) => { + * console.log(`Received data: "${data}"`); + * }); + * stream.write('With ES6'); + * ``` + * @since v0.3.0 + * @deprecated Legacy: Use ES2015 class syntax and `extends` keyword instead. + */ + export function inherits(constructor: unknown, superConstructor: unknown): void; + export type DebugLoggerFunction = (msg: string, ...param: unknown[]) => void; + export interface DebugLogger extends DebugLoggerFunction { + enabled: boolean; + } + /** + * The `util.debuglog()` method is used to create a function that conditionally + * writes debug messages to `stderr` based on the existence of the `NODE_DEBUG`environment variable. If the `section` name appears within the value of that + * environment variable, then the returned function operates similar to `console.error()`. If not, then the returned function is a no-op. + * + * ```js + * const util = require('util'); + * const debuglog = util.debuglog('foo'); + * + * debuglog('hello from foo [%d]', 123); + * ``` + * + * If this program is run with `NODE_DEBUG=foo` in the environment, then + * it will output something like: + * + * ```console + * FOO 3245: hello from foo [123] + * ``` + * + * where `3245` is the process id. If it is not run with that + * environment variable set, then it will not print anything. + * + * The `section` supports wildcard also: + * + * ```js + * const util = require('util'); + * const debuglog = util.debuglog('foo-bar'); + * + * debuglog('hi there, it\'s foo-bar [%d]', 2333); + * ``` + * + * if it is run with `NODE_DEBUG=foo*` in the environment, then it will output + * something like: + * + * ```console + * FOO-BAR 3257: hi there, it's foo-bar [2333] + * ``` + * + * Multiple comma-separated `section` names may be specified in the `NODE_DEBUG`environment variable: `NODE_DEBUG=fs,net,tls`. + * + * The optional `callback` argument can be used to replace the logging function + * with a different function that doesn't have any initialization or + * unnecessary wrapping. + * + * ```js + * const util = require('util'); + * let debuglog = util.debuglog('internals', (debug) => { + * // Replace with a logging function that optimizes out + * // testing if the section is enabled + * debuglog = debug; + * }); + * ``` + * @since v0.11.3 + * @param section A string identifying the portion of the application for which the `debuglog` function is being created. + * @param callback A callback invoked the first time the logging function is called with a function argument that is a more optimized logging function. + * @return The logging function + */ + export function debuglog(section: string, callback?: (fn: DebugLoggerFunction) => void): DebugLogger; + export const debug: typeof debuglog; + /** + * Returns `true` if the given `object` is a `Boolean`. Otherwise, returns `false`. + * + * ```js + * const util = require('util'); + * + * util.isBoolean(1); + * // Returns: false + * util.isBoolean(0); + * // Returns: false + * util.isBoolean(false); + * // Returns: true + * ``` + * @since v0.11.5 + * @deprecated Since v4.0.0 - Use `typeof value === 'boolean'` instead. + */ + export function isBoolean(object: unknown): object is boolean; + /** + * Returns `true` if the given `object` is a `Buffer`. Otherwise, returns `false`. + * + * ```js + * const util = require('util'); + * + * util.isBuffer({ length: 0 }); + * // Returns: false + * util.isBuffer([]); + * // Returns: false + * util.isBuffer(Buffer.from('hello world')); + * // Returns: true + * ``` + * @since v0.11.5 + * @deprecated Since v4.0.0 - Use `isBuffer` instead. + */ + export function isBuffer(object: unknown): object is Buffer; + /** + * Returns `true` if the given `object` is a `Function`. Otherwise, returns`false`. + * + * ```js + * const util = require('util'); + * + * function Foo() {} + * const Bar = () => {}; + * + * util.isFunction({}); + * // Returns: false + * util.isFunction(Foo); + * // Returns: true + * util.isFunction(Bar); + * // Returns: true + * ``` + * @since v0.11.5 + * @deprecated Since v4.0.0 - Use `typeof value === 'function'` instead. + */ + export function isFunction(object: unknown): boolean; + /** + * Returns `true` if the given `object` is strictly `null`. Otherwise, returns`false`. + * + * ```js + * const util = require('util'); + * + * util.isNull(0); + * // Returns: false + * util.isNull(undefined); + * // Returns: false + * util.isNull(null); + * // Returns: true + * ``` + * @since v0.11.5 + * @deprecated Since v4.0.0 - Use `value === null` instead. + */ + export function isNull(object: unknown): object is null; + /** + * Returns `true` if the given `object` is `null` or `undefined`. Otherwise, + * returns `false`. + * + * ```js + * const util = require('util'); + * + * util.isNullOrUndefined(0); + * // Returns: false + * util.isNullOrUndefined(undefined); + * // Returns: true + * util.isNullOrUndefined(null); + * // Returns: true + * ``` + * @since v0.11.5 + * @deprecated Since v4.0.0 - Use `value === undefined || value === null` instead. + */ + export function isNullOrUndefined(object: unknown): object is null | undefined; + /** + * Returns `true` if the given `object` is a `Number`. Otherwise, returns `false`. + * + * ```js + * const util = require('util'); + * + * util.isNumber(false); + * // Returns: false + * util.isNumber(Infinity); + * // Returns: true + * util.isNumber(0); + * // Returns: true + * util.isNumber(NaN); + * // Returns: true + * ``` + * @since v0.11.5 + * @deprecated Since v4.0.0 - Use `typeof value === 'number'` instead. + */ + export function isNumber(object: unknown): object is number; + /** + * Returns `true` if the given `object` is strictly an `Object`**and** not a`Function` (even though functions are objects in JavaScript). + * Otherwise, returns `false`. + * + * ```js + * const util = require('util'); + * + * util.isObject(5); + * // Returns: false + * util.isObject(null); + * // Returns: false + * util.isObject({}); + * // Returns: true + * util.isObject(() => {}); + * // Returns: false + * ``` + * @since v0.11.5 + * @deprecated Since v4.0.0 - Deprecated: Use `value !== null && typeof value === 'object'` instead. + */ + export function isObject(object: unknown): boolean; + /** + * Returns `true` if the given `object` is a primitive type. Otherwise, returns`false`. + * + * ```js + * const util = require('util'); + * + * util.isPrimitive(5); + * // Returns: true + * util.isPrimitive('foo'); + * // Returns: true + * util.isPrimitive(false); + * // Returns: true + * util.isPrimitive(null); + * // Returns: true + * util.isPrimitive(undefined); + * // Returns: true + * util.isPrimitive({}); + * // Returns: false + * util.isPrimitive(() => {}); + * // Returns: false + * util.isPrimitive(/^$/); + * // Returns: false + * util.isPrimitive(new Date()); + * // Returns: false + * ``` + * @since v0.11.5 + * @deprecated Since v4.0.0 - Use `(typeof value !== 'object' && typeof value !== 'function') || value === null` instead. + */ + export function isPrimitive(object: unknown): boolean; + /** + * Returns `true` if the given `object` is a `string`. Otherwise, returns `false`. + * + * ```js + * const util = require('util'); + * + * util.isString(''); + * // Returns: true + * util.isString('foo'); + * // Returns: true + * util.isString(String('foo')); + * // Returns: true + * util.isString(5); + * // Returns: false + * ``` + * @since v0.11.5 + * @deprecated Since v4.0.0 - Use `typeof value === 'string'` instead. + */ + export function isString(object: unknown): object is string; + /** + * Returns `true` if the given `object` is a `Symbol`. Otherwise, returns `false`. + * + * ```js + * const util = require('util'); + * + * util.isSymbol(5); + * // Returns: false + * util.isSymbol('foo'); + * // Returns: false + * util.isSymbol(Symbol('foo')); + * // Returns: true + * ``` + * @since v0.11.5 + * @deprecated Since v4.0.0 - Use `typeof value === 'symbol'` instead. + */ + export function isSymbol(object: unknown): object is symbol; + /** + * Returns `true` if the given `object` is `undefined`. Otherwise, returns `false`. + * + * ```js + * const util = require('util'); + * + * const foo = undefined; + * util.isUndefined(5); + * // Returns: false + * util.isUndefined(foo); + * // Returns: true + * util.isUndefined(null); + * // Returns: false + * ``` + * @since v0.11.5 + * @deprecated Since v4.0.0 - Use `value === undefined` instead. + */ + export function isUndefined(object: unknown): object is undefined; + /** + * The `util.deprecate()` method wraps `fn` (which may be a function or class) in + * such a way that it is marked as deprecated. + * + * ```js + * const util = require('util'); + * + * exports.obsoleteFunction = util.deprecate(() => { + * // Do something here. + * }, 'obsoleteFunction() is deprecated. Use newShinyFunction() instead.'); + * ``` + * + * When called, `util.deprecate()` will return a function that will emit a`DeprecationWarning` using the `'warning'` event. The warning will + * be emitted and printed to `stderr` the first time the returned function is + * called. After the warning is emitted, the wrapped function is called without + * emitting a warning. + * + * If the same optional `code` is supplied in multiple calls to `util.deprecate()`, + * the warning will be emitted only once for that `code`. + * + * ```js + * const util = require('util'); + * + * const fn1 = util.deprecate(someFunction, someMessage, 'DEP0001'); + * const fn2 = util.deprecate(someOtherFunction, someOtherMessage, 'DEP0001'); + * fn1(); // Emits a deprecation warning with code DEP0001 + * fn2(); // Does not emit a deprecation warning because it has the same code + * ``` + * + * If either the `--no-deprecation` or `--no-warnings` command-line flags are + * used, or if the `process.noDeprecation` property is set to `true`_prior_ to + * the first deprecation warning, the `util.deprecate()` method does nothing. + * + * If the `--trace-deprecation` or `--trace-warnings` command-line flags are set, + * or the `process.traceDeprecation` property is set to `true`, a warning and a + * stack trace are printed to `stderr` the first time the deprecated function is + * called. + * + * If the `--throw-deprecation` command-line flag is set, or the`process.throwDeprecation` property is set to `true`, then an exception will be + * thrown when the deprecated function is called. + * + * The `--throw-deprecation` command-line flag and `process.throwDeprecation`property take precedence over `--trace-deprecation` and`process.traceDeprecation`. + * @since v0.8.0 + * @param fn The function that is being deprecated. + * @param msg A warning message to display when the deprecated function is invoked. + * @param code A deprecation code. See the `list of deprecated APIs` for a list of codes. + * @return The deprecated function wrapped to emit a warning. + */ + export function deprecate(fn: T, msg: string, code?: string): T; + /** + * Returns `true` if there is deep strict equality between `val1` and `val2`. + * Otherwise, returns `false`. + * + * See `assert.deepStrictEqual()` for more information about deep strict + * equality. + * @since v9.0.0 + */ + export function isDeepStrictEqual(val1: unknown, val2: unknown): boolean; + /** + * Returns `str` with any ANSI escape codes removed. + * + * ```js + * console.log(util.stripVTControlCharacters('\u001B[4mvalue\u001B[0m')); + * // Prints "value" + * ``` + * @since v16.11.0 + */ + export function stripVTControlCharacters(str: string): string; + /** + * Takes an `async` function (or a function that returns a `Promise`) and returns a + * function following the error-first callback style, i.e. taking + * an `(err, value) => ...` callback as the last argument. In the callback, the + * first argument will be the rejection reason (or `null` if the `Promise`resolved), and the second argument will be the resolved value. + * + * ```js + * const util = require('util'); + * + * async function fn() { + * return 'hello world'; + * } + * const callbackFunction = util.callbackify(fn); + * + * callbackFunction((err, ret) => { + * if (err) throw err; + * console.log(ret); + * }); + * ``` + * + * Will print: + * + * ```text + * hello world + * ``` + * + * The callback is executed asynchronously, and will have a limited stack trace. + * If the callback throws, the process will emit an `'uncaughtException'` event, and if not handled will exit. + * + * Since `null` has a special meaning as the first argument to a callback, if a + * wrapped function rejects a `Promise` with a falsy value as a reason, the value + * is wrapped in an `Error` with the original value stored in a field named`reason`. + * + * ```js + * function fn() { + * return Promise.reject(null); + * } + * const callbackFunction = util.callbackify(fn); + * + * callbackFunction((err, ret) => { + * // When the Promise was rejected with `null` it is wrapped with an Error and + * // the original value is stored in `reason`. + * err && err.hasOwnProperty('reason') && err.reason === null; // true + * }); + * ``` + * @since v8.2.0 + * @param original An `async` function + * @return a callback style function + */ + export function callbackify(fn: () => Promise): (callback: (err: NodeJS.ErrnoException) => void) => void; + export function callbackify(fn: () => Promise): (callback: (err: NodeJS.ErrnoException, result: TResult) => void) => void; + export function callbackify(fn: (arg1: T1) => Promise): (arg1: T1, callback: (err: NodeJS.ErrnoException) => void) => void; + export function callbackify(fn: (arg1: T1) => Promise): (arg1: T1, callback: (err: NodeJS.ErrnoException, result: TResult) => void) => void; + export function callbackify(fn: (arg1: T1, arg2: T2) => Promise): (arg1: T1, arg2: T2, callback: (err: NodeJS.ErrnoException) => void) => void; + export function callbackify(fn: (arg1: T1, arg2: T2) => Promise): (arg1: T1, arg2: T2, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void; + export function callbackify(fn: (arg1: T1, arg2: T2, arg3: T3) => Promise): (arg1: T1, arg2: T2, arg3: T3, callback: (err: NodeJS.ErrnoException) => void) => void; + export function callbackify( + fn: (arg1: T1, arg2: T2, arg3: T3) => Promise + ): (arg1: T1, arg2: T2, arg3: T3, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void; + export function callbackify( + fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise + ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: NodeJS.ErrnoException) => void) => void; + export function callbackify( + fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise + ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void; + export function callbackify( + fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise + ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: NodeJS.ErrnoException) => void) => void; + export function callbackify( + fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise + ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void; + export function callbackify( + fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise + ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, callback: (err: NodeJS.ErrnoException) => void) => void; + export function callbackify( + fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise + ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void; + export interface CustomPromisifyLegacy extends Function { + __promisify__: TCustom; + } + export interface CustomPromisifySymbol extends Function { + [promisify.custom]: TCustom; + } + export type CustomPromisify = CustomPromisifySymbol | CustomPromisifyLegacy; + /** + * Takes a function following the common error-first callback style, i.e. taking + * an `(err, value) => ...` callback as the last argument, and returns a version + * that returns promises. + * + * ```js + * const util = require('util'); + * const fs = require('fs'); + * + * const stat = util.promisify(fs.stat); + * stat('.').then((stats) => { + * // Do something with `stats` + * }).catch((error) => { + * // Handle the error. + * }); + * ``` + * + * Or, equivalently using `async function`s: + * + * ```js + * const util = require('util'); + * const fs = require('fs'); + * + * const stat = util.promisify(fs.stat); + * + * async function callStat() { + * const stats = await stat('.'); + * console.log(`This directory is owned by ${stats.uid}`); + * } + * ``` + * + * If there is an `original[util.promisify.custom]` property present, `promisify`will return its value, see `Custom promisified functions`. + * + * `promisify()` assumes that `original` is a function taking a callback as its + * final argument in all cases. If `original` is not a function, `promisify()`will throw an error. If `original` is a function but its last argument is not + * an error-first callback, it will still be passed an error-first + * callback as its last argument. + * + * Using `promisify()` on class methods or other methods that use `this` may not + * work as expected unless handled specially: + * + * ```js + * const util = require('util'); + * + * class Foo { + * constructor() { + * this.a = 42; + * } + * + * bar(callback) { + * callback(null, this.a); + * } + * } + * + * const foo = new Foo(); + * + * const naiveBar = util.promisify(foo.bar); + * // TypeError: Cannot read property 'a' of undefined + * // naiveBar().then(a => console.log(a)); + * + * naiveBar.call(foo).then((a) => console.log(a)); // '42' + * + * const bindBar = naiveBar.bind(foo); + * bindBar().then((a) => console.log(a)); // '42' + * ``` + * @since v8.0.0 + */ + export function promisify(fn: CustomPromisify): TCustom; + export function promisify(fn: (callback: (err: any, result: TResult) => void) => void): () => Promise; + export function promisify(fn: (callback: (err?: any) => void) => void): () => Promise; + export function promisify(fn: (arg1: T1, callback: (err: any, result: TResult) => void) => void): (arg1: T1) => Promise; + export function promisify(fn: (arg1: T1, callback: (err?: any) => void) => void): (arg1: T1) => Promise; + export function promisify(fn: (arg1: T1, arg2: T2, callback: (err: any, result: TResult) => void) => void): (arg1: T1, arg2: T2) => Promise; + export function promisify(fn: (arg1: T1, arg2: T2, callback: (err?: any) => void) => void): (arg1: T1, arg2: T2) => Promise; + export function promisify(fn: (arg1: T1, arg2: T2, arg3: T3, callback: (err: any, result: TResult) => void) => void): (arg1: T1, arg2: T2, arg3: T3) => Promise; + export function promisify(fn: (arg1: T1, arg2: T2, arg3: T3, callback: (err?: any) => void) => void): (arg1: T1, arg2: T2, arg3: T3) => Promise; + export function promisify( + fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: any, result: TResult) => void) => void + ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise; + export function promisify(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err?: any) => void) => void): (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise; + export function promisify( + fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: any, result: TResult) => void) => void + ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise; + export function promisify( + fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err?: any) => void) => void + ): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise; + export function promisify(fn: Function): Function; + export namespace promisify { + /** + * That can be used to declare custom promisified variants of functions. + */ + const custom: unique symbol; + } + /** + * An implementation of the [WHATWG Encoding Standard](https://encoding.spec.whatwg.org/) `TextDecoder` API. + * + * ```js + * const decoder = new TextDecoder('shift_jis'); + * let string = ''; + * let buffer; + * while (buffer = getNextChunkSomehow()) { + * string += decoder.decode(buffer, { stream: true }); + * } + * string += decoder.decode(); // end-of-stream + * ``` + * @since v8.3.0 + */ + export class TextDecoder { + /** + * The encoding supported by the `TextDecoder` instance. + */ + readonly encoding: string; + /** + * The value will be `true` if decoding errors result in a `TypeError` being + * thrown. + */ + readonly fatal: boolean; + /** + * The value will be `true` if the decoding result will include the byte order + * mark. + */ + readonly ignoreBOM: boolean; + constructor( + encoding?: string, + options?: { + fatal?: boolean | undefined; + ignoreBOM?: boolean | undefined; + } + ); + /** + * Decodes the `input` and returns a string. If `options.stream` is `true`, any + * incomplete byte sequences occurring at the end of the `input` are buffered + * internally and emitted after the next call to `textDecoder.decode()`. + * + * If `textDecoder.fatal` is `true`, decoding errors that occur will result in a`TypeError` being thrown. + * @param input An `ArrayBuffer`, `DataView` or `TypedArray` instance containing the encoded data. + */ + decode( + input?: NodeJS.ArrayBufferView | ArrayBuffer | null, + options?: { + stream?: boolean | undefined; + } + ): string; + } + export interface EncodeIntoResult { + /** + * The read Unicode code units of input. + */ + read: number; + /** + * The written UTF-8 bytes of output. + */ + written: number; + } + export { types }; + /** + * An implementation of the [WHATWG Encoding Standard](https://encoding.spec.whatwg.org/) `TextEncoder` API. All + * instances of `TextEncoder` only support UTF-8 encoding. + * + * ```js + * const encoder = new TextEncoder(); + * const uint8array = encoder.encode('this is some data'); + * ``` + * + * The `TextEncoder` class is also available on the global object. + * @since v8.3.0 + */ + export class TextEncoder { + /** + * The encoding supported by the `TextEncoder` instance. Always set to `'utf-8'`. + */ + readonly encoding: string; + /** + * UTF-8 encodes the `input` string and returns a `Uint8Array` containing the + * encoded bytes. + * @param [input='an empty string'] The text to encode. + */ + encode(input?: string): Uint8Array; + /** + * UTF-8 encodes the `src` string to the `dest` Uint8Array and returns an object + * containing the read Unicode code units and written UTF-8 bytes. + * + * ```js + * const encoder = new TextEncoder(); + * const src = 'this is some data'; + * const dest = new Uint8Array(10); + * const { read, written } = encoder.encodeInto(src, dest); + * ``` + * @param src The text to encode. + * @param dest The array to hold the encode result. + */ + encodeInto(src: string, dest: Uint8Array): EncodeIntoResult; + } +} +declare module 'util/types' { + export * from 'util/types'; +} +declare module 'util/types' { + import { KeyObject, webcrypto } from 'node:crypto'; + /** + * Returns `true` if the value is a built-in [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) or + * [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) instance. + * + * See also `util.types.isArrayBuffer()` and `util.types.isSharedArrayBuffer()`. + * + * ```js + * util.types.isAnyArrayBuffer(new ArrayBuffer()); // Returns true + * util.types.isAnyArrayBuffer(new SharedArrayBuffer()); // Returns true + * ``` + * @since v10.0.0 + */ + function isAnyArrayBuffer(object: unknown): object is ArrayBufferLike; + /** + * Returns `true` if the value is an `arguments` object. + * + * ```js + * function foo() { + * util.types.isArgumentsObject(arguments); // Returns true + * } + * ``` + * @since v10.0.0 + */ + function isArgumentsObject(object: unknown): object is IArguments; + /** + * Returns `true` if the value is a built-in [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) instance. + * This does _not_ include [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) instances. Usually, it is + * desirable to test for both; See `util.types.isAnyArrayBuffer()` for that. + * + * ```js + * util.types.isArrayBuffer(new ArrayBuffer()); // Returns true + * util.types.isArrayBuffer(new SharedArrayBuffer()); // Returns false + * ``` + * @since v10.0.0 + */ + function isArrayBuffer(object: unknown): object is ArrayBuffer; + /** + * Returns `true` if the value is an instance of one of the [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) views, such as typed + * array objects or [`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView). Equivalent to + * [`ArrayBuffer.isView()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView). + * + * ```js + * util.types.isArrayBufferView(new Int8Array()); // true + * util.types.isArrayBufferView(Buffer.from('hello world')); // true + * util.types.isArrayBufferView(new DataView(new ArrayBuffer(16))); // true + * util.types.isArrayBufferView(new ArrayBuffer()); // false + * ``` + * @since v10.0.0 + */ + function isArrayBufferView(object: unknown): object is NodeJS.ArrayBufferView; + /** + * Returns `true` if the value is an [async function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function). + * This only reports back what the JavaScript engine is seeing; + * in particular, the return value may not match the original source code if + * a transpilation tool was used. + * + * ```js + * util.types.isAsyncFunction(function foo() {}); // Returns false + * util.types.isAsyncFunction(async function foo() {}); // Returns true + * ``` + * @since v10.0.0 + */ + function isAsyncFunction(object: unknown): boolean; + /** + * Returns `true` if the value is a `BigInt64Array` instance. + * + * ```js + * util.types.isBigInt64Array(new BigInt64Array()); // Returns true + * util.types.isBigInt64Array(new BigUint64Array()); // Returns false + * ``` + * @since v10.0.0 + */ + function isBigInt64Array(value: unknown): value is BigInt64Array; + /** + * Returns `true` if the value is a `BigUint64Array` instance. + * + * ```js + * util.types.isBigUint64Array(new BigInt64Array()); // Returns false + * util.types.isBigUint64Array(new BigUint64Array()); // Returns true + * ``` + * @since v10.0.0 + */ + function isBigUint64Array(value: unknown): value is BigUint64Array; + /** + * Returns `true` if the value is a boolean object, e.g. created + * by `new Boolean()`. + * + * ```js + * util.types.isBooleanObject(false); // Returns false + * util.types.isBooleanObject(true); // Returns false + * util.types.isBooleanObject(new Boolean(false)); // Returns true + * util.types.isBooleanObject(new Boolean(true)); // Returns true + * util.types.isBooleanObject(Boolean(false)); // Returns false + * util.types.isBooleanObject(Boolean(true)); // Returns false + * ``` + * @since v10.0.0 + */ + function isBooleanObject(object: unknown): object is Boolean; + /** + * Returns `true` if the value is any boxed primitive object, e.g. created + * by `new Boolean()`, `new String()` or `Object(Symbol())`. + * + * For example: + * + * ```js + * util.types.isBoxedPrimitive(false); // Returns false + * util.types.isBoxedPrimitive(new Boolean(false)); // Returns true + * util.types.isBoxedPrimitive(Symbol('foo')); // Returns false + * util.types.isBoxedPrimitive(Object(Symbol('foo'))); // Returns true + * util.types.isBoxedPrimitive(Object(BigInt(5))); // Returns true + * ``` + * @since v10.11.0 + */ + function isBoxedPrimitive(object: unknown): object is String | Number | BigInt | Boolean | Symbol; + /** + * Returns `true` if the value is a built-in [`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView) instance. + * + * ```js + * const ab = new ArrayBuffer(20); + * util.types.isDataView(new DataView(ab)); // Returns true + * util.types.isDataView(new Float64Array()); // Returns false + * ``` + * + * See also [`ArrayBuffer.isView()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView). + * @since v10.0.0 + */ + function isDataView(object: unknown): object is DataView; + /** + * Returns `true` if the value is a built-in [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) instance. + * + * ```js + * util.types.isDate(new Date()); // Returns true + * ``` + * @since v10.0.0 + */ + function isDate(object: unknown): object is Date; + /** + * Returns `true` if the value is a native `External` value. + * + * A native `External` value is a special type of object that contains a + * raw C++ pointer (`void*`) for access from native code, and has no other + * properties. Such objects are created either by Node.js internals or native + * addons. In JavaScript, they are [frozen](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze) objects with a`null` prototype. + * + * ```c + * #include + * #include + * napi_value result; + * static napi_value MyNapi(napi_env env, napi_callback_info info) { + * int* raw = (int*) malloc(1024); + * napi_status status = napi_create_external(env, (void*) raw, NULL, NULL, &result); + * if (status != napi_ok) { + * napi_throw_error(env, NULL, "napi_create_external failed"); + * return NULL; + * } + * return result; + * } + * ... + * DECLARE_NAPI_PROPERTY("myNapi", MyNapi) + * ... + * ``` + * + * ```js + * const native = require('napi_addon.node'); + * const data = native.myNapi(); + * util.types.isExternal(data); // returns true + * util.types.isExternal(0); // returns false + * util.types.isExternal(new String('foo')); // returns false + * ``` + * + * For further information on `napi_create_external`, refer to `napi_create_external()`. + * @since v10.0.0 + */ + function isExternal(object: unknown): boolean; + /** + * Returns `true` if the value is a built-in [`Float32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array) instance. + * + * ```js + * util.types.isFloat32Array(new ArrayBuffer()); // Returns false + * util.types.isFloat32Array(new Float32Array()); // Returns true + * util.types.isFloat32Array(new Float64Array()); // Returns false + * ``` + * @since v10.0.0 + */ + function isFloat32Array(object: unknown): object is Float32Array; + /** + * Returns `true` if the value is a built-in [`Float64Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array) instance. + * + * ```js + * util.types.isFloat64Array(new ArrayBuffer()); // Returns false + * util.types.isFloat64Array(new Uint8Array()); // Returns false + * util.types.isFloat64Array(new Float64Array()); // Returns true + * ``` + * @since v10.0.0 + */ + function isFloat64Array(object: unknown): object is Float64Array; + /** + * Returns `true` if the value is a generator function. + * This only reports back what the JavaScript engine is seeing; + * in particular, the return value may not match the original source code if + * a transpilation tool was used. + * + * ```js + * util.types.isGeneratorFunction(function foo() {}); // Returns false + * util.types.isGeneratorFunction(function* foo() {}); // Returns true + * ``` + * @since v10.0.0 + */ + function isGeneratorFunction(object: unknown): object is GeneratorFunction; + /** + * Returns `true` if the value is a generator object as returned from a + * built-in generator function. + * This only reports back what the JavaScript engine is seeing; + * in particular, the return value may not match the original source code if + * a transpilation tool was used. + * + * ```js + * function* foo() {} + * const generator = foo(); + * util.types.isGeneratorObject(generator); // Returns true + * ``` + * @since v10.0.0 + */ + function isGeneratorObject(object: unknown): object is Generator; + /** + * Returns `true` if the value is a built-in [`Int8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array) instance. + * + * ```js + * util.types.isInt8Array(new ArrayBuffer()); // Returns false + * util.types.isInt8Array(new Int8Array()); // Returns true + * util.types.isInt8Array(new Float64Array()); // Returns false + * ``` + * @since v10.0.0 + */ + function isInt8Array(object: unknown): object is Int8Array; + /** + * Returns `true` if the value is a built-in [`Int16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array) instance. + * + * ```js + * util.types.isInt16Array(new ArrayBuffer()); // Returns false + * util.types.isInt16Array(new Int16Array()); // Returns true + * util.types.isInt16Array(new Float64Array()); // Returns false + * ``` + * @since v10.0.0 + */ + function isInt16Array(object: unknown): object is Int16Array; + /** + * Returns `true` if the value is a built-in [`Int32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array) instance. + * + * ```js + * util.types.isInt32Array(new ArrayBuffer()); // Returns false + * util.types.isInt32Array(new Int32Array()); // Returns true + * util.types.isInt32Array(new Float64Array()); // Returns false + * ``` + * @since v10.0.0 + */ + function isInt32Array(object: unknown): object is Int32Array; + /** + * Returns `true` if the value is a built-in [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) instance. + * + * ```js + * util.types.isMap(new Map()); // Returns true + * ``` + * @since v10.0.0 + */ + function isMap(object: T | {}): object is T extends ReadonlyMap ? (unknown extends T ? never : ReadonlyMap) : Map; + /** + * Returns `true` if the value is an iterator returned for a built-in [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) instance. + * + * ```js + * const map = new Map(); + * util.types.isMapIterator(map.keys()); // Returns true + * util.types.isMapIterator(map.values()); // Returns true + * util.types.isMapIterator(map.entries()); // Returns true + * util.types.isMapIterator(map[Symbol.iterator]()); // Returns true + * ``` + * @since v10.0.0 + */ + function isMapIterator(object: unknown): boolean; + /** + * Returns `true` if the value is an instance of a [Module Namespace Object](https://tc39.github.io/ecma262/#sec-module-namespace-exotic-objects). + * + * ```js + * import * as ns from './a.js'; + * + * util.types.isModuleNamespaceObject(ns); // Returns true + * ``` + * @since v10.0.0 + */ + function isModuleNamespaceObject(value: unknown): boolean; + /** + * Returns `true` if the value is an instance of a built-in `Error` type. + * + * ```js + * util.types.isNativeError(new Error()); // Returns true + * util.types.isNativeError(new TypeError()); // Returns true + * util.types.isNativeError(new RangeError()); // Returns true + * ``` + * @since v10.0.0 + */ + function isNativeError(object: unknown): object is Error; + /** + * Returns `true` if the value is a number object, e.g. created + * by `new Number()`. + * + * ```js + * util.types.isNumberObject(0); // Returns false + * util.types.isNumberObject(new Number(0)); // Returns true + * ``` + * @since v10.0.0 + */ + function isNumberObject(object: unknown): object is Number; + /** + * Returns `true` if the value is a built-in [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise). + * + * ```js + * util.types.isPromise(Promise.resolve(42)); // Returns true + * ``` + * @since v10.0.0 + */ + function isPromise(object: unknown): object is Promise; + /** + * Returns `true` if the value is a [`Proxy`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) instance. + * + * ```js + * const target = {}; + * const proxy = new Proxy(target, {}); + * util.types.isProxy(target); // Returns false + * util.types.isProxy(proxy); // Returns true + * ``` + * @since v10.0.0 + */ + function isProxy(object: unknown): boolean; + /** + * Returns `true` if the value is a regular expression object. + * + * ```js + * util.types.isRegExp(/abc/); // Returns true + * util.types.isRegExp(new RegExp('abc')); // Returns true + * ``` + * @since v10.0.0 + */ + function isRegExp(object: unknown): object is RegExp; + /** + * Returns `true` if the value is a built-in [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set) instance. + * + * ```js + * util.types.isSet(new Set()); // Returns true + * ``` + * @since v10.0.0 + */ + function isSet(object: T | {}): object is T extends ReadonlySet ? (unknown extends T ? never : ReadonlySet) : Set; + /** + * Returns `true` if the value is an iterator returned for a built-in [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set) instance. + * + * ```js + * const set = new Set(); + * util.types.isSetIterator(set.keys()); // Returns true + * util.types.isSetIterator(set.values()); // Returns true + * util.types.isSetIterator(set.entries()); // Returns true + * util.types.isSetIterator(set[Symbol.iterator]()); // Returns true + * ``` + * @since v10.0.0 + */ + function isSetIterator(object: unknown): boolean; + /** + * Returns `true` if the value is a built-in [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) instance. + * This does _not_ include [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) instances. Usually, it is + * desirable to test for both; See `util.types.isAnyArrayBuffer()` for that. + * + * ```js + * util.types.isSharedArrayBuffer(new ArrayBuffer()); // Returns false + * util.types.isSharedArrayBuffer(new SharedArrayBuffer()); // Returns true + * ``` + * @since v10.0.0 + */ + function isSharedArrayBuffer(object: unknown): object is SharedArrayBuffer; + /** + * Returns `true` if the value is a string object, e.g. created + * by `new String()`. + * + * ```js + * util.types.isStringObject('foo'); // Returns false + * util.types.isStringObject(new String('foo')); // Returns true + * ``` + * @since v10.0.0 + */ + function isStringObject(object: unknown): object is String; + /** + * Returns `true` if the value is a symbol object, created + * by calling `Object()` on a `Symbol` primitive. + * + * ```js + * const symbol = Symbol('foo'); + * util.types.isSymbolObject(symbol); // Returns false + * util.types.isSymbolObject(Object(symbol)); // Returns true + * ``` + * @since v10.0.0 + */ + function isSymbolObject(object: unknown): object is Symbol; + /** + * Returns `true` if the value is a built-in [`TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) instance. + * + * ```js + * util.types.isTypedArray(new ArrayBuffer()); // Returns false + * util.types.isTypedArray(new Uint8Array()); // Returns true + * util.types.isTypedArray(new Float64Array()); // Returns true + * ``` + * + * See also [`ArrayBuffer.isView()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView). + * @since v10.0.0 + */ + function isTypedArray(object: unknown): object is NodeJS.TypedArray; + /** + * Returns `true` if the value is a built-in [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) instance. + * + * ```js + * util.types.isUint8Array(new ArrayBuffer()); // Returns false + * util.types.isUint8Array(new Uint8Array()); // Returns true + * util.types.isUint8Array(new Float64Array()); // Returns false + * ``` + * @since v10.0.0 + */ + function isUint8Array(object: unknown): object is Uint8Array; + /** + * Returns `true` if the value is a built-in [`Uint8ClampedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray) instance. + * + * ```js + * util.types.isUint8ClampedArray(new ArrayBuffer()); // Returns false + * util.types.isUint8ClampedArray(new Uint8ClampedArray()); // Returns true + * util.types.isUint8ClampedArray(new Float64Array()); // Returns false + * ``` + * @since v10.0.0 + */ + function isUint8ClampedArray(object: unknown): object is Uint8ClampedArray; + /** + * Returns `true` if the value is a built-in [`Uint16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array) instance. + * + * ```js + * util.types.isUint16Array(new ArrayBuffer()); // Returns false + * util.types.isUint16Array(new Uint16Array()); // Returns true + * util.types.isUint16Array(new Float64Array()); // Returns false + * ``` + * @since v10.0.0 + */ + function isUint16Array(object: unknown): object is Uint16Array; + /** + * Returns `true` if the value is a built-in [`Uint32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array) instance. + * + * ```js + * util.types.isUint32Array(new ArrayBuffer()); // Returns false + * util.types.isUint32Array(new Uint32Array()); // Returns true + * util.types.isUint32Array(new Float64Array()); // Returns false + * ``` + * @since v10.0.0 + */ + function isUint32Array(object: unknown): object is Uint32Array; + /** + * Returns `true` if the value is a built-in [`WeakMap`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap) instance. + * + * ```js + * util.types.isWeakMap(new WeakMap()); // Returns true + * ``` + * @since v10.0.0 + */ + function isWeakMap(object: unknown): object is WeakMap; + /** + * Returns `true` if the value is a built-in [`WeakSet`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet) instance. + * + * ```js + * util.types.isWeakSet(new WeakSet()); // Returns true + * ``` + * @since v10.0.0 + */ + function isWeakSet(object: unknown): object is WeakSet; + /** + * Returns `true` if `value` is a `KeyObject`, `false` otherwise. + * @since v16.2.0 + */ + function isKeyObject(object: unknown): object is KeyObject; + /** + * Returns `true` if `value` is a `CryptoKey`, `false` otherwise. + * @since v16.2.0 + */ + function isCryptoKey(object: unknown): object is webcrypto.CryptoKey; +} +declare module 'node:util' { + export * from 'util'; +} +declare module 'node:util/types' { + export * from 'util/types'; +} diff --git a/node_modules/@types/node/v8.d.ts b/node_modules/@types/node/v8.d.ts new file mode 100755 index 00000000..f467fccf --- /dev/null +++ b/node_modules/@types/node/v8.d.ts @@ -0,0 +1,378 @@ +/** + * The `v8` module exposes APIs that are specific to the version of [V8](https://developers.google.com/v8/) built into the Node.js binary. It can be accessed using: + * + * ```js + * const v8 = require('v8'); + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/v8.js) + */ +declare module 'v8' { + import { Readable } from 'node:stream'; + interface HeapSpaceInfo { + space_name: string; + space_size: number; + space_used_size: number; + space_available_size: number; + physical_space_size: number; + } + // ** Signifies if the --zap_code_space option is enabled or not. 1 == enabled, 0 == disabled. */ + type DoesZapCodeSpaceFlag = 0 | 1; + interface HeapInfo { + total_heap_size: number; + total_heap_size_executable: number; + total_physical_size: number; + total_available_size: number; + used_heap_size: number; + heap_size_limit: number; + malloced_memory: number; + peak_malloced_memory: number; + does_zap_garbage: DoesZapCodeSpaceFlag; + number_of_native_contexts: number; + number_of_detached_contexts: number; + } + interface HeapCodeStatistics { + code_and_metadata_size: number; + bytecode_and_metadata_size: number; + external_script_source_size: number; + } + /** + * Returns an integer representing a version tag derived from the V8 version, + * command-line flags, and detected CPU features. This is useful for determining + * whether a `vm.Script` `cachedData` buffer is compatible with this instance + * of V8. + * + * ```js + * console.log(v8.cachedDataVersionTag()); // 3947234607 + * // The value returned by v8.cachedDataVersionTag() is derived from the V8 + * // version, command-line flags, and detected CPU features. Test that the value + * // does indeed update when flags are toggled. + * v8.setFlagsFromString('--allow_natives_syntax'); + * console.log(v8.cachedDataVersionTag()); // 183726201 + * ``` + * @since v8.0.0 + */ + function cachedDataVersionTag(): number; + /** + * Returns an object with the following properties: + * + * `does_zap_garbage` is a 0/1 boolean, which signifies whether the`--zap_code_space` option is enabled or not. This makes V8 overwrite heap + * garbage with a bit pattern. The RSS footprint (resident set size) gets bigger + * because it continuously touches all heap pages and that makes them less likely + * to get swapped out by the operating system. + * + * `number_of_native_contexts` The value of native\_context is the number of the + * top-level contexts currently active. Increase of this number over time indicates + * a memory leak. + * + * `number_of_detached_contexts` The value of detached\_context is the number + * of contexts that were detached and not yet garbage collected. This number + * being non-zero indicates a potential memory leak. + * + * ```js + * { + * total_heap_size: 7326976, + * total_heap_size_executable: 4194304, + * total_physical_size: 7326976, + * total_available_size: 1152656, + * used_heap_size: 3476208, + * heap_size_limit: 1535115264, + * malloced_memory: 16384, + * peak_malloced_memory: 1127496, + * does_zap_garbage: 0, + * number_of_native_contexts: 1, + * number_of_detached_contexts: 0 + * } + * ``` + * @since v1.0.0 + */ + function getHeapStatistics(): HeapInfo; + /** + * Returns statistics about the V8 heap spaces, i.e. the segments which make up + * the V8 heap. Neither the ordering of heap spaces, nor the availability of a + * heap space can be guaranteed as the statistics are provided via the + * V8[`GetHeapSpaceStatistics`](https://v8docs.nodesource.com/node-13.2/d5/dda/classv8_1_1_isolate.html#ac673576f24fdc7a33378f8f57e1d13a4) function and may change from one V8 version to the + * next. + * + * The value returned is an array of objects containing the following properties: + * + * ```json + * [ + * { + * "space_name": "new_space", + * "space_size": 2063872, + * "space_used_size": 951112, + * "space_available_size": 80824, + * "physical_space_size": 2063872 + * }, + * { + * "space_name": "old_space", + * "space_size": 3090560, + * "space_used_size": 2493792, + * "space_available_size": 0, + * "physical_space_size": 3090560 + * }, + * { + * "space_name": "code_space", + * "space_size": 1260160, + * "space_used_size": 644256, + * "space_available_size": 960, + * "physical_space_size": 1260160 + * }, + * { + * "space_name": "map_space", + * "space_size": 1094160, + * "space_used_size": 201608, + * "space_available_size": 0, + * "physical_space_size": 1094160 + * }, + * { + * "space_name": "large_object_space", + * "space_size": 0, + * "space_used_size": 0, + * "space_available_size": 1490980608, + * "physical_space_size": 0 + * } + * ] + * ``` + * @since v6.0.0 + */ + function getHeapSpaceStatistics(): HeapSpaceInfo[]; + /** + * The `v8.setFlagsFromString()` method can be used to programmatically set + * V8 command-line flags. This method should be used with care. Changing settings + * after the VM has started may result in unpredictable behavior, including + * crashes and data loss; or it may simply do nothing. + * + * The V8 options available for a version of Node.js may be determined by running`node --v8-options`. + * + * Usage: + * + * ```js + * // Print GC events to stdout for one minute. + * const v8 = require('v8'); + * v8.setFlagsFromString('--trace_gc'); + * setTimeout(() => { v8.setFlagsFromString('--notrace_gc'); }, 60e3); + * ``` + * @since v1.0.0 + */ + function setFlagsFromString(flags: string): void; + /** + * Generates a snapshot of the current V8 heap and returns a Readable + * Stream that may be used to read the JSON serialized representation. + * This JSON stream format is intended to be used with tools such as + * Chrome DevTools. The JSON schema is undocumented and specific to the + * V8 engine. Therefore, the schema may change from one version of V8 to the next. + * + * ```js + * // Print heap snapshot to the console + * const v8 = require('v8'); + * const stream = v8.getHeapSnapshot(); + * stream.pipe(process.stdout); + * ``` + * @since v11.13.0 + * @return A Readable Stream containing the V8 heap snapshot + */ + function getHeapSnapshot(): Readable; + /** + * Generates a snapshot of the current V8 heap and writes it to a JSON + * file. This file is intended to be used with tools such as Chrome + * DevTools. The JSON schema is undocumented and specific to the V8 + * engine, and may change from one version of V8 to the next. + * + * A heap snapshot is specific to a single V8 isolate. When using `worker threads`, a heap snapshot generated from the main thread will + * not contain any information about the workers, and vice versa. + * + * ```js + * const { writeHeapSnapshot } = require('v8'); + * const { + * Worker, + * isMainThread, + * parentPort + * } = require('worker_threads'); + * + * if (isMainThread) { + * const worker = new Worker(__filename); + * + * worker.once('message', (filename) => { + * console.log(`worker heapdump: ${filename}`); + * // Now get a heapdump for the main thread. + * console.log(`main thread heapdump: ${writeHeapSnapshot()}`); + * }); + * + * // Tell the worker to create a heapdump. + * worker.postMessage('heapdump'); + * } else { + * parentPort.once('message', (message) => { + * if (message === 'heapdump') { + * // Generate a heapdump for the worker + * // and return the filename to the parent. + * parentPort.postMessage(writeHeapSnapshot()); + * } + * }); + * } + * ``` + * @since v11.13.0 + * @param filename The file path where the V8 heap snapshot is to be saved. If not specified, a file name with the pattern `'Heap-${yyyymmdd}-${hhmmss}-${pid}-${thread_id}.heapsnapshot'` will be + * generated, where `{pid}` will be the PID of the Node.js process, `{thread_id}` will be `0` when `writeHeapSnapshot()` is called from the main Node.js thread or the id of a + * worker thread. + * @return The filename where the snapshot was saved. + */ + function writeHeapSnapshot(filename?: string): string; + /** + * Returns an object with the following properties: + * + * ```js + * { + * code_and_metadata_size: 212208, + * bytecode_and_metadata_size: 161368, + * external_script_source_size: 1410794 + * } + * ``` + * @since v12.8.0 + */ + function getHeapCodeStatistics(): HeapCodeStatistics; + /** + * @since v8.0.0 + */ + class Serializer { + /** + * Writes out a header, which includes the serialization format version. + */ + writeHeader(): void; + /** + * Serializes a JavaScript value and adds the serialized representation to the + * internal buffer. + * + * This throws an error if `value` cannot be serialized. + */ + writeValue(val: any): boolean; + /** + * Returns the stored internal buffer. This serializer should not be used once + * the buffer is released. Calling this method results in undefined behavior + * if a previous write has failed. + */ + releaseBuffer(): Buffer; + /** + * Marks an `ArrayBuffer` as having its contents transferred out of band. + * Pass the corresponding `ArrayBuffer` in the deserializing context to `deserializer.transferArrayBuffer()`. + * @param id A 32-bit unsigned integer. + * @param arrayBuffer An `ArrayBuffer` instance. + */ + transferArrayBuffer(id: number, arrayBuffer: ArrayBuffer): void; + /** + * Write a raw 32-bit unsigned integer. + * For use inside of a custom `serializer._writeHostObject()`. + */ + writeUint32(value: number): void; + /** + * Write a raw 64-bit unsigned integer, split into high and low 32-bit parts. + * For use inside of a custom `serializer._writeHostObject()`. + */ + writeUint64(hi: number, lo: number): void; + /** + * Write a JS `number` value. + * For use inside of a custom `serializer._writeHostObject()`. + */ + writeDouble(value: number): void; + /** + * Write raw bytes into the serializer’s internal buffer. The deserializer + * will require a way to compute the length of the buffer. + * For use inside of a custom `serializer._writeHostObject()`. + */ + writeRawBytes(buffer: NodeJS.TypedArray): void; + } + /** + * A subclass of `Serializer` that serializes `TypedArray`(in particular `Buffer`) and `DataView` objects as host objects, and only + * stores the part of their underlying `ArrayBuffer`s that they are referring to. + * @since v8.0.0 + */ + class DefaultSerializer extends Serializer {} + /** + * @since v8.0.0 + */ + class Deserializer { + constructor(data: NodeJS.TypedArray); + /** + * Reads and validates a header (including the format version). + * May, for example, reject an invalid or unsupported wire format. In that case, + * an `Error` is thrown. + */ + readHeader(): boolean; + /** + * Deserializes a JavaScript value from the buffer and returns it. + */ + readValue(): any; + /** + * Marks an `ArrayBuffer` as having its contents transferred out of band. + * Pass the corresponding `ArrayBuffer` in the serializing context to `serializer.transferArrayBuffer()` (or return the `id` from `serializer._getSharedArrayBufferId()` in the case of + * `SharedArrayBuffer`s). + * @param id A 32-bit unsigned integer. + * @param arrayBuffer An `ArrayBuffer` instance. + */ + transferArrayBuffer(id: number, arrayBuffer: ArrayBuffer): void; + /** + * Reads the underlying wire format version. Likely mostly to be useful to + * legacy code reading old wire format versions. May not be called before`.readHeader()`. + */ + getWireFormatVersion(): number; + /** + * Read a raw 32-bit unsigned integer and return it. + * For use inside of a custom `deserializer._readHostObject()`. + */ + readUint32(): number; + /** + * Read a raw 64-bit unsigned integer and return it as an array `[hi, lo]`with two 32-bit unsigned integer entries. + * For use inside of a custom `deserializer._readHostObject()`. + */ + readUint64(): [number, number]; + /** + * Read a JS `number` value. + * For use inside of a custom `deserializer._readHostObject()`. + */ + readDouble(): number; + /** + * Read raw bytes from the deserializer’s internal buffer. The `length` parameter + * must correspond to the length of the buffer that was passed to `serializer.writeRawBytes()`. + * For use inside of a custom `deserializer._readHostObject()`. + */ + readRawBytes(length: number): Buffer; + } + /** + * A subclass of `Deserializer` corresponding to the format written by `DefaultSerializer`. + * @since v8.0.0 + */ + class DefaultDeserializer extends Deserializer {} + /** + * Uses a `DefaultSerializer` to serialize `value` into a buffer. + * @since v8.0.0 + */ + function serialize(value: any): Buffer; + /** + * Uses a `DefaultDeserializer` with default options to read a JS value + * from a buffer. + * @since v8.0.0 + * @param buffer A buffer returned by {@link serialize}. + */ + function deserialize(buffer: NodeJS.TypedArray): any; + /** + * The `v8.takeCoverage()` method allows the user to write the coverage started by `NODE_V8_COVERAGE` to disk on demand. This method can be invoked multiple + * times during the lifetime of the process. Each time the execution counter will + * be reset and a new coverage report will be written to the directory specified + * by `NODE_V8_COVERAGE`. + * + * When the process is about to exit, one last coverage will still be written to + * disk unless {@link stopCoverage} is invoked before the process exits. + * @since v15.1.0, v12.22.0 + */ + function takeCoverage(): void; + /** + * The `v8.stopCoverage()` method allows the user to stop the coverage collection + * started by `NODE_V8_COVERAGE`, so that V8 can release the execution count + * records and optimize code. This can be used in conjunction with {@link takeCoverage} if the user wants to collect the coverage on demand. + * @since v15.1.0, v12.22.0 + */ + function stopCoverage(): void; +} +declare module 'node:v8' { + export * from 'v8'; +} diff --git a/node_modules/@types/node/vm.d.ts b/node_modules/@types/node/vm.d.ts new file mode 100755 index 00000000..a46b3919 --- /dev/null +++ b/node_modules/@types/node/vm.d.ts @@ -0,0 +1,507 @@ +/** + * The `vm` module enables compiling and running code within V8 Virtual + * Machine contexts. **The `vm` module is not a security mechanism. Do** + * **not use it to run untrusted code.** + * + * JavaScript code can be compiled and run immediately or + * compiled, saved, and run later. + * + * A common use case is to run the code in a different V8 Context. This means + * invoked code has a different global object than the invoking code. + * + * One can provide the context by `contextifying` an + * object. The invoked code treats any property in the context like a + * global variable. Any changes to global variables caused by the invoked + * code are reflected in the context object. + * + * ```js + * const vm = require('vm'); + * + * const x = 1; + * + * const context = { x: 2 }; + * vm.createContext(context); // Contextify the object. + * + * const code = 'x += 40; var y = 17;'; + * // `x` and `y` are global variables in the context. + * // Initially, x has the value 2 because that is the value of context.x. + * vm.runInContext(code, context); + * + * console.log(context.x); // 42 + * console.log(context.y); // 17 + * + * console.log(x); // 1; y is not defined. + * ``` + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/vm.js) + */ +declare module 'vm' { + interface Context extends NodeJS.Dict {} + interface BaseOptions { + /** + * Specifies the filename used in stack traces produced by this script. + * Default: `''`. + */ + filename?: string | undefined; + /** + * Specifies the line number offset that is displayed in stack traces produced by this script. + * Default: `0`. + */ + lineOffset?: number | undefined; + /** + * Specifies the column number offset that is displayed in stack traces produced by this script. + * @default 0 + */ + columnOffset?: number | undefined; + } + interface ScriptOptions extends BaseOptions { + displayErrors?: boolean | undefined; + timeout?: number | undefined; + cachedData?: Buffer | undefined; + /** @deprecated in favor of `script.createCachedData()` */ + produceCachedData?: boolean | undefined; + } + interface RunningScriptOptions extends BaseOptions { + /** + * When `true`, if an `Error` occurs while compiling the `code`, the line of code causing the error is attached to the stack trace. + * Default: `true`. + */ + displayErrors?: boolean | undefined; + /** + * Specifies the number of milliseconds to execute code before terminating execution. + * If execution is terminated, an `Error` will be thrown. This value must be a strictly positive integer. + */ + timeout?: number | undefined; + /** + * If `true`, the execution will be terminated when `SIGINT` (Ctrl+C) is received. + * Existing handlers for the event that have been attached via `process.on('SIGINT')` will be disabled during script execution, but will continue to work after that. + * If execution is terminated, an `Error` will be thrown. + * Default: `false`. + */ + breakOnSigint?: boolean | undefined; + /** + * If set to `afterEvaluate`, microtasks will be run immediately after the script has run. + */ + microtaskMode?: 'afterEvaluate' | undefined; + } + interface CompileFunctionOptions extends BaseOptions { + /** + * Provides an optional data with V8's code cache data for the supplied source. + */ + cachedData?: Buffer | undefined; + /** + * Specifies whether to produce new cache data. + * Default: `false`, + */ + produceCachedData?: boolean | undefined; + /** + * The sandbox/context in which the said function should be compiled in. + */ + parsingContext?: Context | undefined; + /** + * An array containing a collection of context extensions (objects wrapping the current scope) to be applied while compiling + */ + contextExtensions?: Object[] | undefined; + } + interface CreateContextOptions { + /** + * Human-readable name of the newly created context. + * @default 'VM Context i' Where i is an ascending numerical index of the created context. + */ + name?: string | undefined; + /** + * Corresponds to the newly created context for display purposes. + * The origin should be formatted like a `URL`, but with only the scheme, host, and port (if necessary), + * like the value of the `url.origin` property of a URL object. + * Most notably, this string should omit the trailing slash, as that denotes a path. + * @default '' + */ + origin?: string | undefined; + codeGeneration?: + | { + /** + * If set to false any calls to eval or function constructors (Function, GeneratorFunction, etc) + * will throw an EvalError. + * @default true + */ + strings?: boolean | undefined; + /** + * If set to false any attempt to compile a WebAssembly module will throw a WebAssembly.CompileError. + * @default true + */ + wasm?: boolean | undefined; + } + | undefined; + /** + * If set to `afterEvaluate`, microtasks will be run immediately after the script has run. + */ + microtaskMode?: 'afterEvaluate' | undefined; + } + type MeasureMemoryMode = 'summary' | 'detailed'; + interface MeasureMemoryOptions { + /** + * @default 'summary' + */ + mode?: MeasureMemoryMode | undefined; + context?: Context | undefined; + } + interface MemoryMeasurement { + total: { + jsMemoryEstimate: number; + jsMemoryRange: [number, number]; + }; + } + /** + * Instances of the `vm.Script` class contain precompiled scripts that can be + * executed in specific contexts. + * @since v0.3.1 + */ + class Script { + constructor(code: string, options?: ScriptOptions); + /** + * Runs the compiled code contained by the `vm.Script` object within the given`contextifiedObject` and returns the result. Running code does not have access + * to local scope. + * + * The following example compiles code that increments a global variable, sets + * the value of another global variable, then execute the code multiple times. + * The globals are contained in the `context` object. + * + * ```js + * const vm = require('vm'); + * + * const context = { + * animal: 'cat', + * count: 2 + * }; + * + * const script = new vm.Script('count += 1; name = "kitty";'); + * + * vm.createContext(context); + * for (let i = 0; i < 10; ++i) { + * script.runInContext(context); + * } + * + * console.log(context); + * // Prints: { animal: 'cat', count: 12, name: 'kitty' } + * ``` + * + * Using the `timeout` or `breakOnSigint` options will result in new event loops + * and corresponding threads being started, which have a non-zero performance + * overhead. + * @since v0.3.1 + * @param contextifiedObject A `contextified` object as returned by the `vm.createContext()` method. + * @return the result of the very last statement executed in the script. + */ + runInContext(contextifiedObject: Context, options?: RunningScriptOptions): any; + /** + * First contextifies the given `contextObject`, runs the compiled code contained + * by the `vm.Script` object within the created context, and returns the result. + * Running code does not have access to local scope. + * + * The following example compiles code that sets a global variable, then executes + * the code multiple times in different contexts. The globals are set on and + * contained within each individual `context`. + * + * ```js + * const vm = require('vm'); + * + * const script = new vm.Script('globalVar = "set"'); + * + * const contexts = [{}, {}, {}]; + * contexts.forEach((context) => { + * script.runInNewContext(context); + * }); + * + * console.log(contexts); + * // Prints: [{ globalVar: 'set' }, { globalVar: 'set' }, { globalVar: 'set' }] + * ``` + * @since v0.3.1 + * @param contextObject An object that will be `contextified`. If `undefined`, a new object will be created. + * @return the result of the very last statement executed in the script. + */ + runInNewContext(contextObject?: Context, options?: RunningScriptOptions): any; + /** + * Runs the compiled code contained by the `vm.Script` within the context of the + * current `global` object. Running code does not have access to local scope, but_does_ have access to the current `global` object. + * + * The following example compiles code that increments a `global` variable then + * executes that code multiple times: + * + * ```js + * const vm = require('vm'); + * + * global.globalVar = 0; + * + * const script = new vm.Script('globalVar += 1', { filename: 'myfile.vm' }); + * + * for (let i = 0; i < 1000; ++i) { + * script.runInThisContext(); + * } + * + * console.log(globalVar); + * + * // 1000 + * ``` + * @since v0.3.1 + * @return the result of the very last statement executed in the script. + */ + runInThisContext(options?: RunningScriptOptions): any; + /** + * Creates a code cache that can be used with the `Script` constructor's`cachedData` option. Returns a `Buffer`. This method may be called at any + * time and any number of times. + * + * ```js + * const script = new vm.Script(` + * function add(a, b) { + * return a + b; + * } + * + * const x = add(1, 2); + * `); + * + * const cacheWithoutX = script.createCachedData(); + * + * script.runInThisContext(); + * + * const cacheWithX = script.createCachedData(); + * ``` + * @since v10.6.0 + */ + createCachedData(): Buffer; + /** @deprecated in favor of `script.createCachedData()` */ + cachedDataProduced?: boolean | undefined; + cachedDataRejected?: boolean | undefined; + cachedData?: Buffer | undefined; + } + /** + * If given a `contextObject`, the `vm.createContext()` method will `prepare + * that object` so that it can be used in calls to {@link runInContext} or `script.runInContext()`. Inside such scripts, + * the `contextObject` will be the global object, retaining all of its existing + * properties but also having the built-in objects and functions any standard [global object](https://es5.github.io/#x15.1) has. Outside of scripts run by the vm module, global variables + * will remain unchanged. + * + * ```js + * const vm = require('vm'); + * + * global.globalVar = 3; + * + * const context = { globalVar: 1 }; + * vm.createContext(context); + * + * vm.runInContext('globalVar *= 2;', context); + * + * console.log(context); + * // Prints: { globalVar: 2 } + * + * console.log(global.globalVar); + * // Prints: 3 + * ``` + * + * If `contextObject` is omitted (or passed explicitly as `undefined`), a new, + * empty `contextified` object will be returned. + * + * The `vm.createContext()` method is primarily useful for creating a single + * context that can be used to run multiple scripts. For instance, if emulating a + * web browser, the method can be used to create a single context representing a + * window's global object, then run all ` +``` + + + +Node + + +Install with `npm install deprecation` + +```js +const { Deprecation } = require("deprecation"); +// or: import { Deprecation } from "deprecation"; +``` + + + + + +```js +function foo() { + bar(); +} + +function bar() { + baz(); +} + +function baz() { + console.warn(new Deprecation("[my-lib] foo() is deprecated, use bar()")); +} + +foo(); +// { Deprecation: [my-lib] foo() is deprecated, use bar() +// at baz (/path/to/file.js:12:15) +// at bar (/path/to/file.js:8:3) +// at foo (/path/to/file.js:4:3) +``` + +To log a deprecation message only once, you can use the [once](https://www.npmjs.com/package/once) module. + +```js +const Deprecation = require("deprecation"); +const once = require("once"); + +const deprecateFoo = once(console.warn); + +function foo() { + deprecateFoo(new Deprecation("[my-lib] foo() is deprecated, use bar()")); +} + +foo(); +foo(); // logs nothing +``` + +## License + +[ISC](LICENSE) diff --git a/node_modules/deprecation/dist-node/index.js b/node_modules/deprecation/dist-node/index.js new file mode 100644 index 00000000..9da17757 --- /dev/null +++ b/node_modules/deprecation/dist-node/index.js @@ -0,0 +1,20 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +class Deprecation extends Error { + constructor(message) { + super(message); // Maintains proper stack trace (only available on V8) + + /* istanbul ignore next */ + + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + + this.name = 'Deprecation'; + } + +} + +exports.Deprecation = Deprecation; diff --git a/node_modules/deprecation/dist-src/index.js b/node_modules/deprecation/dist-src/index.js new file mode 100644 index 00000000..7950fdc0 --- /dev/null +++ b/node_modules/deprecation/dist-src/index.js @@ -0,0 +1,14 @@ +export class Deprecation extends Error { + constructor(message) { + super(message); // Maintains proper stack trace (only available on V8) + + /* istanbul ignore next */ + + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + + this.name = 'Deprecation'; + } + +} \ No newline at end of file diff --git a/node_modules/deprecation/dist-types/index.d.ts b/node_modules/deprecation/dist-types/index.d.ts new file mode 100644 index 00000000..e3ae7ad4 --- /dev/null +++ b/node_modules/deprecation/dist-types/index.d.ts @@ -0,0 +1,3 @@ +export class Deprecation extends Error { + name: "Deprecation"; +} diff --git a/node_modules/deprecation/dist-web/index.js b/node_modules/deprecation/dist-web/index.js new file mode 100644 index 00000000..c6bbda75 --- /dev/null +++ b/node_modules/deprecation/dist-web/index.js @@ -0,0 +1,16 @@ +class Deprecation extends Error { + constructor(message) { + super(message); // Maintains proper stack trace (only available on V8) + + /* istanbul ignore next */ + + if (Error.captureStackTrace) { + Error.captureStackTrace(this, this.constructor); + } + + this.name = 'Deprecation'; + } + +} + +export { Deprecation }; diff --git a/node_modules/deprecation/package.json b/node_modules/deprecation/package.json new file mode 100644 index 00000000..a45fd513 --- /dev/null +++ b/node_modules/deprecation/package.json @@ -0,0 +1,34 @@ +{ + "name": "deprecation", + "description": "Log a deprecation message with stack", + "version": "2.3.1", + "license": "ISC", + "files": [ + "dist-*/", + "bin/" + ], + "esnext": "dist-src/index.js", + "main": "dist-node/index.js", + "module": "dist-web/index.js", + "types": "dist-types/index.d.ts", + "pika": true, + "sideEffects": false, + "keywords": [ + "deprecate", + "deprecated", + "deprecation" + ], + "repository": { + "type": "git", + "url": "https://github.com/gr2m/deprecation.git" + }, + "dependencies": {}, + "devDependencies": { + "@pika/pack": "^0.3.7", + "@pika/plugin-build-node": "^0.4.0", + "@pika/plugin-build-types": "^0.4.0", + "@pika/plugin-build-web": "^0.4.0", + "@pika/plugin-standard-pkg": "^0.4.0", + "semantic-release": "^15.13.3" + } +} diff --git a/node_modules/end-of-stream/LICENSE b/node_modules/end-of-stream/LICENSE new file mode 100644 index 00000000..757562ec --- /dev/null +++ b/node_modules/end-of-stream/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014 Mathias Buus + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/node_modules/end-of-stream/README.md b/node_modules/end-of-stream/README.md new file mode 100644 index 00000000..857b14bd --- /dev/null +++ b/node_modules/end-of-stream/README.md @@ -0,0 +1,54 @@ +# end-of-stream + +A node module that calls a callback when a readable/writable/duplex stream has completed or failed. + + npm install end-of-stream + +[![Build status](https://travis-ci.org/mafintosh/end-of-stream.svg?branch=master)](https://travis-ci.org/mafintosh/end-of-stream) + +## Usage + +Simply pass a stream and a callback to the `eos`. +Both legacy streams, streams2 and stream3 are supported. + +``` js +var eos = require('end-of-stream'); + +eos(readableStream, function(err) { + // this will be set to the stream instance + if (err) return console.log('stream had an error or closed early'); + console.log('stream has ended', this === readableStream); +}); + +eos(writableStream, function(err) { + if (err) return console.log('stream had an error or closed early'); + console.log('stream has finished', this === writableStream); +}); + +eos(duplexStream, function(err) { + if (err) return console.log('stream had an error or closed early'); + console.log('stream has ended and finished', this === duplexStream); +}); + +eos(duplexStream, {readable:false}, function(err) { + if (err) return console.log('stream had an error or closed early'); + console.log('stream has finished but might still be readable'); +}); + +eos(duplexStream, {writable:false}, function(err) { + if (err) return console.log('stream had an error or closed early'); + console.log('stream has ended but might still be writable'); +}); + +eos(readableStream, {error:false}, function(err) { + // do not treat emit('error', err) as a end-of-stream +}); +``` + +## License + +MIT + +## Related + +`end-of-stream` is part of the [mississippi stream utility collection](https://github.com/maxogden/mississippi) which includes more useful stream modules similar to this one. diff --git a/node_modules/end-of-stream/index.js b/node_modules/end-of-stream/index.js new file mode 100644 index 00000000..c77f0d5d --- /dev/null +++ b/node_modules/end-of-stream/index.js @@ -0,0 +1,94 @@ +var once = require('once'); + +var noop = function() {}; + +var isRequest = function(stream) { + return stream.setHeader && typeof stream.abort === 'function'; +}; + +var isChildProcess = function(stream) { + return stream.stdio && Array.isArray(stream.stdio) && stream.stdio.length === 3 +}; + +var eos = function(stream, opts, callback) { + if (typeof opts === 'function') return eos(stream, null, opts); + if (!opts) opts = {}; + + callback = once(callback || noop); + + var ws = stream._writableState; + var rs = stream._readableState; + var readable = opts.readable || (opts.readable !== false && stream.readable); + var writable = opts.writable || (opts.writable !== false && stream.writable); + var cancelled = false; + + var onlegacyfinish = function() { + if (!stream.writable) onfinish(); + }; + + var onfinish = function() { + writable = false; + if (!readable) callback.call(stream); + }; + + var onend = function() { + readable = false; + if (!writable) callback.call(stream); + }; + + var onexit = function(exitCode) { + callback.call(stream, exitCode ? new Error('exited with error code: ' + exitCode) : null); + }; + + var onerror = function(err) { + callback.call(stream, err); + }; + + var onclose = function() { + process.nextTick(onclosenexttick); + }; + + var onclosenexttick = function() { + if (cancelled) return; + if (readable && !(rs && (rs.ended && !rs.destroyed))) return callback.call(stream, new Error('premature close')); + if (writable && !(ws && (ws.ended && !ws.destroyed))) return callback.call(stream, new Error('premature close')); + }; + + var onrequest = function() { + stream.req.on('finish', onfinish); + }; + + if (isRequest(stream)) { + stream.on('complete', onfinish); + stream.on('abort', onclose); + if (stream.req) onrequest(); + else stream.on('request', onrequest); + } else if (writable && !ws) { // legacy streams + stream.on('end', onlegacyfinish); + stream.on('close', onlegacyfinish); + } + + if (isChildProcess(stream)) stream.on('exit', onexit); + + stream.on('end', onend); + stream.on('finish', onfinish); + if (opts.error !== false) stream.on('error', onerror); + stream.on('close', onclose); + + return function() { + cancelled = true; + stream.removeListener('complete', onfinish); + stream.removeListener('abort', onclose); + stream.removeListener('request', onrequest); + if (stream.req) stream.req.removeListener('finish', onfinish); + stream.removeListener('end', onlegacyfinish); + stream.removeListener('close', onlegacyfinish); + stream.removeListener('finish', onfinish); + stream.removeListener('exit', onexit); + stream.removeListener('end', onend); + stream.removeListener('error', onerror); + stream.removeListener('close', onclose); + }; +}; + +module.exports = eos; diff --git a/node_modules/end-of-stream/package.json b/node_modules/end-of-stream/package.json new file mode 100644 index 00000000..b75bbf0f --- /dev/null +++ b/node_modules/end-of-stream/package.json @@ -0,0 +1,37 @@ +{ + "name": "end-of-stream", + "version": "1.4.4", + "description": "Call a callback when a readable/writable/duplex stream has completed or failed.", + "repository": { + "type": "git", + "url": "git://github.com/mafintosh/end-of-stream.git" + }, + "dependencies": { + "once": "^1.4.0" + }, + "scripts": { + "test": "node test.js" + }, + "files": [ + "index.js" + ], + "keywords": [ + "stream", + "streams", + "callback", + "finish", + "close", + "end", + "wait" + ], + "bugs": { + "url": "https://github.com/mafintosh/end-of-stream/issues" + }, + "homepage": "https://github.com/mafintosh/end-of-stream", + "main": "index.js", + "author": "Mathias Buus ", + "license": "MIT", + "devDependencies": { + "tape": "^4.11.0" + } +} diff --git a/node_modules/execa/index.js b/node_modules/execa/index.js new file mode 100644 index 00000000..aad9ac88 --- /dev/null +++ b/node_modules/execa/index.js @@ -0,0 +1,361 @@ +'use strict'; +const path = require('path'); +const childProcess = require('child_process'); +const crossSpawn = require('cross-spawn'); +const stripEof = require('strip-eof'); +const npmRunPath = require('npm-run-path'); +const isStream = require('is-stream'); +const _getStream = require('get-stream'); +const pFinally = require('p-finally'); +const onExit = require('signal-exit'); +const errname = require('./lib/errname'); +const stdio = require('./lib/stdio'); + +const TEN_MEGABYTES = 1000 * 1000 * 10; + +function handleArgs(cmd, args, opts) { + let parsed; + + opts = Object.assign({ + extendEnv: true, + env: {} + }, opts); + + if (opts.extendEnv) { + opts.env = Object.assign({}, process.env, opts.env); + } + + if (opts.__winShell === true) { + delete opts.__winShell; + parsed = { + command: cmd, + args, + options: opts, + file: cmd, + original: { + cmd, + args + } + }; + } else { + parsed = crossSpawn._parse(cmd, args, opts); + } + + opts = Object.assign({ + maxBuffer: TEN_MEGABYTES, + buffer: true, + stripEof: true, + preferLocal: true, + localDir: parsed.options.cwd || process.cwd(), + encoding: 'utf8', + reject: true, + cleanup: true + }, parsed.options); + + opts.stdio = stdio(opts); + + if (opts.preferLocal) { + opts.env = npmRunPath.env(Object.assign({}, opts, {cwd: opts.localDir})); + } + + if (opts.detached) { + // #115 + opts.cleanup = false; + } + + if (process.platform === 'win32' && path.basename(parsed.command) === 'cmd.exe') { + // #116 + parsed.args.unshift('/q'); + } + + return { + cmd: parsed.command, + args: parsed.args, + opts, + parsed + }; +} + +function handleInput(spawned, input) { + if (input === null || input === undefined) { + return; + } + + if (isStream(input)) { + input.pipe(spawned.stdin); + } else { + spawned.stdin.end(input); + } +} + +function handleOutput(opts, val) { + if (val && opts.stripEof) { + val = stripEof(val); + } + + return val; +} + +function handleShell(fn, cmd, opts) { + let file = '/bin/sh'; + let args = ['-c', cmd]; + + opts = Object.assign({}, opts); + + if (process.platform === 'win32') { + opts.__winShell = true; + file = process.env.comspec || 'cmd.exe'; + args = ['/s', '/c', `"${cmd}"`]; + opts.windowsVerbatimArguments = true; + } + + if (opts.shell) { + file = opts.shell; + delete opts.shell; + } + + return fn(file, args, opts); +} + +function getStream(process, stream, {encoding, buffer, maxBuffer}) { + if (!process[stream]) { + return null; + } + + let ret; + + if (!buffer) { + // TODO: Use `ret = util.promisify(stream.finished)(process[stream]);` when targeting Node.js 10 + ret = new Promise((resolve, reject) => { + process[stream] + .once('end', resolve) + .once('error', reject); + }); + } else if (encoding) { + ret = _getStream(process[stream], { + encoding, + maxBuffer + }); + } else { + ret = _getStream.buffer(process[stream], {maxBuffer}); + } + + return ret.catch(err => { + err.stream = stream; + err.message = `${stream} ${err.message}`; + throw err; + }); +} + +function makeError(result, options) { + const {stdout, stderr} = result; + + let err = result.error; + const {code, signal} = result; + + const {parsed, joinedCmd} = options; + const timedOut = options.timedOut || false; + + if (!err) { + let output = ''; + + if (Array.isArray(parsed.opts.stdio)) { + if (parsed.opts.stdio[2] !== 'inherit') { + output += output.length > 0 ? stderr : `\n${stderr}`; + } + + if (parsed.opts.stdio[1] !== 'inherit') { + output += `\n${stdout}`; + } + } else if (parsed.opts.stdio !== 'inherit') { + output = `\n${stderr}${stdout}`; + } + + err = new Error(`Command failed: ${joinedCmd}${output}`); + err.code = code < 0 ? errname(code) : code; + } + + err.stdout = stdout; + err.stderr = stderr; + err.failed = true; + err.signal = signal || null; + err.cmd = joinedCmd; + err.timedOut = timedOut; + + return err; +} + +function joinCmd(cmd, args) { + let joinedCmd = cmd; + + if (Array.isArray(args) && args.length > 0) { + joinedCmd += ' ' + args.join(' '); + } + + return joinedCmd; +} + +module.exports = (cmd, args, opts) => { + const parsed = handleArgs(cmd, args, opts); + const {encoding, buffer, maxBuffer} = parsed.opts; + const joinedCmd = joinCmd(cmd, args); + + let spawned; + try { + spawned = childProcess.spawn(parsed.cmd, parsed.args, parsed.opts); + } catch (err) { + return Promise.reject(err); + } + + let removeExitHandler; + if (parsed.opts.cleanup) { + removeExitHandler = onExit(() => { + spawned.kill(); + }); + } + + let timeoutId = null; + let timedOut = false; + + const cleanup = () => { + if (timeoutId) { + clearTimeout(timeoutId); + timeoutId = null; + } + + if (removeExitHandler) { + removeExitHandler(); + } + }; + + if (parsed.opts.timeout > 0) { + timeoutId = setTimeout(() => { + timeoutId = null; + timedOut = true; + spawned.kill(parsed.opts.killSignal); + }, parsed.opts.timeout); + } + + const processDone = new Promise(resolve => { + spawned.on('exit', (code, signal) => { + cleanup(); + resolve({code, signal}); + }); + + spawned.on('error', err => { + cleanup(); + resolve({error: err}); + }); + + if (spawned.stdin) { + spawned.stdin.on('error', err => { + cleanup(); + resolve({error: err}); + }); + } + }); + + function destroy() { + if (spawned.stdout) { + spawned.stdout.destroy(); + } + + if (spawned.stderr) { + spawned.stderr.destroy(); + } + } + + const handlePromise = () => pFinally(Promise.all([ + processDone, + getStream(spawned, 'stdout', {encoding, buffer, maxBuffer}), + getStream(spawned, 'stderr', {encoding, buffer, maxBuffer}) + ]).then(arr => { + const result = arr[0]; + result.stdout = arr[1]; + result.stderr = arr[2]; + + if (result.error || result.code !== 0 || result.signal !== null) { + const err = makeError(result, { + joinedCmd, + parsed, + timedOut + }); + + // TODO: missing some timeout logic for killed + // https://github.com/nodejs/node/blob/master/lib/child_process.js#L203 + // err.killed = spawned.killed || killed; + err.killed = err.killed || spawned.killed; + + if (!parsed.opts.reject) { + return err; + } + + throw err; + } + + return { + stdout: handleOutput(parsed.opts, result.stdout), + stderr: handleOutput(parsed.opts, result.stderr), + code: 0, + failed: false, + killed: false, + signal: null, + cmd: joinedCmd, + timedOut: false + }; + }), destroy); + + crossSpawn._enoent.hookChildProcess(spawned, parsed.parsed); + + handleInput(spawned, parsed.opts.input); + + spawned.then = (onfulfilled, onrejected) => handlePromise().then(onfulfilled, onrejected); + spawned.catch = onrejected => handlePromise().catch(onrejected); + + return spawned; +}; + +// TODO: set `stderr: 'ignore'` when that option is implemented +module.exports.stdout = (...args) => module.exports(...args).then(x => x.stdout); + +// TODO: set `stdout: 'ignore'` when that option is implemented +module.exports.stderr = (...args) => module.exports(...args).then(x => x.stderr); + +module.exports.shell = (cmd, opts) => handleShell(module.exports, cmd, opts); + +module.exports.sync = (cmd, args, opts) => { + const parsed = handleArgs(cmd, args, opts); + const joinedCmd = joinCmd(cmd, args); + + if (isStream(parsed.opts.input)) { + throw new TypeError('The `input` option cannot be a stream in sync mode'); + } + + const result = childProcess.spawnSync(parsed.cmd, parsed.args, parsed.opts); + result.code = result.status; + + if (result.error || result.status !== 0 || result.signal !== null) { + const err = makeError(result, { + joinedCmd, + parsed + }); + + if (!parsed.opts.reject) { + return err; + } + + throw err; + } + + return { + stdout: handleOutput(parsed.opts, result.stdout), + stderr: handleOutput(parsed.opts, result.stderr), + code: 0, + failed: false, + signal: null, + cmd: joinedCmd, + timedOut: false + }; +}; + +module.exports.shellSync = (cmd, opts) => handleShell(module.exports.sync, cmd, opts); diff --git a/node_modules/execa/lib/errname.js b/node_modules/execa/lib/errname.js new file mode 100644 index 00000000..e367837b --- /dev/null +++ b/node_modules/execa/lib/errname.js @@ -0,0 +1,39 @@ +'use strict'; +// Older verions of Node.js might not have `util.getSystemErrorName()`. +// In that case, fall back to a deprecated internal. +const util = require('util'); + +let uv; + +if (typeof util.getSystemErrorName === 'function') { + module.exports = util.getSystemErrorName; +} else { + try { + uv = process.binding('uv'); + + if (typeof uv.errname !== 'function') { + throw new TypeError('uv.errname is not a function'); + } + } catch (err) { + console.error('execa/lib/errname: unable to establish process.binding(\'uv\')', err); + uv = null; + } + + module.exports = code => errname(uv, code); +} + +// Used for testing the fallback behavior +module.exports.__test__ = errname; + +function errname(uv, code) { + if (uv) { + return uv.errname(code); + } + + if (!(code < 0)) { + throw new Error('err >= 0'); + } + + return `Unknown system error ${code}`; +} + diff --git a/node_modules/execa/lib/stdio.js b/node_modules/execa/lib/stdio.js new file mode 100644 index 00000000..a82d4683 --- /dev/null +++ b/node_modules/execa/lib/stdio.js @@ -0,0 +1,41 @@ +'use strict'; +const alias = ['stdin', 'stdout', 'stderr']; + +const hasAlias = opts => alias.some(x => Boolean(opts[x])); + +module.exports = opts => { + if (!opts) { + return null; + } + + if (opts.stdio && hasAlias(opts)) { + throw new Error(`It's not possible to provide \`stdio\` in combination with one of ${alias.map(x => `\`${x}\``).join(', ')}`); + } + + if (typeof opts.stdio === 'string') { + return opts.stdio; + } + + const stdio = opts.stdio || []; + + if (!Array.isArray(stdio)) { + throw new TypeError(`Expected \`stdio\` to be of type \`string\` or \`Array\`, got \`${typeof stdio}\``); + } + + const result = []; + const len = Math.max(stdio.length, alias.length); + + for (let i = 0; i < len; i++) { + let value = null; + + if (stdio[i] !== undefined) { + value = stdio[i]; + } else if (opts[alias[i]] !== undefined) { + value = opts[alias[i]]; + } + + result[i] = value; + } + + return result; +}; diff --git a/node_modules/execa/license b/node_modules/execa/license new file mode 100644 index 00000000..e7af2f77 --- /dev/null +++ b/node_modules/execa/license @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) Sindre Sorhus (sindresorhus.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/execa/node_modules/cross-spawn/CHANGELOG.md b/node_modules/execa/node_modules/cross-spawn/CHANGELOG.md new file mode 100644 index 00000000..ded9620b --- /dev/null +++ b/node_modules/execa/node_modules/cross-spawn/CHANGELOG.md @@ -0,0 +1,100 @@ +# Change Log + +All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. + + +## [6.0.5](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.4...v6.0.5) (2018-03-02) + + +### Bug Fixes + +* avoid using deprecated Buffer constructor ([#94](https://github.com/moxystudio/node-cross-spawn/issues/94)) ([d5770df](https://github.com/moxystudio/node-cross-spawn/commit/d5770df)), closes [/nodejs.org/api/deprecations.html#deprecations_dep0005](https://github.com//nodejs.org/api/deprecations.html/issues/deprecations_dep0005) + + + + +## [6.0.4](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.3...v6.0.4) (2018-01-31) + + +### Bug Fixes + +* fix paths being incorrectly normalized on unix ([06ee3c6](https://github.com/moxystudio/node-cross-spawn/commit/06ee3c6)), closes [#90](https://github.com/moxystudio/node-cross-spawn/issues/90) + + + + +## [6.0.3](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.2...v6.0.3) (2018-01-23) + + + + +## [6.0.2](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.1...v6.0.2) (2018-01-23) + + + + +## [6.0.1](https://github.com/moxystudio/node-cross-spawn/compare/v6.0.0...v6.0.1) (2018-01-23) + + + + +# [6.0.0](https://github.com/moxystudio/node-cross-spawn/compare/5.1.0...6.0.0) (2018-01-23) + + +### Bug Fixes + +* fix certain arguments not being correctly escaped or causing batch syntax error ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)), closes [#82](https://github.com/moxystudio/node-cross-spawn/issues/82) [#51](https://github.com/moxystudio/node-cross-spawn/issues/51) +* fix commands as posix relatixe paths not working correctly, e.g.: `./my-command` ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)) +* fix `options` argument being mutated ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)) +* fix commands resolution when PATH was actually Path ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)) + + +### Features + +* improve compliance with node's ENOENT errors ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)) +* improve detection of node's shell option support ([900cf10](https://github.com/moxystudio/node-cross-spawn/commit/900cf10)) + + +### Chores + +* upgrade tooling +* upgrate project to es6 (node v4) + + +### BREAKING CHANGES + +* remove support for older nodejs versions, only `node >= 4` is supported + + + +## [5.1.0](https://github.com/moxystudio/node-cross-spawn/compare/5.0.1...5.1.0) (2017-02-26) + + +### Bug Fixes + +* fix `options.shell` support for NodeJS [v4.8](https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_V4.md#4.8.0) + + + +## [5.0.1](https://github.com/moxystudio/node-cross-spawn/compare/5.0.0...5.0.1) (2016-11-04) + + +### Bug Fixes + +* fix `options.shell` support for NodeJS v7 + + + +# [5.0.0](https://github.com/moxystudio/node-cross-spawn/compare/4.0.2...5.0.0) (2016-10-30) + + +## Features + +* add support for `options.shell` +* improve parsing of shebangs by using [`shebang-command`](https://github.com/kevva/shebang-command) module + + +## Chores + +* refactor some code to make it more clear +* update README caveats diff --git a/node_modules/execa/node_modules/cross-spawn/LICENSE b/node_modules/execa/node_modules/cross-spawn/LICENSE new file mode 100644 index 00000000..8407b9a3 --- /dev/null +++ b/node_modules/execa/node_modules/cross-spawn/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018 Made With MOXY Lda + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/execa/node_modules/cross-spawn/README.md b/node_modules/execa/node_modules/cross-spawn/README.md new file mode 100644 index 00000000..e895cd7a --- /dev/null +++ b/node_modules/execa/node_modules/cross-spawn/README.md @@ -0,0 +1,94 @@ +# cross-spawn + +[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Build status][appveyor-image]][appveyor-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url] [![Greenkeeper badge][greenkeeper-image]][greenkeeper-url] + +[npm-url]:https://npmjs.org/package/cross-spawn +[downloads-image]:http://img.shields.io/npm/dm/cross-spawn.svg +[npm-image]:http://img.shields.io/npm/v/cross-spawn.svg +[travis-url]:https://travis-ci.org/moxystudio/node-cross-spawn +[travis-image]:http://img.shields.io/travis/moxystudio/node-cross-spawn/master.svg +[appveyor-url]:https://ci.appveyor.com/project/satazor/node-cross-spawn +[appveyor-image]:https://img.shields.io/appveyor/ci/satazor/node-cross-spawn/master.svg +[codecov-url]:https://codecov.io/gh/moxystudio/node-cross-spawn +[codecov-image]:https://img.shields.io/codecov/c/github/moxystudio/node-cross-spawn/master.svg +[david-dm-url]:https://david-dm.org/moxystudio/node-cross-spawn +[david-dm-image]:https://img.shields.io/david/moxystudio/node-cross-spawn.svg +[david-dm-dev-url]:https://david-dm.org/moxystudio/node-cross-spawn?type=dev +[david-dm-dev-image]:https://img.shields.io/david/dev/moxystudio/node-cross-spawn.svg +[greenkeeper-image]:https://badges.greenkeeper.io/moxystudio/node-cross-spawn.svg +[greenkeeper-url]:https://greenkeeper.io/ + +A cross platform solution to node's spawn and spawnSync. + + +## Installation + +`$ npm install cross-spawn` + + +## Why + +Node has issues when using spawn on Windows: + +- It ignores [PATHEXT](https://github.com/joyent/node/issues/2318) +- It does not support [shebangs](https://en.wikipedia.org/wiki/Shebang_(Unix)) +- Has problems running commands with [spaces](https://github.com/nodejs/node/issues/7367) +- Has problems running commands with posix relative paths (e.g.: `./my-folder/my-executable`) +- Has an [issue](https://github.com/moxystudio/node-cross-spawn/issues/82) with command shims (files in `node_modules/.bin/`), where arguments with quotes and parenthesis would result in [invalid syntax error](https://github.com/moxystudio/node-cross-spawn/blob/e77b8f22a416db46b6196767bcd35601d7e11d54/test/index.test.js#L149) +- No `options.shell` support on node `` where `` must not contain any arguments. +If you would like to have the shebang support improved, feel free to contribute via a pull-request. + +Remember to always test your code on Windows! + + +## Tests + +`$ npm test` +`$ npm test -- --watch` during development + +## License + +Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php). diff --git a/node_modules/execa/node_modules/cross-spawn/index.js b/node_modules/execa/node_modules/cross-spawn/index.js new file mode 100644 index 00000000..5509742c --- /dev/null +++ b/node_modules/execa/node_modules/cross-spawn/index.js @@ -0,0 +1,39 @@ +'use strict'; + +const cp = require('child_process'); +const parse = require('./lib/parse'); +const enoent = require('./lib/enoent'); + +function spawn(command, args, options) { + // Parse the arguments + const parsed = parse(command, args, options); + + // Spawn the child process + const spawned = cp.spawn(parsed.command, parsed.args, parsed.options); + + // Hook into child process "exit" event to emit an error if the command + // does not exists, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16 + enoent.hookChildProcess(spawned, parsed); + + return spawned; +} + +function spawnSync(command, args, options) { + // Parse the arguments + const parsed = parse(command, args, options); + + // Spawn the child process + const result = cp.spawnSync(parsed.command, parsed.args, parsed.options); + + // Analyze if the command does not exist, see: https://github.com/IndigoUnited/node-cross-spawn/issues/16 + result.error = result.error || enoent.verifyENOENTSync(result.status, parsed); + + return result; +} + +module.exports = spawn; +module.exports.spawn = spawn; +module.exports.sync = spawnSync; + +module.exports._parse = parse; +module.exports._enoent = enoent; diff --git a/node_modules/execa/node_modules/cross-spawn/lib/enoent.js b/node_modules/execa/node_modules/cross-spawn/lib/enoent.js new file mode 100644 index 00000000..14df9b62 --- /dev/null +++ b/node_modules/execa/node_modules/cross-spawn/lib/enoent.js @@ -0,0 +1,59 @@ +'use strict'; + +const isWin = process.platform === 'win32'; + +function notFoundError(original, syscall) { + return Object.assign(new Error(`${syscall} ${original.command} ENOENT`), { + code: 'ENOENT', + errno: 'ENOENT', + syscall: `${syscall} ${original.command}`, + path: original.command, + spawnargs: original.args, + }); +} + +function hookChildProcess(cp, parsed) { + if (!isWin) { + return; + } + + const originalEmit = cp.emit; + + cp.emit = function (name, arg1) { + // If emitting "exit" event and exit code is 1, we need to check if + // the command exists and emit an "error" instead + // See https://github.com/IndigoUnited/node-cross-spawn/issues/16 + if (name === 'exit') { + const err = verifyENOENT(arg1, parsed, 'spawn'); + + if (err) { + return originalEmit.call(cp, 'error', err); + } + } + + return originalEmit.apply(cp, arguments); // eslint-disable-line prefer-rest-params + }; +} + +function verifyENOENT(status, parsed) { + if (isWin && status === 1 && !parsed.file) { + return notFoundError(parsed.original, 'spawn'); + } + + return null; +} + +function verifyENOENTSync(status, parsed) { + if (isWin && status === 1 && !parsed.file) { + return notFoundError(parsed.original, 'spawnSync'); + } + + return null; +} + +module.exports = { + hookChildProcess, + verifyENOENT, + verifyENOENTSync, + notFoundError, +}; diff --git a/node_modules/execa/node_modules/cross-spawn/lib/parse.js b/node_modules/execa/node_modules/cross-spawn/lib/parse.js new file mode 100644 index 00000000..962827a9 --- /dev/null +++ b/node_modules/execa/node_modules/cross-spawn/lib/parse.js @@ -0,0 +1,125 @@ +'use strict'; + +const path = require('path'); +const niceTry = require('nice-try'); +const resolveCommand = require('./util/resolveCommand'); +const escape = require('./util/escape'); +const readShebang = require('./util/readShebang'); +const semver = require('semver'); + +const isWin = process.platform === 'win32'; +const isExecutableRegExp = /\.(?:com|exe)$/i; +const isCmdShimRegExp = /node_modules[\\/].bin[\\/][^\\/]+\.cmd$/i; + +// `options.shell` is supported in Node ^4.8.0, ^5.7.0 and >= 6.0.0 +const supportsShellOption = niceTry(() => semver.satisfies(process.version, '^4.8.0 || ^5.7.0 || >= 6.0.0', true)) || false; + +function detectShebang(parsed) { + parsed.file = resolveCommand(parsed); + + const shebang = parsed.file && readShebang(parsed.file); + + if (shebang) { + parsed.args.unshift(parsed.file); + parsed.command = shebang; + + return resolveCommand(parsed); + } + + return parsed.file; +} + +function parseNonShell(parsed) { + if (!isWin) { + return parsed; + } + + // Detect & add support for shebangs + const commandFile = detectShebang(parsed); + + // We don't need a shell if the command filename is an executable + const needsShell = !isExecutableRegExp.test(commandFile); + + // If a shell is required, use cmd.exe and take care of escaping everything correctly + // Note that `forceShell` is an hidden option used only in tests + if (parsed.options.forceShell || needsShell) { + // Need to double escape meta chars if the command is a cmd-shim located in `node_modules/.bin/` + // The cmd-shim simply calls execute the package bin file with NodeJS, proxying any argument + // Because the escape of metachars with ^ gets interpreted when the cmd.exe is first called, + // we need to double escape them + const needsDoubleEscapeMetaChars = isCmdShimRegExp.test(commandFile); + + // Normalize posix paths into OS compatible paths (e.g.: foo/bar -> foo\bar) + // This is necessary otherwise it will always fail with ENOENT in those cases + parsed.command = path.normalize(parsed.command); + + // Escape command & arguments + parsed.command = escape.command(parsed.command); + parsed.args = parsed.args.map((arg) => escape.argument(arg, needsDoubleEscapeMetaChars)); + + const shellCommand = [parsed.command].concat(parsed.args).join(' '); + + parsed.args = ['/d', '/s', '/c', `"${shellCommand}"`]; + parsed.command = process.env.comspec || 'cmd.exe'; + parsed.options.windowsVerbatimArguments = true; // Tell node's spawn that the arguments are already escaped + } + + return parsed; +} + +function parseShell(parsed) { + // If node supports the shell option, there's no need to mimic its behavior + if (supportsShellOption) { + return parsed; + } + + // Mimic node shell option + // See https://github.com/nodejs/node/blob/b9f6a2dc059a1062776133f3d4fd848c4da7d150/lib/child_process.js#L335 + const shellCommand = [parsed.command].concat(parsed.args).join(' '); + + if (isWin) { + parsed.command = typeof parsed.options.shell === 'string' ? parsed.options.shell : process.env.comspec || 'cmd.exe'; + parsed.args = ['/d', '/s', '/c', `"${shellCommand}"`]; + parsed.options.windowsVerbatimArguments = true; // Tell node's spawn that the arguments are already escaped + } else { + if (typeof parsed.options.shell === 'string') { + parsed.command = parsed.options.shell; + } else if (process.platform === 'android') { + parsed.command = '/system/bin/sh'; + } else { + parsed.command = '/bin/sh'; + } + + parsed.args = ['-c', shellCommand]; + } + + return parsed; +} + +function parse(command, args, options) { + // Normalize arguments, similar to nodejs + if (args && !Array.isArray(args)) { + options = args; + args = null; + } + + args = args ? args.slice(0) : []; // Clone array to avoid changing the original + options = Object.assign({}, options); // Clone object to avoid changing the original + + // Build our parsed object + const parsed = { + command, + args, + options, + file: undefined, + original: { + command, + args, + }, + }; + + // Delegate further parsing to shell or non-shell + return options.shell ? parseShell(parsed) : parseNonShell(parsed); +} + +module.exports = parse; diff --git a/node_modules/execa/node_modules/cross-spawn/lib/util/escape.js b/node_modules/execa/node_modules/cross-spawn/lib/util/escape.js new file mode 100644 index 00000000..b0bb84c3 --- /dev/null +++ b/node_modules/execa/node_modules/cross-spawn/lib/util/escape.js @@ -0,0 +1,45 @@ +'use strict'; + +// See http://www.robvanderwoude.com/escapechars.php +const metaCharsRegExp = /([()\][%!^"`<>&|;, *?])/g; + +function escapeCommand(arg) { + // Escape meta chars + arg = arg.replace(metaCharsRegExp, '^$1'); + + return arg; +} + +function escapeArgument(arg, doubleEscapeMetaChars) { + // Convert to string + arg = `${arg}`; + + // Algorithm below is based on https://qntm.org/cmd + + // Sequence of backslashes followed by a double quote: + // double up all the backslashes and escape the double quote + arg = arg.replace(/(\\*)"/g, '$1$1\\"'); + + // Sequence of backslashes followed by the end of the string + // (which will become a double quote later): + // double up all the backslashes + arg = arg.replace(/(\\*)$/, '$1$1'); + + // All other backslashes occur literally + + // Quote the whole thing: + arg = `"${arg}"`; + + // Escape meta chars + arg = arg.replace(metaCharsRegExp, '^$1'); + + // Double escape meta chars if necessary + if (doubleEscapeMetaChars) { + arg = arg.replace(metaCharsRegExp, '^$1'); + } + + return arg; +} + +module.exports.command = escapeCommand; +module.exports.argument = escapeArgument; diff --git a/node_modules/execa/node_modules/cross-spawn/lib/util/readShebang.js b/node_modules/execa/node_modules/cross-spawn/lib/util/readShebang.js new file mode 100644 index 00000000..bd4f1280 --- /dev/null +++ b/node_modules/execa/node_modules/cross-spawn/lib/util/readShebang.js @@ -0,0 +1,32 @@ +'use strict'; + +const fs = require('fs'); +const shebangCommand = require('shebang-command'); + +function readShebang(command) { + // Read the first 150 bytes from the file + const size = 150; + let buffer; + + if (Buffer.alloc) { + // Node.js v4.5+ / v5.10+ + buffer = Buffer.alloc(size); + } else { + // Old Node.js API + buffer = new Buffer(size); + buffer.fill(0); // zero-fill + } + + let fd; + + try { + fd = fs.openSync(command, 'r'); + fs.readSync(fd, buffer, 0, size, 0); + fs.closeSync(fd); + } catch (e) { /* Empty */ } + + // Attempt to extract shebang (null is returned if not a shebang) + return shebangCommand(buffer.toString()); +} + +module.exports = readShebang; diff --git a/node_modules/execa/node_modules/cross-spawn/lib/util/resolveCommand.js b/node_modules/execa/node_modules/cross-spawn/lib/util/resolveCommand.js new file mode 100644 index 00000000..2fd5ad27 --- /dev/null +++ b/node_modules/execa/node_modules/cross-spawn/lib/util/resolveCommand.js @@ -0,0 +1,47 @@ +'use strict'; + +const path = require('path'); +const which = require('which'); +const pathKey = require('path-key')(); + +function resolveCommandAttempt(parsed, withoutPathExt) { + const cwd = process.cwd(); + const hasCustomCwd = parsed.options.cwd != null; + + // If a custom `cwd` was specified, we need to change the process cwd + // because `which` will do stat calls but does not support a custom cwd + if (hasCustomCwd) { + try { + process.chdir(parsed.options.cwd); + } catch (err) { + /* Empty */ + } + } + + let resolved; + + try { + resolved = which.sync(parsed.command, { + path: (parsed.options.env || process.env)[pathKey], + pathExt: withoutPathExt ? path.delimiter : undefined, + }); + } catch (e) { + /* Empty */ + } finally { + process.chdir(cwd); + } + + // If we successfully resolved, ensure that an absolute path is returned + // Note that when a custom `cwd` was used, we need to resolve to an absolute path based on it + if (resolved) { + resolved = path.resolve(hasCustomCwd ? parsed.options.cwd : '', resolved); + } + + return resolved; +} + +function resolveCommand(parsed) { + return resolveCommandAttempt(parsed) || resolveCommandAttempt(parsed, true); +} + +module.exports = resolveCommand; diff --git a/node_modules/execa/node_modules/cross-spawn/node_modules/.bin/semver b/node_modules/execa/node_modules/cross-spawn/node_modules/.bin/semver new file mode 120000 index 00000000..b3ca6032 --- /dev/null +++ b/node_modules/execa/node_modules/cross-spawn/node_modules/.bin/semver @@ -0,0 +1 @@ +../../../semver/bin/semver \ No newline at end of file diff --git a/node_modules/execa/node_modules/cross-spawn/node_modules/.bin/which b/node_modules/execa/node_modules/cross-spawn/node_modules/.bin/which new file mode 120000 index 00000000..091d52ad --- /dev/null +++ b/node_modules/execa/node_modules/cross-spawn/node_modules/.bin/which @@ -0,0 +1 @@ +../../../which/bin/which \ No newline at end of file diff --git a/node_modules/execa/node_modules/cross-spawn/package.json b/node_modules/execa/node_modules/cross-spawn/package.json new file mode 100644 index 00000000..1a69be8c --- /dev/null +++ b/node_modules/execa/node_modules/cross-spawn/package.json @@ -0,0 +1,76 @@ +{ + "name": "cross-spawn", + "version": "6.0.5", + "description": "Cross platform child_process#spawn and child_process#spawnSync", + "keywords": [ + "spawn", + "spawnSync", + "windows", + "cross-platform", + "path-ext", + "shebang", + "cmd", + "execute" + ], + "author": "André Cruz ", + "homepage": "https://github.com/moxystudio/node-cross-spawn", + "repository": { + "type": "git", + "url": "git@github.com:moxystudio/node-cross-spawn.git" + }, + "license": "MIT", + "main": "index.js", + "files": [ + "lib" + ], + "scripts": { + "lint": "eslint .", + "test": "jest --env node --coverage", + "prerelease": "npm t && npm run lint", + "release": "standard-version", + "precommit": "lint-staged", + "commitmsg": "commitlint -e $GIT_PARAMS" + }, + "standard-version": { + "scripts": { + "posttag": "git push --follow-tags origin master && npm publish" + } + }, + "lint-staged": { + "*.js": [ + "eslint --fix", + "git add" + ] + }, + "commitlint": { + "extends": [ + "@commitlint/config-conventional" + ] + }, + "dependencies": { + "nice-try": "^1.0.4", + "path-key": "^2.0.1", + "semver": "^5.5.0", + "shebang-command": "^1.2.0", + "which": "^1.2.9" + }, + "devDependencies": { + "@commitlint/cli": "^6.0.0", + "@commitlint/config-conventional": "^6.0.2", + "babel-core": "^6.26.0", + "babel-jest": "^22.1.0", + "babel-preset-moxy": "^2.2.1", + "eslint": "^4.3.0", + "eslint-config-moxy": "^5.0.0", + "husky": "^0.14.3", + "jest": "^22.0.0", + "lint-staged": "^7.0.0", + "mkdirp": "^0.5.1", + "regenerator-runtime": "^0.11.1", + "rimraf": "^2.6.2", + "standard-version": "^4.2.0" + }, + "engines": { + "node": ">=4.8" + } +} diff --git a/node_modules/execa/node_modules/is-stream/index.js b/node_modules/execa/node_modules/is-stream/index.js new file mode 100644 index 00000000..6f7ec91a --- /dev/null +++ b/node_modules/execa/node_modules/is-stream/index.js @@ -0,0 +1,21 @@ +'use strict'; + +var isStream = module.exports = function (stream) { + return stream !== null && typeof stream === 'object' && typeof stream.pipe === 'function'; +}; + +isStream.writable = function (stream) { + return isStream(stream) && stream.writable !== false && typeof stream._write === 'function' && typeof stream._writableState === 'object'; +}; + +isStream.readable = function (stream) { + return isStream(stream) && stream.readable !== false && typeof stream._read === 'function' && typeof stream._readableState === 'object'; +}; + +isStream.duplex = function (stream) { + return isStream.writable(stream) && isStream.readable(stream); +}; + +isStream.transform = function (stream) { + return isStream.duplex(stream) && typeof stream._transform === 'function' && typeof stream._transformState === 'object'; +}; diff --git a/node_modules/execa/node_modules/is-stream/license b/node_modules/execa/node_modules/is-stream/license new file mode 100644 index 00000000..654d0bfe --- /dev/null +++ b/node_modules/execa/node_modules/is-stream/license @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) Sindre Sorhus (sindresorhus.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/execa/node_modules/is-stream/package.json b/node_modules/execa/node_modules/is-stream/package.json new file mode 100644 index 00000000..0308918d --- /dev/null +++ b/node_modules/execa/node_modules/is-stream/package.json @@ -0,0 +1,38 @@ +{ + "name": "is-stream", + "version": "1.1.0", + "description": "Check if something is a Node.js stream", + "license": "MIT", + "repository": "sindresorhus/is-stream", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=0.10.0" + }, + "scripts": { + "test": "xo && ava" + }, + "files": [ + "index.js" + ], + "keywords": [ + "stream", + "type", + "streams", + "writable", + "readable", + "duplex", + "transform", + "check", + "detect", + "is" + ], + "devDependencies": { + "ava": "*", + "tempfile": "^1.1.0", + "xo": "*" + } +} diff --git a/node_modules/execa/node_modules/is-stream/readme.md b/node_modules/execa/node_modules/is-stream/readme.md new file mode 100644 index 00000000..d8afce81 --- /dev/null +++ b/node_modules/execa/node_modules/is-stream/readme.md @@ -0,0 +1,42 @@ +# is-stream [![Build Status](https://travis-ci.org/sindresorhus/is-stream.svg?branch=master)](https://travis-ci.org/sindresorhus/is-stream) + +> Check if something is a [Node.js stream](https://nodejs.org/api/stream.html) + + +## Install + +``` +$ npm install --save is-stream +``` + + +## Usage + +```js +const fs = require('fs'); +const isStream = require('is-stream'); + +isStream(fs.createReadStream('unicorn.png')); +//=> true + +isStream({}); +//=> false +``` + + +## API + +### isStream(stream) + +#### isStream.writable(stream) + +#### isStream.readable(stream) + +#### isStream.duplex(stream) + +#### isStream.transform(stream) + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/execa/node_modules/npm-run-path/index.js b/node_modules/execa/node_modules/npm-run-path/index.js new file mode 100644 index 00000000..56f31e47 --- /dev/null +++ b/node_modules/execa/node_modules/npm-run-path/index.js @@ -0,0 +1,39 @@ +'use strict'; +const path = require('path'); +const pathKey = require('path-key'); + +module.exports = opts => { + opts = Object.assign({ + cwd: process.cwd(), + path: process.env[pathKey()] + }, opts); + + let prev; + let pth = path.resolve(opts.cwd); + const ret = []; + + while (prev !== pth) { + ret.push(path.join(pth, 'node_modules/.bin')); + prev = pth; + pth = path.resolve(pth, '..'); + } + + // ensure the running `node` binary is used + ret.push(path.dirname(process.execPath)); + + return ret.concat(opts.path).join(path.delimiter); +}; + +module.exports.env = opts => { + opts = Object.assign({ + env: process.env + }, opts); + + const env = Object.assign({}, opts.env); + const path = pathKey({env}); + + opts.path = env[path]; + env[path] = module.exports(opts); + + return env; +}; diff --git a/node_modules/execa/node_modules/npm-run-path/license b/node_modules/execa/node_modules/npm-run-path/license new file mode 100644 index 00000000..654d0bfe --- /dev/null +++ b/node_modules/execa/node_modules/npm-run-path/license @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) Sindre Sorhus (sindresorhus.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/execa/node_modules/npm-run-path/package.json b/node_modules/execa/node_modules/npm-run-path/package.json new file mode 100644 index 00000000..3c27504c --- /dev/null +++ b/node_modules/execa/node_modules/npm-run-path/package.json @@ -0,0 +1,45 @@ +{ + "name": "npm-run-path", + "version": "2.0.2", + "description": "Get your PATH prepended with locally installed binaries", + "license": "MIT", + "repository": "sindresorhus/npm-run-path", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=4" + }, + "scripts": { + "test": "xo && ava" + }, + "files": [ + "index.js" + ], + "keywords": [ + "npm", + "run", + "path", + "package", + "bin", + "binary", + "binaries", + "script", + "cli", + "command-line", + "execute", + "executable" + ], + "dependencies": { + "path-key": "^2.0.0" + }, + "devDependencies": { + "ava": "*", + "xo": "*" + }, + "xo": { + "esnext": true + } +} diff --git a/node_modules/execa/node_modules/npm-run-path/readme.md b/node_modules/execa/node_modules/npm-run-path/readme.md new file mode 100644 index 00000000..4ff4722a --- /dev/null +++ b/node_modules/execa/node_modules/npm-run-path/readme.md @@ -0,0 +1,81 @@ +# npm-run-path [![Build Status](https://travis-ci.org/sindresorhus/npm-run-path.svg?branch=master)](https://travis-ci.org/sindresorhus/npm-run-path) + +> Get your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) prepended with locally installed binaries + +In [npm run scripts](https://docs.npmjs.com/cli/run-script) you can execute locally installed binaries by name. This enables the same outside npm. + + +## Install + +``` +$ npm install --save npm-run-path +``` + + +## Usage + +```js +const childProcess = require('child_process'); +const npmRunPath = require('npm-run-path'); + +console.log(process.env.PATH); +//=> '/usr/local/bin' + +console.log(npmRunPath()); +//=> '/Users/sindresorhus/dev/foo/node_modules/.bin:/Users/sindresorhus/dev/node_modules/.bin:/Users/sindresorhus/node_modules/.bin:/Users/node_modules/.bin:/node_modules/.bin:/usr/local/bin' + +// `foo` is a locally installed binary +childProcess.execFileSync('foo', { + env: npmRunPath.env() +}); +``` + + +## API + +### npmRunPath([options]) + +#### options + +##### cwd + +Type: `string`
+Default: `process.cwd()` + +Working directory. + +##### path + +Type: `string`
+Default: [`PATH`](https://github.com/sindresorhus/path-key) + +PATH to be appended.
+Set it to an empty string to exclude the default PATH. + +### npmRunPath.env([options]) + +#### options + +##### cwd + +Type: `string`
+Default: `process.cwd()` + +Working directory. + +##### env + +Type: `Object` + +Accepts an object of environment variables, like `process.env`, and modifies the PATH using the correct [PATH key](https://github.com/sindresorhus/path-key). Use this if you're modifying the PATH for use in the `child_process` options. + + +## Related + +- [npm-run-path-cli](https://github.com/sindresorhus/npm-run-path-cli) - CLI for this module +- [execa](https://github.com/sindresorhus/execa) - Execute a locally installed binary + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/execa/node_modules/path-key/index.js b/node_modules/execa/node_modules/path-key/index.js new file mode 100644 index 00000000..62c8250a --- /dev/null +++ b/node_modules/execa/node_modules/path-key/index.js @@ -0,0 +1,13 @@ +'use strict'; +module.exports = opts => { + opts = opts || {}; + + const env = opts.env || process.env; + const platform = opts.platform || process.platform; + + if (platform !== 'win32') { + return 'PATH'; + } + + return Object.keys(env).find(x => x.toUpperCase() === 'PATH') || 'Path'; +}; diff --git a/node_modules/execa/node_modules/path-key/license b/node_modules/execa/node_modules/path-key/license new file mode 100644 index 00000000..654d0bfe --- /dev/null +++ b/node_modules/execa/node_modules/path-key/license @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) Sindre Sorhus (sindresorhus.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/execa/node_modules/path-key/package.json b/node_modules/execa/node_modules/path-key/package.json new file mode 100644 index 00000000..81e0e8be --- /dev/null +++ b/node_modules/execa/node_modules/path-key/package.json @@ -0,0 +1,39 @@ +{ + "name": "path-key", + "version": "2.0.1", + "description": "Get the PATH environment variable key cross-platform", + "license": "MIT", + "repository": "sindresorhus/path-key", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=4" + }, + "scripts": { + "test": "xo && ava" + }, + "files": [ + "index.js" + ], + "keywords": [ + "path", + "key", + "environment", + "env", + "variable", + "var", + "get", + "cross-platform", + "windows" + ], + "devDependencies": { + "ava": "*", + "xo": "*" + }, + "xo": { + "esnext": true + } +} diff --git a/node_modules/execa/node_modules/path-key/readme.md b/node_modules/execa/node_modules/path-key/readme.md new file mode 100644 index 00000000..cb5710aa --- /dev/null +++ b/node_modules/execa/node_modules/path-key/readme.md @@ -0,0 +1,51 @@ +# path-key [![Build Status](https://travis-ci.org/sindresorhus/path-key.svg?branch=master)](https://travis-ci.org/sindresorhus/path-key) + +> Get the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable key cross-platform + +It's usually `PATH`, but on Windows it can be any casing like `Path`... + + +## Install + +``` +$ npm install --save path-key +``` + + +## Usage + +```js +const pathKey = require('path-key'); + +const key = pathKey(); +//=> 'PATH' + +const PATH = process.env[key]; +//=> '/usr/local/bin:/usr/bin:/bin' +``` + + +## API + +### pathKey([options]) + +#### options + +##### env + +Type: `Object`
+Default: [`process.env`](https://nodejs.org/api/process.html#process_process_env) + +Use a custom environment variables object. + +#### platform + +Type: `string`
+Default: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform) + +Get the PATH key for a specific platform. + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/execa/node_modules/semver/CHANGELOG.md b/node_modules/execa/node_modules/semver/CHANGELOG.md new file mode 100644 index 00000000..66304fdd --- /dev/null +++ b/node_modules/execa/node_modules/semver/CHANGELOG.md @@ -0,0 +1,39 @@ +# changes log + +## 5.7 + +* Add `minVersion` method + +## 5.6 + +* Move boolean `loose` param to an options object, with + backwards-compatibility protection. +* Add ability to opt out of special prerelease version handling with + the `includePrerelease` option flag. + +## 5.5 + +* Add version coercion capabilities + +## 5.4 + +* Add intersection checking + +## 5.3 + +* Add `minSatisfying` method + +## 5.2 + +* Add `prerelease(v)` that returns prerelease components + +## 5.1 + +* Add Backus-Naur for ranges +* Remove excessively cute inspection methods + +## 5.0 + +* Remove AMD/Browserified build artifacts +* Fix ltr and gtr when using the `*` range +* Fix for range `*` with a prerelease identifier diff --git a/node_modules/execa/node_modules/semver/LICENSE b/node_modules/execa/node_modules/semver/LICENSE new file mode 100644 index 00000000..19129e31 --- /dev/null +++ b/node_modules/execa/node_modules/semver/LICENSE @@ -0,0 +1,15 @@ +The ISC License + +Copyright (c) Isaac Z. Schlueter and Contributors + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR +IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/execa/node_modules/semver/README.md b/node_modules/execa/node_modules/semver/README.md new file mode 100644 index 00000000..f8dfa5a0 --- /dev/null +++ b/node_modules/execa/node_modules/semver/README.md @@ -0,0 +1,412 @@ +semver(1) -- The semantic versioner for npm +=========================================== + +## Install + +```bash +npm install --save semver +```` + +## Usage + +As a node module: + +```js +const semver = require('semver') + +semver.valid('1.2.3') // '1.2.3' +semver.valid('a.b.c') // null +semver.clean(' =v1.2.3 ') // '1.2.3' +semver.satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3') // true +semver.gt('1.2.3', '9.8.7') // false +semver.lt('1.2.3', '9.8.7') // true +semver.minVersion('>=1.0.0') // '1.0.0' +semver.valid(semver.coerce('v2')) // '2.0.0' +semver.valid(semver.coerce('42.6.7.9.3-alpha')) // '42.6.7' +``` + +As a command-line utility: + +``` +$ semver -h + +A JavaScript implementation of the https://semver.org/ specification +Copyright Isaac Z. Schlueter + +Usage: semver [options] [ [...]] +Prints valid versions sorted by SemVer precedence + +Options: +-r --range + Print versions that match the specified range. + +-i --increment [] + Increment a version by the specified level. Level can + be one of: major, minor, patch, premajor, preminor, + prepatch, or prerelease. Default level is 'patch'. + Only one version may be specified. + +--preid + Identifier to be used to prefix premajor, preminor, + prepatch or prerelease version increments. + +-l --loose + Interpret versions and ranges loosely + +-p --include-prerelease + Always include prerelease versions in range matching + +-c --coerce + Coerce a string into SemVer if possible + (does not imply --loose) + +Program exits successfully if any valid version satisfies +all supplied ranges, and prints all satisfying versions. + +If no satisfying versions are found, then exits failure. + +Versions are printed in ascending order, so supplying +multiple versions to the utility will just sort them. +``` + +## Versions + +A "version" is described by the `v2.0.0` specification found at +. + +A leading `"="` or `"v"` character is stripped off and ignored. + +## Ranges + +A `version range` is a set of `comparators` which specify versions +that satisfy the range. + +A `comparator` is composed of an `operator` and a `version`. The set +of primitive `operators` is: + +* `<` Less than +* `<=` Less than or equal to +* `>` Greater than +* `>=` Greater than or equal to +* `=` Equal. If no operator is specified, then equality is assumed, + so this operator is optional, but MAY be included. + +For example, the comparator `>=1.2.7` would match the versions +`1.2.7`, `1.2.8`, `2.5.3`, and `1.3.9`, but not the versions `1.2.6` +or `1.1.0`. + +Comparators can be joined by whitespace to form a `comparator set`, +which is satisfied by the **intersection** of all of the comparators +it includes. + +A range is composed of one or more comparator sets, joined by `||`. A +version matches a range if and only if every comparator in at least +one of the `||`-separated comparator sets is satisfied by the version. + +For example, the range `>=1.2.7 <1.3.0` would match the versions +`1.2.7`, `1.2.8`, and `1.2.99`, but not the versions `1.2.6`, `1.3.0`, +or `1.1.0`. + +The range `1.2.7 || >=1.2.9 <2.0.0` would match the versions `1.2.7`, +`1.2.9`, and `1.4.6`, but not the versions `1.2.8` or `2.0.0`. + +### Prerelease Tags + +If a version has a prerelease tag (for example, `1.2.3-alpha.3`) then +it will only be allowed to satisfy comparator sets if at least one +comparator with the same `[major, minor, patch]` tuple also has a +prerelease tag. + +For example, the range `>1.2.3-alpha.3` would be allowed to match the +version `1.2.3-alpha.7`, but it would *not* be satisfied by +`3.4.5-alpha.9`, even though `3.4.5-alpha.9` is technically "greater +than" `1.2.3-alpha.3` according to the SemVer sort rules. The version +range only accepts prerelease tags on the `1.2.3` version. The +version `3.4.5` *would* satisfy the range, because it does not have a +prerelease flag, and `3.4.5` is greater than `1.2.3-alpha.7`. + +The purpose for this behavior is twofold. First, prerelease versions +frequently are updated very quickly, and contain many breaking changes +that are (by the author's design) not yet fit for public consumption. +Therefore, by default, they are excluded from range matching +semantics. + +Second, a user who has opted into using a prerelease version has +clearly indicated the intent to use *that specific* set of +alpha/beta/rc versions. By including a prerelease tag in the range, +the user is indicating that they are aware of the risk. However, it +is still not appropriate to assume that they have opted into taking a +similar risk on the *next* set of prerelease versions. + +Note that this behavior can be suppressed (treating all prerelease +versions as if they were normal versions, for the purpose of range +matching) by setting the `includePrerelease` flag on the options +object to any +[functions](https://github.com/npm/node-semver#functions) that do +range matching. + +#### Prerelease Identifiers + +The method `.inc` takes an additional `identifier` string argument that +will append the value of the string as a prerelease identifier: + +```javascript +semver.inc('1.2.3', 'prerelease', 'beta') +// '1.2.4-beta.0' +``` + +command-line example: + +```bash +$ semver 1.2.3 -i prerelease --preid beta +1.2.4-beta.0 +``` + +Which then can be used to increment further: + +```bash +$ semver 1.2.4-beta.0 -i prerelease +1.2.4-beta.1 +``` + +### Advanced Range Syntax + +Advanced range syntax desugars to primitive comparators in +deterministic ways. + +Advanced ranges may be combined in the same way as primitive +comparators using white space or `||`. + +#### Hyphen Ranges `X.Y.Z - A.B.C` + +Specifies an inclusive set. + +* `1.2.3 - 2.3.4` := `>=1.2.3 <=2.3.4` + +If a partial version is provided as the first version in the inclusive +range, then the missing pieces are replaced with zeroes. + +* `1.2 - 2.3.4` := `>=1.2.0 <=2.3.4` + +If a partial version is provided as the second version in the +inclusive range, then all versions that start with the supplied parts +of the tuple are accepted, but nothing that would be greater than the +provided tuple parts. + +* `1.2.3 - 2.3` := `>=1.2.3 <2.4.0` +* `1.2.3 - 2` := `>=1.2.3 <3.0.0` + +#### X-Ranges `1.2.x` `1.X` `1.2.*` `*` + +Any of `X`, `x`, or `*` may be used to "stand in" for one of the +numeric values in the `[major, minor, patch]` tuple. + +* `*` := `>=0.0.0` (Any version satisfies) +* `1.x` := `>=1.0.0 <2.0.0` (Matching major version) +* `1.2.x` := `>=1.2.0 <1.3.0` (Matching major and minor versions) + +A partial version range is treated as an X-Range, so the special +character is in fact optional. + +* `""` (empty string) := `*` := `>=0.0.0` +* `1` := `1.x.x` := `>=1.0.0 <2.0.0` +* `1.2` := `1.2.x` := `>=1.2.0 <1.3.0` + +#### Tilde Ranges `~1.2.3` `~1.2` `~1` + +Allows patch-level changes if a minor version is specified on the +comparator. Allows minor-level changes if not. + +* `~1.2.3` := `>=1.2.3 <1.(2+1).0` := `>=1.2.3 <1.3.0` +* `~1.2` := `>=1.2.0 <1.(2+1).0` := `>=1.2.0 <1.3.0` (Same as `1.2.x`) +* `~1` := `>=1.0.0 <(1+1).0.0` := `>=1.0.0 <2.0.0` (Same as `1.x`) +* `~0.2.3` := `>=0.2.3 <0.(2+1).0` := `>=0.2.3 <0.3.0` +* `~0.2` := `>=0.2.0 <0.(2+1).0` := `>=0.2.0 <0.3.0` (Same as `0.2.x`) +* `~0` := `>=0.0.0 <(0+1).0.0` := `>=0.0.0 <1.0.0` (Same as `0.x`) +* `~1.2.3-beta.2` := `>=1.2.3-beta.2 <1.3.0` Note that prereleases in + the `1.2.3` version will be allowed, if they are greater than or + equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but + `1.2.4-beta.2` would not, because it is a prerelease of a + different `[major, minor, patch]` tuple. + +#### Caret Ranges `^1.2.3` `^0.2.5` `^0.0.4` + +Allows changes that do not modify the left-most non-zero digit in the +`[major, minor, patch]` tuple. In other words, this allows patch and +minor updates for versions `1.0.0` and above, patch updates for +versions `0.X >=0.1.0`, and *no* updates for versions `0.0.X`. + +Many authors treat a `0.x` version as if the `x` were the major +"breaking-change" indicator. + +Caret ranges are ideal when an author may make breaking changes +between `0.2.4` and `0.3.0` releases, which is a common practice. +However, it presumes that there will *not* be breaking changes between +`0.2.4` and `0.2.5`. It allows for changes that are presumed to be +additive (but non-breaking), according to commonly observed practices. + +* `^1.2.3` := `>=1.2.3 <2.0.0` +* `^0.2.3` := `>=0.2.3 <0.3.0` +* `^0.0.3` := `>=0.0.3 <0.0.4` +* `^1.2.3-beta.2` := `>=1.2.3-beta.2 <2.0.0` Note that prereleases in + the `1.2.3` version will be allowed, if they are greater than or + equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but + `1.2.4-beta.2` would not, because it is a prerelease of a + different `[major, minor, patch]` tuple. +* `^0.0.3-beta` := `>=0.0.3-beta <0.0.4` Note that prereleases in the + `0.0.3` version *only* will be allowed, if they are greater than or + equal to `beta`. So, `0.0.3-pr.2` would be allowed. + +When parsing caret ranges, a missing `patch` value desugars to the +number `0`, but will allow flexibility within that value, even if the +major and minor versions are both `0`. + +* `^1.2.x` := `>=1.2.0 <2.0.0` +* `^0.0.x` := `>=0.0.0 <0.1.0` +* `^0.0` := `>=0.0.0 <0.1.0` + +A missing `minor` and `patch` values will desugar to zero, but also +allow flexibility within those values, even if the major version is +zero. + +* `^1.x` := `>=1.0.0 <2.0.0` +* `^0.x` := `>=0.0.0 <1.0.0` + +### Range Grammar + +Putting all this together, here is a Backus-Naur grammar for ranges, +for the benefit of parser authors: + +```bnf +range-set ::= range ( logical-or range ) * +logical-or ::= ( ' ' ) * '||' ( ' ' ) * +range ::= hyphen | simple ( ' ' simple ) * | '' +hyphen ::= partial ' - ' partial +simple ::= primitive | partial | tilde | caret +primitive ::= ( '<' | '>' | '>=' | '<=' | '=' ) partial +partial ::= xr ( '.' xr ( '.' xr qualifier ? )? )? +xr ::= 'x' | 'X' | '*' | nr +nr ::= '0' | ['1'-'9'] ( ['0'-'9'] ) * +tilde ::= '~' partial +caret ::= '^' partial +qualifier ::= ( '-' pre )? ( '+' build )? +pre ::= parts +build ::= parts +parts ::= part ( '.' part ) * +part ::= nr | [-0-9A-Za-z]+ +``` + +## Functions + +All methods and classes take a final `options` object argument. All +options in this object are `false` by default. The options supported +are: + +- `loose` Be more forgiving about not-quite-valid semver strings. + (Any resulting output will always be 100% strict compliant, of + course.) For backwards compatibility reasons, if the `options` + argument is a boolean value instead of an object, it is interpreted + to be the `loose` param. +- `includePrerelease` Set to suppress the [default + behavior](https://github.com/npm/node-semver#prerelease-tags) of + excluding prerelease tagged versions from ranges unless they are + explicitly opted into. + +Strict-mode Comparators and Ranges will be strict about the SemVer +strings that they parse. + +* `valid(v)`: Return the parsed version, or null if it's not valid. +* `inc(v, release)`: Return the version incremented by the release + type (`major`, `premajor`, `minor`, `preminor`, `patch`, + `prepatch`, or `prerelease`), or null if it's not valid + * `premajor` in one call will bump the version up to the next major + version and down to a prerelease of that major version. + `preminor`, and `prepatch` work the same way. + * If called from a non-prerelease version, the `prerelease` will work the + same as `prepatch`. It increments the patch version, then makes a + prerelease. If the input version is already a prerelease it simply + increments it. +* `prerelease(v)`: Returns an array of prerelease components, or null + if none exist. Example: `prerelease('1.2.3-alpha.1') -> ['alpha', 1]` +* `major(v)`: Return the major version number. +* `minor(v)`: Return the minor version number. +* `patch(v)`: Return the patch version number. +* `intersects(r1, r2, loose)`: Return true if the two supplied ranges + or comparators intersect. +* `parse(v)`: Attempt to parse a string as a semantic version, returning either + a `SemVer` object or `null`. + +### Comparison + +* `gt(v1, v2)`: `v1 > v2` +* `gte(v1, v2)`: `v1 >= v2` +* `lt(v1, v2)`: `v1 < v2` +* `lte(v1, v2)`: `v1 <= v2` +* `eq(v1, v2)`: `v1 == v2` This is true if they're logically equivalent, + even if they're not the exact same string. You already know how to + compare strings. +* `neq(v1, v2)`: `v1 != v2` The opposite of `eq`. +* `cmp(v1, comparator, v2)`: Pass in a comparison string, and it'll call + the corresponding function above. `"==="` and `"!=="` do simple + string comparison, but are included for completeness. Throws if an + invalid comparison string is provided. +* `compare(v1, v2)`: Return `0` if `v1 == v2`, or `1` if `v1` is greater, or `-1` if + `v2` is greater. Sorts in ascending order if passed to `Array.sort()`. +* `rcompare(v1, v2)`: The reverse of compare. Sorts an array of versions + in descending order when passed to `Array.sort()`. +* `diff(v1, v2)`: Returns difference between two versions by the release type + (`major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, or `prerelease`), + or null if the versions are the same. + +### Comparators + +* `intersects(comparator)`: Return true if the comparators intersect + +### Ranges + +* `validRange(range)`: Return the valid range or null if it's not valid +* `satisfies(version, range)`: Return true if the version satisfies the + range. +* `maxSatisfying(versions, range)`: Return the highest version in the list + that satisfies the range, or `null` if none of them do. +* `minSatisfying(versions, range)`: Return the lowest version in the list + that satisfies the range, or `null` if none of them do. +* `minVersion(range)`: Return the lowest version that can possibly match + the given range. +* `gtr(version, range)`: Return `true` if version is greater than all the + versions possible in the range. +* `ltr(version, range)`: Return `true` if version is less than all the + versions possible in the range. +* `outside(version, range, hilo)`: Return true if the version is outside + the bounds of the range in either the high or low direction. The + `hilo` argument must be either the string `'>'` or `'<'`. (This is + the function called by `gtr` and `ltr`.) +* `intersects(range)`: Return true if any of the ranges comparators intersect + +Note that, since ranges may be non-contiguous, a version might not be +greater than a range, less than a range, *or* satisfy a range! For +example, the range `1.2 <1.2.9 || >2.0.0` would have a hole from `1.2.9` +until `2.0.0`, so the version `1.2.10` would not be greater than the +range (because `2.0.1` satisfies, which is higher), nor less than the +range (since `1.2.8` satisfies, which is lower), and it also does not +satisfy the range. + +If you want to know if a version satisfies or does not satisfy a +range, use the `satisfies(version, range)` function. + +### Coercion + +* `coerce(version)`: Coerces a string to semver if possible + +This aims to provide a very forgiving translation of a non-semver string to +semver. It looks for the first digit in a string, and consumes all +remaining characters which satisfy at least a partial semver (e.g., `1`, +`1.2`, `1.2.3`) up to the max permitted length (256 characters). Longer +versions are simply truncated (`4.6.3.9.2-alpha2` becomes `4.6.3`). All +surrounding text is simply ignored (`v3.4 replaces v3.3.1` becomes +`3.4.0`). Only text which lacks digits will fail coercion (`version one` +is not valid). The maximum length for any semver component considered for +coercion is 16 characters; longer components will be ignored +(`10000000000000000.4.7.4` becomes `4.7.4`). The maximum value for any +semver component is `Number.MAX_SAFE_INTEGER || (2**53 - 1)`; higher value +components are invalid (`9999999999999999.4.7.4` is likely invalid). diff --git a/node_modules/execa/node_modules/semver/bin/semver b/node_modules/execa/node_modules/semver/bin/semver new file mode 100755 index 00000000..801e77f1 --- /dev/null +++ b/node_modules/execa/node_modules/semver/bin/semver @@ -0,0 +1,160 @@ +#!/usr/bin/env node +// Standalone semver comparison program. +// Exits successfully and prints matching version(s) if +// any supplied version is valid and passes all tests. + +var argv = process.argv.slice(2) + +var versions = [] + +var range = [] + +var inc = null + +var version = require('../package.json').version + +var loose = false + +var includePrerelease = false + +var coerce = false + +var identifier + +var semver = require('../semver') + +var reverse = false + +var options = {} + +main() + +function main () { + if (!argv.length) return help() + while (argv.length) { + var a = argv.shift() + var indexOfEqualSign = a.indexOf('=') + if (indexOfEqualSign !== -1) { + a = a.slice(0, indexOfEqualSign) + argv.unshift(a.slice(indexOfEqualSign + 1)) + } + switch (a) { + case '-rv': case '-rev': case '--rev': case '--reverse': + reverse = true + break + case '-l': case '--loose': + loose = true + break + case '-p': case '--include-prerelease': + includePrerelease = true + break + case '-v': case '--version': + versions.push(argv.shift()) + break + case '-i': case '--inc': case '--increment': + switch (argv[0]) { + case 'major': case 'minor': case 'patch': case 'prerelease': + case 'premajor': case 'preminor': case 'prepatch': + inc = argv.shift() + break + default: + inc = 'patch' + break + } + break + case '--preid': + identifier = argv.shift() + break + case '-r': case '--range': + range.push(argv.shift()) + break + case '-c': case '--coerce': + coerce = true + break + case '-h': case '--help': case '-?': + return help() + default: + versions.push(a) + break + } + } + + var options = { loose: loose, includePrerelease: includePrerelease } + + versions = versions.map(function (v) { + return coerce ? (semver.coerce(v) || { version: v }).version : v + }).filter(function (v) { + return semver.valid(v) + }) + if (!versions.length) return fail() + if (inc && (versions.length !== 1 || range.length)) { return failInc() } + + for (var i = 0, l = range.length; i < l; i++) { + versions = versions.filter(function (v) { + return semver.satisfies(v, range[i], options) + }) + if (!versions.length) return fail() + } + return success(versions) +} + +function failInc () { + console.error('--inc can only be used on a single version with no range') + fail() +} + +function fail () { process.exit(1) } + +function success () { + var compare = reverse ? 'rcompare' : 'compare' + versions.sort(function (a, b) { + return semver[compare](a, b, options) + }).map(function (v) { + return semver.clean(v, options) + }).map(function (v) { + return inc ? semver.inc(v, inc, options, identifier) : v + }).forEach(function (v, i, _) { console.log(v) }) +} + +function help () { + console.log(['SemVer ' + version, + '', + 'A JavaScript implementation of the https://semver.org/ specification', + 'Copyright Isaac Z. Schlueter', + '', + 'Usage: semver [options] [ [...]]', + 'Prints valid versions sorted by SemVer precedence', + '', + 'Options:', + '-r --range ', + ' Print versions that match the specified range.', + '', + '-i --increment []', + ' Increment a version by the specified level. Level can', + ' be one of: major, minor, patch, premajor, preminor,', + " prepatch, or prerelease. Default level is 'patch'.", + ' Only one version may be specified.', + '', + '--preid ', + ' Identifier to be used to prefix premajor, preminor,', + ' prepatch or prerelease version increments.', + '', + '-l --loose', + ' Interpret versions and ranges loosely', + '', + '-p --include-prerelease', + ' Always include prerelease versions in range matching', + '', + '-c --coerce', + ' Coerce a string into SemVer if possible', + ' (does not imply --loose)', + '', + 'Program exits successfully if any valid version satisfies', + 'all supplied ranges, and prints all satisfying versions.', + '', + 'If no satisfying versions are found, then exits failure.', + '', + 'Versions are printed in ascending order, so supplying', + 'multiple versions to the utility will just sort them.' + ].join('\n')) +} diff --git a/node_modules/execa/node_modules/semver/package.json b/node_modules/execa/node_modules/semver/package.json new file mode 100644 index 00000000..69d2db16 --- /dev/null +++ b/node_modules/execa/node_modules/semver/package.json @@ -0,0 +1,28 @@ +{ + "name": "semver", + "version": "5.7.1", + "description": "The semantic version parser used by npm.", + "main": "semver.js", + "scripts": { + "test": "tap", + "preversion": "npm test", + "postversion": "npm publish", + "postpublish": "git push origin --all; git push origin --tags" + }, + "devDependencies": { + "tap": "^13.0.0-rc.18" + }, + "license": "ISC", + "repository": "https://github.com/npm/node-semver", + "bin": { + "semver": "./bin/semver" + }, + "files": [ + "bin", + "range.bnf", + "semver.js" + ], + "tap": { + "check-coverage": true + } +} diff --git a/node_modules/execa/node_modules/semver/range.bnf b/node_modules/execa/node_modules/semver/range.bnf new file mode 100644 index 00000000..d4c6ae0d --- /dev/null +++ b/node_modules/execa/node_modules/semver/range.bnf @@ -0,0 +1,16 @@ +range-set ::= range ( logical-or range ) * +logical-or ::= ( ' ' ) * '||' ( ' ' ) * +range ::= hyphen | simple ( ' ' simple ) * | '' +hyphen ::= partial ' - ' partial +simple ::= primitive | partial | tilde | caret +primitive ::= ( '<' | '>' | '>=' | '<=' | '=' ) partial +partial ::= xr ( '.' xr ( '.' xr qualifier ? )? )? +xr ::= 'x' | 'X' | '*' | nr +nr ::= '0' | [1-9] ( [0-9] ) * +tilde ::= '~' partial +caret ::= '^' partial +qualifier ::= ( '-' pre )? ( '+' build )? +pre ::= parts +build ::= parts +parts ::= part ( '.' part ) * +part ::= nr | [-0-9A-Za-z]+ diff --git a/node_modules/execa/node_modules/semver/semver.js b/node_modules/execa/node_modules/semver/semver.js new file mode 100644 index 00000000..d315d5d6 --- /dev/null +++ b/node_modules/execa/node_modules/semver/semver.js @@ -0,0 +1,1483 @@ +exports = module.exports = SemVer + +var debug +/* istanbul ignore next */ +if (typeof process === 'object' && + process.env && + process.env.NODE_DEBUG && + /\bsemver\b/i.test(process.env.NODE_DEBUG)) { + debug = function () { + var args = Array.prototype.slice.call(arguments, 0) + args.unshift('SEMVER') + console.log.apply(console, args) + } +} else { + debug = function () {} +} + +// Note: this is the semver.org version of the spec that it implements +// Not necessarily the package version of this code. +exports.SEMVER_SPEC_VERSION = '2.0.0' + +var MAX_LENGTH = 256 +var MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER || + /* istanbul ignore next */ 9007199254740991 + +// Max safe segment length for coercion. +var MAX_SAFE_COMPONENT_LENGTH = 16 + +// The actual regexps go on exports.re +var re = exports.re = [] +var src = exports.src = [] +var R = 0 + +// The following Regular Expressions can be used for tokenizing, +// validating, and parsing SemVer version strings. + +// ## Numeric Identifier +// A single `0`, or a non-zero digit followed by zero or more digits. + +var NUMERICIDENTIFIER = R++ +src[NUMERICIDENTIFIER] = '0|[1-9]\\d*' +var NUMERICIDENTIFIERLOOSE = R++ +src[NUMERICIDENTIFIERLOOSE] = '[0-9]+' + +// ## Non-numeric Identifier +// Zero or more digits, followed by a letter or hyphen, and then zero or +// more letters, digits, or hyphens. + +var NONNUMERICIDENTIFIER = R++ +src[NONNUMERICIDENTIFIER] = '\\d*[a-zA-Z-][a-zA-Z0-9-]*' + +// ## Main Version +// Three dot-separated numeric identifiers. + +var MAINVERSION = R++ +src[MAINVERSION] = '(' + src[NUMERICIDENTIFIER] + ')\\.' + + '(' + src[NUMERICIDENTIFIER] + ')\\.' + + '(' + src[NUMERICIDENTIFIER] + ')' + +var MAINVERSIONLOOSE = R++ +src[MAINVERSIONLOOSE] = '(' + src[NUMERICIDENTIFIERLOOSE] + ')\\.' + + '(' + src[NUMERICIDENTIFIERLOOSE] + ')\\.' + + '(' + src[NUMERICIDENTIFIERLOOSE] + ')' + +// ## Pre-release Version Identifier +// A numeric identifier, or a non-numeric identifier. + +var PRERELEASEIDENTIFIER = R++ +src[PRERELEASEIDENTIFIER] = '(?:' + src[NUMERICIDENTIFIER] + + '|' + src[NONNUMERICIDENTIFIER] + ')' + +var PRERELEASEIDENTIFIERLOOSE = R++ +src[PRERELEASEIDENTIFIERLOOSE] = '(?:' + src[NUMERICIDENTIFIERLOOSE] + + '|' + src[NONNUMERICIDENTIFIER] + ')' + +// ## Pre-release Version +// Hyphen, followed by one or more dot-separated pre-release version +// identifiers. + +var PRERELEASE = R++ +src[PRERELEASE] = '(?:-(' + src[PRERELEASEIDENTIFIER] + + '(?:\\.' + src[PRERELEASEIDENTIFIER] + ')*))' + +var PRERELEASELOOSE = R++ +src[PRERELEASELOOSE] = '(?:-?(' + src[PRERELEASEIDENTIFIERLOOSE] + + '(?:\\.' + src[PRERELEASEIDENTIFIERLOOSE] + ')*))' + +// ## Build Metadata Identifier +// Any combination of digits, letters, or hyphens. + +var BUILDIDENTIFIER = R++ +src[BUILDIDENTIFIER] = '[0-9A-Za-z-]+' + +// ## Build Metadata +// Plus sign, followed by one or more period-separated build metadata +// identifiers. + +var BUILD = R++ +src[BUILD] = '(?:\\+(' + src[BUILDIDENTIFIER] + + '(?:\\.' + src[BUILDIDENTIFIER] + ')*))' + +// ## Full Version String +// A main version, followed optionally by a pre-release version and +// build metadata. + +// Note that the only major, minor, patch, and pre-release sections of +// the version string are capturing groups. The build metadata is not a +// capturing group, because it should not ever be used in version +// comparison. + +var FULL = R++ +var FULLPLAIN = 'v?' + src[MAINVERSION] + + src[PRERELEASE] + '?' + + src[BUILD] + '?' + +src[FULL] = '^' + FULLPLAIN + '$' + +// like full, but allows v1.2.3 and =1.2.3, which people do sometimes. +// also, 1.0.0alpha1 (prerelease without the hyphen) which is pretty +// common in the npm registry. +var LOOSEPLAIN = '[v=\\s]*' + src[MAINVERSIONLOOSE] + + src[PRERELEASELOOSE] + '?' + + src[BUILD] + '?' + +var LOOSE = R++ +src[LOOSE] = '^' + LOOSEPLAIN + '$' + +var GTLT = R++ +src[GTLT] = '((?:<|>)?=?)' + +// Something like "2.*" or "1.2.x". +// Note that "x.x" is a valid xRange identifer, meaning "any version" +// Only the first item is strictly required. +var XRANGEIDENTIFIERLOOSE = R++ +src[XRANGEIDENTIFIERLOOSE] = src[NUMERICIDENTIFIERLOOSE] + '|x|X|\\*' +var XRANGEIDENTIFIER = R++ +src[XRANGEIDENTIFIER] = src[NUMERICIDENTIFIER] + '|x|X|\\*' + +var XRANGEPLAIN = R++ +src[XRANGEPLAIN] = '[v=\\s]*(' + src[XRANGEIDENTIFIER] + ')' + + '(?:\\.(' + src[XRANGEIDENTIFIER] + ')' + + '(?:\\.(' + src[XRANGEIDENTIFIER] + ')' + + '(?:' + src[PRERELEASE] + ')?' + + src[BUILD] + '?' + + ')?)?' + +var XRANGEPLAINLOOSE = R++ +src[XRANGEPLAINLOOSE] = '[v=\\s]*(' + src[XRANGEIDENTIFIERLOOSE] + ')' + + '(?:\\.(' + src[XRANGEIDENTIFIERLOOSE] + ')' + + '(?:\\.(' + src[XRANGEIDENTIFIERLOOSE] + ')' + + '(?:' + src[PRERELEASELOOSE] + ')?' + + src[BUILD] + '?' + + ')?)?' + +var XRANGE = R++ +src[XRANGE] = '^' + src[GTLT] + '\\s*' + src[XRANGEPLAIN] + '$' +var XRANGELOOSE = R++ +src[XRANGELOOSE] = '^' + src[GTLT] + '\\s*' + src[XRANGEPLAINLOOSE] + '$' + +// Coercion. +// Extract anything that could conceivably be a part of a valid semver +var COERCE = R++ +src[COERCE] = '(?:^|[^\\d])' + + '(\\d{1,' + MAX_SAFE_COMPONENT_LENGTH + '})' + + '(?:\\.(\\d{1,' + MAX_SAFE_COMPONENT_LENGTH + '}))?' + + '(?:\\.(\\d{1,' + MAX_SAFE_COMPONENT_LENGTH + '}))?' + + '(?:$|[^\\d])' + +// Tilde ranges. +// Meaning is "reasonably at or greater than" +var LONETILDE = R++ +src[LONETILDE] = '(?:~>?)' + +var TILDETRIM = R++ +src[TILDETRIM] = '(\\s*)' + src[LONETILDE] + '\\s+' +re[TILDETRIM] = new RegExp(src[TILDETRIM], 'g') +var tildeTrimReplace = '$1~' + +var TILDE = R++ +src[TILDE] = '^' + src[LONETILDE] + src[XRANGEPLAIN] + '$' +var TILDELOOSE = R++ +src[TILDELOOSE] = '^' + src[LONETILDE] + src[XRANGEPLAINLOOSE] + '$' + +// Caret ranges. +// Meaning is "at least and backwards compatible with" +var LONECARET = R++ +src[LONECARET] = '(?:\\^)' + +var CARETTRIM = R++ +src[CARETTRIM] = '(\\s*)' + src[LONECARET] + '\\s+' +re[CARETTRIM] = new RegExp(src[CARETTRIM], 'g') +var caretTrimReplace = '$1^' + +var CARET = R++ +src[CARET] = '^' + src[LONECARET] + src[XRANGEPLAIN] + '$' +var CARETLOOSE = R++ +src[CARETLOOSE] = '^' + src[LONECARET] + src[XRANGEPLAINLOOSE] + '$' + +// A simple gt/lt/eq thing, or just "" to indicate "any version" +var COMPARATORLOOSE = R++ +src[COMPARATORLOOSE] = '^' + src[GTLT] + '\\s*(' + LOOSEPLAIN + ')$|^$' +var COMPARATOR = R++ +src[COMPARATOR] = '^' + src[GTLT] + '\\s*(' + FULLPLAIN + ')$|^$' + +// An expression to strip any whitespace between the gtlt and the thing +// it modifies, so that `> 1.2.3` ==> `>1.2.3` +var COMPARATORTRIM = R++ +src[COMPARATORTRIM] = '(\\s*)' + src[GTLT] + + '\\s*(' + LOOSEPLAIN + '|' + src[XRANGEPLAIN] + ')' + +// this one has to use the /g flag +re[COMPARATORTRIM] = new RegExp(src[COMPARATORTRIM], 'g') +var comparatorTrimReplace = '$1$2$3' + +// Something like `1.2.3 - 1.2.4` +// Note that these all use the loose form, because they'll be +// checked against either the strict or loose comparator form +// later. +var HYPHENRANGE = R++ +src[HYPHENRANGE] = '^\\s*(' + src[XRANGEPLAIN] + ')' + + '\\s+-\\s+' + + '(' + src[XRANGEPLAIN] + ')' + + '\\s*$' + +var HYPHENRANGELOOSE = R++ +src[HYPHENRANGELOOSE] = '^\\s*(' + src[XRANGEPLAINLOOSE] + ')' + + '\\s+-\\s+' + + '(' + src[XRANGEPLAINLOOSE] + ')' + + '\\s*$' + +// Star ranges basically just allow anything at all. +var STAR = R++ +src[STAR] = '(<|>)?=?\\s*\\*' + +// Compile to actual regexp objects. +// All are flag-free, unless they were created above with a flag. +for (var i = 0; i < R; i++) { + debug(i, src[i]) + if (!re[i]) { + re[i] = new RegExp(src[i]) + } +} + +exports.parse = parse +function parse (version, options) { + if (!options || typeof options !== 'object') { + options = { + loose: !!options, + includePrerelease: false + } + } + + if (version instanceof SemVer) { + return version + } + + if (typeof version !== 'string') { + return null + } + + if (version.length > MAX_LENGTH) { + return null + } + + var r = options.loose ? re[LOOSE] : re[FULL] + if (!r.test(version)) { + return null + } + + try { + return new SemVer(version, options) + } catch (er) { + return null + } +} + +exports.valid = valid +function valid (version, options) { + var v = parse(version, options) + return v ? v.version : null +} + +exports.clean = clean +function clean (version, options) { + var s = parse(version.trim().replace(/^[=v]+/, ''), options) + return s ? s.version : null +} + +exports.SemVer = SemVer + +function SemVer (version, options) { + if (!options || typeof options !== 'object') { + options = { + loose: !!options, + includePrerelease: false + } + } + if (version instanceof SemVer) { + if (version.loose === options.loose) { + return version + } else { + version = version.version + } + } else if (typeof version !== 'string') { + throw new TypeError('Invalid Version: ' + version) + } + + if (version.length > MAX_LENGTH) { + throw new TypeError('version is longer than ' + MAX_LENGTH + ' characters') + } + + if (!(this instanceof SemVer)) { + return new SemVer(version, options) + } + + debug('SemVer', version, options) + this.options = options + this.loose = !!options.loose + + var m = version.trim().match(options.loose ? re[LOOSE] : re[FULL]) + + if (!m) { + throw new TypeError('Invalid Version: ' + version) + } + + this.raw = version + + // these are actually numbers + this.major = +m[1] + this.minor = +m[2] + this.patch = +m[3] + + if (this.major > MAX_SAFE_INTEGER || this.major < 0) { + throw new TypeError('Invalid major version') + } + + if (this.minor > MAX_SAFE_INTEGER || this.minor < 0) { + throw new TypeError('Invalid minor version') + } + + if (this.patch > MAX_SAFE_INTEGER || this.patch < 0) { + throw new TypeError('Invalid patch version') + } + + // numberify any prerelease numeric ids + if (!m[4]) { + this.prerelease = [] + } else { + this.prerelease = m[4].split('.').map(function (id) { + if (/^[0-9]+$/.test(id)) { + var num = +id + if (num >= 0 && num < MAX_SAFE_INTEGER) { + return num + } + } + return id + }) + } + + this.build = m[5] ? m[5].split('.') : [] + this.format() +} + +SemVer.prototype.format = function () { + this.version = this.major + '.' + this.minor + '.' + this.patch + if (this.prerelease.length) { + this.version += '-' + this.prerelease.join('.') + } + return this.version +} + +SemVer.prototype.toString = function () { + return this.version +} + +SemVer.prototype.compare = function (other) { + debug('SemVer.compare', this.version, this.options, other) + if (!(other instanceof SemVer)) { + other = new SemVer(other, this.options) + } + + return this.compareMain(other) || this.comparePre(other) +} + +SemVer.prototype.compareMain = function (other) { + if (!(other instanceof SemVer)) { + other = new SemVer(other, this.options) + } + + return compareIdentifiers(this.major, other.major) || + compareIdentifiers(this.minor, other.minor) || + compareIdentifiers(this.patch, other.patch) +} + +SemVer.prototype.comparePre = function (other) { + if (!(other instanceof SemVer)) { + other = new SemVer(other, this.options) + } + + // NOT having a prerelease is > having one + if (this.prerelease.length && !other.prerelease.length) { + return -1 + } else if (!this.prerelease.length && other.prerelease.length) { + return 1 + } else if (!this.prerelease.length && !other.prerelease.length) { + return 0 + } + + var i = 0 + do { + var a = this.prerelease[i] + var b = other.prerelease[i] + debug('prerelease compare', i, a, b) + if (a === undefined && b === undefined) { + return 0 + } else if (b === undefined) { + return 1 + } else if (a === undefined) { + return -1 + } else if (a === b) { + continue + } else { + return compareIdentifiers(a, b) + } + } while (++i) +} + +// preminor will bump the version up to the next minor release, and immediately +// down to pre-release. premajor and prepatch work the same way. +SemVer.prototype.inc = function (release, identifier) { + switch (release) { + case 'premajor': + this.prerelease.length = 0 + this.patch = 0 + this.minor = 0 + this.major++ + this.inc('pre', identifier) + break + case 'preminor': + this.prerelease.length = 0 + this.patch = 0 + this.minor++ + this.inc('pre', identifier) + break + case 'prepatch': + // If this is already a prerelease, it will bump to the next version + // drop any prereleases that might already exist, since they are not + // relevant at this point. + this.prerelease.length = 0 + this.inc('patch', identifier) + this.inc('pre', identifier) + break + // If the input is a non-prerelease version, this acts the same as + // prepatch. + case 'prerelease': + if (this.prerelease.length === 0) { + this.inc('patch', identifier) + } + this.inc('pre', identifier) + break + + case 'major': + // If this is a pre-major version, bump up to the same major version. + // Otherwise increment major. + // 1.0.0-5 bumps to 1.0.0 + // 1.1.0 bumps to 2.0.0 + if (this.minor !== 0 || + this.patch !== 0 || + this.prerelease.length === 0) { + this.major++ + } + this.minor = 0 + this.patch = 0 + this.prerelease = [] + break + case 'minor': + // If this is a pre-minor version, bump up to the same minor version. + // Otherwise increment minor. + // 1.2.0-5 bumps to 1.2.0 + // 1.2.1 bumps to 1.3.0 + if (this.patch !== 0 || this.prerelease.length === 0) { + this.minor++ + } + this.patch = 0 + this.prerelease = [] + break + case 'patch': + // If this is not a pre-release version, it will increment the patch. + // If it is a pre-release it will bump up to the same patch version. + // 1.2.0-5 patches to 1.2.0 + // 1.2.0 patches to 1.2.1 + if (this.prerelease.length === 0) { + this.patch++ + } + this.prerelease = [] + break + // This probably shouldn't be used publicly. + // 1.0.0 "pre" would become 1.0.0-0 which is the wrong direction. + case 'pre': + if (this.prerelease.length === 0) { + this.prerelease = [0] + } else { + var i = this.prerelease.length + while (--i >= 0) { + if (typeof this.prerelease[i] === 'number') { + this.prerelease[i]++ + i = -2 + } + } + if (i === -1) { + // didn't increment anything + this.prerelease.push(0) + } + } + if (identifier) { + // 1.2.0-beta.1 bumps to 1.2.0-beta.2, + // 1.2.0-beta.fooblz or 1.2.0-beta bumps to 1.2.0-beta.0 + if (this.prerelease[0] === identifier) { + if (isNaN(this.prerelease[1])) { + this.prerelease = [identifier, 0] + } + } else { + this.prerelease = [identifier, 0] + } + } + break + + default: + throw new Error('invalid increment argument: ' + release) + } + this.format() + this.raw = this.version + return this +} + +exports.inc = inc +function inc (version, release, loose, identifier) { + if (typeof (loose) === 'string') { + identifier = loose + loose = undefined + } + + try { + return new SemVer(version, loose).inc(release, identifier).version + } catch (er) { + return null + } +} + +exports.diff = diff +function diff (version1, version2) { + if (eq(version1, version2)) { + return null + } else { + var v1 = parse(version1) + var v2 = parse(version2) + var prefix = '' + if (v1.prerelease.length || v2.prerelease.length) { + prefix = 'pre' + var defaultResult = 'prerelease' + } + for (var key in v1) { + if (key === 'major' || key === 'minor' || key === 'patch') { + if (v1[key] !== v2[key]) { + return prefix + key + } + } + } + return defaultResult // may be undefined + } +} + +exports.compareIdentifiers = compareIdentifiers + +var numeric = /^[0-9]+$/ +function compareIdentifiers (a, b) { + var anum = numeric.test(a) + var bnum = numeric.test(b) + + if (anum && bnum) { + a = +a + b = +b + } + + return a === b ? 0 + : (anum && !bnum) ? -1 + : (bnum && !anum) ? 1 + : a < b ? -1 + : 1 +} + +exports.rcompareIdentifiers = rcompareIdentifiers +function rcompareIdentifiers (a, b) { + return compareIdentifiers(b, a) +} + +exports.major = major +function major (a, loose) { + return new SemVer(a, loose).major +} + +exports.minor = minor +function minor (a, loose) { + return new SemVer(a, loose).minor +} + +exports.patch = patch +function patch (a, loose) { + return new SemVer(a, loose).patch +} + +exports.compare = compare +function compare (a, b, loose) { + return new SemVer(a, loose).compare(new SemVer(b, loose)) +} + +exports.compareLoose = compareLoose +function compareLoose (a, b) { + return compare(a, b, true) +} + +exports.rcompare = rcompare +function rcompare (a, b, loose) { + return compare(b, a, loose) +} + +exports.sort = sort +function sort (list, loose) { + return list.sort(function (a, b) { + return exports.compare(a, b, loose) + }) +} + +exports.rsort = rsort +function rsort (list, loose) { + return list.sort(function (a, b) { + return exports.rcompare(a, b, loose) + }) +} + +exports.gt = gt +function gt (a, b, loose) { + return compare(a, b, loose) > 0 +} + +exports.lt = lt +function lt (a, b, loose) { + return compare(a, b, loose) < 0 +} + +exports.eq = eq +function eq (a, b, loose) { + return compare(a, b, loose) === 0 +} + +exports.neq = neq +function neq (a, b, loose) { + return compare(a, b, loose) !== 0 +} + +exports.gte = gte +function gte (a, b, loose) { + return compare(a, b, loose) >= 0 +} + +exports.lte = lte +function lte (a, b, loose) { + return compare(a, b, loose) <= 0 +} + +exports.cmp = cmp +function cmp (a, op, b, loose) { + switch (op) { + case '===': + if (typeof a === 'object') + a = a.version + if (typeof b === 'object') + b = b.version + return a === b + + case '!==': + if (typeof a === 'object') + a = a.version + if (typeof b === 'object') + b = b.version + return a !== b + + case '': + case '=': + case '==': + return eq(a, b, loose) + + case '!=': + return neq(a, b, loose) + + case '>': + return gt(a, b, loose) + + case '>=': + return gte(a, b, loose) + + case '<': + return lt(a, b, loose) + + case '<=': + return lte(a, b, loose) + + default: + throw new TypeError('Invalid operator: ' + op) + } +} + +exports.Comparator = Comparator +function Comparator (comp, options) { + if (!options || typeof options !== 'object') { + options = { + loose: !!options, + includePrerelease: false + } + } + + if (comp instanceof Comparator) { + if (comp.loose === !!options.loose) { + return comp + } else { + comp = comp.value + } + } + + if (!(this instanceof Comparator)) { + return new Comparator(comp, options) + } + + debug('comparator', comp, options) + this.options = options + this.loose = !!options.loose + this.parse(comp) + + if (this.semver === ANY) { + this.value = '' + } else { + this.value = this.operator + this.semver.version + } + + debug('comp', this) +} + +var ANY = {} +Comparator.prototype.parse = function (comp) { + var r = this.options.loose ? re[COMPARATORLOOSE] : re[COMPARATOR] + var m = comp.match(r) + + if (!m) { + throw new TypeError('Invalid comparator: ' + comp) + } + + this.operator = m[1] + if (this.operator === '=') { + this.operator = '' + } + + // if it literally is just '>' or '' then allow anything. + if (!m[2]) { + this.semver = ANY + } else { + this.semver = new SemVer(m[2], this.options.loose) + } +} + +Comparator.prototype.toString = function () { + return this.value +} + +Comparator.prototype.test = function (version) { + debug('Comparator.test', version, this.options.loose) + + if (this.semver === ANY) { + return true + } + + if (typeof version === 'string') { + version = new SemVer(version, this.options) + } + + return cmp(version, this.operator, this.semver, this.options) +} + +Comparator.prototype.intersects = function (comp, options) { + if (!(comp instanceof Comparator)) { + throw new TypeError('a Comparator is required') + } + + if (!options || typeof options !== 'object') { + options = { + loose: !!options, + includePrerelease: false + } + } + + var rangeTmp + + if (this.operator === '') { + rangeTmp = new Range(comp.value, options) + return satisfies(this.value, rangeTmp, options) + } else if (comp.operator === '') { + rangeTmp = new Range(this.value, options) + return satisfies(comp.semver, rangeTmp, options) + } + + var sameDirectionIncreasing = + (this.operator === '>=' || this.operator === '>') && + (comp.operator === '>=' || comp.operator === '>') + var sameDirectionDecreasing = + (this.operator === '<=' || this.operator === '<') && + (comp.operator === '<=' || comp.operator === '<') + var sameSemVer = this.semver.version === comp.semver.version + var differentDirectionsInclusive = + (this.operator === '>=' || this.operator === '<=') && + (comp.operator === '>=' || comp.operator === '<=') + var oppositeDirectionsLessThan = + cmp(this.semver, '<', comp.semver, options) && + ((this.operator === '>=' || this.operator === '>') && + (comp.operator === '<=' || comp.operator === '<')) + var oppositeDirectionsGreaterThan = + cmp(this.semver, '>', comp.semver, options) && + ((this.operator === '<=' || this.operator === '<') && + (comp.operator === '>=' || comp.operator === '>')) + + return sameDirectionIncreasing || sameDirectionDecreasing || + (sameSemVer && differentDirectionsInclusive) || + oppositeDirectionsLessThan || oppositeDirectionsGreaterThan +} + +exports.Range = Range +function Range (range, options) { + if (!options || typeof options !== 'object') { + options = { + loose: !!options, + includePrerelease: false + } + } + + if (range instanceof Range) { + if (range.loose === !!options.loose && + range.includePrerelease === !!options.includePrerelease) { + return range + } else { + return new Range(range.raw, options) + } + } + + if (range instanceof Comparator) { + return new Range(range.value, options) + } + + if (!(this instanceof Range)) { + return new Range(range, options) + } + + this.options = options + this.loose = !!options.loose + this.includePrerelease = !!options.includePrerelease + + // First, split based on boolean or || + this.raw = range + this.set = range.split(/\s*\|\|\s*/).map(function (range) { + return this.parseRange(range.trim()) + }, this).filter(function (c) { + // throw out any that are not relevant for whatever reason + return c.length + }) + + if (!this.set.length) { + throw new TypeError('Invalid SemVer Range: ' + range) + } + + this.format() +} + +Range.prototype.format = function () { + this.range = this.set.map(function (comps) { + return comps.join(' ').trim() + }).join('||').trim() + return this.range +} + +Range.prototype.toString = function () { + return this.range +} + +Range.prototype.parseRange = function (range) { + var loose = this.options.loose + range = range.trim() + // `1.2.3 - 1.2.4` => `>=1.2.3 <=1.2.4` + var hr = loose ? re[HYPHENRANGELOOSE] : re[HYPHENRANGE] + range = range.replace(hr, hyphenReplace) + debug('hyphen replace', range) + // `> 1.2.3 < 1.2.5` => `>1.2.3 <1.2.5` + range = range.replace(re[COMPARATORTRIM], comparatorTrimReplace) + debug('comparator trim', range, re[COMPARATORTRIM]) + + // `~ 1.2.3` => `~1.2.3` + range = range.replace(re[TILDETRIM], tildeTrimReplace) + + // `^ 1.2.3` => `^1.2.3` + range = range.replace(re[CARETTRIM], caretTrimReplace) + + // normalize spaces + range = range.split(/\s+/).join(' ') + + // At this point, the range is completely trimmed and + // ready to be split into comparators. + + var compRe = loose ? re[COMPARATORLOOSE] : re[COMPARATOR] + var set = range.split(' ').map(function (comp) { + return parseComparator(comp, this.options) + }, this).join(' ').split(/\s+/) + if (this.options.loose) { + // in loose mode, throw out any that are not valid comparators + set = set.filter(function (comp) { + return !!comp.match(compRe) + }) + } + set = set.map(function (comp) { + return new Comparator(comp, this.options) + }, this) + + return set +} + +Range.prototype.intersects = function (range, options) { + if (!(range instanceof Range)) { + throw new TypeError('a Range is required') + } + + return this.set.some(function (thisComparators) { + return thisComparators.every(function (thisComparator) { + return range.set.some(function (rangeComparators) { + return rangeComparators.every(function (rangeComparator) { + return thisComparator.intersects(rangeComparator, options) + }) + }) + }) + }) +} + +// Mostly just for testing and legacy API reasons +exports.toComparators = toComparators +function toComparators (range, options) { + return new Range(range, options).set.map(function (comp) { + return comp.map(function (c) { + return c.value + }).join(' ').trim().split(' ') + }) +} + +// comprised of xranges, tildes, stars, and gtlt's at this point. +// already replaced the hyphen ranges +// turn into a set of JUST comparators. +function parseComparator (comp, options) { + debug('comp', comp, options) + comp = replaceCarets(comp, options) + debug('caret', comp) + comp = replaceTildes(comp, options) + debug('tildes', comp) + comp = replaceXRanges(comp, options) + debug('xrange', comp) + comp = replaceStars(comp, options) + debug('stars', comp) + return comp +} + +function isX (id) { + return !id || id.toLowerCase() === 'x' || id === '*' +} + +// ~, ~> --> * (any, kinda silly) +// ~2, ~2.x, ~2.x.x, ~>2, ~>2.x ~>2.x.x --> >=2.0.0 <3.0.0 +// ~2.0, ~2.0.x, ~>2.0, ~>2.0.x --> >=2.0.0 <2.1.0 +// ~1.2, ~1.2.x, ~>1.2, ~>1.2.x --> >=1.2.0 <1.3.0 +// ~1.2.3, ~>1.2.3 --> >=1.2.3 <1.3.0 +// ~1.2.0, ~>1.2.0 --> >=1.2.0 <1.3.0 +function replaceTildes (comp, options) { + return comp.trim().split(/\s+/).map(function (comp) { + return replaceTilde(comp, options) + }).join(' ') +} + +function replaceTilde (comp, options) { + var r = options.loose ? re[TILDELOOSE] : re[TILDE] + return comp.replace(r, function (_, M, m, p, pr) { + debug('tilde', comp, _, M, m, p, pr) + var ret + + if (isX(M)) { + ret = '' + } else if (isX(m)) { + ret = '>=' + M + '.0.0 <' + (+M + 1) + '.0.0' + } else if (isX(p)) { + // ~1.2 == >=1.2.0 <1.3.0 + ret = '>=' + M + '.' + m + '.0 <' + M + '.' + (+m + 1) + '.0' + } else if (pr) { + debug('replaceTilde pr', pr) + ret = '>=' + M + '.' + m + '.' + p + '-' + pr + + ' <' + M + '.' + (+m + 1) + '.0' + } else { + // ~1.2.3 == >=1.2.3 <1.3.0 + ret = '>=' + M + '.' + m + '.' + p + + ' <' + M + '.' + (+m + 1) + '.0' + } + + debug('tilde return', ret) + return ret + }) +} + +// ^ --> * (any, kinda silly) +// ^2, ^2.x, ^2.x.x --> >=2.0.0 <3.0.0 +// ^2.0, ^2.0.x --> >=2.0.0 <3.0.0 +// ^1.2, ^1.2.x --> >=1.2.0 <2.0.0 +// ^1.2.3 --> >=1.2.3 <2.0.0 +// ^1.2.0 --> >=1.2.0 <2.0.0 +function replaceCarets (comp, options) { + return comp.trim().split(/\s+/).map(function (comp) { + return replaceCaret(comp, options) + }).join(' ') +} + +function replaceCaret (comp, options) { + debug('caret', comp, options) + var r = options.loose ? re[CARETLOOSE] : re[CARET] + return comp.replace(r, function (_, M, m, p, pr) { + debug('caret', comp, _, M, m, p, pr) + var ret + + if (isX(M)) { + ret = '' + } else if (isX(m)) { + ret = '>=' + M + '.0.0 <' + (+M + 1) + '.0.0' + } else if (isX(p)) { + if (M === '0') { + ret = '>=' + M + '.' + m + '.0 <' + M + '.' + (+m + 1) + '.0' + } else { + ret = '>=' + M + '.' + m + '.0 <' + (+M + 1) + '.0.0' + } + } else if (pr) { + debug('replaceCaret pr', pr) + if (M === '0') { + if (m === '0') { + ret = '>=' + M + '.' + m + '.' + p + '-' + pr + + ' <' + M + '.' + m + '.' + (+p + 1) + } else { + ret = '>=' + M + '.' + m + '.' + p + '-' + pr + + ' <' + M + '.' + (+m + 1) + '.0' + } + } else { + ret = '>=' + M + '.' + m + '.' + p + '-' + pr + + ' <' + (+M + 1) + '.0.0' + } + } else { + debug('no pr') + if (M === '0') { + if (m === '0') { + ret = '>=' + M + '.' + m + '.' + p + + ' <' + M + '.' + m + '.' + (+p + 1) + } else { + ret = '>=' + M + '.' + m + '.' + p + + ' <' + M + '.' + (+m + 1) + '.0' + } + } else { + ret = '>=' + M + '.' + m + '.' + p + + ' <' + (+M + 1) + '.0.0' + } + } + + debug('caret return', ret) + return ret + }) +} + +function replaceXRanges (comp, options) { + debug('replaceXRanges', comp, options) + return comp.split(/\s+/).map(function (comp) { + return replaceXRange(comp, options) + }).join(' ') +} + +function replaceXRange (comp, options) { + comp = comp.trim() + var r = options.loose ? re[XRANGELOOSE] : re[XRANGE] + return comp.replace(r, function (ret, gtlt, M, m, p, pr) { + debug('xRange', comp, ret, gtlt, M, m, p, pr) + var xM = isX(M) + var xm = xM || isX(m) + var xp = xm || isX(p) + var anyX = xp + + if (gtlt === '=' && anyX) { + gtlt = '' + } + + if (xM) { + if (gtlt === '>' || gtlt === '<') { + // nothing is allowed + ret = '<0.0.0' + } else { + // nothing is forbidden + ret = '*' + } + } else if (gtlt && anyX) { + // we know patch is an x, because we have any x at all. + // replace X with 0 + if (xm) { + m = 0 + } + p = 0 + + if (gtlt === '>') { + // >1 => >=2.0.0 + // >1.2 => >=1.3.0 + // >1.2.3 => >= 1.2.4 + gtlt = '>=' + if (xm) { + M = +M + 1 + m = 0 + p = 0 + } else { + m = +m + 1 + p = 0 + } + } else if (gtlt === '<=') { + // <=0.7.x is actually <0.8.0, since any 0.7.x should + // pass. Similarly, <=7.x is actually <8.0.0, etc. + gtlt = '<' + if (xm) { + M = +M + 1 + } else { + m = +m + 1 + } + } + + ret = gtlt + M + '.' + m + '.' + p + } else if (xm) { + ret = '>=' + M + '.0.0 <' + (+M + 1) + '.0.0' + } else if (xp) { + ret = '>=' + M + '.' + m + '.0 <' + M + '.' + (+m + 1) + '.0' + } + + debug('xRange return', ret) + + return ret + }) +} + +// Because * is AND-ed with everything else in the comparator, +// and '' means "any version", just remove the *s entirely. +function replaceStars (comp, options) { + debug('replaceStars', comp, options) + // Looseness is ignored here. star is always as loose as it gets! + return comp.trim().replace(re[STAR], '') +} + +// This function is passed to string.replace(re[HYPHENRANGE]) +// M, m, patch, prerelease, build +// 1.2 - 3.4.5 => >=1.2.0 <=3.4.5 +// 1.2.3 - 3.4 => >=1.2.0 <3.5.0 Any 3.4.x will do +// 1.2 - 3.4 => >=1.2.0 <3.5.0 +function hyphenReplace ($0, + from, fM, fm, fp, fpr, fb, + to, tM, tm, tp, tpr, tb) { + if (isX(fM)) { + from = '' + } else if (isX(fm)) { + from = '>=' + fM + '.0.0' + } else if (isX(fp)) { + from = '>=' + fM + '.' + fm + '.0' + } else { + from = '>=' + from + } + + if (isX(tM)) { + to = '' + } else if (isX(tm)) { + to = '<' + (+tM + 1) + '.0.0' + } else if (isX(tp)) { + to = '<' + tM + '.' + (+tm + 1) + '.0' + } else if (tpr) { + to = '<=' + tM + '.' + tm + '.' + tp + '-' + tpr + } else { + to = '<=' + to + } + + return (from + ' ' + to).trim() +} + +// if ANY of the sets match ALL of its comparators, then pass +Range.prototype.test = function (version) { + if (!version) { + return false + } + + if (typeof version === 'string') { + version = new SemVer(version, this.options) + } + + for (var i = 0; i < this.set.length; i++) { + if (testSet(this.set[i], version, this.options)) { + return true + } + } + return false +} + +function testSet (set, version, options) { + for (var i = 0; i < set.length; i++) { + if (!set[i].test(version)) { + return false + } + } + + if (version.prerelease.length && !options.includePrerelease) { + // Find the set of versions that are allowed to have prereleases + // For example, ^1.2.3-pr.1 desugars to >=1.2.3-pr.1 <2.0.0 + // That should allow `1.2.3-pr.2` to pass. + // However, `1.2.4-alpha.notready` should NOT be allowed, + // even though it's within the range set by the comparators. + for (i = 0; i < set.length; i++) { + debug(set[i].semver) + if (set[i].semver === ANY) { + continue + } + + if (set[i].semver.prerelease.length > 0) { + var allowed = set[i].semver + if (allowed.major === version.major && + allowed.minor === version.minor && + allowed.patch === version.patch) { + return true + } + } + } + + // Version has a -pre, but it's not one of the ones we like. + return false + } + + return true +} + +exports.satisfies = satisfies +function satisfies (version, range, options) { + try { + range = new Range(range, options) + } catch (er) { + return false + } + return range.test(version) +} + +exports.maxSatisfying = maxSatisfying +function maxSatisfying (versions, range, options) { + var max = null + var maxSV = null + try { + var rangeObj = new Range(range, options) + } catch (er) { + return null + } + versions.forEach(function (v) { + if (rangeObj.test(v)) { + // satisfies(v, range, options) + if (!max || maxSV.compare(v) === -1) { + // compare(max, v, true) + max = v + maxSV = new SemVer(max, options) + } + } + }) + return max +} + +exports.minSatisfying = minSatisfying +function minSatisfying (versions, range, options) { + var min = null + var minSV = null + try { + var rangeObj = new Range(range, options) + } catch (er) { + return null + } + versions.forEach(function (v) { + if (rangeObj.test(v)) { + // satisfies(v, range, options) + if (!min || minSV.compare(v) === 1) { + // compare(min, v, true) + min = v + minSV = new SemVer(min, options) + } + } + }) + return min +} + +exports.minVersion = minVersion +function minVersion (range, loose) { + range = new Range(range, loose) + + var minver = new SemVer('0.0.0') + if (range.test(minver)) { + return minver + } + + minver = new SemVer('0.0.0-0') + if (range.test(minver)) { + return minver + } + + minver = null + for (var i = 0; i < range.set.length; ++i) { + var comparators = range.set[i] + + comparators.forEach(function (comparator) { + // Clone to avoid manipulating the comparator's semver object. + var compver = new SemVer(comparator.semver.version) + switch (comparator.operator) { + case '>': + if (compver.prerelease.length === 0) { + compver.patch++ + } else { + compver.prerelease.push(0) + } + compver.raw = compver.format() + /* fallthrough */ + case '': + case '>=': + if (!minver || gt(minver, compver)) { + minver = compver + } + break + case '<': + case '<=': + /* Ignore maximum versions */ + break + /* istanbul ignore next */ + default: + throw new Error('Unexpected operation: ' + comparator.operator) + } + }) + } + + if (minver && range.test(minver)) { + return minver + } + + return null +} + +exports.validRange = validRange +function validRange (range, options) { + try { + // Return '*' instead of '' so that truthiness works. + // This will throw if it's invalid anyway + return new Range(range, options).range || '*' + } catch (er) { + return null + } +} + +// Determine if version is less than all the versions possible in the range +exports.ltr = ltr +function ltr (version, range, options) { + return outside(version, range, '<', options) +} + +// Determine if version is greater than all the versions possible in the range. +exports.gtr = gtr +function gtr (version, range, options) { + return outside(version, range, '>', options) +} + +exports.outside = outside +function outside (version, range, hilo, options) { + version = new SemVer(version, options) + range = new Range(range, options) + + var gtfn, ltefn, ltfn, comp, ecomp + switch (hilo) { + case '>': + gtfn = gt + ltefn = lte + ltfn = lt + comp = '>' + ecomp = '>=' + break + case '<': + gtfn = lt + ltefn = gte + ltfn = gt + comp = '<' + ecomp = '<=' + break + default: + throw new TypeError('Must provide a hilo val of "<" or ">"') + } + + // If it satisifes the range it is not outside + if (satisfies(version, range, options)) { + return false + } + + // From now on, variable terms are as if we're in "gtr" mode. + // but note that everything is flipped for the "ltr" function. + + for (var i = 0; i < range.set.length; ++i) { + var comparators = range.set[i] + + var high = null + var low = null + + comparators.forEach(function (comparator) { + if (comparator.semver === ANY) { + comparator = new Comparator('>=0.0.0') + } + high = high || comparator + low = low || comparator + if (gtfn(comparator.semver, high.semver, options)) { + high = comparator + } else if (ltfn(comparator.semver, low.semver, options)) { + low = comparator + } + }) + + // If the edge version comparator has a operator then our version + // isn't outside it + if (high.operator === comp || high.operator === ecomp) { + return false + } + + // If the lowest version comparator has an operator and our version + // is less than it then it isn't higher than the range + if ((!low.operator || low.operator === comp) && + ltefn(version, low.semver)) { + return false + } else if (low.operator === ecomp && ltfn(version, low.semver)) { + return false + } + } + return true +} + +exports.prerelease = prerelease +function prerelease (version, options) { + var parsed = parse(version, options) + return (parsed && parsed.prerelease.length) ? parsed.prerelease : null +} + +exports.intersects = intersects +function intersects (r1, r2, options) { + r1 = new Range(r1, options) + r2 = new Range(r2, options) + return r1.intersects(r2) +} + +exports.coerce = coerce +function coerce (version) { + if (version instanceof SemVer) { + return version + } + + if (typeof version !== 'string') { + return null + } + + var match = version.match(re[COERCE]) + + if (match == null) { + return null + } + + return parse(match[1] + + '.' + (match[2] || '0') + + '.' + (match[3] || '0')) +} diff --git a/node_modules/execa/node_modules/shebang-command/index.js b/node_modules/execa/node_modules/shebang-command/index.js new file mode 100644 index 00000000..2de70b07 --- /dev/null +++ b/node_modules/execa/node_modules/shebang-command/index.js @@ -0,0 +1,19 @@ +'use strict'; +var shebangRegex = require('shebang-regex'); + +module.exports = function (str) { + var match = str.match(shebangRegex); + + if (!match) { + return null; + } + + var arr = match[0].replace(/#! ?/, '').split(' '); + var bin = arr[0].split('/').pop(); + var arg = arr[1]; + + return (bin === 'env' ? + arg : + bin + (arg ? ' ' + arg : '') + ); +}; diff --git a/node_modules/execa/node_modules/shebang-command/license b/node_modules/execa/node_modules/shebang-command/license new file mode 100644 index 00000000..0f8cf79c --- /dev/null +++ b/node_modules/execa/node_modules/shebang-command/license @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) Kevin Martensson (github.com/kevva) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/execa/node_modules/shebang-command/package.json b/node_modules/execa/node_modules/shebang-command/package.json new file mode 100644 index 00000000..19c9ce53 --- /dev/null +++ b/node_modules/execa/node_modules/shebang-command/package.json @@ -0,0 +1,39 @@ +{ + "name": "shebang-command", + "version": "1.2.0", + "description": "Get the command from a shebang", + "license": "MIT", + "repository": "kevva/shebang-command", + "author": { + "name": "Kevin Martensson", + "email": "kevinmartensson@gmail.com", + "url": "github.com/kevva" + }, + "engines": { + "node": ">=0.10.0" + }, + "scripts": { + "test": "xo && ava" + }, + "files": [ + "index.js" + ], + "keywords": [ + "cmd", + "command", + "parse", + "shebang" + ], + "dependencies": { + "shebang-regex": "^1.0.0" + }, + "devDependencies": { + "ava": "*", + "xo": "*" + }, + "xo": { + "ignores": [ + "test.js" + ] + } +} diff --git a/node_modules/execa/node_modules/shebang-command/readme.md b/node_modules/execa/node_modules/shebang-command/readme.md new file mode 100644 index 00000000..16b0be4d --- /dev/null +++ b/node_modules/execa/node_modules/shebang-command/readme.md @@ -0,0 +1,39 @@ +# shebang-command [![Build Status](https://travis-ci.org/kevva/shebang-command.svg?branch=master)](https://travis-ci.org/kevva/shebang-command) + +> Get the command from a shebang + + +## Install + +``` +$ npm install --save shebang-command +``` + + +## Usage + +```js +const shebangCommand = require('shebang-command'); + +shebangCommand('#!/usr/bin/env node'); +//=> 'node' + +shebangCommand('#!/bin/bash'); +//=> 'bash' +``` + + +## API + +### shebangCommand(string) + +#### string + +Type: `string` + +String containing a shebang. + + +## License + +MIT © [Kevin Martensson](http://github.com/kevva) diff --git a/node_modules/execa/node_modules/shebang-regex/index.js b/node_modules/execa/node_modules/shebang-regex/index.js new file mode 100644 index 00000000..d052d2e0 --- /dev/null +++ b/node_modules/execa/node_modules/shebang-regex/index.js @@ -0,0 +1,2 @@ +'use strict'; +module.exports = /^#!.*/; diff --git a/node_modules/execa/node_modules/shebang-regex/license b/node_modules/execa/node_modules/shebang-regex/license new file mode 100644 index 00000000..654d0bfe --- /dev/null +++ b/node_modules/execa/node_modules/shebang-regex/license @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) Sindre Sorhus (sindresorhus.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/execa/node_modules/shebang-regex/package.json b/node_modules/execa/node_modules/shebang-regex/package.json new file mode 100644 index 00000000..d8ec9b61 --- /dev/null +++ b/node_modules/execa/node_modules/shebang-regex/package.json @@ -0,0 +1,32 @@ +{ + "name": "shebang-regex", + "version": "1.0.0", + "description": "Regular expression for matching a shebang", + "license": "MIT", + "repository": "sindresorhus/shebang-regex", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=0.10.0" + }, + "scripts": { + "test": "node test.js" + }, + "files": [ + "index.js" + ], + "keywords": [ + "re", + "regex", + "regexp", + "shebang", + "match", + "test" + ], + "devDependencies": { + "ava": "0.0.4" + } +} diff --git a/node_modules/execa/node_modules/shebang-regex/readme.md b/node_modules/execa/node_modules/shebang-regex/readme.md new file mode 100644 index 00000000..ef75e51b --- /dev/null +++ b/node_modules/execa/node_modules/shebang-regex/readme.md @@ -0,0 +1,29 @@ +# shebang-regex [![Build Status](https://travis-ci.org/sindresorhus/shebang-regex.svg?branch=master)](https://travis-ci.org/sindresorhus/shebang-regex) + +> Regular expression for matching a [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) + + +## Install + +``` +$ npm install --save shebang-regex +``` + + +## Usage + +```js +var shebangRegex = require('shebang-regex'); +var str = '#!/usr/bin/env node\nconsole.log("unicorns");'; + +shebangRegex.test(str); +//=> true + +shebangRegex.exec(str)[0]; +//=> '#!/usr/bin/env node' +``` + + +## License + +MIT © [Sindre Sorhus](http://sindresorhus.com) diff --git a/node_modules/execa/node_modules/which/CHANGELOG.md b/node_modules/execa/node_modules/which/CHANGELOG.md new file mode 100644 index 00000000..3d83d269 --- /dev/null +++ b/node_modules/execa/node_modules/which/CHANGELOG.md @@ -0,0 +1,152 @@ +# Changes + + +## 1.3.1 + +* update deps +* update travis + +## v1.3.0 + +* Add nothrow option to which.sync +* update tap + +## v1.2.14 + +* appveyor: drop node 5 and 0.x +* travis-ci: add node 6, drop 0.x + +## v1.2.13 + +* test: Pass missing option to pass on windows +* update tap +* update isexe to 2.0.0 +* neveragain.tech pledge request + +## v1.2.12 + +* Removed unused require + +## v1.2.11 + +* Prevent changelog script from being included in package + +## v1.2.10 + +* Use env.PATH only, not env.Path + +## v1.2.9 + +* fix for paths starting with ../ +* Remove unused `is-absolute` module + +## v1.2.8 + +* bullet items in changelog that contain (but don't start with) # + +## v1.2.7 + +* strip 'update changelog' changelog entries out of changelog + +## v1.2.6 + +* make the changelog bulleted + +## v1.2.5 + +* make a changelog, and keep it up to date +* don't include tests in package +* Properly handle relative-path executables +* appveyor +* Attach error code to Not Found error +* Make tests pass on Windows + +## v1.2.4 + +* Fix typo + +## v1.2.3 + +* update isexe, fix regression in pathExt handling + +## v1.2.2 + +* update deps, use isexe module, test windows + +## v1.2.1 + +* Sometimes windows PATH entries are quoted +* Fixed a bug in the check for group and user mode bits. This bug was introduced during refactoring for supporting strict mode. +* doc cli + +## v1.2.0 + +* Add support for opt.all and -as cli flags +* test the bin +* update travis +* Allow checking for multiple programs in bin/which +* tap 2 + +## v1.1.2 + +* travis +* Refactored and fixed undefined error on Windows +* Support strict mode + +## v1.1.1 + +* test +g exes against secondary groups, if available +* Use windows exe semantics on cygwin & msys +* cwd should be first in path on win32, not last +* Handle lower-case 'env.Path' on Windows +* Update docs +* use single-quotes + +## v1.1.0 + +* Add tests, depend on is-absolute + +## v1.0.9 + +* which.js: root is allowed to execute files owned by anyone + +## v1.0.8 + +* don't use graceful-fs + +## v1.0.7 + +* add license to package.json + +## v1.0.6 + +* isc license + +## 1.0.5 + +* Awful typo + +## 1.0.4 + +* Test for path absoluteness properly +* win: Allow '' as a pathext if cmd has a . in it + +## 1.0.3 + +* Remove references to execPath +* Make `which.sync()` work on Windows by honoring the PATHEXT variable. +* Make `isExe()` always return true on Windows. +* MIT + +## 1.0.2 + +* Only files can be exes + +## 1.0.1 + +* Respect the PATHEXT env for win32 support +* should 0755 the bin +* binary +* guts +* package +* 1st diff --git a/node_modules/execa/node_modules/which/LICENSE b/node_modules/execa/node_modules/which/LICENSE new file mode 100644 index 00000000..19129e31 --- /dev/null +++ b/node_modules/execa/node_modules/which/LICENSE @@ -0,0 +1,15 @@ +The ISC License + +Copyright (c) Isaac Z. Schlueter and Contributors + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR +IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/execa/node_modules/which/README.md b/node_modules/execa/node_modules/which/README.md new file mode 100644 index 00000000..8c0b0cbf --- /dev/null +++ b/node_modules/execa/node_modules/which/README.md @@ -0,0 +1,51 @@ +# which + +Like the unix `which` utility. + +Finds the first instance of a specified executable in the PATH +environment variable. Does not cache the results, so `hash -r` is not +needed when the PATH changes. + +## USAGE + +```javascript +var which = require('which') + +// async usage +which('node', function (er, resolvedPath) { + // er is returned if no "node" is found on the PATH + // if it is found, then the absolute path to the exec is returned +}) + +// sync usage +// throws if not found +var resolved = which.sync('node') + +// if nothrow option is used, returns null if not found +resolved = which.sync('node', {nothrow: true}) + +// Pass options to override the PATH and PATHEXT environment vars. +which('node', { path: someOtherPath }, function (er, resolved) { + if (er) + throw er + console.log('found at %j', resolved) +}) +``` + +## CLI USAGE + +Same as the BSD `which(1)` binary. + +``` +usage: which [-as] program ... +``` + +## OPTIONS + +You may pass an options object as the second argument. + +- `path`: Use instead of the `PATH` environment variable. +- `pathExt`: Use instead of the `PATHEXT` environment variable. +- `all`: Return all matches, instead of just the first one. Note that + this means the function returns an array of strings instead of a + single string. diff --git a/node_modules/execa/node_modules/which/bin/which b/node_modules/execa/node_modules/which/bin/which new file mode 100755 index 00000000..7cee3729 --- /dev/null +++ b/node_modules/execa/node_modules/which/bin/which @@ -0,0 +1,52 @@ +#!/usr/bin/env node +var which = require("../") +if (process.argv.length < 3) + usage() + +function usage () { + console.error('usage: which [-as] program ...') + process.exit(1) +} + +var all = false +var silent = false +var dashdash = false +var args = process.argv.slice(2).filter(function (arg) { + if (dashdash || !/^-/.test(arg)) + return true + + if (arg === '--') { + dashdash = true + return false + } + + var flags = arg.substr(1).split('') + for (var f = 0; f < flags.length; f++) { + var flag = flags[f] + switch (flag) { + case 's': + silent = true + break + case 'a': + all = true + break + default: + console.error('which: illegal option -- ' + flag) + usage() + } + } + return false +}) + +process.exit(args.reduce(function (pv, current) { + try { + var f = which.sync(current, { all: all }) + if (all) + f = f.join('\n') + if (!silent) + console.log(f) + return pv; + } catch (e) { + return 1; + } +}, 0)) diff --git a/node_modules/execa/node_modules/which/package.json b/node_modules/execa/node_modules/which/package.json new file mode 100644 index 00000000..51be376f --- /dev/null +++ b/node_modules/execa/node_modules/which/package.json @@ -0,0 +1,30 @@ +{ + "author": "Isaac Z. Schlueter (http://blog.izs.me)", + "name": "which", + "description": "Like which(1) unix command. Find the first instance of an executable in the PATH.", + "version": "1.3.1", + "repository": { + "type": "git", + "url": "git://github.com/isaacs/node-which.git" + }, + "main": "which.js", + "bin": "./bin/which", + "license": "ISC", + "dependencies": { + "isexe": "^2.0.0" + }, + "devDependencies": { + "mkdirp": "^0.5.0", + "rimraf": "^2.6.2", + "tap": "^12.0.1" + }, + "scripts": { + "test": "tap test/*.js --cov", + "changelog": "bash gen-changelog.sh", + "postversion": "npm run changelog && git add CHANGELOG.md && git commit -m 'update changelog - '${npm_package_version}" + }, + "files": [ + "which.js", + "bin/which" + ] +} diff --git a/node_modules/execa/node_modules/which/which.js b/node_modules/execa/node_modules/which/which.js new file mode 100644 index 00000000..4347f91a --- /dev/null +++ b/node_modules/execa/node_modules/which/which.js @@ -0,0 +1,135 @@ +module.exports = which +which.sync = whichSync + +var isWindows = process.platform === 'win32' || + process.env.OSTYPE === 'cygwin' || + process.env.OSTYPE === 'msys' + +var path = require('path') +var COLON = isWindows ? ';' : ':' +var isexe = require('isexe') + +function getNotFoundError (cmd) { + var er = new Error('not found: ' + cmd) + er.code = 'ENOENT' + + return er +} + +function getPathInfo (cmd, opt) { + var colon = opt.colon || COLON + var pathEnv = opt.path || process.env.PATH || '' + var pathExt = [''] + + pathEnv = pathEnv.split(colon) + + var pathExtExe = '' + if (isWindows) { + pathEnv.unshift(process.cwd()) + pathExtExe = (opt.pathExt || process.env.PATHEXT || '.EXE;.CMD;.BAT;.COM') + pathExt = pathExtExe.split(colon) + + + // Always test the cmd itself first. isexe will check to make sure + // it's found in the pathExt set. + if (cmd.indexOf('.') !== -1 && pathExt[0] !== '') + pathExt.unshift('') + } + + // If it has a slash, then we don't bother searching the pathenv. + // just check the file itself, and that's it. + if (cmd.match(/\//) || isWindows && cmd.match(/\\/)) + pathEnv = [''] + + return { + env: pathEnv, + ext: pathExt, + extExe: pathExtExe + } +} + +function which (cmd, opt, cb) { + if (typeof opt === 'function') { + cb = opt + opt = {} + } + + var info = getPathInfo(cmd, opt) + var pathEnv = info.env + var pathExt = info.ext + var pathExtExe = info.extExe + var found = [] + + ;(function F (i, l) { + if (i === l) { + if (opt.all && found.length) + return cb(null, found) + else + return cb(getNotFoundError(cmd)) + } + + var pathPart = pathEnv[i] + if (pathPart.charAt(0) === '"' && pathPart.slice(-1) === '"') + pathPart = pathPart.slice(1, -1) + + var p = path.join(pathPart, cmd) + if (!pathPart && (/^\.[\\\/]/).test(cmd)) { + p = cmd.slice(0, 2) + p + } + ;(function E (ii, ll) { + if (ii === ll) return F(i + 1, l) + var ext = pathExt[ii] + isexe(p + ext, { pathExt: pathExtExe }, function (er, is) { + if (!er && is) { + if (opt.all) + found.push(p + ext) + else + return cb(null, p + ext) + } + return E(ii + 1, ll) + }) + })(0, pathExt.length) + })(0, pathEnv.length) +} + +function whichSync (cmd, opt) { + opt = opt || {} + + var info = getPathInfo(cmd, opt) + var pathEnv = info.env + var pathExt = info.ext + var pathExtExe = info.extExe + var found = [] + + for (var i = 0, l = pathEnv.length; i < l; i ++) { + var pathPart = pathEnv[i] + if (pathPart.charAt(0) === '"' && pathPart.slice(-1) === '"') + pathPart = pathPart.slice(1, -1) + + var p = path.join(pathPart, cmd) + if (!pathPart && /^\.[\\\/]/.test(cmd)) { + p = cmd.slice(0, 2) + p + } + for (var j = 0, ll = pathExt.length; j < ll; j ++) { + var cur = p + pathExt[j] + var is + try { + is = isexe.sync(cur, { pathExt: pathExtExe }) + if (is) { + if (opt.all) + found.push(cur) + else + return cur + } + } catch (ex) {} + } + } + + if (opt.all && found.length) + return found + + if (opt.nothrow) + return null + + throw getNotFoundError(cmd) +} diff --git a/node_modules/execa/package.json b/node_modules/execa/package.json new file mode 100644 index 00000000..ad98225c --- /dev/null +++ b/node_modules/execa/package.json @@ -0,0 +1,69 @@ +{ + "name": "execa", + "version": "1.0.0", + "description": "A better `child_process`", + "license": "MIT", + "repository": "sindresorhus/execa", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=6" + }, + "scripts": { + "test": "xo && nyc ava" + }, + "files": [ + "index.js", + "lib" + ], + "keywords": [ + "exec", + "child", + "process", + "execute", + "fork", + "execfile", + "spawn", + "file", + "shell", + "bin", + "binary", + "binaries", + "npm", + "path", + "local" + ], + "dependencies": { + "cross-spawn": "^6.0.0", + "get-stream": "^4.0.0", + "is-stream": "^1.1.0", + "npm-run-path": "^2.0.0", + "p-finally": "^1.0.0", + "signal-exit": "^3.0.0", + "strip-eof": "^1.0.0" + }, + "devDependencies": { + "ava": "*", + "cat-names": "^1.0.2", + "coveralls": "^3.0.1", + "delay": "^3.0.0", + "is-running": "^2.0.0", + "nyc": "^13.0.1", + "tempfile": "^2.0.0", + "xo": "*" + }, + "nyc": { + "reporter": [ + "text", + "lcov" + ], + "exclude": [ + "**/fixtures/**", + "**/test.js", + "**/test/**" + ] + } +} diff --git a/node_modules/execa/readme.md b/node_modules/execa/readme.md new file mode 100644 index 00000000..f3f533d9 --- /dev/null +++ b/node_modules/execa/readme.md @@ -0,0 +1,327 @@ +# execa [![Build Status: Linux](https://travis-ci.org/sindresorhus/execa.svg?branch=master)](https://travis-ci.org/sindresorhus/execa) [![Build status: Windows](https://ci.appveyor.com/api/projects/status/x5ajamxtjtt93cqv/branch/master?svg=true)](https://ci.appveyor.com/project/sindresorhus/execa/branch/master) [![Coverage Status](https://coveralls.io/repos/github/sindresorhus/execa/badge.svg?branch=master)](https://coveralls.io/github/sindresorhus/execa?branch=master) + +> A better [`child_process`](https://nodejs.org/api/child_process.html) + + +## Why + +- Promise interface. +- [Strips EOF](https://github.com/sindresorhus/strip-eof) from the output so you don't have to `stdout.trim()`. +- Supports [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) binaries cross-platform. +- [Improved Windows support.](https://github.com/IndigoUnited/node-cross-spawn#why) +- Higher max buffer. 10 MB instead of 200 KB. +- [Executes locally installed binaries by name.](#preferlocal) +- [Cleans up spawned processes when the parent process dies.](#cleanup) + + +## Install + +``` +$ npm install execa +``` + + + + + + +## Usage + +```js +const execa = require('execa'); + +(async () => { + const {stdout} = await execa('echo', ['unicorns']); + console.log(stdout); + //=> 'unicorns' +})(); +``` + +Additional examples: + +```js +const execa = require('execa'); + +(async () => { + // Pipe the child process stdout to the current stdout + execa('echo', ['unicorns']).stdout.pipe(process.stdout); + + + // Run a shell command + const {stdout} = await execa.shell('echo unicorns'); + //=> 'unicorns' + + + // Catching an error + try { + await execa.shell('exit 3'); + } catch (error) { + console.log(error); + /* + { + message: 'Command failed: /bin/sh -c exit 3' + killed: false, + code: 3, + signal: null, + cmd: '/bin/sh -c exit 3', + stdout: '', + stderr: '', + timedOut: false + } + */ + } +})(); + +// Catching an error with a sync method +try { + execa.shellSync('exit 3'); +} catch (error) { + console.log(error); + /* + { + message: 'Command failed: /bin/sh -c exit 3' + code: 3, + signal: null, + cmd: '/bin/sh -c exit 3', + stdout: '', + stderr: '', + timedOut: false + } + */ +} +``` + + +## API + +### execa(file, [arguments], [options]) + +Execute a file. + +Think of this as a mix of `child_process.execFile` and `child_process.spawn`. + +Returns a [`child_process` instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess), which is enhanced to also be a `Promise` for a result `Object` with `stdout` and `stderr` properties. + +### execa.stdout(file, [arguments], [options]) + +Same as `execa()`, but returns only `stdout`. + +### execa.stderr(file, [arguments], [options]) + +Same as `execa()`, but returns only `stderr`. + +### execa.shell(command, [options]) + +Execute a command through the system shell. Prefer `execa()` whenever possible, as it's both faster and safer. + +Returns a [`child_process` instance](https://nodejs.org/api/child_process.html#child_process_class_childprocess). + +The `child_process` instance is enhanced to also be promise for a result object with `stdout` and `stderr` properties. + +### execa.sync(file, [arguments], [options]) + +Execute a file synchronously. + +Returns the same result object as [`child_process.spawnSync`](https://nodejs.org/api/child_process.html#child_process_child_process_spawnsync_command_args_options). + +This method throws an `Error` if the command fails. + +### execa.shellSync(file, [options]) + +Execute a command synchronously through the system shell. + +Returns the same result object as [`child_process.spawnSync`](https://nodejs.org/api/child_process.html#child_process_child_process_spawnsync_command_args_options). + +### options + +Type: `Object` + +#### cwd + +Type: `string`
+Default: `process.cwd()` + +Current working directory of the child process. + +#### env + +Type: `Object`
+Default: `process.env` + +Environment key-value pairs. Extends automatically from `process.env`. Set `extendEnv` to `false` if you don't want this. + +#### extendEnv + +Type: `boolean`
+Default: `true` + +Set to `false` if you don't want to extend the environment variables when providing the `env` property. + +#### argv0 + +Type: `string` + +Explicitly set the value of `argv[0]` sent to the child process. This will be set to `command` or `file` if not specified. + +#### stdio + +Type: `string[]` `string`
+Default: `pipe` + +Child's [stdio](https://nodejs.org/api/child_process.html#child_process_options_stdio) configuration. + +#### detached + +Type: `boolean` + +Prepare child to run independently of its parent process. Specific behavior [depends on the platform](https://nodejs.org/api/child_process.html#child_process_options_detached). + +#### uid + +Type: `number` + +Sets the user identity of the process. + +#### gid + +Type: `number` + +Sets the group identity of the process. + +#### shell + +Type: `boolean` `string`
+Default: `false` + +If `true`, runs `command` inside of a shell. Uses `/bin/sh` on UNIX and `cmd.exe` on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX or `/d /s /c` on Windows. + +#### stripEof + +Type: `boolean`
+Default: `true` + +[Strip EOF](https://github.com/sindresorhus/strip-eof) (last newline) from the output. + +#### preferLocal + +Type: `boolean`
+Default: `true` + +Prefer locally installed binaries when looking for a binary to execute.
+If you `$ npm install foo`, you can then `execa('foo')`. + +#### localDir + +Type: `string`
+Default: `process.cwd()` + +Preferred path to find locally installed binaries in (use with `preferLocal`). + +#### input + +Type: `string` `Buffer` `stream.Readable` + +Write some input to the `stdin` of your binary.
+Streams are not allowed when using the synchronous methods. + +#### reject + +Type: `boolean`
+Default: `true` + +Setting this to `false` resolves the promise with the error instead of rejecting it. + +#### cleanup + +Type: `boolean`
+Default: `true` + +Keep track of the spawned process and `kill` it when the parent process exits. + +#### encoding + +Type: `string`
+Default: `utf8` + +Specify the character encoding used to decode the `stdout` and `stderr` output. + +#### timeout + +Type: `number`
+Default: `0` + +If timeout is greater than `0`, the parent will send the signal identified by the `killSignal` property (the default is `SIGTERM`) if the child runs longer than timeout milliseconds. + +#### buffer + +Type: `boolean`
+Default: `true` + +Buffer the output from the spawned process. When buffering is disabled you must consume the output of the `stdout` and `stderr` streams because the promise will not be resolved/rejected until they have completed. + +#### maxBuffer + +Type: `number`
+Default: `10000000` (10MB) + +Largest amount of data in bytes allowed on `stdout` or `stderr`. + +#### killSignal + +Type: `string` `number`
+Default: `SIGTERM` + +Signal value to be used when the spawned process will be killed. + +#### stdin + +Type: `string` `number` `Stream` `undefined` `null`
+Default: `pipe` + +Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio). + +#### stdout + +Type: `string` `number` `Stream` `undefined` `null`
+Default: `pipe` + +Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio). + +#### stderr + +Type: `string` `number` `Stream` `undefined` `null`
+Default: `pipe` + +Same options as [`stdio`](https://nodejs.org/dist/latest-v6.x/docs/api/child_process.html#child_process_options_stdio). + +#### windowsVerbatimArguments + +Type: `boolean`
+Default: `false` + +If `true`, no quoting or escaping of arguments is done on Windows. Ignored on other platforms. This is set to `true` automatically when the `shell` option is `true`. + + +## Tips + +### Save and pipe output from a child process + +Let's say you want to show the output of a child process in real-time while also saving it to a variable. + +```js +const execa = require('execa'); +const getStream = require('get-stream'); + +const stream = execa('echo', ['foo']).stdout; + +stream.pipe(process.stdout); + +getStream(stream).then(value => { + console.log('child output:', value); +}); +``` + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/get-stream/buffer-stream.js b/node_modules/get-stream/buffer-stream.js new file mode 100644 index 00000000..4121c8e5 --- /dev/null +++ b/node_modules/get-stream/buffer-stream.js @@ -0,0 +1,51 @@ +'use strict'; +const {PassThrough} = require('stream'); + +module.exports = options => { + options = Object.assign({}, options); + + const {array} = options; + let {encoding} = options; + const buffer = encoding === 'buffer'; + let objectMode = false; + + if (array) { + objectMode = !(encoding || buffer); + } else { + encoding = encoding || 'utf8'; + } + + if (buffer) { + encoding = null; + } + + let len = 0; + const ret = []; + const stream = new PassThrough({objectMode}); + + if (encoding) { + stream.setEncoding(encoding); + } + + stream.on('data', chunk => { + ret.push(chunk); + + if (objectMode) { + len = ret.length; + } else { + len += chunk.length; + } + }); + + stream.getBufferedValue = () => { + if (array) { + return ret; + } + + return buffer ? Buffer.concat(ret, len) : ret.join(''); + }; + + stream.getBufferedLength = () => len; + + return stream; +}; diff --git a/node_modules/get-stream/index.js b/node_modules/get-stream/index.js new file mode 100644 index 00000000..7e5584a6 --- /dev/null +++ b/node_modules/get-stream/index.js @@ -0,0 +1,50 @@ +'use strict'; +const pump = require('pump'); +const bufferStream = require('./buffer-stream'); + +class MaxBufferError extends Error { + constructor() { + super('maxBuffer exceeded'); + this.name = 'MaxBufferError'; + } +} + +function getStream(inputStream, options) { + if (!inputStream) { + return Promise.reject(new Error('Expected a stream')); + } + + options = Object.assign({maxBuffer: Infinity}, options); + + const {maxBuffer} = options; + + let stream; + return new Promise((resolve, reject) => { + const rejectPromise = error => { + if (error) { // A null check + error.bufferedData = stream.getBufferedValue(); + } + reject(error); + }; + + stream = pump(inputStream, bufferStream(options), error => { + if (error) { + rejectPromise(error); + return; + } + + resolve(); + }); + + stream.on('data', () => { + if (stream.getBufferedLength() > maxBuffer) { + rejectPromise(new MaxBufferError()); + } + }); + }).then(() => stream.getBufferedValue()); +} + +module.exports = getStream; +module.exports.buffer = (stream, options) => getStream(stream, Object.assign({}, options, {encoding: 'buffer'})); +module.exports.array = (stream, options) => getStream(stream, Object.assign({}, options, {array: true})); +module.exports.MaxBufferError = MaxBufferError; diff --git a/node_modules/get-stream/license b/node_modules/get-stream/license new file mode 100644 index 00000000..e7af2f77 --- /dev/null +++ b/node_modules/get-stream/license @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) Sindre Sorhus (sindresorhus.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/get-stream/package.json b/node_modules/get-stream/package.json new file mode 100644 index 00000000..619651cd --- /dev/null +++ b/node_modules/get-stream/package.json @@ -0,0 +1,46 @@ +{ + "name": "get-stream", + "version": "4.1.0", + "description": "Get a stream as a string, buffer, or array", + "license": "MIT", + "repository": "sindresorhus/get-stream", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=6" + }, + "scripts": { + "test": "xo && ava" + }, + "files": [ + "index.js", + "buffer-stream.js" + ], + "keywords": [ + "get", + "stream", + "promise", + "concat", + "string", + "text", + "buffer", + "read", + "data", + "consume", + "readable", + "readablestream", + "array", + "object" + ], + "dependencies": { + "pump": "^3.0.0" + }, + "devDependencies": { + "ava": "*", + "into-stream": "^3.0.0", + "xo": "*" + } +} diff --git a/node_modules/get-stream/readme.md b/node_modules/get-stream/readme.md new file mode 100644 index 00000000..b87a4d37 --- /dev/null +++ b/node_modules/get-stream/readme.md @@ -0,0 +1,123 @@ +# get-stream [![Build Status](https://travis-ci.org/sindresorhus/get-stream.svg?branch=master)](https://travis-ci.org/sindresorhus/get-stream) + +> Get a stream as a string, buffer, or array + + +## Install + +``` +$ npm install get-stream +``` + + +## Usage + +```js +const fs = require('fs'); +const getStream = require('get-stream'); + +(async () => { + const stream = fs.createReadStream('unicorn.txt'); + + console.log(await getStream(stream)); + /* + ,,))))))));, + __)))))))))))))), + \|/ -\(((((''''((((((((. + -*-==//////(('' . `)))))), + /|\ ))| o ;-. '((((( ,(, + ( `| / ) ;))))' ,_))^;(~ + | | | ,))((((_ _____------~~~-. %,;(;(>';'~ + o_); ; )))(((` ~---~ `:: \ %%~~)(v;(`('~ + ; ''''```` `: `:::|\,__,%% );`'; ~ + | _ ) / `:|`----' `-' + ______/\/~ | / / + /~;;.____/;;' / ___--,-( `;;;/ + / // _;______;'------~~~~~ /;;/\ / + // | | / ; \;;,\ + (<_ | ; /',/-----' _> + \_| ||_ //~;~~~~~~~~~ + `\_| (,~~ + \~\ + ~~ + */ +})(); +``` + + +## API + +The methods returns a promise that resolves when the `end` event fires on the stream, indicating that there is no more data to be read. The stream is switched to flowing mode. + +### getStream(stream, [options]) + +Get the `stream` as a string. + +#### options + +Type: `Object` + +##### encoding + +Type: `string`
+Default: `utf8` + +[Encoding](https://nodejs.org/api/buffer.html#buffer_buffer) of the incoming stream. + +##### maxBuffer + +Type: `number`
+Default: `Infinity` + +Maximum length of the returned string. If it exceeds this value before the stream ends, the promise will be rejected with a `getStream.MaxBufferError` error. + +### getStream.buffer(stream, [options]) + +Get the `stream` as a buffer. + +It honors the `maxBuffer` option as above, but it refers to byte length rather than string length. + +### getStream.array(stream, [options]) + +Get the `stream` as an array of values. + +It honors both the `maxBuffer` and `encoding` options. The behavior changes slightly based on the encoding chosen: + +- When `encoding` is unset, it assumes an [object mode stream](https://nodesource.com/blog/understanding-object-streams/) and collects values emitted from `stream` unmodified. In this case `maxBuffer` refers to the number of items in the array (not the sum of their sizes). + +- When `encoding` is set to `buffer`, it collects an array of buffers. `maxBuffer` refers to the summed byte lengths of every buffer in the array. + +- When `encoding` is set to anything else, it collects an array of strings. `maxBuffer` refers to the summed character lengths of every string in the array. + + +## Errors + +If the input stream emits an `error` event, the promise will be rejected with the error. The buffered data will be attached to the `bufferedData` property of the error. + +```js +(async () => { + try { + await getStream(streamThatErrorsAtTheEnd('unicorn')); + } catch (error) { + console.log(error.bufferedData); + //=> 'unicorn' + } +})() +``` + + +## FAQ + +### How is this different from [`concat-stream`](https://github.com/maxogden/concat-stream)? + +This module accepts a stream instead of being one and returns a promise instead of using a callback. The API is simpler and it only supports returning a string, buffer, or array. It doesn't have a fragile type inference. You explicitly choose what you want. And it doesn't depend on the huge `readable-stream` package. + + +## Related + +- [get-stdin](https://github.com/sindresorhus/get-stdin) - Get stdin as a string or buffer + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/is-plain-object/LICENSE b/node_modules/is-plain-object/LICENSE new file mode 100644 index 00000000..3f2eca18 --- /dev/null +++ b/node_modules/is-plain-object/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014-2017, Jon Schlinkert. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/is-plain-object/README.md b/node_modules/is-plain-object/README.md new file mode 100644 index 00000000..60b7b591 --- /dev/null +++ b/node_modules/is-plain-object/README.md @@ -0,0 +1,119 @@ +# is-plain-object [![NPM version](https://img.shields.io/npm/v/is-plain-object.svg?style=flat)](https://www.npmjs.com/package/is-plain-object) [![NPM monthly downloads](https://img.shields.io/npm/dm/is-plain-object.svg?style=flat)](https://npmjs.org/package/is-plain-object) [![NPM total downloads](https://img.shields.io/npm/dt/is-plain-object.svg?style=flat)](https://npmjs.org/package/is-plain-object) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/is-plain-object.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/is-plain-object) + +> Returns true if an object was created by the `Object` constructor. + +Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. + +## Install + +Install with [npm](https://www.npmjs.com/): + +```sh +$ npm install --save is-plain-object +``` + +Use [isobject](https://github.com/jonschlinkert/isobject) if you only want to check if the value is an object and not an array or null. + +## Usage + +```js +import isPlainObject from 'is-plain-object'; +``` + +**true** when created by the `Object` constructor. + +```js +isPlainObject(Object.create({})); +//=> true +isPlainObject(Object.create(Object.prototype)); +//=> true +isPlainObject({foo: 'bar'}); +//=> true +isPlainObject({}); +//=> true +``` + +**false** when not created by the `Object` constructor. + +```js +isPlainObject(1); +//=> false +isPlainObject(['foo', 'bar']); +//=> false +isPlainObject([]); +//=> false +isPlainObject(new Foo); +//=> false +isPlainObject(null); +//=> false +isPlainObject(Object.create(null)); +//=> false +``` + +## About + +
+Contributing + +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). + +
+ +
+Running Tests + +Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: + +```sh +$ npm install && npm test +``` + +
+ +
+Building docs + +_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ + +To generate the readme, run the following command: + +```sh +$ npm install -g verbose/verb#dev verb-generate-readme && verb +``` + +
+ +### Related projects + +You might also be interested in these projects: + +* [is-number](https://www.npmjs.com/package/is-number): Returns true if a number or string value is a finite number. Useful for regex… [more](https://github.com/jonschlinkert/is-number) | [homepage](https://github.com/jonschlinkert/is-number "Returns true if a number or string value is a finite number. Useful for regex matches, parsing, user input, etc.") +* [isobject](https://www.npmjs.com/package/isobject): Returns true if the value is an object and not an array or null. | [homepage](https://github.com/jonschlinkert/isobject "Returns true if the value is an object and not an array or null.") +* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of "Get the native type of a value.") + +### Contributors + +| **Commits** | **Contributor** | +| --- | --- | +| 19 | [jonschlinkert](https://github.com/jonschlinkert) | +| 6 | [TrySound](https://github.com/TrySound) | +| 6 | [stevenvachon](https://github.com/stevenvachon) | +| 3 | [onokumus](https://github.com/onokumus) | +| 1 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) | + +### Author + +**Jon Schlinkert** + +* [GitHub Profile](https://github.com/jonschlinkert) +* [Twitter Profile](https://twitter.com/jonschlinkert) +* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert) + +### License + +Copyright © 2019, [Jon Schlinkert](https://github.com/jonschlinkert). +Released under the [MIT License](LICENSE). + +*** + +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on April 28, 2019._ \ No newline at end of file diff --git a/node_modules/is-plain-object/index.cjs.js b/node_modules/is-plain-object/index.cjs.js new file mode 100644 index 00000000..d7dda951 --- /dev/null +++ b/node_modules/is-plain-object/index.cjs.js @@ -0,0 +1,48 @@ +'use strict'; + +/*! + * isobject + * + * Copyright (c) 2014-2017, Jon Schlinkert. + * Released under the MIT License. + */ + +function isObject(val) { + return val != null && typeof val === 'object' && Array.isArray(val) === false; +} + +/*! + * is-plain-object + * + * Copyright (c) 2014-2017, Jon Schlinkert. + * Released under the MIT License. + */ + +function isObjectObject(o) { + return isObject(o) === true + && Object.prototype.toString.call(o) === '[object Object]'; +} + +function isPlainObject(o) { + var ctor,prot; + + if (isObjectObject(o) === false) return false; + + // If has modified constructor + ctor = o.constructor; + if (typeof ctor !== 'function') return false; + + // If has modified prototype + prot = ctor.prototype; + if (isObjectObject(prot) === false) return false; + + // If constructor does not have an Object-specific method + if (prot.hasOwnProperty('isPrototypeOf') === false) { + return false; + } + + // Most likely a plain Object + return true; +} + +module.exports = isPlainObject; diff --git a/node_modules/is-plain-object/index.d.ts b/node_modules/is-plain-object/index.d.ts new file mode 100644 index 00000000..fd131f01 --- /dev/null +++ b/node_modules/is-plain-object/index.d.ts @@ -0,0 +1,3 @@ +declare function isPlainObject(o: any): boolean; + +export default isPlainObject; diff --git a/node_modules/is-plain-object/index.js b/node_modules/is-plain-object/index.js new file mode 100644 index 00000000..565ce9e4 --- /dev/null +++ b/node_modules/is-plain-object/index.js @@ -0,0 +1,35 @@ +/*! + * is-plain-object + * + * Copyright (c) 2014-2017, Jon Schlinkert. + * Released under the MIT License. + */ + +import isObject from 'isobject'; + +function isObjectObject(o) { + return isObject(o) === true + && Object.prototype.toString.call(o) === '[object Object]'; +} + +export default function isPlainObject(o) { + var ctor,prot; + + if (isObjectObject(o) === false) return false; + + // If has modified constructor + ctor = o.constructor; + if (typeof ctor !== 'function') return false; + + // If has modified prototype + prot = ctor.prototype; + if (isObjectObject(prot) === false) return false; + + // If constructor does not have an Object-specific method + if (prot.hasOwnProperty('isPrototypeOf') === false) { + return false; + } + + // Most likely a plain Object + return true; +}; diff --git a/node_modules/is-plain-object/node_modules/isobject/LICENSE b/node_modules/is-plain-object/node_modules/isobject/LICENSE new file mode 100644 index 00000000..943e71d0 --- /dev/null +++ b/node_modules/is-plain-object/node_modules/isobject/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014-2017, Jon Schlinkert. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/node_modules/is-plain-object/node_modules/isobject/README.md b/node_modules/is-plain-object/node_modules/isobject/README.md new file mode 100644 index 00000000..1c6e21fa --- /dev/null +++ b/node_modules/is-plain-object/node_modules/isobject/README.md @@ -0,0 +1,127 @@ +# isobject [![NPM version](https://img.shields.io/npm/v/isobject.svg?style=flat)](https://www.npmjs.com/package/isobject) [![NPM monthly downloads](https://img.shields.io/npm/dm/isobject.svg?style=flat)](https://npmjs.org/package/isobject) [![NPM total downloads](https://img.shields.io/npm/dt/isobject.svg?style=flat)](https://npmjs.org/package/isobject) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/isobject.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/isobject) + +> Returns true if the value is an object and not an array or null. + +Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. + +## Install + +Install with [npm](https://www.npmjs.com/): + +```sh +$ npm install --save isobject +``` + +Use [is-plain-object](https://github.com/jonschlinkert/is-plain-object) if you want only objects that are created by the `Object` constructor. + +## Install + +Install with [npm](https://www.npmjs.com/): + +```sh +$ npm install isobject +``` + +## Usage + +```js +import isObject from 'isobject'; +``` + +**True** + +All of the following return `true`: + +```js +isObject({}); +isObject(Object.create({})); +isObject(Object.create(Object.prototype)); +isObject(Object.create(null)); +isObject({}); +isObject(new Foo); +isObject(/foo/); +``` + +**False** + +All of the following return `false`: + +```js +isObject(); +isObject(function () {}); +isObject(1); +isObject([]); +isObject(undefined); +isObject(null); +``` + +## About + +
+Contributing + +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). + +
+ +
+Running Tests + +Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: + +```sh +$ npm install && npm test +``` + +
+ +
+Building docs + +_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ + +To generate the readme, run the following command: + +```sh +$ npm install -g verbose/verb#dev verb-generate-readme && verb +``` + +
+ +### Related projects + +You might also be interested in these projects: + +* [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow "Extend an object with the properties of additional objects. node.js/javascript util.") +* [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object "Returns true if an object was created by the `Object` constructor.") +* [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of "Get the native type of a value.") +* [merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep "Recursively merge values in a javascript object.") + +### Contributors + +| **Commits** | **Contributor** | +| --- | --- | +| 30 | [jonschlinkert](https://github.com/jonschlinkert) | +| 8 | [doowb](https://github.com/doowb) | +| 7 | [TrySound](https://github.com/TrySound) | +| 3 | [onokumus](https://github.com/onokumus) | +| 1 | [LeSuisse](https://github.com/LeSuisse) | +| 1 | [tmcw](https://github.com/tmcw) | +| 1 | [ZhouHansen](https://github.com/ZhouHansen) | + +### Author + +**Jon Schlinkert** + +* [GitHub Profile](https://github.com/jonschlinkert) +* [Twitter Profile](https://twitter.com/jonschlinkert) +* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert) + +### License + +Copyright © 2019, [Jon Schlinkert](https://github.com/jonschlinkert). +Released under the [MIT License](LICENSE). + +*** + +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on April 28, 2019._ \ No newline at end of file diff --git a/node_modules/is-plain-object/node_modules/isobject/index.cjs.js b/node_modules/is-plain-object/node_modules/isobject/index.cjs.js new file mode 100644 index 00000000..49debe73 --- /dev/null +++ b/node_modules/is-plain-object/node_modules/isobject/index.cjs.js @@ -0,0 +1,14 @@ +'use strict'; + +/*! + * isobject + * + * Copyright (c) 2014-2017, Jon Schlinkert. + * Released under the MIT License. + */ + +function isObject(val) { + return val != null && typeof val === 'object' && Array.isArray(val) === false; +} + +module.exports = isObject; diff --git a/node_modules/is-plain-object/node_modules/isobject/index.d.ts b/node_modules/is-plain-object/node_modules/isobject/index.d.ts new file mode 100644 index 00000000..c471c715 --- /dev/null +++ b/node_modules/is-plain-object/node_modules/isobject/index.d.ts @@ -0,0 +1,3 @@ +declare function isObject(val: any): boolean; + +export default isObject; diff --git a/node_modules/is-plain-object/node_modules/isobject/index.js b/node_modules/is-plain-object/node_modules/isobject/index.js new file mode 100644 index 00000000..e9f03822 --- /dev/null +++ b/node_modules/is-plain-object/node_modules/isobject/index.js @@ -0,0 +1,10 @@ +/*! + * isobject + * + * Copyright (c) 2014-2017, Jon Schlinkert. + * Released under the MIT License. + */ + +export default function isObject(val) { + return val != null && typeof val === 'object' && Array.isArray(val) === false; +}; diff --git a/node_modules/is-plain-object/node_modules/isobject/package.json b/node_modules/is-plain-object/node_modules/isobject/package.json new file mode 100644 index 00000000..c5683e81 --- /dev/null +++ b/node_modules/is-plain-object/node_modules/isobject/package.json @@ -0,0 +1,80 @@ +{ + "name": "isobject", + "description": "Returns true if the value is an object and not an array or null.", + "version": "4.0.0", + "homepage": "https://github.com/jonschlinkert/isobject", + "author": "Jon Schlinkert (https://github.com/jonschlinkert)", + "contributors": [ + "(https://github.com/LeSuisse)", + "Brian Woodward (https://twitter.com/doowb)", + "Jon Schlinkert (http://twitter.com/jonschlinkert)", + "Magnús Dæhlen (https://github.com/magnudae)", + "Tom MacWright (https://macwright.org)" + ], + "repository": "jonschlinkert/isobject", + "bugs": { + "url": "https://github.com/jonschlinkert/isobject/issues" + }, + "license": "MIT", + "files": [ + "index.d.ts", + "index.cjs.js", + "index.js" + ], + "main": "index.cjs.js", + "module": "index.js", + "engines": { + "node": ">=0.10.0" + }, + "scripts": { + "build": "rollup -i index.js -o index.cjs.js -f cjs", + "test": "mocha -r esm", + "prepublish": "npm run build" + }, + "dependencies": {}, + "devDependencies": { + "esm": "^3.2.22", + "gulp-format-md": "^0.1.9", + "mocha": "^2.4.5", + "rollup": "^1.10.1" + }, + "keywords": [ + "check", + "is", + "is-object", + "isobject", + "kind", + "kind-of", + "kindof", + "native", + "object", + "type", + "typeof", + "value" + ], + "types": "index.d.ts", + "verb": { + "related": { + "list": [ + "extend-shallow", + "is-plain-object", + "kind-of", + "merge-deep" + ] + }, + "toc": false, + "layout": "default", + "tasks": [ + "readme" + ], + "plugins": [ + "gulp-format-md" + ], + "lint": { + "reflinks": true + }, + "reflinks": [ + "verb" + ] + } +} diff --git a/node_modules/is-plain-object/package.json b/node_modules/is-plain-object/package.json new file mode 100644 index 00000000..fd2e3a5b --- /dev/null +++ b/node_modules/is-plain-object/package.json @@ -0,0 +1,82 @@ +{ + "name": "is-plain-object", + "description": "Returns true if an object was created by the `Object` constructor.", + "version": "3.0.0", + "homepage": "https://github.com/jonschlinkert/is-plain-object", + "author": "Jon Schlinkert (https://github.com/jonschlinkert)", + "contributors": [ + "Jon Schlinkert (http://twitter.com/jonschlinkert)", + "Osman Nuri Okumuş (http://onokumus.com)", + "Steven Vachon (https://svachon.com)", + "(https://github.com/wtgtybhertgeghgtwtg)" + ], + "repository": "jonschlinkert/is-plain-object", + "bugs": { + "url": "https://github.com/jonschlinkert/is-plain-object/issues" + }, + "license": "MIT", + "main": "index.cjs.js", + "module": "index.js", + "types": "index.d.ts", + "files": [ + "index.d.ts", + "index.js", + "index.cjs.js" + ], + "engines": { + "node": ">=0.10.0" + }, + "scripts": { + "build": "rollup -c", + "test_browser": "mocha-headless-chrome --args=disable-web-security -f test/browser.html", + "test_node": "mocha -r esm", + "test": "npm run test_node && npm run build && npm run test_browser", + "prepare": "rollup -c" + }, + "dependencies": { + "isobject": "^4.0.0" + }, + "devDependencies": { + "chai": "^4.2.0", + "esm": "^3.2.22", + "gulp-format-md": "^1.0.0", + "mocha": "^6.1.4", + "mocha-headless-chrome": "^2.0.2", + "rollup": "^1.10.1", + "rollup-plugin-node-resolve": "^4.2.3" + }, + "keywords": [ + "check", + "is", + "is-object", + "isobject", + "javascript", + "kind", + "kind-of", + "object", + "plain", + "type", + "typeof", + "value" + ], + "verb": { + "toc": false, + "layout": "default", + "tasks": [ + "readme" + ], + "plugins": [ + "gulp-format-md" + ], + "related": { + "list": [ + "is-number", + "isobject", + "kind-of" + ] + }, + "lint": { + "reflinks": true + } + } +} diff --git a/node_modules/isexe/.npmignore b/node_modules/isexe/.npmignore new file mode 100644 index 00000000..c1cb757a --- /dev/null +++ b/node_modules/isexe/.npmignore @@ -0,0 +1,2 @@ +.nyc_output/ +coverage/ diff --git a/node_modules/isexe/LICENSE b/node_modules/isexe/LICENSE new file mode 100644 index 00000000..19129e31 --- /dev/null +++ b/node_modules/isexe/LICENSE @@ -0,0 +1,15 @@ +The ISC License + +Copyright (c) Isaac Z. Schlueter and Contributors + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR +IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/isexe/README.md b/node_modules/isexe/README.md new file mode 100644 index 00000000..35769e84 --- /dev/null +++ b/node_modules/isexe/README.md @@ -0,0 +1,51 @@ +# isexe + +Minimal module to check if a file is executable, and a normal file. + +Uses `fs.stat` and tests against the `PATHEXT` environment variable on +Windows. + +## USAGE + +```javascript +var isexe = require('isexe') +isexe('some-file-name', function (err, isExe) { + if (err) { + console.error('probably file does not exist or something', err) + } else if (isExe) { + console.error('this thing can be run') + } else { + console.error('cannot be run') + } +}) + +// same thing but synchronous, throws errors +var isExe = isexe.sync('some-file-name') + +// treat errors as just "not executable" +isexe('maybe-missing-file', { ignoreErrors: true }, callback) +var isExe = isexe.sync('maybe-missing-file', { ignoreErrors: true }) +``` + +## API + +### `isexe(path, [options], [callback])` + +Check if the path is executable. If no callback provided, and a +global `Promise` object is available, then a Promise will be returned. + +Will raise whatever errors may be raised by `fs.stat`, unless +`options.ignoreErrors` is set to true. + +### `isexe.sync(path, [options])` + +Same as `isexe` but returns the value and throws any errors raised. + +### Options + +* `ignoreErrors` Treat all errors as "no, this is not executable", but + don't raise them. +* `uid` Number to use as the user id +* `gid` Number to use as the group id +* `pathExt` List of path extensions to use instead of `PATHEXT` + environment variable on Windows. diff --git a/node_modules/isexe/index.js b/node_modules/isexe/index.js new file mode 100644 index 00000000..553fb32b --- /dev/null +++ b/node_modules/isexe/index.js @@ -0,0 +1,57 @@ +var fs = require('fs') +var core +if (process.platform === 'win32' || global.TESTING_WINDOWS) { + core = require('./windows.js') +} else { + core = require('./mode.js') +} + +module.exports = isexe +isexe.sync = sync + +function isexe (path, options, cb) { + if (typeof options === 'function') { + cb = options + options = {} + } + + if (!cb) { + if (typeof Promise !== 'function') { + throw new TypeError('callback not provided') + } + + return new Promise(function (resolve, reject) { + isexe(path, options || {}, function (er, is) { + if (er) { + reject(er) + } else { + resolve(is) + } + }) + }) + } + + core(path, options || {}, function (er, is) { + // ignore EACCES because that just means we aren't allowed to run it + if (er) { + if (er.code === 'EACCES' || options && options.ignoreErrors) { + er = null + is = false + } + } + cb(er, is) + }) +} + +function sync (path, options) { + // my kingdom for a filtered catch + try { + return core.sync(path, options || {}) + } catch (er) { + if (options && options.ignoreErrors || er.code === 'EACCES') { + return false + } else { + throw er + } + } +} diff --git a/node_modules/isexe/mode.js b/node_modules/isexe/mode.js new file mode 100644 index 00000000..1995ea4a --- /dev/null +++ b/node_modules/isexe/mode.js @@ -0,0 +1,41 @@ +module.exports = isexe +isexe.sync = sync + +var fs = require('fs') + +function isexe (path, options, cb) { + fs.stat(path, function (er, stat) { + cb(er, er ? false : checkStat(stat, options)) + }) +} + +function sync (path, options) { + return checkStat(fs.statSync(path), options) +} + +function checkStat (stat, options) { + return stat.isFile() && checkMode(stat, options) +} + +function checkMode (stat, options) { + var mod = stat.mode + var uid = stat.uid + var gid = stat.gid + + var myUid = options.uid !== undefined ? + options.uid : process.getuid && process.getuid() + var myGid = options.gid !== undefined ? + options.gid : process.getgid && process.getgid() + + var u = parseInt('100', 8) + var g = parseInt('010', 8) + var o = parseInt('001', 8) + var ug = u | g + + var ret = (mod & o) || + (mod & g) && gid === myGid || + (mod & u) && uid === myUid || + (mod & ug) && myUid === 0 + + return ret +} diff --git a/node_modules/isexe/package.json b/node_modules/isexe/package.json new file mode 100644 index 00000000..e4526894 --- /dev/null +++ b/node_modules/isexe/package.json @@ -0,0 +1,31 @@ +{ + "name": "isexe", + "version": "2.0.0", + "description": "Minimal module to check if a file is executable.", + "main": "index.js", + "directories": { + "test": "test" + }, + "devDependencies": { + "mkdirp": "^0.5.1", + "rimraf": "^2.5.0", + "tap": "^10.3.0" + }, + "scripts": { + "test": "tap test/*.js --100", + "preversion": "npm test", + "postversion": "npm publish", + "postpublish": "git push origin --all; git push origin --tags" + }, + "author": "Isaac Z. Schlueter (http://blog.izs.me/)", + "license": "ISC", + "repository": { + "type": "git", + "url": "git+https://github.com/isaacs/isexe.git" + }, + "keywords": [], + "bugs": { + "url": "https://github.com/isaacs/isexe/issues" + }, + "homepage": "https://github.com/isaacs/isexe#readme" +} diff --git a/node_modules/isexe/test/basic.js b/node_modules/isexe/test/basic.js new file mode 100644 index 00000000..d926df64 --- /dev/null +++ b/node_modules/isexe/test/basic.js @@ -0,0 +1,221 @@ +var t = require('tap') +var fs = require('fs') +var path = require('path') +var fixture = path.resolve(__dirname, 'fixtures') +var meow = fixture + '/meow.cat' +var mine = fixture + '/mine.cat' +var ours = fixture + '/ours.cat' +var fail = fixture + '/fail.false' +var noent = fixture + '/enoent.exe' +var mkdirp = require('mkdirp') +var rimraf = require('rimraf') + +var isWindows = process.platform === 'win32' +var hasAccess = typeof fs.access === 'function' +var winSkip = isWindows && 'windows' +var accessSkip = !hasAccess && 'no fs.access function' +var hasPromise = typeof Promise === 'function' +var promiseSkip = !hasPromise && 'no global Promise' + +function reset () { + delete require.cache[require.resolve('../')] + return require('../') +} + +t.test('setup fixtures', function (t) { + rimraf.sync(fixture) + mkdirp.sync(fixture) + fs.writeFileSync(meow, '#!/usr/bin/env cat\nmeow\n') + fs.chmodSync(meow, parseInt('0755', 8)) + fs.writeFileSync(fail, '#!/usr/bin/env false\n') + fs.chmodSync(fail, parseInt('0644', 8)) + fs.writeFileSync(mine, '#!/usr/bin/env cat\nmine\n') + fs.chmodSync(mine, parseInt('0744', 8)) + fs.writeFileSync(ours, '#!/usr/bin/env cat\nours\n') + fs.chmodSync(ours, parseInt('0754', 8)) + t.end() +}) + +t.test('promise', { skip: promiseSkip }, function (t) { + var isexe = reset() + t.test('meow async', function (t) { + isexe(meow).then(function (is) { + t.ok(is) + t.end() + }) + }) + t.test('fail async', function (t) { + isexe(fail).then(function (is) { + t.notOk(is) + t.end() + }) + }) + t.test('noent async', function (t) { + isexe(noent).catch(function (er) { + t.ok(er) + t.end() + }) + }) + t.test('noent ignore async', function (t) { + isexe(noent, { ignoreErrors: true }).then(function (is) { + t.notOk(is) + t.end() + }) + }) + t.end() +}) + +t.test('no promise', function (t) { + global.Promise = null + var isexe = reset() + t.throws('try to meow a promise', function () { + isexe(meow) + }) + t.end() +}) + +t.test('access', { skip: accessSkip || winSkip }, function (t) { + runTest(t) +}) + +t.test('mode', { skip: winSkip }, function (t) { + delete fs.access + delete fs.accessSync + var isexe = reset() + t.ok(isexe.sync(ours, { uid: 0, gid: 0 })) + t.ok(isexe.sync(mine, { uid: 0, gid: 0 })) + runTest(t) +}) + +t.test('windows', function (t) { + global.TESTING_WINDOWS = true + var pathExt = '.EXE;.CAT;.CMD;.COM' + t.test('pathExt option', function (t) { + runTest(t, { pathExt: '.EXE;.CAT;.CMD;.COM' }) + }) + t.test('pathExt env', function (t) { + process.env.PATHEXT = pathExt + runTest(t) + }) + t.test('no pathExt', function (t) { + // with a pathExt of '', any filename is fine. + // so the "fail" one would still pass. + runTest(t, { pathExt: '', skipFail: true }) + }) + t.test('pathext with empty entry', function (t) { + // with a pathExt of '', any filename is fine. + // so the "fail" one would still pass. + runTest(t, { pathExt: ';' + pathExt, skipFail: true }) + }) + t.end() +}) + +t.test('cleanup', function (t) { + rimraf.sync(fixture) + t.end() +}) + +function runTest (t, options) { + var isexe = reset() + + var optionsIgnore = Object.create(options || {}) + optionsIgnore.ignoreErrors = true + + if (!options || !options.skipFail) { + t.notOk(isexe.sync(fail, options)) + } + t.notOk(isexe.sync(noent, optionsIgnore)) + if (!options) { + t.ok(isexe.sync(meow)) + } else { + t.ok(isexe.sync(meow, options)) + } + + t.ok(isexe.sync(mine, options)) + t.ok(isexe.sync(ours, options)) + t.throws(function () { + isexe.sync(noent, options) + }) + + t.test('meow async', function (t) { + if (!options) { + isexe(meow, function (er, is) { + if (er) { + throw er + } + t.ok(is) + t.end() + }) + } else { + isexe(meow, options, function (er, is) { + if (er) { + throw er + } + t.ok(is) + t.end() + }) + } + }) + + t.test('mine async', function (t) { + isexe(mine, options, function (er, is) { + if (er) { + throw er + } + t.ok(is) + t.end() + }) + }) + + t.test('ours async', function (t) { + isexe(ours, options, function (er, is) { + if (er) { + throw er + } + t.ok(is) + t.end() + }) + }) + + if (!options || !options.skipFail) { + t.test('fail async', function (t) { + isexe(fail, options, function (er, is) { + if (er) { + throw er + } + t.notOk(is) + t.end() + }) + }) + } + + t.test('noent async', function (t) { + isexe(noent, options, function (er, is) { + t.ok(er) + t.notOk(is) + t.end() + }) + }) + + t.test('noent ignore async', function (t) { + isexe(noent, optionsIgnore, function (er, is) { + if (er) { + throw er + } + t.notOk(is) + t.end() + }) + }) + + t.test('directory is not executable', function (t) { + isexe(__dirname, options, function (er, is) { + if (er) { + throw er + } + t.notOk(is) + t.end() + }) + }) + + t.end() +} diff --git a/node_modules/isexe/windows.js b/node_modules/isexe/windows.js new file mode 100644 index 00000000..34996734 --- /dev/null +++ b/node_modules/isexe/windows.js @@ -0,0 +1,42 @@ +module.exports = isexe +isexe.sync = sync + +var fs = require('fs') + +function checkPathExt (path, options) { + var pathext = options.pathExt !== undefined ? + options.pathExt : process.env.PATHEXT + + if (!pathext) { + return true + } + + pathext = pathext.split(';') + if (pathext.indexOf('') !== -1) { + return true + } + for (var i = 0; i < pathext.length; i++) { + var p = pathext[i].toLowerCase() + if (p && path.substr(-p.length).toLowerCase() === p) { + return true + } + } + return false +} + +function checkStat (stat, path, options) { + if (!stat.isSymbolicLink() && !stat.isFile()) { + return false + } + return checkPathExt(path, options) +} + +function isexe (path, options, cb) { + fs.stat(path, function (er, stat) { + cb(er, er ? false : checkStat(stat, path, options)) + }) +} + +function sync (path, options) { + return checkStat(fs.statSync(path), path, options) +} diff --git a/node_modules/macos-release/index.d.ts b/node_modules/macos-release/index.d.ts new file mode 100644 index 00000000..c4efcf45 --- /dev/null +++ b/node_modules/macos-release/index.d.ts @@ -0,0 +1,36 @@ +declare const macosRelease: { + /** + Get the name and version of a macOS release from the Darwin version. + + @param release - By default, the current operating system is used, but you can supply a custom [Darwin kernel version](http://en.wikipedia.org/wiki/Darwin_%28operating_system%29#Release_history), which is the output of [`os.release()`](https://nodejs.org/api/os.html#os_os_release). + + @example + ``` + import * as os from 'os'; + import macosRelease = require('macos-release'); + + // On a macOS Sierra system + + macosRelease(); + //=> {name: 'Sierra', version: '10.12'} + + os.release(); + //=> 13.2.0 + // This is the Darwin kernel version + + macosRelease(os.release()); + //=> {name: 'Sierra', version: '10.12'} + + macosRelease('14.0.0'); + //=> {name: 'Yosemite', version: '10.10'} + ``` + */ + (release?: string): string; + + // TODO: remove this in the next major version, refactor the whole definition to: + // declare function macosRelease(release?: string): string; + // export = macosRelease; + default: typeof macosRelease; +}; + +export = macosRelease; diff --git a/node_modules/macos-release/index.js b/node_modules/macos-release/index.js new file mode 100644 index 00000000..b6eba6b0 --- /dev/null +++ b/node_modules/macos-release/index.js @@ -0,0 +1,32 @@ +'use strict'; +const os = require('os'); + +const nameMap = new Map([ + [19, 'Catalina'], + [18, 'Mojave'], + [17, 'High Sierra'], + [16, 'Sierra'], + [15, 'El Capitan'], + [14, 'Yosemite'], + [13, 'Mavericks'], + [12, 'Mountain Lion'], + [11, 'Lion'], + [10, 'Snow Leopard'], + [9, 'Leopard'], + [8, 'Tiger'], + [7, 'Panther'], + [6, 'Jaguar'], + [5, 'Puma'] +]); + +const macosRelease = release => { + release = Number((release || os.release()).split('.')[0]); + return { + name: nameMap.get(release), + version: '10.' + (release - 4) + }; +}; + +module.exports = macosRelease; +// TODO: remove this in the next major version +module.exports.default = macosRelease; diff --git a/node_modules/macos-release/license b/node_modules/macos-release/license new file mode 100644 index 00000000..e7af2f77 --- /dev/null +++ b/node_modules/macos-release/license @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) Sindre Sorhus (sindresorhus.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/macos-release/package.json b/node_modules/macos-release/package.json new file mode 100644 index 00000000..a5c22cd2 --- /dev/null +++ b/node_modules/macos-release/package.json @@ -0,0 +1,39 @@ +{ + "name": "macos-release", + "version": "2.3.0", + "description": "Get the name and version of a macOS release from the Darwin version", + "license": "MIT", + "repository": "sindresorhus/macos-release", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=6" + }, + "scripts": { + "test": "xo && ava && tsd" + }, + "files": [ + "index.js", + "index.d.ts" + ], + "keywords": [ + "macos", + "os", + "darwin", + "operating", + "system", + "platform", + "name", + "title", + "release", + "version" + ], + "devDependencies": { + "ava": "^1.4.1", + "tsd": "^0.7.1", + "xo": "^0.24.0" + } +} diff --git a/node_modules/macos-release/readme.md b/node_modules/macos-release/readme.md new file mode 100644 index 00000000..2e7b9076 --- /dev/null +++ b/node_modules/macos-release/readme.md @@ -0,0 +1,57 @@ +# macos-release [![Build Status](https://travis-ci.org/sindresorhus/macos-release.svg?branch=master)](https://travis-ci.org/sindresorhus/macos-release) + +> Get the name and version of a macOS release from the Darwin version
+> Example: `13.2.0` → `{name: 'Mavericks', version: '10.9'}` + + +## Install + +``` +$ npm install macos-release +``` + + +## Usage + +```js +const os = require('os'); +const macosRelease = require('macos-release'); + +// On a macOS Sierra system + +macosRelease(); +//=> {name: 'Sierra', version: '10.12'} + +os.release(); +//=> 13.2.0 +// This is the Darwin kernel version + +macosRelease(os.release()); +//=> {name: 'Sierra', version: '10.12'} + +macosRelease('14.0.0'); +//=> {name: 'Yosemite', version: '10.10'} +``` + + +## API + +### macosRelease([release]) + +#### release + +Type: `string` + +By default, the current operating system is used, but you can supply a custom [Darwin kernel version](http://en.wikipedia.org/wiki/Darwin_%28operating_system%29#Release_history), which is the output of [`os.release()`](http://nodejs.org/api/os.html#os_os_release). + + +## Related + +- [os-name](https://github.com/sindresorhus/os-name) - Get the name of the current operating system. Example: `macOS Sierra` +- [macos-version](https://github.com/sindresorhus/macos-version) - Get the macOS version of the current system. Example: `10.9.3` +- [win-release](https://github.com/sindresorhus/win-release) - Get the name of a Windows version from the release number: `5.1.2600` → `XP` + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/nice-try/CHANGELOG.md b/node_modules/nice-try/CHANGELOG.md new file mode 100644 index 00000000..9e6baf2f --- /dev/null +++ b/node_modules/nice-try/CHANGELOG.md @@ -0,0 +1,21 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). + +## [1.0.5] - 2018-08-25 + +### Changed + +- Removed `prepublish` script from `package.json` + +## [1.0.4] - 2017-08-08 + +### New + +- Added a changelog + +### Changed + +- Ignore `yarn.lock` and `package-lock.json` files \ No newline at end of file diff --git a/node_modules/nice-try/LICENSE b/node_modules/nice-try/LICENSE new file mode 100644 index 00000000..681c8f50 --- /dev/null +++ b/node_modules/nice-try/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018 Tobias Reich + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/nice-try/README.md b/node_modules/nice-try/README.md new file mode 100644 index 00000000..5b83b788 --- /dev/null +++ b/node_modules/nice-try/README.md @@ -0,0 +1,32 @@ +# nice-try + +[![Travis Build Status](https://travis-ci.org/electerious/nice-try.svg?branch=master)](https://travis-ci.org/electerious/nice-try) [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/8tqb09wrwci3xf8l?svg=true)](https://ci.appveyor.com/project/electerious/nice-try) [![Coverage Status](https://coveralls.io/repos/github/electerious/nice-try/badge.svg?branch=master)](https://coveralls.io/github/electerious/nice-try?branch=master) [![Dependencies](https://david-dm.org/electerious/nice-try.svg)](https://david-dm.org/electerious/nice-try#info=dependencies) [![Greenkeeper badge](https://badges.greenkeeper.io/electerious/nice-try.svg)](https://greenkeeper.io/) + +A function that tries to execute a function and discards any error that occurs. + +## Install + +``` +npm install nice-try +``` + +## Usage + +```js +const niceTry = require('nice-try') + +niceTry(() => JSON.parse('true')) // true +niceTry(() => JSON.parse('truee')) // undefined +niceTry() // undefined +niceTry(true) // undefined +``` + +## API + +### Parameters + +- `fn` `{Function}` Function that might or might not throw an error. + +### Returns + +- `{?*}` Return-value of the function when no error occurred. \ No newline at end of file diff --git a/node_modules/nice-try/package.json b/node_modules/nice-try/package.json new file mode 100644 index 00000000..d3d8887e --- /dev/null +++ b/node_modules/nice-try/package.json @@ -0,0 +1,33 @@ +{ + "name": "nice-try", + "version": "1.0.5", + "authors": [ + "Tobias Reich " + ], + "description": "Tries to execute a function and discards any error that occurs", + "main": "src/index.js", + "keywords": [ + "try", + "catch", + "error" + ], + "license": "MIT", + "homepage": "https://github.com/electerious/nice-try", + "repository": { + "type": "git", + "url": "https://github.com/electerious/nice-try.git" + }, + "files": [ + "src" + ], + "scripts": { + "coveralls": "nyc report --reporter=text-lcov | coveralls", + "test": "nyc node_modules/mocha/bin/_mocha" + }, + "devDependencies": { + "chai": "^4.1.2", + "coveralls": "^3.0.0", + "nyc": "^12.0.1", + "mocha": "^5.1.1" + } +} diff --git a/node_modules/nice-try/src/index.js b/node_modules/nice-try/src/index.js new file mode 100644 index 00000000..837506f2 --- /dev/null +++ b/node_modules/nice-try/src/index.js @@ -0,0 +1,12 @@ +'use strict' + +/** + * Tries to execute a function and discards any error that occurs. + * @param {Function} fn - Function that might or might not throw an error. + * @returns {?*} Return-value of the function when no error occurred. + */ +module.exports = function(fn) { + + try { return fn() } catch (e) {} + +} \ No newline at end of file diff --git a/node_modules/node-fetch/CHANGELOG.md b/node_modules/node-fetch/CHANGELOG.md new file mode 100644 index 00000000..543d3d94 --- /dev/null +++ b/node_modules/node-fetch/CHANGELOG.md @@ -0,0 +1,272 @@ + +Changelog +========= + + +# 2.x release + +## v2.6.1 + +**This is an important security release. It is strongly recommended to update as soon as possible.** + +- Fix: honor the `size` option after following a redirect. + +## v2.6.0 + +- Enhance: `options.agent`, it now accepts a function that returns custom http(s).Agent instance based on current URL, see readme for more information. +- Fix: incorrect `Content-Length` was returned for stream body in 2.5.0 release; note that `node-fetch` doesn't calculate content length for stream body. +- Fix: `Response.url` should return empty string instead of `null` by default. + +## v2.5.0 + +- Enhance: `Response` object now includes `redirected` property. +- Enhance: `fetch()` now accepts third-party `Blob` implementation as body. +- Other: disable `package-lock.json` generation as we never commit them. +- Other: dev dependency update. +- Other: readme update. + +## v2.4.1 + +- Fix: `Blob` import rule for node < 10, as `Readable` isn't a named export. + +## v2.4.0 + +- Enhance: added `Brotli` compression support (using node's zlib). +- Enhance: updated `Blob` implementation per spec. +- Fix: set content type automatically for `URLSearchParams`. +- Fix: `Headers` now reject empty header names. +- Fix: test cases, as node 12+ no longer accepts invalid header response. + +## v2.3.0 + +- Enhance: added `AbortSignal` support, with README example. +- Enhance: handle invalid `Location` header during redirect by rejecting them explicitly with `FetchError`. +- Fix: update `browser.js` to support react-native environment, where `self` isn't available globally. + +## v2.2.1 + +- Fix: `compress` flag shouldn't overwrite existing `Accept-Encoding` header. +- Fix: multiple `import` rules, where `PassThrough` etc. doesn't have a named export when using node <10 and `--exerimental-modules` flag. +- Other: Better README. + +## v2.2.0 + +- Enhance: Support all `ArrayBuffer` view types +- Enhance: Support Web Workers +- Enhance: Support Node.js' `--experimental-modules` mode; deprecate `.es.js` file +- Fix: Add `__esModule` property to the exports object +- Other: Better example in README for writing response to a file +- Other: More tests for Agent + +## v2.1.2 + +- Fix: allow `Body` methods to work on `ArrayBuffer`-backed `Body` objects +- Fix: reject promise returned by `Body` methods when the accumulated `Buffer` exceeds the maximum size +- Fix: support custom `Host` headers with any casing +- Fix: support importing `fetch()` from TypeScript in `browser.js` +- Fix: handle the redirect response body properly + +## v2.1.1 + +Fix packaging errors in v2.1.0. + +## v2.1.0 + +- Enhance: allow using ArrayBuffer as the `body` of a `fetch()` or `Request` +- Fix: store HTTP headers of a `Headers` object internally with the given case, for compatibility with older servers that incorrectly treated header names in a case-sensitive manner +- Fix: silently ignore invalid HTTP headers +- Fix: handle HTTP redirect responses without a `Location` header just like non-redirect responses +- Fix: include bodies when following a redirection when appropriate + +## v2.0.0 + +This is a major release. Check [our upgrade guide](https://github.com/bitinn/node-fetch/blob/master/UPGRADE-GUIDE.md) for an overview on some key differences between v1 and v2. + +### General changes + +- Major: Node.js 0.10.x and 0.12.x support is dropped +- Major: `require('node-fetch/lib/response')` etc. is now unsupported; use `require('node-fetch').Response` or ES6 module imports +- Enhance: start testing on Node.js v4.x, v6.x, v8.x LTS, as well as v9.x stable +- Enhance: use Rollup to produce a distributed bundle (less memory overhead and faster startup) +- Enhance: make `Object.prototype.toString()` on Headers, Requests, and Responses return correct class strings +- Other: rewrite in ES2015 using Babel +- Other: use Codecov for code coverage tracking +- Other: update package.json script for npm 5 +- Other: `encoding` module is now optional (alpha.7) +- Other: expose browser.js through package.json, avoid bundling mishaps (alpha.9) +- Other: allow TypeScript to `import` node-fetch by exposing default (alpha.9) + +### HTTP requests + +- Major: overwrite user's `Content-Length` if we can be sure our information is correct (per spec) +- Fix: errors in a response are caught before the body is accessed +- Fix: support WHATWG URL objects, created by `whatwg-url` package or `require('url').URL` in Node.js 7+ + +### Response and Request classes + +- Major: `response.text()` no longer attempts to detect encoding, instead always opting for UTF-8 (per spec); use `response.textConverted()` for the v1 behavior +- Major: make `response.json()` throw error instead of returning an empty object on 204 no-content respose (per spec; reverts behavior changed in v1.6.2) +- Major: internal methods are no longer exposed +- Major: throw error when a `GET` or `HEAD` Request is constructed with a non-null body (per spec) +- Enhance: add `response.arrayBuffer()` (also applies to Requests) +- Enhance: add experimental `response.blob()` (also applies to Requests) +- Enhance: `URLSearchParams` is now accepted as a body +- Enhance: wrap `response.json()` json parsing error as `FetchError` +- Fix: fix Request and Response with `null` body + +### Headers class + +- Major: remove `headers.getAll()`; make `get()` return all headers delimited by commas (per spec) +- Enhance: make Headers iterable +- Enhance: make Headers constructor accept an array of tuples +- Enhance: make sure header names and values are valid in HTTP +- Fix: coerce Headers prototype function parameters to strings, where applicable + +### Documentation + +- Enhance: more comprehensive API docs +- Enhance: add a list of default headers in README + + +# 1.x release + +## backport releases (v1.7.0 and beyond) + +See [changelog on 1.x branch](https://github.com/bitinn/node-fetch/blob/1.x/CHANGELOG.md) for details. + +## v1.6.3 + +- Enhance: error handling document to explain `FetchError` design +- Fix: support `form-data` 2.x releases (requires `form-data` >= 2.1.0) + +## v1.6.2 + +- Enhance: minor document update +- Fix: response.json() returns empty object on 204 no-content response instead of throwing a syntax error + +## v1.6.1 + +- Fix: if `res.body` is a non-stream non-formdata object, we will call `body.toString` and send it as a string +- Fix: `counter` value is incorrectly set to `follow` value when wrapping Request instance +- Fix: documentation update + +## v1.6.0 + +- Enhance: added `res.buffer()` api for convenience, it returns body as a Node.js buffer +- Enhance: better old server support by handling raw deflate response +- Enhance: skip encoding detection for non-HTML/XML response +- Enhance: minor document update +- Fix: HEAD request doesn't need decompression, as body is empty +- Fix: `req.body` now accepts a Node.js buffer + +## v1.5.3 + +- Fix: handle 204 and 304 responses when body is empty but content-encoding is gzip/deflate +- Fix: allow resolving response and cloned response in any order +- Fix: avoid setting `content-length` when `form-data` body use streams +- Fix: send DELETE request with content-length when body is present +- Fix: allow any url when calling new Request, but still reject non-http(s) url in fetch + +## v1.5.2 + +- Fix: allow node.js core to handle keep-alive connection pool when passing a custom agent + +## v1.5.1 + +- Fix: redirect mode `manual` should work even when there is no redirection or broken redirection + +## v1.5.0 + +- Enhance: rejected promise now use custom `Error` (thx to @pekeler) +- Enhance: `FetchError` contains `err.type` and `err.code`, allows for better error handling (thx to @pekeler) +- Enhance: basic support for redirect mode `manual` and `error`, allows for location header extraction (thx to @jimmywarting for the initial PR) + +## v1.4.1 + +- Fix: wrapping Request instance with FormData body again should preserve the body as-is + +## v1.4.0 + +- Enhance: Request and Response now have `clone` method (thx to @kirill-konshin for the initial PR) +- Enhance: Request and Response now have proper string and buffer body support (thx to @kirill-konshin) +- Enhance: Body constructor has been refactored out (thx to @kirill-konshin) +- Enhance: Headers now has `forEach` method (thx to @tricoder42) +- Enhance: back to 100% code coverage +- Fix: better form-data support (thx to @item4) +- Fix: better character encoding detection under chunked encoding (thx to @dsuket for the initial PR) + +## v1.3.3 + +- Fix: make sure `Content-Length` header is set when body is string for POST/PUT/PATCH requests +- Fix: handle body stream error, for cases such as incorrect `Content-Encoding` header +- Fix: when following certain redirects, use `GET` on subsequent request per Fetch Spec +- Fix: `Request` and `Response` constructors now parse headers input using `Headers` + +## v1.3.2 + +- Enhance: allow auto detect of form-data input (no `FormData` spec on node.js, this is form-data specific feature) + +## v1.3.1 + +- Enhance: allow custom host header to be set (server-side only feature, as it's a forbidden header on client-side) + +## v1.3.0 + +- Enhance: now `fetch.Request` is exposed as well + +## v1.2.1 + +- Enhance: `Headers` now normalized `Number` value to `String`, prevent common mistakes + +## v1.2.0 + +- Enhance: now fetch.Headers and fetch.Response are exposed, making testing easier + +## v1.1.2 + +- Fix: `Headers` should only support `String` and `Array` properties, and ignore others + +## v1.1.1 + +- Enhance: now req.headers accept both plain object and `Headers` instance + +## v1.1.0 + +- Enhance: timeout now also applies to response body (in case of slow response) +- Fix: timeout is now cleared properly when fetch is done/has failed + +## v1.0.6 + +- Fix: less greedy content-type charset matching + +## v1.0.5 + +- Fix: when `follow = 0`, fetch should not follow redirect +- Enhance: update tests for better coverage +- Enhance: code formatting +- Enhance: clean up doc + +## v1.0.4 + +- Enhance: test iojs support +- Enhance: timeout attached to socket event only fire once per redirect + +## v1.0.3 + +- Fix: response size limit should reject large chunk +- Enhance: added character encoding detection for xml, such as rss/atom feed (encoding in DTD) + +## v1.0.2 + +- Fix: added res.ok per spec change + +## v1.0.0 + +- Enhance: better test coverage and doc + + +# 0.x release + +## v0.1 + +- Major: initial public release diff --git a/node_modules/node-fetch/LICENSE.md b/node_modules/node-fetch/LICENSE.md new file mode 100644 index 00000000..660ffecb --- /dev/null +++ b/node_modules/node-fetch/LICENSE.md @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2016 David Frank + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/node_modules/node-fetch/README.md b/node_modules/node-fetch/README.md new file mode 100644 index 00000000..2dde7428 --- /dev/null +++ b/node_modules/node-fetch/README.md @@ -0,0 +1,590 @@ +node-fetch +========== + +[![npm version][npm-image]][npm-url] +[![build status][travis-image]][travis-url] +[![coverage status][codecov-image]][codecov-url] +[![install size][install-size-image]][install-size-url] +[![Discord][discord-image]][discord-url] + +A light-weight module that brings `window.fetch` to Node.js + +(We are looking for [v2 maintainers and collaborators](https://github.com/bitinn/node-fetch/issues/567)) + +[![Backers][opencollective-image]][opencollective-url] + + + +- [Motivation](#motivation) +- [Features](#features) +- [Difference from client-side fetch](#difference-from-client-side-fetch) +- [Installation](#installation) +- [Loading and configuring the module](#loading-and-configuring-the-module) +- [Common Usage](#common-usage) + - [Plain text or HTML](#plain-text-or-html) + - [JSON](#json) + - [Simple Post](#simple-post) + - [Post with JSON](#post-with-json) + - [Post with form parameters](#post-with-form-parameters) + - [Handling exceptions](#handling-exceptions) + - [Handling client and server errors](#handling-client-and-server-errors) +- [Advanced Usage](#advanced-usage) + - [Streams](#streams) + - [Buffer](#buffer) + - [Accessing Headers and other Meta data](#accessing-headers-and-other-meta-data) + - [Extract Set-Cookie Header](#extract-set-cookie-header) + - [Post data using a file stream](#post-data-using-a-file-stream) + - [Post with form-data (detect multipart)](#post-with-form-data-detect-multipart) + - [Request cancellation with AbortSignal](#request-cancellation-with-abortsignal) +- [API](#api) + - [fetch(url[, options])](#fetchurl-options) + - [Options](#options) + - [Class: Request](#class-request) + - [Class: Response](#class-response) + - [Class: Headers](#class-headers) + - [Interface: Body](#interface-body) + - [Class: FetchError](#class-fetcherror) +- [License](#license) +- [Acknowledgement](#acknowledgement) + + + +## Motivation + +Instead of implementing `XMLHttpRequest` in Node.js to run browser-specific [Fetch polyfill](https://github.com/github/fetch), why not go from native `http` to `fetch` API directly? Hence, `node-fetch`, minimal code for a `window.fetch` compatible API on Node.js runtime. + +See Matt Andrews' [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch) or Leonardo Quixada's [cross-fetch](https://github.com/lquixada/cross-fetch) for isomorphic usage (exports `node-fetch` for server-side, `whatwg-fetch` for client-side). + +## Features + +- Stay consistent with `window.fetch` API. +- Make conscious trade-off when following [WHATWG fetch spec][whatwg-fetch] and [stream spec](https://streams.spec.whatwg.org/) implementation details, document known differences. +- Use native promise but allow substituting it with [insert your favorite promise library]. +- Use native Node streams for body on both request and response. +- Decode content encoding (gzip/deflate) properly and convert string output (such as `res.text()` and `res.json()`) to UTF-8 automatically. +- Useful extensions such as timeout, redirect limit, response size limit, [explicit errors](ERROR-HANDLING.md) for troubleshooting. + +## Difference from client-side fetch + +- See [Known Differences](LIMITS.md) for details. +- If you happen to use a missing feature that `window.fetch` offers, feel free to open an issue. +- Pull requests are welcomed too! + +## Installation + +Current stable release (`2.x`) + +```sh +$ npm install node-fetch +``` + +## Loading and configuring the module +We suggest you load the module via `require` until the stabilization of ES modules in node: +```js +const fetch = require('node-fetch'); +``` + +If you are using a Promise library other than native, set it through `fetch.Promise`: +```js +const Bluebird = require('bluebird'); + +fetch.Promise = Bluebird; +``` + +## Common Usage + +NOTE: The documentation below is up-to-date with `2.x` releases; see the [`1.x` readme](https://github.com/bitinn/node-fetch/blob/1.x/README.md), [changelog](https://github.com/bitinn/node-fetch/blob/1.x/CHANGELOG.md) and [2.x upgrade guide](UPGRADE-GUIDE.md) for the differences. + +#### Plain text or HTML +```js +fetch('https://github.com/') + .then(res => res.text()) + .then(body => console.log(body)); +``` + +#### JSON + +```js + +fetch('https://api.github.com/users/github') + .then(res => res.json()) + .then(json => console.log(json)); +``` + +#### Simple Post +```js +fetch('https://httpbin.org/post', { method: 'POST', body: 'a=1' }) + .then(res => res.json()) // expecting a json response + .then(json => console.log(json)); +``` + +#### Post with JSON + +```js +const body = { a: 1 }; + +fetch('https://httpbin.org/post', { + method: 'post', + body: JSON.stringify(body), + headers: { 'Content-Type': 'application/json' }, + }) + .then(res => res.json()) + .then(json => console.log(json)); +``` + +#### Post with form parameters +`URLSearchParams` is available in Node.js as of v7.5.0. See [official documentation](https://nodejs.org/api/url.html#url_class_urlsearchparams) for more usage methods. + +NOTE: The `Content-Type` header is only set automatically to `x-www-form-urlencoded` when an instance of `URLSearchParams` is given as such: + +```js +const { URLSearchParams } = require('url'); + +const params = new URLSearchParams(); +params.append('a', 1); + +fetch('https://httpbin.org/post', { method: 'POST', body: params }) + .then(res => res.json()) + .then(json => console.log(json)); +``` + +#### Handling exceptions +NOTE: 3xx-5xx responses are *NOT* exceptions and should be handled in `then()`; see the next section for more information. + +Adding a catch to the fetch promise chain will catch *all* exceptions, such as errors originating from node core libraries, network errors and operational errors, which are instances of FetchError. See the [error handling document](ERROR-HANDLING.md) for more details. + +```js +fetch('https://domain.invalid/') + .catch(err => console.error(err)); +``` + +#### Handling client and server errors +It is common to create a helper function to check that the response contains no client (4xx) or server (5xx) error responses: + +```js +function checkStatus(res) { + if (res.ok) { // res.status >= 200 && res.status < 300 + return res; + } else { + throw MyCustomError(res.statusText); + } +} + +fetch('https://httpbin.org/status/400') + .then(checkStatus) + .then(res => console.log('will not get here...')) +``` + +## Advanced Usage + +#### Streams +The "Node.js way" is to use streams when possible: + +```js +fetch('https://assets-cdn.github.com/images/modules/logos_page/Octocat.png') + .then(res => { + const dest = fs.createWriteStream('./octocat.png'); + res.body.pipe(dest); + }); +``` + +#### Buffer +If you prefer to cache binary data in full, use buffer(). (NOTE: `buffer()` is a `node-fetch`-only API) + +```js +const fileType = require('file-type'); + +fetch('https://assets-cdn.github.com/images/modules/logos_page/Octocat.png') + .then(res => res.buffer()) + .then(buffer => fileType(buffer)) + .then(type => { /* ... */ }); +``` + +#### Accessing Headers and other Meta data +```js +fetch('https://github.com/') + .then(res => { + console.log(res.ok); + console.log(res.status); + console.log(res.statusText); + console.log(res.headers.raw()); + console.log(res.headers.get('content-type')); + }); +``` + +#### Extract Set-Cookie Header + +Unlike browsers, you can access raw `Set-Cookie` headers manually using `Headers.raw()`. This is a `node-fetch` only API. + +```js +fetch(url).then(res => { + // returns an array of values, instead of a string of comma-separated values + console.log(res.headers.raw()['set-cookie']); +}); +``` + +#### Post data using a file stream + +```js +const { createReadStream } = require('fs'); + +const stream = createReadStream('input.txt'); + +fetch('https://httpbin.org/post', { method: 'POST', body: stream }) + .then(res => res.json()) + .then(json => console.log(json)); +``` + +#### Post with form-data (detect multipart) + +```js +const FormData = require('form-data'); + +const form = new FormData(); +form.append('a', 1); + +fetch('https://httpbin.org/post', { method: 'POST', body: form }) + .then(res => res.json()) + .then(json => console.log(json)); + +// OR, using custom headers +// NOTE: getHeaders() is non-standard API + +const form = new FormData(); +form.append('a', 1); + +const options = { + method: 'POST', + body: form, + headers: form.getHeaders() +} + +fetch('https://httpbin.org/post', options) + .then(res => res.json()) + .then(json => console.log(json)); +``` + +#### Request cancellation with AbortSignal + +> NOTE: You may cancel streamed requests only on Node >= v8.0.0 + +You may cancel requests with `AbortController`. A suggested implementation is [`abort-controller`](https://www.npmjs.com/package/abort-controller). + +An example of timing out a request after 150ms could be achieved as the following: + +```js +import AbortController from 'abort-controller'; + +const controller = new AbortController(); +const timeout = setTimeout( + () => { controller.abort(); }, + 150, +); + +fetch(url, { signal: controller.signal }) + .then(res => res.json()) + .then( + data => { + useData(data) + }, + err => { + if (err.name === 'AbortError') { + // request was aborted + } + }, + ) + .finally(() => { + clearTimeout(timeout); + }); +``` + +See [test cases](https://github.com/bitinn/node-fetch/blob/master/test/test.js) for more examples. + + +## API + +### fetch(url[, options]) + +- `url` A string representing the URL for fetching +- `options` [Options](#fetch-options) for the HTTP(S) request +- Returns: Promise<[Response](#class-response)> + +Perform an HTTP(S) fetch. + +`url` should be an absolute url, such as `https://example.com/`. A path-relative URL (`/file/under/root`) or protocol-relative URL (`//can-be-http-or-https.com/`) will result in a rejected `Promise`. + + +### Options + +The default values are shown after each option key. + +```js +{ + // These properties are part of the Fetch Standard + method: 'GET', + headers: {}, // request headers. format is the identical to that accepted by the Headers constructor (see below) + body: null, // request body. can be null, a string, a Buffer, a Blob, or a Node.js Readable stream + redirect: 'follow', // set to `manual` to extract redirect headers, `error` to reject redirect + signal: null, // pass an instance of AbortSignal to optionally abort requests + + // The following properties are node-fetch extensions + follow: 20, // maximum redirect count. 0 to not follow redirect + timeout: 0, // req/res timeout in ms, it resets on redirect. 0 to disable (OS limit applies). Signal is recommended instead. + compress: true, // support gzip/deflate content encoding. false to disable + size: 0, // maximum response body size in bytes. 0 to disable + agent: null // http(s).Agent instance or function that returns an instance (see below) +} +``` + +##### Default Headers + +If no values are set, the following request headers will be sent automatically: + +Header | Value +------------------- | -------------------------------------------------------- +`Accept-Encoding` | `gzip,deflate` _(when `options.compress === true`)_ +`Accept` | `*/*` +`Connection` | `close` _(when no `options.agent` is present)_ +`Content-Length` | _(automatically calculated, if possible)_ +`Transfer-Encoding` | `chunked` _(when `req.body` is a stream)_ +`User-Agent` | `node-fetch/1.0 (+https://github.com/bitinn/node-fetch)` + +Note: when `body` is a `Stream`, `Content-Length` is not set automatically. + +##### Custom Agent + +The `agent` option allows you to specify networking related options which are out of the scope of Fetch, including and not limited to the following: + +- Support self-signed certificate +- Use only IPv4 or IPv6 +- Custom DNS Lookup + +See [`http.Agent`](https://nodejs.org/api/http.html#http_new_agent_options) for more information. + +In addition, the `agent` option accepts a function that returns `http`(s)`.Agent` instance given current [URL](https://nodejs.org/api/url.html), this is useful during a redirection chain across HTTP and HTTPS protocol. + +```js +const httpAgent = new http.Agent({ + keepAlive: true +}); +const httpsAgent = new https.Agent({ + keepAlive: true +}); + +const options = { + agent: function (_parsedURL) { + if (_parsedURL.protocol == 'http:') { + return httpAgent; + } else { + return httpsAgent; + } + } +} +``` + + +### Class: Request + +An HTTP(S) request containing information about URL, method, headers, and the body. This class implements the [Body](#iface-body) interface. + +Due to the nature of Node.js, the following properties are not implemented at this moment: + +- `type` +- `destination` +- `referrer` +- `referrerPolicy` +- `mode` +- `credentials` +- `cache` +- `integrity` +- `keepalive` + +The following node-fetch extension properties are provided: + +- `follow` +- `compress` +- `counter` +- `agent` + +See [options](#fetch-options) for exact meaning of these extensions. + +#### new Request(input[, options]) + +*(spec-compliant)* + +- `input` A string representing a URL, or another `Request` (which will be cloned) +- `options` [Options][#fetch-options] for the HTTP(S) request + +Constructs a new `Request` object. The constructor is identical to that in the [browser](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request). + +In most cases, directly `fetch(url, options)` is simpler than creating a `Request` object. + + +### Class: Response + +An HTTP(S) response. This class implements the [Body](#iface-body) interface. + +The following properties are not implemented in node-fetch at this moment: + +- `Response.error()` +- `Response.redirect()` +- `type` +- `trailer` + +#### new Response([body[, options]]) + +*(spec-compliant)* + +- `body` A `String` or [`Readable` stream][node-readable] +- `options` A [`ResponseInit`][response-init] options dictionary + +Constructs a new `Response` object. The constructor is identical to that in the [browser](https://developer.mozilla.org/en-US/docs/Web/API/Response/Response). + +Because Node.js does not implement service workers (for which this class was designed), one rarely has to construct a `Response` directly. + +#### response.ok + +*(spec-compliant)* + +Convenience property representing if the request ended normally. Will evaluate to true if the response status was greater than or equal to 200 but smaller than 300. + +#### response.redirected + +*(spec-compliant)* + +Convenience property representing if the request has been redirected at least once. Will evaluate to true if the internal redirect counter is greater than 0. + + +### Class: Headers + +This class allows manipulating and iterating over a set of HTTP headers. All methods specified in the [Fetch Standard][whatwg-fetch] are implemented. + +#### new Headers([init]) + +*(spec-compliant)* + +- `init` Optional argument to pre-fill the `Headers` object + +Construct a new `Headers` object. `init` can be either `null`, a `Headers` object, an key-value map object or any iterable object. + +```js +// Example adapted from https://fetch.spec.whatwg.org/#example-headers-class + +const meta = { + 'Content-Type': 'text/xml', + 'Breaking-Bad': '<3' +}; +const headers = new Headers(meta); + +// The above is equivalent to +const meta = [ + [ 'Content-Type', 'text/xml' ], + [ 'Breaking-Bad', '<3' ] +]; +const headers = new Headers(meta); + +// You can in fact use any iterable objects, like a Map or even another Headers +const meta = new Map(); +meta.set('Content-Type', 'text/xml'); +meta.set('Breaking-Bad', '<3'); +const headers = new Headers(meta); +const copyOfHeaders = new Headers(headers); +``` + + +### Interface: Body + +`Body` is an abstract interface with methods that are applicable to both `Request` and `Response` classes. + +The following methods are not yet implemented in node-fetch at this moment: + +- `formData()` + +#### body.body + +*(deviation from spec)* + +* Node.js [`Readable` stream][node-readable] + +Data are encapsulated in the `Body` object. Note that while the [Fetch Standard][whatwg-fetch] requires the property to always be a WHATWG `ReadableStream`, in node-fetch it is a Node.js [`Readable` stream][node-readable]. + +#### body.bodyUsed + +*(spec-compliant)* + +* `Boolean` + +A boolean property for if this body has been consumed. Per the specs, a consumed body cannot be used again. + +#### body.arrayBuffer() +#### body.blob() +#### body.json() +#### body.text() + +*(spec-compliant)* + +* Returns: Promise + +Consume the body and return a promise that will resolve to one of these formats. + +#### body.buffer() + +*(node-fetch extension)* + +* Returns: Promise<Buffer> + +Consume the body and return a promise that will resolve to a Buffer. + +#### body.textConverted() + +*(node-fetch extension)* + +* Returns: Promise<String> + +Identical to `body.text()`, except instead of always converting to UTF-8, encoding sniffing will be performed and text converted to UTF-8 if possible. + +(This API requires an optional dependency of the npm package [encoding](https://www.npmjs.com/package/encoding), which you need to install manually. `webpack` users may see [a warning message](https://github.com/bitinn/node-fetch/issues/412#issuecomment-379007792) due to this optional dependency.) + + +### Class: FetchError + +*(node-fetch extension)* + +An operational error in the fetching process. See [ERROR-HANDLING.md][] for more info. + + +### Class: AbortError + +*(node-fetch extension)* + +An Error thrown when the request is aborted in response to an `AbortSignal`'s `abort` event. It has a `name` property of `AbortError`. See [ERROR-HANDLING.MD][] for more info. + +## Acknowledgement + +Thanks to [github/fetch](https://github.com/github/fetch) for providing a solid implementation reference. + +`node-fetch` v1 was maintained by [@bitinn](https://github.com/bitinn); v2 was maintained by [@TimothyGu](https://github.com/timothygu), [@bitinn](https://github.com/bitinn) and [@jimmywarting](https://github.com/jimmywarting); v2 readme is written by [@jkantr](https://github.com/jkantr). + +## License + +MIT + +[npm-image]: https://flat.badgen.net/npm/v/node-fetch +[npm-url]: https://www.npmjs.com/package/node-fetch +[travis-image]: https://flat.badgen.net/travis/bitinn/node-fetch +[travis-url]: https://travis-ci.org/bitinn/node-fetch +[codecov-image]: https://flat.badgen.net/codecov/c/github/bitinn/node-fetch/master +[codecov-url]: https://codecov.io/gh/bitinn/node-fetch +[install-size-image]: https://flat.badgen.net/packagephobia/install/node-fetch +[install-size-url]: https://packagephobia.now.sh/result?p=node-fetch +[discord-image]: https://img.shields.io/discord/619915844268326952?color=%237289DA&label=Discord&style=flat-square +[discord-url]: https://discord.gg/Zxbndcm +[opencollective-image]: https://opencollective.com/node-fetch/backers.svg +[opencollective-url]: https://opencollective.com/node-fetch +[whatwg-fetch]: https://fetch.spec.whatwg.org/ +[response-init]: https://fetch.spec.whatwg.org/#responseinit +[node-readable]: https://nodejs.org/api/stream.html#stream_readable_streams +[mdn-headers]: https://developer.mozilla.org/en-US/docs/Web/API/Headers +[LIMITS.md]: https://github.com/bitinn/node-fetch/blob/master/LIMITS.md +[ERROR-HANDLING.md]: https://github.com/bitinn/node-fetch/blob/master/ERROR-HANDLING.md +[UPGRADE-GUIDE.md]: https://github.com/bitinn/node-fetch/blob/master/UPGRADE-GUIDE.md diff --git a/node_modules/node-fetch/browser.js b/node_modules/node-fetch/browser.js new file mode 100644 index 00000000..83c54c58 --- /dev/null +++ b/node_modules/node-fetch/browser.js @@ -0,0 +1,25 @@ +"use strict"; + +// ref: https://github.com/tc39/proposal-global +var getGlobal = function () { + // the only reliable means to get the global object is + // `Function('return this')()` + // However, this causes CSP violations in Chrome apps. + if (typeof self !== 'undefined') { return self; } + if (typeof window !== 'undefined') { return window; } + if (typeof global !== 'undefined') { return global; } + throw new Error('unable to locate global object'); +} + +var global = getGlobal(); + +module.exports = exports = global.fetch; + +// Needed for TypeScript and Webpack. +if (global.fetch) { + exports.default = global.fetch.bind(global); +} + +exports.Headers = global.Headers; +exports.Request = global.Request; +exports.Response = global.Response; \ No newline at end of file diff --git a/node_modules/node-fetch/lib/index.es.js b/node_modules/node-fetch/lib/index.es.js new file mode 100644 index 00000000..61906c95 --- /dev/null +++ b/node_modules/node-fetch/lib/index.es.js @@ -0,0 +1,1640 @@ +process.emitWarning("The .es.js file is deprecated. Use .mjs instead."); + +import Stream from 'stream'; +import http from 'http'; +import Url from 'url'; +import https from 'https'; +import zlib from 'zlib'; + +// Based on https://github.com/tmpvar/jsdom/blob/aa85b2abf07766ff7bf5c1f6daafb3726f2f2db5/lib/jsdom/living/blob.js + +// fix for "Readable" isn't a named export issue +const Readable = Stream.Readable; + +const BUFFER = Symbol('buffer'); +const TYPE = Symbol('type'); + +class Blob { + constructor() { + this[TYPE] = ''; + + const blobParts = arguments[0]; + const options = arguments[1]; + + const buffers = []; + let size = 0; + + if (blobParts) { + const a = blobParts; + const length = Number(a.length); + for (let i = 0; i < length; i++) { + const element = a[i]; + let buffer; + if (element instanceof Buffer) { + buffer = element; + } else if (ArrayBuffer.isView(element)) { + buffer = Buffer.from(element.buffer, element.byteOffset, element.byteLength); + } else if (element instanceof ArrayBuffer) { + buffer = Buffer.from(element); + } else if (element instanceof Blob) { + buffer = element[BUFFER]; + } else { + buffer = Buffer.from(typeof element === 'string' ? element : String(element)); + } + size += buffer.length; + buffers.push(buffer); + } + } + + this[BUFFER] = Buffer.concat(buffers); + + let type = options && options.type !== undefined && String(options.type).toLowerCase(); + if (type && !/[^\u0020-\u007E]/.test(type)) { + this[TYPE] = type; + } + } + get size() { + return this[BUFFER].length; + } + get type() { + return this[TYPE]; + } + text() { + return Promise.resolve(this[BUFFER].toString()); + } + arrayBuffer() { + const buf = this[BUFFER]; + const ab = buf.buffer.slice(buf.byteOffset, buf.byteOffset + buf.byteLength); + return Promise.resolve(ab); + } + stream() { + const readable = new Readable(); + readable._read = function () {}; + readable.push(this[BUFFER]); + readable.push(null); + return readable; + } + toString() { + return '[object Blob]'; + } + slice() { + const size = this.size; + + const start = arguments[0]; + const end = arguments[1]; + let relativeStart, relativeEnd; + if (start === undefined) { + relativeStart = 0; + } else if (start < 0) { + relativeStart = Math.max(size + start, 0); + } else { + relativeStart = Math.min(start, size); + } + if (end === undefined) { + relativeEnd = size; + } else if (end < 0) { + relativeEnd = Math.max(size + end, 0); + } else { + relativeEnd = Math.min(end, size); + } + const span = Math.max(relativeEnd - relativeStart, 0); + + const buffer = this[BUFFER]; + const slicedBuffer = buffer.slice(relativeStart, relativeStart + span); + const blob = new Blob([], { type: arguments[2] }); + blob[BUFFER] = slicedBuffer; + return blob; + } +} + +Object.defineProperties(Blob.prototype, { + size: { enumerable: true }, + type: { enumerable: true }, + slice: { enumerable: true } +}); + +Object.defineProperty(Blob.prototype, Symbol.toStringTag, { + value: 'Blob', + writable: false, + enumerable: false, + configurable: true +}); + +/** + * fetch-error.js + * + * FetchError interface for operational errors + */ + +/** + * Create FetchError instance + * + * @param String message Error message for human + * @param String type Error type for machine + * @param String systemError For Node.js system error + * @return FetchError + */ +function FetchError(message, type, systemError) { + Error.call(this, message); + + this.message = message; + this.type = type; + + // when err.type is `system`, err.code contains system error code + if (systemError) { + this.code = this.errno = systemError.code; + } + + // hide custom error implementation details from end-users + Error.captureStackTrace(this, this.constructor); +} + +FetchError.prototype = Object.create(Error.prototype); +FetchError.prototype.constructor = FetchError; +FetchError.prototype.name = 'FetchError'; + +let convert; +try { + convert = require('encoding').convert; +} catch (e) {} + +const INTERNALS = Symbol('Body internals'); + +// fix an issue where "PassThrough" isn't a named export for node <10 +const PassThrough = Stream.PassThrough; + +/** + * Body mixin + * + * Ref: https://fetch.spec.whatwg.org/#body + * + * @param Stream body Readable stream + * @param Object opts Response options + * @return Void + */ +function Body(body) { + var _this = this; + + var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}, + _ref$size = _ref.size; + + let size = _ref$size === undefined ? 0 : _ref$size; + var _ref$timeout = _ref.timeout; + let timeout = _ref$timeout === undefined ? 0 : _ref$timeout; + + if (body == null) { + // body is undefined or null + body = null; + } else if (isURLSearchParams(body)) { + // body is a URLSearchParams + body = Buffer.from(body.toString()); + } else if (isBlob(body)) ; else if (Buffer.isBuffer(body)) ; else if (Object.prototype.toString.call(body) === '[object ArrayBuffer]') { + // body is ArrayBuffer + body = Buffer.from(body); + } else if (ArrayBuffer.isView(body)) { + // body is ArrayBufferView + body = Buffer.from(body.buffer, body.byteOffset, body.byteLength); + } else if (body instanceof Stream) ; else { + // none of the above + // coerce to string then buffer + body = Buffer.from(String(body)); + } + this[INTERNALS] = { + body, + disturbed: false, + error: null + }; + this.size = size; + this.timeout = timeout; + + if (body instanceof Stream) { + body.on('error', function (err) { + const error = err.name === 'AbortError' ? err : new FetchError(`Invalid response body while trying to fetch ${_this.url}: ${err.message}`, 'system', err); + _this[INTERNALS].error = error; + }); + } +} + +Body.prototype = { + get body() { + return this[INTERNALS].body; + }, + + get bodyUsed() { + return this[INTERNALS].disturbed; + }, + + /** + * Decode response as ArrayBuffer + * + * @return Promise + */ + arrayBuffer() { + return consumeBody.call(this).then(function (buf) { + return buf.buffer.slice(buf.byteOffset, buf.byteOffset + buf.byteLength); + }); + }, + + /** + * Return raw response as Blob + * + * @return Promise + */ + blob() { + let ct = this.headers && this.headers.get('content-type') || ''; + return consumeBody.call(this).then(function (buf) { + return Object.assign( + // Prevent copying + new Blob([], { + type: ct.toLowerCase() + }), { + [BUFFER]: buf + }); + }); + }, + + /** + * Decode response as json + * + * @return Promise + */ + json() { + var _this2 = this; + + return consumeBody.call(this).then(function (buffer) { + try { + return JSON.parse(buffer.toString()); + } catch (err) { + return Body.Promise.reject(new FetchError(`invalid json response body at ${_this2.url} reason: ${err.message}`, 'invalid-json')); + } + }); + }, + + /** + * Decode response as text + * + * @return Promise + */ + text() { + return consumeBody.call(this).then(function (buffer) { + return buffer.toString(); + }); + }, + + /** + * Decode response as buffer (non-spec api) + * + * @return Promise + */ + buffer() { + return consumeBody.call(this); + }, + + /** + * Decode response as text, while automatically detecting the encoding and + * trying to decode to UTF-8 (non-spec api) + * + * @return Promise + */ + textConverted() { + var _this3 = this; + + return consumeBody.call(this).then(function (buffer) { + return convertBody(buffer, _this3.headers); + }); + } +}; + +// In browsers, all properties are enumerable. +Object.defineProperties(Body.prototype, { + body: { enumerable: true }, + bodyUsed: { enumerable: true }, + arrayBuffer: { enumerable: true }, + blob: { enumerable: true }, + json: { enumerable: true }, + text: { enumerable: true } +}); + +Body.mixIn = function (proto) { + for (const name of Object.getOwnPropertyNames(Body.prototype)) { + // istanbul ignore else: future proof + if (!(name in proto)) { + const desc = Object.getOwnPropertyDescriptor(Body.prototype, name); + Object.defineProperty(proto, name, desc); + } + } +}; + +/** + * Consume and convert an entire Body to a Buffer. + * + * Ref: https://fetch.spec.whatwg.org/#concept-body-consume-body + * + * @return Promise + */ +function consumeBody() { + var _this4 = this; + + if (this[INTERNALS].disturbed) { + return Body.Promise.reject(new TypeError(`body used already for: ${this.url}`)); + } + + this[INTERNALS].disturbed = true; + + if (this[INTERNALS].error) { + return Body.Promise.reject(this[INTERNALS].error); + } + + let body = this.body; + + // body is null + if (body === null) { + return Body.Promise.resolve(Buffer.alloc(0)); + } + + // body is blob + if (isBlob(body)) { + body = body.stream(); + } + + // body is buffer + if (Buffer.isBuffer(body)) { + return Body.Promise.resolve(body); + } + + // istanbul ignore if: should never happen + if (!(body instanceof Stream)) { + return Body.Promise.resolve(Buffer.alloc(0)); + } + + // body is stream + // get ready to actually consume the body + let accum = []; + let accumBytes = 0; + let abort = false; + + return new Body.Promise(function (resolve, reject) { + let resTimeout; + + // allow timeout on slow response body + if (_this4.timeout) { + resTimeout = setTimeout(function () { + abort = true; + reject(new FetchError(`Response timeout while trying to fetch ${_this4.url} (over ${_this4.timeout}ms)`, 'body-timeout')); + }, _this4.timeout); + } + + // handle stream errors + body.on('error', function (err) { + if (err.name === 'AbortError') { + // if the request was aborted, reject with this Error + abort = true; + reject(err); + } else { + // other errors, such as incorrect content-encoding + reject(new FetchError(`Invalid response body while trying to fetch ${_this4.url}: ${err.message}`, 'system', err)); + } + }); + + body.on('data', function (chunk) { + if (abort || chunk === null) { + return; + } + + if (_this4.size && accumBytes + chunk.length > _this4.size) { + abort = true; + reject(new FetchError(`content size at ${_this4.url} over limit: ${_this4.size}`, 'max-size')); + return; + } + + accumBytes += chunk.length; + accum.push(chunk); + }); + + body.on('end', function () { + if (abort) { + return; + } + + clearTimeout(resTimeout); + + try { + resolve(Buffer.concat(accum, accumBytes)); + } catch (err) { + // handle streams that have accumulated too much data (issue #414) + reject(new FetchError(`Could not create Buffer from response body for ${_this4.url}: ${err.message}`, 'system', err)); + } + }); + }); +} + +/** + * Detect buffer encoding and convert to target encoding + * ref: http://www.w3.org/TR/2011/WD-html5-20110113/parsing.html#determining-the-character-encoding + * + * @param Buffer buffer Incoming buffer + * @param String encoding Target encoding + * @return String + */ +function convertBody(buffer, headers) { + if (typeof convert !== 'function') { + throw new Error('The package `encoding` must be installed to use the textConverted() function'); + } + + const ct = headers.get('content-type'); + let charset = 'utf-8'; + let res, str; + + // header + if (ct) { + res = /charset=([^;]*)/i.exec(ct); + } + + // no charset in content type, peek at response body for at most 1024 bytes + str = buffer.slice(0, 1024).toString(); + + // html5 + if (!res && str) { + res = / 0 && arguments[0] !== undefined ? arguments[0] : undefined; + + this[MAP] = Object.create(null); + + if (init instanceof Headers) { + const rawHeaders = init.raw(); + const headerNames = Object.keys(rawHeaders); + + for (const headerName of headerNames) { + for (const value of rawHeaders[headerName]) { + this.append(headerName, value); + } + } + + return; + } + + // We don't worry about converting prop to ByteString here as append() + // will handle it. + if (init == null) ; else if (typeof init === 'object') { + const method = init[Symbol.iterator]; + if (method != null) { + if (typeof method !== 'function') { + throw new TypeError('Header pairs must be iterable'); + } + + // sequence> + // Note: per spec we have to first exhaust the lists then process them + const pairs = []; + for (const pair of init) { + if (typeof pair !== 'object' || typeof pair[Symbol.iterator] !== 'function') { + throw new TypeError('Each header pair must be iterable'); + } + pairs.push(Array.from(pair)); + } + + for (const pair of pairs) { + if (pair.length !== 2) { + throw new TypeError('Each header pair must be a name/value tuple'); + } + this.append(pair[0], pair[1]); + } + } else { + // record + for (const key of Object.keys(init)) { + const value = init[key]; + this.append(key, value); + } + } + } else { + throw new TypeError('Provided initializer must be an object'); + } + } + + /** + * Return combined header value given name + * + * @param String name Header name + * @return Mixed + */ + get(name) { + name = `${name}`; + validateName(name); + const key = find(this[MAP], name); + if (key === undefined) { + return null; + } + + return this[MAP][key].join(', '); + } + + /** + * Iterate over all headers + * + * @param Function callback Executed for each item with parameters (value, name, thisArg) + * @param Boolean thisArg `this` context for callback function + * @return Void + */ + forEach(callback) { + let thisArg = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : undefined; + + let pairs = getHeaders(this); + let i = 0; + while (i < pairs.length) { + var _pairs$i = pairs[i]; + const name = _pairs$i[0], + value = _pairs$i[1]; + + callback.call(thisArg, value, name, this); + pairs = getHeaders(this); + i++; + } + } + + /** + * Overwrite header values given name + * + * @param String name Header name + * @param String value Header value + * @return Void + */ + set(name, value) { + name = `${name}`; + value = `${value}`; + validateName(name); + validateValue(value); + const key = find(this[MAP], name); + this[MAP][key !== undefined ? key : name] = [value]; + } + + /** + * Append a value onto existing header + * + * @param String name Header name + * @param String value Header value + * @return Void + */ + append(name, value) { + name = `${name}`; + value = `${value}`; + validateName(name); + validateValue(value); + const key = find(this[MAP], name); + if (key !== undefined) { + this[MAP][key].push(value); + } else { + this[MAP][name] = [value]; + } + } + + /** + * Check for header name existence + * + * @param String name Header name + * @return Boolean + */ + has(name) { + name = `${name}`; + validateName(name); + return find(this[MAP], name) !== undefined; + } + + /** + * Delete all header values given name + * + * @param String name Header name + * @return Void + */ + delete(name) { + name = `${name}`; + validateName(name); + const key = find(this[MAP], name); + if (key !== undefined) { + delete this[MAP][key]; + } + } + + /** + * Return raw headers (non-spec api) + * + * @return Object + */ + raw() { + return this[MAP]; + } + + /** + * Get an iterator on keys. + * + * @return Iterator + */ + keys() { + return createHeadersIterator(this, 'key'); + } + + /** + * Get an iterator on values. + * + * @return Iterator + */ + values() { + return createHeadersIterator(this, 'value'); + } + + /** + * Get an iterator on entries. + * + * This is the default iterator of the Headers object. + * + * @return Iterator + */ + [Symbol.iterator]() { + return createHeadersIterator(this, 'key+value'); + } +} +Headers.prototype.entries = Headers.prototype[Symbol.iterator]; + +Object.defineProperty(Headers.prototype, Symbol.toStringTag, { + value: 'Headers', + writable: false, + enumerable: false, + configurable: true +}); + +Object.defineProperties(Headers.prototype, { + get: { enumerable: true }, + forEach: { enumerable: true }, + set: { enumerable: true }, + append: { enumerable: true }, + has: { enumerable: true }, + delete: { enumerable: true }, + keys: { enumerable: true }, + values: { enumerable: true }, + entries: { enumerable: true } +}); + +function getHeaders(headers) { + let kind = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'key+value'; + + const keys = Object.keys(headers[MAP]).sort(); + return keys.map(kind === 'key' ? function (k) { + return k.toLowerCase(); + } : kind === 'value' ? function (k) { + return headers[MAP][k].join(', '); + } : function (k) { + return [k.toLowerCase(), headers[MAP][k].join(', ')]; + }); +} + +const INTERNAL = Symbol('internal'); + +function createHeadersIterator(target, kind) { + const iterator = Object.create(HeadersIteratorPrototype); + iterator[INTERNAL] = { + target, + kind, + index: 0 + }; + return iterator; +} + +const HeadersIteratorPrototype = Object.setPrototypeOf({ + next() { + // istanbul ignore if + if (!this || Object.getPrototypeOf(this) !== HeadersIteratorPrototype) { + throw new TypeError('Value of `this` is not a HeadersIterator'); + } + + var _INTERNAL = this[INTERNAL]; + const target = _INTERNAL.target, + kind = _INTERNAL.kind, + index = _INTERNAL.index; + + const values = getHeaders(target, kind); + const len = values.length; + if (index >= len) { + return { + value: undefined, + done: true + }; + } + + this[INTERNAL].index = index + 1; + + return { + value: values[index], + done: false + }; + } +}, Object.getPrototypeOf(Object.getPrototypeOf([][Symbol.iterator]()))); + +Object.defineProperty(HeadersIteratorPrototype, Symbol.toStringTag, { + value: 'HeadersIterator', + writable: false, + enumerable: false, + configurable: true +}); + +/** + * Export the Headers object in a form that Node.js can consume. + * + * @param Headers headers + * @return Object + */ +function exportNodeCompatibleHeaders(headers) { + const obj = Object.assign({ __proto__: null }, headers[MAP]); + + // http.request() only supports string as Host header. This hack makes + // specifying custom Host header possible. + const hostHeaderKey = find(headers[MAP], 'Host'); + if (hostHeaderKey !== undefined) { + obj[hostHeaderKey] = obj[hostHeaderKey][0]; + } + + return obj; +} + +/** + * Create a Headers object from an object of headers, ignoring those that do + * not conform to HTTP grammar productions. + * + * @param Object obj Object of headers + * @return Headers + */ +function createHeadersLenient(obj) { + const headers = new Headers(); + for (const name of Object.keys(obj)) { + if (invalidTokenRegex.test(name)) { + continue; + } + if (Array.isArray(obj[name])) { + for (const val of obj[name]) { + if (invalidHeaderCharRegex.test(val)) { + continue; + } + if (headers[MAP][name] === undefined) { + headers[MAP][name] = [val]; + } else { + headers[MAP][name].push(val); + } + } + } else if (!invalidHeaderCharRegex.test(obj[name])) { + headers[MAP][name] = [obj[name]]; + } + } + return headers; +} + +const INTERNALS$1 = Symbol('Response internals'); + +// fix an issue where "STATUS_CODES" aren't a named export for node <10 +const STATUS_CODES = http.STATUS_CODES; + +/** + * Response class + * + * @param Stream body Readable stream + * @param Object opts Response options + * @return Void + */ +class Response { + constructor() { + let body = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null; + let opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; + + Body.call(this, body, opts); + + const status = opts.status || 200; + const headers = new Headers(opts.headers); + + if (body != null && !headers.has('Content-Type')) { + const contentType = extractContentType(body); + if (contentType) { + headers.append('Content-Type', contentType); + } + } + + this[INTERNALS$1] = { + url: opts.url, + status, + statusText: opts.statusText || STATUS_CODES[status], + headers, + counter: opts.counter + }; + } + + get url() { + return this[INTERNALS$1].url || ''; + } + + get status() { + return this[INTERNALS$1].status; + } + + /** + * Convenience property representing if the request ended normally + */ + get ok() { + return this[INTERNALS$1].status >= 200 && this[INTERNALS$1].status < 300; + } + + get redirected() { + return this[INTERNALS$1].counter > 0; + } + + get statusText() { + return this[INTERNALS$1].statusText; + } + + get headers() { + return this[INTERNALS$1].headers; + } + + /** + * Clone this response + * + * @return Response + */ + clone() { + return new Response(clone(this), { + url: this.url, + status: this.status, + statusText: this.statusText, + headers: this.headers, + ok: this.ok, + redirected: this.redirected + }); + } +} + +Body.mixIn(Response.prototype); + +Object.defineProperties(Response.prototype, { + url: { enumerable: true }, + status: { enumerable: true }, + ok: { enumerable: true }, + redirected: { enumerable: true }, + statusText: { enumerable: true }, + headers: { enumerable: true }, + clone: { enumerable: true } +}); + +Object.defineProperty(Response.prototype, Symbol.toStringTag, { + value: 'Response', + writable: false, + enumerable: false, + configurable: true +}); + +const INTERNALS$2 = Symbol('Request internals'); + +// fix an issue where "format", "parse" aren't a named export for node <10 +const parse_url = Url.parse; +const format_url = Url.format; + +const streamDestructionSupported = 'destroy' in Stream.Readable.prototype; + +/** + * Check if a value is an instance of Request. + * + * @param Mixed input + * @return Boolean + */ +function isRequest(input) { + return typeof input === 'object' && typeof input[INTERNALS$2] === 'object'; +} + +function isAbortSignal(signal) { + const proto = signal && typeof signal === 'object' && Object.getPrototypeOf(signal); + return !!(proto && proto.constructor.name === 'AbortSignal'); +} + +/** + * Request class + * + * @param Mixed input Url or Request instance + * @param Object init Custom options + * @return Void + */ +class Request { + constructor(input) { + let init = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; + + let parsedURL; + + // normalize input + if (!isRequest(input)) { + if (input && input.href) { + // in order to support Node.js' Url objects; though WHATWG's URL objects + // will fall into this branch also (since their `toString()` will return + // `href` property anyway) + parsedURL = parse_url(input.href); + } else { + // coerce input to a string before attempting to parse + parsedURL = parse_url(`${input}`); + } + input = {}; + } else { + parsedURL = parse_url(input.url); + } + + let method = init.method || input.method || 'GET'; + method = method.toUpperCase(); + + if ((init.body != null || isRequest(input) && input.body !== null) && (method === 'GET' || method === 'HEAD')) { + throw new TypeError('Request with GET/HEAD method cannot have body'); + } + + let inputBody = init.body != null ? init.body : isRequest(input) && input.body !== null ? clone(input) : null; + + Body.call(this, inputBody, { + timeout: init.timeout || input.timeout || 0, + size: init.size || input.size || 0 + }); + + const headers = new Headers(init.headers || input.headers || {}); + + if (inputBody != null && !headers.has('Content-Type')) { + const contentType = extractContentType(inputBody); + if (contentType) { + headers.append('Content-Type', contentType); + } + } + + let signal = isRequest(input) ? input.signal : null; + if ('signal' in init) signal = init.signal; + + if (signal != null && !isAbortSignal(signal)) { + throw new TypeError('Expected signal to be an instanceof AbortSignal'); + } + + this[INTERNALS$2] = { + method, + redirect: init.redirect || input.redirect || 'follow', + headers, + parsedURL, + signal + }; + + // node-fetch-only options + this.follow = init.follow !== undefined ? init.follow : input.follow !== undefined ? input.follow : 20; + this.compress = init.compress !== undefined ? init.compress : input.compress !== undefined ? input.compress : true; + this.counter = init.counter || input.counter || 0; + this.agent = init.agent || input.agent; + } + + get method() { + return this[INTERNALS$2].method; + } + + get url() { + return format_url(this[INTERNALS$2].parsedURL); + } + + get headers() { + return this[INTERNALS$2].headers; + } + + get redirect() { + return this[INTERNALS$2].redirect; + } + + get signal() { + return this[INTERNALS$2].signal; + } + + /** + * Clone this request + * + * @return Request + */ + clone() { + return new Request(this); + } +} + +Body.mixIn(Request.prototype); + +Object.defineProperty(Request.prototype, Symbol.toStringTag, { + value: 'Request', + writable: false, + enumerable: false, + configurable: true +}); + +Object.defineProperties(Request.prototype, { + method: { enumerable: true }, + url: { enumerable: true }, + headers: { enumerable: true }, + redirect: { enumerable: true }, + clone: { enumerable: true }, + signal: { enumerable: true } +}); + +/** + * Convert a Request to Node.js http request options. + * + * @param Request A Request instance + * @return Object The options object to be passed to http.request + */ +function getNodeRequestOptions(request) { + const parsedURL = request[INTERNALS$2].parsedURL; + const headers = new Headers(request[INTERNALS$2].headers); + + // fetch step 1.3 + if (!headers.has('Accept')) { + headers.set('Accept', '*/*'); + } + + // Basic fetch + if (!parsedURL.protocol || !parsedURL.hostname) { + throw new TypeError('Only absolute URLs are supported'); + } + + if (!/^https?:$/.test(parsedURL.protocol)) { + throw new TypeError('Only HTTP(S) protocols are supported'); + } + + if (request.signal && request.body instanceof Stream.Readable && !streamDestructionSupported) { + throw new Error('Cancellation of streamed requests with AbortSignal is not supported in node < 8'); + } + + // HTTP-network-or-cache fetch steps 2.4-2.7 + let contentLengthValue = null; + if (request.body == null && /^(POST|PUT)$/i.test(request.method)) { + contentLengthValue = '0'; + } + if (request.body != null) { + const totalBytes = getTotalBytes(request); + if (typeof totalBytes === 'number') { + contentLengthValue = String(totalBytes); + } + } + if (contentLengthValue) { + headers.set('Content-Length', contentLengthValue); + } + + // HTTP-network-or-cache fetch step 2.11 + if (!headers.has('User-Agent')) { + headers.set('User-Agent', 'node-fetch/1.0 (+https://github.com/bitinn/node-fetch)'); + } + + // HTTP-network-or-cache fetch step 2.15 + if (request.compress && !headers.has('Accept-Encoding')) { + headers.set('Accept-Encoding', 'gzip,deflate'); + } + + let agent = request.agent; + if (typeof agent === 'function') { + agent = agent(parsedURL); + } + + if (!headers.has('Connection') && !agent) { + headers.set('Connection', 'close'); + } + + // HTTP-network fetch step 4.2 + // chunked encoding is handled by Node.js + + return Object.assign({}, parsedURL, { + method: request.method, + headers: exportNodeCompatibleHeaders(headers), + agent + }); +} + +/** + * abort-error.js + * + * AbortError interface for cancelled requests + */ + +/** + * Create AbortError instance + * + * @param String message Error message for human + * @return AbortError + */ +function AbortError(message) { + Error.call(this, message); + + this.type = 'aborted'; + this.message = message; + + // hide custom error implementation details from end-users + Error.captureStackTrace(this, this.constructor); +} + +AbortError.prototype = Object.create(Error.prototype); +AbortError.prototype.constructor = AbortError; +AbortError.prototype.name = 'AbortError'; + +// fix an issue where "PassThrough", "resolve" aren't a named export for node <10 +const PassThrough$1 = Stream.PassThrough; +const resolve_url = Url.resolve; + +/** + * Fetch function + * + * @param Mixed url Absolute url or Request instance + * @param Object opts Fetch options + * @return Promise + */ +function fetch(url, opts) { + + // allow custom promise + if (!fetch.Promise) { + throw new Error('native promise missing, set fetch.Promise to your favorite alternative'); + } + + Body.Promise = fetch.Promise; + + // wrap http.request into fetch + return new fetch.Promise(function (resolve, reject) { + // build request object + const request = new Request(url, opts); + const options = getNodeRequestOptions(request); + + const send = (options.protocol === 'https:' ? https : http).request; + const signal = request.signal; + + let response = null; + + const abort = function abort() { + let error = new AbortError('The user aborted a request.'); + reject(error); + if (request.body && request.body instanceof Stream.Readable) { + request.body.destroy(error); + } + if (!response || !response.body) return; + response.body.emit('error', error); + }; + + if (signal && signal.aborted) { + abort(); + return; + } + + const abortAndFinalize = function abortAndFinalize() { + abort(); + finalize(); + }; + + // send request + const req = send(options); + let reqTimeout; + + if (signal) { + signal.addEventListener('abort', abortAndFinalize); + } + + function finalize() { + req.abort(); + if (signal) signal.removeEventListener('abort', abortAndFinalize); + clearTimeout(reqTimeout); + } + + if (request.timeout) { + req.once('socket', function (socket) { + reqTimeout = setTimeout(function () { + reject(new FetchError(`network timeout at: ${request.url}`, 'request-timeout')); + finalize(); + }, request.timeout); + }); + } + + req.on('error', function (err) { + reject(new FetchError(`request to ${request.url} failed, reason: ${err.message}`, 'system', err)); + finalize(); + }); + + req.on('response', function (res) { + clearTimeout(reqTimeout); + + const headers = createHeadersLenient(res.headers); + + // HTTP fetch step 5 + if (fetch.isRedirect(res.statusCode)) { + // HTTP fetch step 5.2 + const location = headers.get('Location'); + + // HTTP fetch step 5.3 + const locationURL = location === null ? null : resolve_url(request.url, location); + + // HTTP fetch step 5.5 + switch (request.redirect) { + case 'error': + reject(new FetchError(`uri requested responds with a redirect, redirect mode is set to error: ${request.url}`, 'no-redirect')); + finalize(); + return; + case 'manual': + // node-fetch-specific step: make manual redirect a bit easier to use by setting the Location header value to the resolved URL. + if (locationURL !== null) { + // handle corrupted header + try { + headers.set('Location', locationURL); + } catch (err) { + // istanbul ignore next: nodejs server prevent invalid response headers, we can't test this through normal request + reject(err); + } + } + break; + case 'follow': + // HTTP-redirect fetch step 2 + if (locationURL === null) { + break; + } + + // HTTP-redirect fetch step 5 + if (request.counter >= request.follow) { + reject(new FetchError(`maximum redirect reached at: ${request.url}`, 'max-redirect')); + finalize(); + return; + } + + // HTTP-redirect fetch step 6 (counter increment) + // Create a new Request object. + const requestOpts = { + headers: new Headers(request.headers), + follow: request.follow, + counter: request.counter + 1, + agent: request.agent, + compress: request.compress, + method: request.method, + body: request.body, + signal: request.signal, + timeout: request.timeout, + size: request.size + }; + + // HTTP-redirect fetch step 9 + if (res.statusCode !== 303 && request.body && getTotalBytes(request) === null) { + reject(new FetchError('Cannot follow redirect with body being a readable stream', 'unsupported-redirect')); + finalize(); + return; + } + + // HTTP-redirect fetch step 11 + if (res.statusCode === 303 || (res.statusCode === 301 || res.statusCode === 302) && request.method === 'POST') { + requestOpts.method = 'GET'; + requestOpts.body = undefined; + requestOpts.headers.delete('content-length'); + } + + // HTTP-redirect fetch step 15 + resolve(fetch(new Request(locationURL, requestOpts))); + finalize(); + return; + } + } + + // prepare response + res.once('end', function () { + if (signal) signal.removeEventListener('abort', abortAndFinalize); + }); + let body = res.pipe(new PassThrough$1()); + + const response_options = { + url: request.url, + status: res.statusCode, + statusText: res.statusMessage, + headers: headers, + size: request.size, + timeout: request.timeout, + counter: request.counter + }; + + // HTTP-network fetch step 12.1.1.3 + const codings = headers.get('Content-Encoding'); + + // HTTP-network fetch step 12.1.1.4: handle content codings + + // in following scenarios we ignore compression support + // 1. compression support is disabled + // 2. HEAD request + // 3. no Content-Encoding header + // 4. no content response (204) + // 5. content not modified response (304) + if (!request.compress || request.method === 'HEAD' || codings === null || res.statusCode === 204 || res.statusCode === 304) { + response = new Response(body, response_options); + resolve(response); + return; + } + + // For Node v6+ + // Be less strict when decoding compressed responses, since sometimes + // servers send slightly invalid responses that are still accepted + // by common browsers. + // Always using Z_SYNC_FLUSH is what cURL does. + const zlibOptions = { + flush: zlib.Z_SYNC_FLUSH, + finishFlush: zlib.Z_SYNC_FLUSH + }; + + // for gzip + if (codings == 'gzip' || codings == 'x-gzip') { + body = body.pipe(zlib.createGunzip(zlibOptions)); + response = new Response(body, response_options); + resolve(response); + return; + } + + // for deflate + if (codings == 'deflate' || codings == 'x-deflate') { + // handle the infamous raw deflate response from old servers + // a hack for old IIS and Apache servers + const raw = res.pipe(new PassThrough$1()); + raw.once('data', function (chunk) { + // see http://stackoverflow.com/questions/37519828 + if ((chunk[0] & 0x0F) === 0x08) { + body = body.pipe(zlib.createInflate()); + } else { + body = body.pipe(zlib.createInflateRaw()); + } + response = new Response(body, response_options); + resolve(response); + }); + return; + } + + // for br + if (codings == 'br' && typeof zlib.createBrotliDecompress === 'function') { + body = body.pipe(zlib.createBrotliDecompress()); + response = new Response(body, response_options); + resolve(response); + return; + } + + // otherwise, use response as-is + response = new Response(body, response_options); + resolve(response); + }); + + writeToStream(req, request); + }); +} +/** + * Redirect code matching + * + * @param Number code Status code + * @return Boolean + */ +fetch.isRedirect = function (code) { + return code === 301 || code === 302 || code === 303 || code === 307 || code === 308; +}; + +// expose Promise +fetch.Promise = global.Promise; + +export default fetch; +export { Headers, Request, Response, FetchError }; diff --git a/node_modules/node-fetch/lib/index.js b/node_modules/node-fetch/lib/index.js new file mode 100644 index 00000000..4b241bfb --- /dev/null +++ b/node_modules/node-fetch/lib/index.js @@ -0,0 +1,1649 @@ +'use strict'; + +Object.defineProperty(exports, '__esModule', { value: true }); + +function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } + +var Stream = _interopDefault(require('stream')); +var http = _interopDefault(require('http')); +var Url = _interopDefault(require('url')); +var https = _interopDefault(require('https')); +var zlib = _interopDefault(require('zlib')); + +// Based on https://github.com/tmpvar/jsdom/blob/aa85b2abf07766ff7bf5c1f6daafb3726f2f2db5/lib/jsdom/living/blob.js + +// fix for "Readable" isn't a named export issue +const Readable = Stream.Readable; + +const BUFFER = Symbol('buffer'); +const TYPE = Symbol('type'); + +class Blob { + constructor() { + this[TYPE] = ''; + + const blobParts = arguments[0]; + const options = arguments[1]; + + const buffers = []; + let size = 0; + + if (blobParts) { + const a = blobParts; + const length = Number(a.length); + for (let i = 0; i < length; i++) { + const element = a[i]; + let buffer; + if (element instanceof Buffer) { + buffer = element; + } else if (ArrayBuffer.isView(element)) { + buffer = Buffer.from(element.buffer, element.byteOffset, element.byteLength); + } else if (element instanceof ArrayBuffer) { + buffer = Buffer.from(element); + } else if (element instanceof Blob) { + buffer = element[BUFFER]; + } else { + buffer = Buffer.from(typeof element === 'string' ? element : String(element)); + } + size += buffer.length; + buffers.push(buffer); + } + } + + this[BUFFER] = Buffer.concat(buffers); + + let type = options && options.type !== undefined && String(options.type).toLowerCase(); + if (type && !/[^\u0020-\u007E]/.test(type)) { + this[TYPE] = type; + } + } + get size() { + return this[BUFFER].length; + } + get type() { + return this[TYPE]; + } + text() { + return Promise.resolve(this[BUFFER].toString()); + } + arrayBuffer() { + const buf = this[BUFFER]; + const ab = buf.buffer.slice(buf.byteOffset, buf.byteOffset + buf.byteLength); + return Promise.resolve(ab); + } + stream() { + const readable = new Readable(); + readable._read = function () {}; + readable.push(this[BUFFER]); + readable.push(null); + return readable; + } + toString() { + return '[object Blob]'; + } + slice() { + const size = this.size; + + const start = arguments[0]; + const end = arguments[1]; + let relativeStart, relativeEnd; + if (start === undefined) { + relativeStart = 0; + } else if (start < 0) { + relativeStart = Math.max(size + start, 0); + } else { + relativeStart = Math.min(start, size); + } + if (end === undefined) { + relativeEnd = size; + } else if (end < 0) { + relativeEnd = Math.max(size + end, 0); + } else { + relativeEnd = Math.min(end, size); + } + const span = Math.max(relativeEnd - relativeStart, 0); + + const buffer = this[BUFFER]; + const slicedBuffer = buffer.slice(relativeStart, relativeStart + span); + const blob = new Blob([], { type: arguments[2] }); + blob[BUFFER] = slicedBuffer; + return blob; + } +} + +Object.defineProperties(Blob.prototype, { + size: { enumerable: true }, + type: { enumerable: true }, + slice: { enumerable: true } +}); + +Object.defineProperty(Blob.prototype, Symbol.toStringTag, { + value: 'Blob', + writable: false, + enumerable: false, + configurable: true +}); + +/** + * fetch-error.js + * + * FetchError interface for operational errors + */ + +/** + * Create FetchError instance + * + * @param String message Error message for human + * @param String type Error type for machine + * @param String systemError For Node.js system error + * @return FetchError + */ +function FetchError(message, type, systemError) { + Error.call(this, message); + + this.message = message; + this.type = type; + + // when err.type is `system`, err.code contains system error code + if (systemError) { + this.code = this.errno = systemError.code; + } + + // hide custom error implementation details from end-users + Error.captureStackTrace(this, this.constructor); +} + +FetchError.prototype = Object.create(Error.prototype); +FetchError.prototype.constructor = FetchError; +FetchError.prototype.name = 'FetchError'; + +let convert; +try { + convert = require('encoding').convert; +} catch (e) {} + +const INTERNALS = Symbol('Body internals'); + +// fix an issue where "PassThrough" isn't a named export for node <10 +const PassThrough = Stream.PassThrough; + +/** + * Body mixin + * + * Ref: https://fetch.spec.whatwg.org/#body + * + * @param Stream body Readable stream + * @param Object opts Response options + * @return Void + */ +function Body(body) { + var _this = this; + + var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}, + _ref$size = _ref.size; + + let size = _ref$size === undefined ? 0 : _ref$size; + var _ref$timeout = _ref.timeout; + let timeout = _ref$timeout === undefined ? 0 : _ref$timeout; + + if (body == null) { + // body is undefined or null + body = null; + } else if (isURLSearchParams(body)) { + // body is a URLSearchParams + body = Buffer.from(body.toString()); + } else if (isBlob(body)) ; else if (Buffer.isBuffer(body)) ; else if (Object.prototype.toString.call(body) === '[object ArrayBuffer]') { + // body is ArrayBuffer + body = Buffer.from(body); + } else if (ArrayBuffer.isView(body)) { + // body is ArrayBufferView + body = Buffer.from(body.buffer, body.byteOffset, body.byteLength); + } else if (body instanceof Stream) ; else { + // none of the above + // coerce to string then buffer + body = Buffer.from(String(body)); + } + this[INTERNALS] = { + body, + disturbed: false, + error: null + }; + this.size = size; + this.timeout = timeout; + + if (body instanceof Stream) { + body.on('error', function (err) { + const error = err.name === 'AbortError' ? err : new FetchError(`Invalid response body while trying to fetch ${_this.url}: ${err.message}`, 'system', err); + _this[INTERNALS].error = error; + }); + } +} + +Body.prototype = { + get body() { + return this[INTERNALS].body; + }, + + get bodyUsed() { + return this[INTERNALS].disturbed; + }, + + /** + * Decode response as ArrayBuffer + * + * @return Promise + */ + arrayBuffer() { + return consumeBody.call(this).then(function (buf) { + return buf.buffer.slice(buf.byteOffset, buf.byteOffset + buf.byteLength); + }); + }, + + /** + * Return raw response as Blob + * + * @return Promise + */ + blob() { + let ct = this.headers && this.headers.get('content-type') || ''; + return consumeBody.call(this).then(function (buf) { + return Object.assign( + // Prevent copying + new Blob([], { + type: ct.toLowerCase() + }), { + [BUFFER]: buf + }); + }); + }, + + /** + * Decode response as json + * + * @return Promise + */ + json() { + var _this2 = this; + + return consumeBody.call(this).then(function (buffer) { + try { + return JSON.parse(buffer.toString()); + } catch (err) { + return Body.Promise.reject(new FetchError(`invalid json response body at ${_this2.url} reason: ${err.message}`, 'invalid-json')); + } + }); + }, + + /** + * Decode response as text + * + * @return Promise + */ + text() { + return consumeBody.call(this).then(function (buffer) { + return buffer.toString(); + }); + }, + + /** + * Decode response as buffer (non-spec api) + * + * @return Promise + */ + buffer() { + return consumeBody.call(this); + }, + + /** + * Decode response as text, while automatically detecting the encoding and + * trying to decode to UTF-8 (non-spec api) + * + * @return Promise + */ + textConverted() { + var _this3 = this; + + return consumeBody.call(this).then(function (buffer) { + return convertBody(buffer, _this3.headers); + }); + } +}; + +// In browsers, all properties are enumerable. +Object.defineProperties(Body.prototype, { + body: { enumerable: true }, + bodyUsed: { enumerable: true }, + arrayBuffer: { enumerable: true }, + blob: { enumerable: true }, + json: { enumerable: true }, + text: { enumerable: true } +}); + +Body.mixIn = function (proto) { + for (const name of Object.getOwnPropertyNames(Body.prototype)) { + // istanbul ignore else: future proof + if (!(name in proto)) { + const desc = Object.getOwnPropertyDescriptor(Body.prototype, name); + Object.defineProperty(proto, name, desc); + } + } +}; + +/** + * Consume and convert an entire Body to a Buffer. + * + * Ref: https://fetch.spec.whatwg.org/#concept-body-consume-body + * + * @return Promise + */ +function consumeBody() { + var _this4 = this; + + if (this[INTERNALS].disturbed) { + return Body.Promise.reject(new TypeError(`body used already for: ${this.url}`)); + } + + this[INTERNALS].disturbed = true; + + if (this[INTERNALS].error) { + return Body.Promise.reject(this[INTERNALS].error); + } + + let body = this.body; + + // body is null + if (body === null) { + return Body.Promise.resolve(Buffer.alloc(0)); + } + + // body is blob + if (isBlob(body)) { + body = body.stream(); + } + + // body is buffer + if (Buffer.isBuffer(body)) { + return Body.Promise.resolve(body); + } + + // istanbul ignore if: should never happen + if (!(body instanceof Stream)) { + return Body.Promise.resolve(Buffer.alloc(0)); + } + + // body is stream + // get ready to actually consume the body + let accum = []; + let accumBytes = 0; + let abort = false; + + return new Body.Promise(function (resolve, reject) { + let resTimeout; + + // allow timeout on slow response body + if (_this4.timeout) { + resTimeout = setTimeout(function () { + abort = true; + reject(new FetchError(`Response timeout while trying to fetch ${_this4.url} (over ${_this4.timeout}ms)`, 'body-timeout')); + }, _this4.timeout); + } + + // handle stream errors + body.on('error', function (err) { + if (err.name === 'AbortError') { + // if the request was aborted, reject with this Error + abort = true; + reject(err); + } else { + // other errors, such as incorrect content-encoding + reject(new FetchError(`Invalid response body while trying to fetch ${_this4.url}: ${err.message}`, 'system', err)); + } + }); + + body.on('data', function (chunk) { + if (abort || chunk === null) { + return; + } + + if (_this4.size && accumBytes + chunk.length > _this4.size) { + abort = true; + reject(new FetchError(`content size at ${_this4.url} over limit: ${_this4.size}`, 'max-size')); + return; + } + + accumBytes += chunk.length; + accum.push(chunk); + }); + + body.on('end', function () { + if (abort) { + return; + } + + clearTimeout(resTimeout); + + try { + resolve(Buffer.concat(accum, accumBytes)); + } catch (err) { + // handle streams that have accumulated too much data (issue #414) + reject(new FetchError(`Could not create Buffer from response body for ${_this4.url}: ${err.message}`, 'system', err)); + } + }); + }); +} + +/** + * Detect buffer encoding and convert to target encoding + * ref: http://www.w3.org/TR/2011/WD-html5-20110113/parsing.html#determining-the-character-encoding + * + * @param Buffer buffer Incoming buffer + * @param String encoding Target encoding + * @return String + */ +function convertBody(buffer, headers) { + if (typeof convert !== 'function') { + throw new Error('The package `encoding` must be installed to use the textConverted() function'); + } + + const ct = headers.get('content-type'); + let charset = 'utf-8'; + let res, str; + + // header + if (ct) { + res = /charset=([^;]*)/i.exec(ct); + } + + // no charset in content type, peek at response body for at most 1024 bytes + str = buffer.slice(0, 1024).toString(); + + // html5 + if (!res && str) { + res = / 0 && arguments[0] !== undefined ? arguments[0] : undefined; + + this[MAP] = Object.create(null); + + if (init instanceof Headers) { + const rawHeaders = init.raw(); + const headerNames = Object.keys(rawHeaders); + + for (const headerName of headerNames) { + for (const value of rawHeaders[headerName]) { + this.append(headerName, value); + } + } + + return; + } + + // We don't worry about converting prop to ByteString here as append() + // will handle it. + if (init == null) ; else if (typeof init === 'object') { + const method = init[Symbol.iterator]; + if (method != null) { + if (typeof method !== 'function') { + throw new TypeError('Header pairs must be iterable'); + } + + // sequence> + // Note: per spec we have to first exhaust the lists then process them + const pairs = []; + for (const pair of init) { + if (typeof pair !== 'object' || typeof pair[Symbol.iterator] !== 'function') { + throw new TypeError('Each header pair must be iterable'); + } + pairs.push(Array.from(pair)); + } + + for (const pair of pairs) { + if (pair.length !== 2) { + throw new TypeError('Each header pair must be a name/value tuple'); + } + this.append(pair[0], pair[1]); + } + } else { + // record + for (const key of Object.keys(init)) { + const value = init[key]; + this.append(key, value); + } + } + } else { + throw new TypeError('Provided initializer must be an object'); + } + } + + /** + * Return combined header value given name + * + * @param String name Header name + * @return Mixed + */ + get(name) { + name = `${name}`; + validateName(name); + const key = find(this[MAP], name); + if (key === undefined) { + return null; + } + + return this[MAP][key].join(', '); + } + + /** + * Iterate over all headers + * + * @param Function callback Executed for each item with parameters (value, name, thisArg) + * @param Boolean thisArg `this` context for callback function + * @return Void + */ + forEach(callback) { + let thisArg = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : undefined; + + let pairs = getHeaders(this); + let i = 0; + while (i < pairs.length) { + var _pairs$i = pairs[i]; + const name = _pairs$i[0], + value = _pairs$i[1]; + + callback.call(thisArg, value, name, this); + pairs = getHeaders(this); + i++; + } + } + + /** + * Overwrite header values given name + * + * @param String name Header name + * @param String value Header value + * @return Void + */ + set(name, value) { + name = `${name}`; + value = `${value}`; + validateName(name); + validateValue(value); + const key = find(this[MAP], name); + this[MAP][key !== undefined ? key : name] = [value]; + } + + /** + * Append a value onto existing header + * + * @param String name Header name + * @param String value Header value + * @return Void + */ + append(name, value) { + name = `${name}`; + value = `${value}`; + validateName(name); + validateValue(value); + const key = find(this[MAP], name); + if (key !== undefined) { + this[MAP][key].push(value); + } else { + this[MAP][name] = [value]; + } + } + + /** + * Check for header name existence + * + * @param String name Header name + * @return Boolean + */ + has(name) { + name = `${name}`; + validateName(name); + return find(this[MAP], name) !== undefined; + } + + /** + * Delete all header values given name + * + * @param String name Header name + * @return Void + */ + delete(name) { + name = `${name}`; + validateName(name); + const key = find(this[MAP], name); + if (key !== undefined) { + delete this[MAP][key]; + } + } + + /** + * Return raw headers (non-spec api) + * + * @return Object + */ + raw() { + return this[MAP]; + } + + /** + * Get an iterator on keys. + * + * @return Iterator + */ + keys() { + return createHeadersIterator(this, 'key'); + } + + /** + * Get an iterator on values. + * + * @return Iterator + */ + values() { + return createHeadersIterator(this, 'value'); + } + + /** + * Get an iterator on entries. + * + * This is the default iterator of the Headers object. + * + * @return Iterator + */ + [Symbol.iterator]() { + return createHeadersIterator(this, 'key+value'); + } +} +Headers.prototype.entries = Headers.prototype[Symbol.iterator]; + +Object.defineProperty(Headers.prototype, Symbol.toStringTag, { + value: 'Headers', + writable: false, + enumerable: false, + configurable: true +}); + +Object.defineProperties(Headers.prototype, { + get: { enumerable: true }, + forEach: { enumerable: true }, + set: { enumerable: true }, + append: { enumerable: true }, + has: { enumerable: true }, + delete: { enumerable: true }, + keys: { enumerable: true }, + values: { enumerable: true }, + entries: { enumerable: true } +}); + +function getHeaders(headers) { + let kind = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'key+value'; + + const keys = Object.keys(headers[MAP]).sort(); + return keys.map(kind === 'key' ? function (k) { + return k.toLowerCase(); + } : kind === 'value' ? function (k) { + return headers[MAP][k].join(', '); + } : function (k) { + return [k.toLowerCase(), headers[MAP][k].join(', ')]; + }); +} + +const INTERNAL = Symbol('internal'); + +function createHeadersIterator(target, kind) { + const iterator = Object.create(HeadersIteratorPrototype); + iterator[INTERNAL] = { + target, + kind, + index: 0 + }; + return iterator; +} + +const HeadersIteratorPrototype = Object.setPrototypeOf({ + next() { + // istanbul ignore if + if (!this || Object.getPrototypeOf(this) !== HeadersIteratorPrototype) { + throw new TypeError('Value of `this` is not a HeadersIterator'); + } + + var _INTERNAL = this[INTERNAL]; + const target = _INTERNAL.target, + kind = _INTERNAL.kind, + index = _INTERNAL.index; + + const values = getHeaders(target, kind); + const len = values.length; + if (index >= len) { + return { + value: undefined, + done: true + }; + } + + this[INTERNAL].index = index + 1; + + return { + value: values[index], + done: false + }; + } +}, Object.getPrototypeOf(Object.getPrototypeOf([][Symbol.iterator]()))); + +Object.defineProperty(HeadersIteratorPrototype, Symbol.toStringTag, { + value: 'HeadersIterator', + writable: false, + enumerable: false, + configurable: true +}); + +/** + * Export the Headers object in a form that Node.js can consume. + * + * @param Headers headers + * @return Object + */ +function exportNodeCompatibleHeaders(headers) { + const obj = Object.assign({ __proto__: null }, headers[MAP]); + + // http.request() only supports string as Host header. This hack makes + // specifying custom Host header possible. + const hostHeaderKey = find(headers[MAP], 'Host'); + if (hostHeaderKey !== undefined) { + obj[hostHeaderKey] = obj[hostHeaderKey][0]; + } + + return obj; +} + +/** + * Create a Headers object from an object of headers, ignoring those that do + * not conform to HTTP grammar productions. + * + * @param Object obj Object of headers + * @return Headers + */ +function createHeadersLenient(obj) { + const headers = new Headers(); + for (const name of Object.keys(obj)) { + if (invalidTokenRegex.test(name)) { + continue; + } + if (Array.isArray(obj[name])) { + for (const val of obj[name]) { + if (invalidHeaderCharRegex.test(val)) { + continue; + } + if (headers[MAP][name] === undefined) { + headers[MAP][name] = [val]; + } else { + headers[MAP][name].push(val); + } + } + } else if (!invalidHeaderCharRegex.test(obj[name])) { + headers[MAP][name] = [obj[name]]; + } + } + return headers; +} + +const INTERNALS$1 = Symbol('Response internals'); + +// fix an issue where "STATUS_CODES" aren't a named export for node <10 +const STATUS_CODES = http.STATUS_CODES; + +/** + * Response class + * + * @param Stream body Readable stream + * @param Object opts Response options + * @return Void + */ +class Response { + constructor() { + let body = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null; + let opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; + + Body.call(this, body, opts); + + const status = opts.status || 200; + const headers = new Headers(opts.headers); + + if (body != null && !headers.has('Content-Type')) { + const contentType = extractContentType(body); + if (contentType) { + headers.append('Content-Type', contentType); + } + } + + this[INTERNALS$1] = { + url: opts.url, + status, + statusText: opts.statusText || STATUS_CODES[status], + headers, + counter: opts.counter + }; + } + + get url() { + return this[INTERNALS$1].url || ''; + } + + get status() { + return this[INTERNALS$1].status; + } + + /** + * Convenience property representing if the request ended normally + */ + get ok() { + return this[INTERNALS$1].status >= 200 && this[INTERNALS$1].status < 300; + } + + get redirected() { + return this[INTERNALS$1].counter > 0; + } + + get statusText() { + return this[INTERNALS$1].statusText; + } + + get headers() { + return this[INTERNALS$1].headers; + } + + /** + * Clone this response + * + * @return Response + */ + clone() { + return new Response(clone(this), { + url: this.url, + status: this.status, + statusText: this.statusText, + headers: this.headers, + ok: this.ok, + redirected: this.redirected + }); + } +} + +Body.mixIn(Response.prototype); + +Object.defineProperties(Response.prototype, { + url: { enumerable: true }, + status: { enumerable: true }, + ok: { enumerable: true }, + redirected: { enumerable: true }, + statusText: { enumerable: true }, + headers: { enumerable: true }, + clone: { enumerable: true } +}); + +Object.defineProperty(Response.prototype, Symbol.toStringTag, { + value: 'Response', + writable: false, + enumerable: false, + configurable: true +}); + +const INTERNALS$2 = Symbol('Request internals'); + +// fix an issue where "format", "parse" aren't a named export for node <10 +const parse_url = Url.parse; +const format_url = Url.format; + +const streamDestructionSupported = 'destroy' in Stream.Readable.prototype; + +/** + * Check if a value is an instance of Request. + * + * @param Mixed input + * @return Boolean + */ +function isRequest(input) { + return typeof input === 'object' && typeof input[INTERNALS$2] === 'object'; +} + +function isAbortSignal(signal) { + const proto = signal && typeof signal === 'object' && Object.getPrototypeOf(signal); + return !!(proto && proto.constructor.name === 'AbortSignal'); +} + +/** + * Request class + * + * @param Mixed input Url or Request instance + * @param Object init Custom options + * @return Void + */ +class Request { + constructor(input) { + let init = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; + + let parsedURL; + + // normalize input + if (!isRequest(input)) { + if (input && input.href) { + // in order to support Node.js' Url objects; though WHATWG's URL objects + // will fall into this branch also (since their `toString()` will return + // `href` property anyway) + parsedURL = parse_url(input.href); + } else { + // coerce input to a string before attempting to parse + parsedURL = parse_url(`${input}`); + } + input = {}; + } else { + parsedURL = parse_url(input.url); + } + + let method = init.method || input.method || 'GET'; + method = method.toUpperCase(); + + if ((init.body != null || isRequest(input) && input.body !== null) && (method === 'GET' || method === 'HEAD')) { + throw new TypeError('Request with GET/HEAD method cannot have body'); + } + + let inputBody = init.body != null ? init.body : isRequest(input) && input.body !== null ? clone(input) : null; + + Body.call(this, inputBody, { + timeout: init.timeout || input.timeout || 0, + size: init.size || input.size || 0 + }); + + const headers = new Headers(init.headers || input.headers || {}); + + if (inputBody != null && !headers.has('Content-Type')) { + const contentType = extractContentType(inputBody); + if (contentType) { + headers.append('Content-Type', contentType); + } + } + + let signal = isRequest(input) ? input.signal : null; + if ('signal' in init) signal = init.signal; + + if (signal != null && !isAbortSignal(signal)) { + throw new TypeError('Expected signal to be an instanceof AbortSignal'); + } + + this[INTERNALS$2] = { + method, + redirect: init.redirect || input.redirect || 'follow', + headers, + parsedURL, + signal + }; + + // node-fetch-only options + this.follow = init.follow !== undefined ? init.follow : input.follow !== undefined ? input.follow : 20; + this.compress = init.compress !== undefined ? init.compress : input.compress !== undefined ? input.compress : true; + this.counter = init.counter || input.counter || 0; + this.agent = init.agent || input.agent; + } + + get method() { + return this[INTERNALS$2].method; + } + + get url() { + return format_url(this[INTERNALS$2].parsedURL); + } + + get headers() { + return this[INTERNALS$2].headers; + } + + get redirect() { + return this[INTERNALS$2].redirect; + } + + get signal() { + return this[INTERNALS$2].signal; + } + + /** + * Clone this request + * + * @return Request + */ + clone() { + return new Request(this); + } +} + +Body.mixIn(Request.prototype); + +Object.defineProperty(Request.prototype, Symbol.toStringTag, { + value: 'Request', + writable: false, + enumerable: false, + configurable: true +}); + +Object.defineProperties(Request.prototype, { + method: { enumerable: true }, + url: { enumerable: true }, + headers: { enumerable: true }, + redirect: { enumerable: true }, + clone: { enumerable: true }, + signal: { enumerable: true } +}); + +/** + * Convert a Request to Node.js http request options. + * + * @param Request A Request instance + * @return Object The options object to be passed to http.request + */ +function getNodeRequestOptions(request) { + const parsedURL = request[INTERNALS$2].parsedURL; + const headers = new Headers(request[INTERNALS$2].headers); + + // fetch step 1.3 + if (!headers.has('Accept')) { + headers.set('Accept', '*/*'); + } + + // Basic fetch + if (!parsedURL.protocol || !parsedURL.hostname) { + throw new TypeError('Only absolute URLs are supported'); + } + + if (!/^https?:$/.test(parsedURL.protocol)) { + throw new TypeError('Only HTTP(S) protocols are supported'); + } + + if (request.signal && request.body instanceof Stream.Readable && !streamDestructionSupported) { + throw new Error('Cancellation of streamed requests with AbortSignal is not supported in node < 8'); + } + + // HTTP-network-or-cache fetch steps 2.4-2.7 + let contentLengthValue = null; + if (request.body == null && /^(POST|PUT)$/i.test(request.method)) { + contentLengthValue = '0'; + } + if (request.body != null) { + const totalBytes = getTotalBytes(request); + if (typeof totalBytes === 'number') { + contentLengthValue = String(totalBytes); + } + } + if (contentLengthValue) { + headers.set('Content-Length', contentLengthValue); + } + + // HTTP-network-or-cache fetch step 2.11 + if (!headers.has('User-Agent')) { + headers.set('User-Agent', 'node-fetch/1.0 (+https://github.com/bitinn/node-fetch)'); + } + + // HTTP-network-or-cache fetch step 2.15 + if (request.compress && !headers.has('Accept-Encoding')) { + headers.set('Accept-Encoding', 'gzip,deflate'); + } + + let agent = request.agent; + if (typeof agent === 'function') { + agent = agent(parsedURL); + } + + if (!headers.has('Connection') && !agent) { + headers.set('Connection', 'close'); + } + + // HTTP-network fetch step 4.2 + // chunked encoding is handled by Node.js + + return Object.assign({}, parsedURL, { + method: request.method, + headers: exportNodeCompatibleHeaders(headers), + agent + }); +} + +/** + * abort-error.js + * + * AbortError interface for cancelled requests + */ + +/** + * Create AbortError instance + * + * @param String message Error message for human + * @return AbortError + */ +function AbortError(message) { + Error.call(this, message); + + this.type = 'aborted'; + this.message = message; + + // hide custom error implementation details from end-users + Error.captureStackTrace(this, this.constructor); +} + +AbortError.prototype = Object.create(Error.prototype); +AbortError.prototype.constructor = AbortError; +AbortError.prototype.name = 'AbortError'; + +// fix an issue where "PassThrough", "resolve" aren't a named export for node <10 +const PassThrough$1 = Stream.PassThrough; +const resolve_url = Url.resolve; + +/** + * Fetch function + * + * @param Mixed url Absolute url or Request instance + * @param Object opts Fetch options + * @return Promise + */ +function fetch(url, opts) { + + // allow custom promise + if (!fetch.Promise) { + throw new Error('native promise missing, set fetch.Promise to your favorite alternative'); + } + + Body.Promise = fetch.Promise; + + // wrap http.request into fetch + return new fetch.Promise(function (resolve, reject) { + // build request object + const request = new Request(url, opts); + const options = getNodeRequestOptions(request); + + const send = (options.protocol === 'https:' ? https : http).request; + const signal = request.signal; + + let response = null; + + const abort = function abort() { + let error = new AbortError('The user aborted a request.'); + reject(error); + if (request.body && request.body instanceof Stream.Readable) { + request.body.destroy(error); + } + if (!response || !response.body) return; + response.body.emit('error', error); + }; + + if (signal && signal.aborted) { + abort(); + return; + } + + const abortAndFinalize = function abortAndFinalize() { + abort(); + finalize(); + }; + + // send request + const req = send(options); + let reqTimeout; + + if (signal) { + signal.addEventListener('abort', abortAndFinalize); + } + + function finalize() { + req.abort(); + if (signal) signal.removeEventListener('abort', abortAndFinalize); + clearTimeout(reqTimeout); + } + + if (request.timeout) { + req.once('socket', function (socket) { + reqTimeout = setTimeout(function () { + reject(new FetchError(`network timeout at: ${request.url}`, 'request-timeout')); + finalize(); + }, request.timeout); + }); + } + + req.on('error', function (err) { + reject(new FetchError(`request to ${request.url} failed, reason: ${err.message}`, 'system', err)); + finalize(); + }); + + req.on('response', function (res) { + clearTimeout(reqTimeout); + + const headers = createHeadersLenient(res.headers); + + // HTTP fetch step 5 + if (fetch.isRedirect(res.statusCode)) { + // HTTP fetch step 5.2 + const location = headers.get('Location'); + + // HTTP fetch step 5.3 + const locationURL = location === null ? null : resolve_url(request.url, location); + + // HTTP fetch step 5.5 + switch (request.redirect) { + case 'error': + reject(new FetchError(`uri requested responds with a redirect, redirect mode is set to error: ${request.url}`, 'no-redirect')); + finalize(); + return; + case 'manual': + // node-fetch-specific step: make manual redirect a bit easier to use by setting the Location header value to the resolved URL. + if (locationURL !== null) { + // handle corrupted header + try { + headers.set('Location', locationURL); + } catch (err) { + // istanbul ignore next: nodejs server prevent invalid response headers, we can't test this through normal request + reject(err); + } + } + break; + case 'follow': + // HTTP-redirect fetch step 2 + if (locationURL === null) { + break; + } + + // HTTP-redirect fetch step 5 + if (request.counter >= request.follow) { + reject(new FetchError(`maximum redirect reached at: ${request.url}`, 'max-redirect')); + finalize(); + return; + } + + // HTTP-redirect fetch step 6 (counter increment) + // Create a new Request object. + const requestOpts = { + headers: new Headers(request.headers), + follow: request.follow, + counter: request.counter + 1, + agent: request.agent, + compress: request.compress, + method: request.method, + body: request.body, + signal: request.signal, + timeout: request.timeout, + size: request.size + }; + + // HTTP-redirect fetch step 9 + if (res.statusCode !== 303 && request.body && getTotalBytes(request) === null) { + reject(new FetchError('Cannot follow redirect with body being a readable stream', 'unsupported-redirect')); + finalize(); + return; + } + + // HTTP-redirect fetch step 11 + if (res.statusCode === 303 || (res.statusCode === 301 || res.statusCode === 302) && request.method === 'POST') { + requestOpts.method = 'GET'; + requestOpts.body = undefined; + requestOpts.headers.delete('content-length'); + } + + // HTTP-redirect fetch step 15 + resolve(fetch(new Request(locationURL, requestOpts))); + finalize(); + return; + } + } + + // prepare response + res.once('end', function () { + if (signal) signal.removeEventListener('abort', abortAndFinalize); + }); + let body = res.pipe(new PassThrough$1()); + + const response_options = { + url: request.url, + status: res.statusCode, + statusText: res.statusMessage, + headers: headers, + size: request.size, + timeout: request.timeout, + counter: request.counter + }; + + // HTTP-network fetch step 12.1.1.3 + const codings = headers.get('Content-Encoding'); + + // HTTP-network fetch step 12.1.1.4: handle content codings + + // in following scenarios we ignore compression support + // 1. compression support is disabled + // 2. HEAD request + // 3. no Content-Encoding header + // 4. no content response (204) + // 5. content not modified response (304) + if (!request.compress || request.method === 'HEAD' || codings === null || res.statusCode === 204 || res.statusCode === 304) { + response = new Response(body, response_options); + resolve(response); + return; + } + + // For Node v6+ + // Be less strict when decoding compressed responses, since sometimes + // servers send slightly invalid responses that are still accepted + // by common browsers. + // Always using Z_SYNC_FLUSH is what cURL does. + const zlibOptions = { + flush: zlib.Z_SYNC_FLUSH, + finishFlush: zlib.Z_SYNC_FLUSH + }; + + // for gzip + if (codings == 'gzip' || codings == 'x-gzip') { + body = body.pipe(zlib.createGunzip(zlibOptions)); + response = new Response(body, response_options); + resolve(response); + return; + } + + // for deflate + if (codings == 'deflate' || codings == 'x-deflate') { + // handle the infamous raw deflate response from old servers + // a hack for old IIS and Apache servers + const raw = res.pipe(new PassThrough$1()); + raw.once('data', function (chunk) { + // see http://stackoverflow.com/questions/37519828 + if ((chunk[0] & 0x0F) === 0x08) { + body = body.pipe(zlib.createInflate()); + } else { + body = body.pipe(zlib.createInflateRaw()); + } + response = new Response(body, response_options); + resolve(response); + }); + return; + } + + // for br + if (codings == 'br' && typeof zlib.createBrotliDecompress === 'function') { + body = body.pipe(zlib.createBrotliDecompress()); + response = new Response(body, response_options); + resolve(response); + return; + } + + // otherwise, use response as-is + response = new Response(body, response_options); + resolve(response); + }); + + writeToStream(req, request); + }); +} +/** + * Redirect code matching + * + * @param Number code Status code + * @return Boolean + */ +fetch.isRedirect = function (code) { + return code === 301 || code === 302 || code === 303 || code === 307 || code === 308; +}; + +// expose Promise +fetch.Promise = global.Promise; + +module.exports = exports = fetch; +Object.defineProperty(exports, "__esModule", { value: true }); +exports.default = exports; +exports.Headers = Headers; +exports.Request = Request; +exports.Response = Response; +exports.FetchError = FetchError; diff --git a/node_modules/node-fetch/lib/index.mjs b/node_modules/node-fetch/lib/index.mjs new file mode 100644 index 00000000..ecf59af8 --- /dev/null +++ b/node_modules/node-fetch/lib/index.mjs @@ -0,0 +1,1638 @@ +import Stream from 'stream'; +import http from 'http'; +import Url from 'url'; +import https from 'https'; +import zlib from 'zlib'; + +// Based on https://github.com/tmpvar/jsdom/blob/aa85b2abf07766ff7bf5c1f6daafb3726f2f2db5/lib/jsdom/living/blob.js + +// fix for "Readable" isn't a named export issue +const Readable = Stream.Readable; + +const BUFFER = Symbol('buffer'); +const TYPE = Symbol('type'); + +class Blob { + constructor() { + this[TYPE] = ''; + + const blobParts = arguments[0]; + const options = arguments[1]; + + const buffers = []; + let size = 0; + + if (blobParts) { + const a = blobParts; + const length = Number(a.length); + for (let i = 0; i < length; i++) { + const element = a[i]; + let buffer; + if (element instanceof Buffer) { + buffer = element; + } else if (ArrayBuffer.isView(element)) { + buffer = Buffer.from(element.buffer, element.byteOffset, element.byteLength); + } else if (element instanceof ArrayBuffer) { + buffer = Buffer.from(element); + } else if (element instanceof Blob) { + buffer = element[BUFFER]; + } else { + buffer = Buffer.from(typeof element === 'string' ? element : String(element)); + } + size += buffer.length; + buffers.push(buffer); + } + } + + this[BUFFER] = Buffer.concat(buffers); + + let type = options && options.type !== undefined && String(options.type).toLowerCase(); + if (type && !/[^\u0020-\u007E]/.test(type)) { + this[TYPE] = type; + } + } + get size() { + return this[BUFFER].length; + } + get type() { + return this[TYPE]; + } + text() { + return Promise.resolve(this[BUFFER].toString()); + } + arrayBuffer() { + const buf = this[BUFFER]; + const ab = buf.buffer.slice(buf.byteOffset, buf.byteOffset + buf.byteLength); + return Promise.resolve(ab); + } + stream() { + const readable = new Readable(); + readable._read = function () {}; + readable.push(this[BUFFER]); + readable.push(null); + return readable; + } + toString() { + return '[object Blob]'; + } + slice() { + const size = this.size; + + const start = arguments[0]; + const end = arguments[1]; + let relativeStart, relativeEnd; + if (start === undefined) { + relativeStart = 0; + } else if (start < 0) { + relativeStart = Math.max(size + start, 0); + } else { + relativeStart = Math.min(start, size); + } + if (end === undefined) { + relativeEnd = size; + } else if (end < 0) { + relativeEnd = Math.max(size + end, 0); + } else { + relativeEnd = Math.min(end, size); + } + const span = Math.max(relativeEnd - relativeStart, 0); + + const buffer = this[BUFFER]; + const slicedBuffer = buffer.slice(relativeStart, relativeStart + span); + const blob = new Blob([], { type: arguments[2] }); + blob[BUFFER] = slicedBuffer; + return blob; + } +} + +Object.defineProperties(Blob.prototype, { + size: { enumerable: true }, + type: { enumerable: true }, + slice: { enumerable: true } +}); + +Object.defineProperty(Blob.prototype, Symbol.toStringTag, { + value: 'Blob', + writable: false, + enumerable: false, + configurable: true +}); + +/** + * fetch-error.js + * + * FetchError interface for operational errors + */ + +/** + * Create FetchError instance + * + * @param String message Error message for human + * @param String type Error type for machine + * @param String systemError For Node.js system error + * @return FetchError + */ +function FetchError(message, type, systemError) { + Error.call(this, message); + + this.message = message; + this.type = type; + + // when err.type is `system`, err.code contains system error code + if (systemError) { + this.code = this.errno = systemError.code; + } + + // hide custom error implementation details from end-users + Error.captureStackTrace(this, this.constructor); +} + +FetchError.prototype = Object.create(Error.prototype); +FetchError.prototype.constructor = FetchError; +FetchError.prototype.name = 'FetchError'; + +let convert; +try { + convert = require('encoding').convert; +} catch (e) {} + +const INTERNALS = Symbol('Body internals'); + +// fix an issue where "PassThrough" isn't a named export for node <10 +const PassThrough = Stream.PassThrough; + +/** + * Body mixin + * + * Ref: https://fetch.spec.whatwg.org/#body + * + * @param Stream body Readable stream + * @param Object opts Response options + * @return Void + */ +function Body(body) { + var _this = this; + + var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}, + _ref$size = _ref.size; + + let size = _ref$size === undefined ? 0 : _ref$size; + var _ref$timeout = _ref.timeout; + let timeout = _ref$timeout === undefined ? 0 : _ref$timeout; + + if (body == null) { + // body is undefined or null + body = null; + } else if (isURLSearchParams(body)) { + // body is a URLSearchParams + body = Buffer.from(body.toString()); + } else if (isBlob(body)) ; else if (Buffer.isBuffer(body)) ; else if (Object.prototype.toString.call(body) === '[object ArrayBuffer]') { + // body is ArrayBuffer + body = Buffer.from(body); + } else if (ArrayBuffer.isView(body)) { + // body is ArrayBufferView + body = Buffer.from(body.buffer, body.byteOffset, body.byteLength); + } else if (body instanceof Stream) ; else { + // none of the above + // coerce to string then buffer + body = Buffer.from(String(body)); + } + this[INTERNALS] = { + body, + disturbed: false, + error: null + }; + this.size = size; + this.timeout = timeout; + + if (body instanceof Stream) { + body.on('error', function (err) { + const error = err.name === 'AbortError' ? err : new FetchError(`Invalid response body while trying to fetch ${_this.url}: ${err.message}`, 'system', err); + _this[INTERNALS].error = error; + }); + } +} + +Body.prototype = { + get body() { + return this[INTERNALS].body; + }, + + get bodyUsed() { + return this[INTERNALS].disturbed; + }, + + /** + * Decode response as ArrayBuffer + * + * @return Promise + */ + arrayBuffer() { + return consumeBody.call(this).then(function (buf) { + return buf.buffer.slice(buf.byteOffset, buf.byteOffset + buf.byteLength); + }); + }, + + /** + * Return raw response as Blob + * + * @return Promise + */ + blob() { + let ct = this.headers && this.headers.get('content-type') || ''; + return consumeBody.call(this).then(function (buf) { + return Object.assign( + // Prevent copying + new Blob([], { + type: ct.toLowerCase() + }), { + [BUFFER]: buf + }); + }); + }, + + /** + * Decode response as json + * + * @return Promise + */ + json() { + var _this2 = this; + + return consumeBody.call(this).then(function (buffer) { + try { + return JSON.parse(buffer.toString()); + } catch (err) { + return Body.Promise.reject(new FetchError(`invalid json response body at ${_this2.url} reason: ${err.message}`, 'invalid-json')); + } + }); + }, + + /** + * Decode response as text + * + * @return Promise + */ + text() { + return consumeBody.call(this).then(function (buffer) { + return buffer.toString(); + }); + }, + + /** + * Decode response as buffer (non-spec api) + * + * @return Promise + */ + buffer() { + return consumeBody.call(this); + }, + + /** + * Decode response as text, while automatically detecting the encoding and + * trying to decode to UTF-8 (non-spec api) + * + * @return Promise + */ + textConverted() { + var _this3 = this; + + return consumeBody.call(this).then(function (buffer) { + return convertBody(buffer, _this3.headers); + }); + } +}; + +// In browsers, all properties are enumerable. +Object.defineProperties(Body.prototype, { + body: { enumerable: true }, + bodyUsed: { enumerable: true }, + arrayBuffer: { enumerable: true }, + blob: { enumerable: true }, + json: { enumerable: true }, + text: { enumerable: true } +}); + +Body.mixIn = function (proto) { + for (const name of Object.getOwnPropertyNames(Body.prototype)) { + // istanbul ignore else: future proof + if (!(name in proto)) { + const desc = Object.getOwnPropertyDescriptor(Body.prototype, name); + Object.defineProperty(proto, name, desc); + } + } +}; + +/** + * Consume and convert an entire Body to a Buffer. + * + * Ref: https://fetch.spec.whatwg.org/#concept-body-consume-body + * + * @return Promise + */ +function consumeBody() { + var _this4 = this; + + if (this[INTERNALS].disturbed) { + return Body.Promise.reject(new TypeError(`body used already for: ${this.url}`)); + } + + this[INTERNALS].disturbed = true; + + if (this[INTERNALS].error) { + return Body.Promise.reject(this[INTERNALS].error); + } + + let body = this.body; + + // body is null + if (body === null) { + return Body.Promise.resolve(Buffer.alloc(0)); + } + + // body is blob + if (isBlob(body)) { + body = body.stream(); + } + + // body is buffer + if (Buffer.isBuffer(body)) { + return Body.Promise.resolve(body); + } + + // istanbul ignore if: should never happen + if (!(body instanceof Stream)) { + return Body.Promise.resolve(Buffer.alloc(0)); + } + + // body is stream + // get ready to actually consume the body + let accum = []; + let accumBytes = 0; + let abort = false; + + return new Body.Promise(function (resolve, reject) { + let resTimeout; + + // allow timeout on slow response body + if (_this4.timeout) { + resTimeout = setTimeout(function () { + abort = true; + reject(new FetchError(`Response timeout while trying to fetch ${_this4.url} (over ${_this4.timeout}ms)`, 'body-timeout')); + }, _this4.timeout); + } + + // handle stream errors + body.on('error', function (err) { + if (err.name === 'AbortError') { + // if the request was aborted, reject with this Error + abort = true; + reject(err); + } else { + // other errors, such as incorrect content-encoding + reject(new FetchError(`Invalid response body while trying to fetch ${_this4.url}: ${err.message}`, 'system', err)); + } + }); + + body.on('data', function (chunk) { + if (abort || chunk === null) { + return; + } + + if (_this4.size && accumBytes + chunk.length > _this4.size) { + abort = true; + reject(new FetchError(`content size at ${_this4.url} over limit: ${_this4.size}`, 'max-size')); + return; + } + + accumBytes += chunk.length; + accum.push(chunk); + }); + + body.on('end', function () { + if (abort) { + return; + } + + clearTimeout(resTimeout); + + try { + resolve(Buffer.concat(accum, accumBytes)); + } catch (err) { + // handle streams that have accumulated too much data (issue #414) + reject(new FetchError(`Could not create Buffer from response body for ${_this4.url}: ${err.message}`, 'system', err)); + } + }); + }); +} + +/** + * Detect buffer encoding and convert to target encoding + * ref: http://www.w3.org/TR/2011/WD-html5-20110113/parsing.html#determining-the-character-encoding + * + * @param Buffer buffer Incoming buffer + * @param String encoding Target encoding + * @return String + */ +function convertBody(buffer, headers) { + if (typeof convert !== 'function') { + throw new Error('The package `encoding` must be installed to use the textConverted() function'); + } + + const ct = headers.get('content-type'); + let charset = 'utf-8'; + let res, str; + + // header + if (ct) { + res = /charset=([^;]*)/i.exec(ct); + } + + // no charset in content type, peek at response body for at most 1024 bytes + str = buffer.slice(0, 1024).toString(); + + // html5 + if (!res && str) { + res = / 0 && arguments[0] !== undefined ? arguments[0] : undefined; + + this[MAP] = Object.create(null); + + if (init instanceof Headers) { + const rawHeaders = init.raw(); + const headerNames = Object.keys(rawHeaders); + + for (const headerName of headerNames) { + for (const value of rawHeaders[headerName]) { + this.append(headerName, value); + } + } + + return; + } + + // We don't worry about converting prop to ByteString here as append() + // will handle it. + if (init == null) ; else if (typeof init === 'object') { + const method = init[Symbol.iterator]; + if (method != null) { + if (typeof method !== 'function') { + throw new TypeError('Header pairs must be iterable'); + } + + // sequence> + // Note: per spec we have to first exhaust the lists then process them + const pairs = []; + for (const pair of init) { + if (typeof pair !== 'object' || typeof pair[Symbol.iterator] !== 'function') { + throw new TypeError('Each header pair must be iterable'); + } + pairs.push(Array.from(pair)); + } + + for (const pair of pairs) { + if (pair.length !== 2) { + throw new TypeError('Each header pair must be a name/value tuple'); + } + this.append(pair[0], pair[1]); + } + } else { + // record + for (const key of Object.keys(init)) { + const value = init[key]; + this.append(key, value); + } + } + } else { + throw new TypeError('Provided initializer must be an object'); + } + } + + /** + * Return combined header value given name + * + * @param String name Header name + * @return Mixed + */ + get(name) { + name = `${name}`; + validateName(name); + const key = find(this[MAP], name); + if (key === undefined) { + return null; + } + + return this[MAP][key].join(', '); + } + + /** + * Iterate over all headers + * + * @param Function callback Executed for each item with parameters (value, name, thisArg) + * @param Boolean thisArg `this` context for callback function + * @return Void + */ + forEach(callback) { + let thisArg = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : undefined; + + let pairs = getHeaders(this); + let i = 0; + while (i < pairs.length) { + var _pairs$i = pairs[i]; + const name = _pairs$i[0], + value = _pairs$i[1]; + + callback.call(thisArg, value, name, this); + pairs = getHeaders(this); + i++; + } + } + + /** + * Overwrite header values given name + * + * @param String name Header name + * @param String value Header value + * @return Void + */ + set(name, value) { + name = `${name}`; + value = `${value}`; + validateName(name); + validateValue(value); + const key = find(this[MAP], name); + this[MAP][key !== undefined ? key : name] = [value]; + } + + /** + * Append a value onto existing header + * + * @param String name Header name + * @param String value Header value + * @return Void + */ + append(name, value) { + name = `${name}`; + value = `${value}`; + validateName(name); + validateValue(value); + const key = find(this[MAP], name); + if (key !== undefined) { + this[MAP][key].push(value); + } else { + this[MAP][name] = [value]; + } + } + + /** + * Check for header name existence + * + * @param String name Header name + * @return Boolean + */ + has(name) { + name = `${name}`; + validateName(name); + return find(this[MAP], name) !== undefined; + } + + /** + * Delete all header values given name + * + * @param String name Header name + * @return Void + */ + delete(name) { + name = `${name}`; + validateName(name); + const key = find(this[MAP], name); + if (key !== undefined) { + delete this[MAP][key]; + } + } + + /** + * Return raw headers (non-spec api) + * + * @return Object + */ + raw() { + return this[MAP]; + } + + /** + * Get an iterator on keys. + * + * @return Iterator + */ + keys() { + return createHeadersIterator(this, 'key'); + } + + /** + * Get an iterator on values. + * + * @return Iterator + */ + values() { + return createHeadersIterator(this, 'value'); + } + + /** + * Get an iterator on entries. + * + * This is the default iterator of the Headers object. + * + * @return Iterator + */ + [Symbol.iterator]() { + return createHeadersIterator(this, 'key+value'); + } +} +Headers.prototype.entries = Headers.prototype[Symbol.iterator]; + +Object.defineProperty(Headers.prototype, Symbol.toStringTag, { + value: 'Headers', + writable: false, + enumerable: false, + configurable: true +}); + +Object.defineProperties(Headers.prototype, { + get: { enumerable: true }, + forEach: { enumerable: true }, + set: { enumerable: true }, + append: { enumerable: true }, + has: { enumerable: true }, + delete: { enumerable: true }, + keys: { enumerable: true }, + values: { enumerable: true }, + entries: { enumerable: true } +}); + +function getHeaders(headers) { + let kind = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'key+value'; + + const keys = Object.keys(headers[MAP]).sort(); + return keys.map(kind === 'key' ? function (k) { + return k.toLowerCase(); + } : kind === 'value' ? function (k) { + return headers[MAP][k].join(', '); + } : function (k) { + return [k.toLowerCase(), headers[MAP][k].join(', ')]; + }); +} + +const INTERNAL = Symbol('internal'); + +function createHeadersIterator(target, kind) { + const iterator = Object.create(HeadersIteratorPrototype); + iterator[INTERNAL] = { + target, + kind, + index: 0 + }; + return iterator; +} + +const HeadersIteratorPrototype = Object.setPrototypeOf({ + next() { + // istanbul ignore if + if (!this || Object.getPrototypeOf(this) !== HeadersIteratorPrototype) { + throw new TypeError('Value of `this` is not a HeadersIterator'); + } + + var _INTERNAL = this[INTERNAL]; + const target = _INTERNAL.target, + kind = _INTERNAL.kind, + index = _INTERNAL.index; + + const values = getHeaders(target, kind); + const len = values.length; + if (index >= len) { + return { + value: undefined, + done: true + }; + } + + this[INTERNAL].index = index + 1; + + return { + value: values[index], + done: false + }; + } +}, Object.getPrototypeOf(Object.getPrototypeOf([][Symbol.iterator]()))); + +Object.defineProperty(HeadersIteratorPrototype, Symbol.toStringTag, { + value: 'HeadersIterator', + writable: false, + enumerable: false, + configurable: true +}); + +/** + * Export the Headers object in a form that Node.js can consume. + * + * @param Headers headers + * @return Object + */ +function exportNodeCompatibleHeaders(headers) { + const obj = Object.assign({ __proto__: null }, headers[MAP]); + + // http.request() only supports string as Host header. This hack makes + // specifying custom Host header possible. + const hostHeaderKey = find(headers[MAP], 'Host'); + if (hostHeaderKey !== undefined) { + obj[hostHeaderKey] = obj[hostHeaderKey][0]; + } + + return obj; +} + +/** + * Create a Headers object from an object of headers, ignoring those that do + * not conform to HTTP grammar productions. + * + * @param Object obj Object of headers + * @return Headers + */ +function createHeadersLenient(obj) { + const headers = new Headers(); + for (const name of Object.keys(obj)) { + if (invalidTokenRegex.test(name)) { + continue; + } + if (Array.isArray(obj[name])) { + for (const val of obj[name]) { + if (invalidHeaderCharRegex.test(val)) { + continue; + } + if (headers[MAP][name] === undefined) { + headers[MAP][name] = [val]; + } else { + headers[MAP][name].push(val); + } + } + } else if (!invalidHeaderCharRegex.test(obj[name])) { + headers[MAP][name] = [obj[name]]; + } + } + return headers; +} + +const INTERNALS$1 = Symbol('Response internals'); + +// fix an issue where "STATUS_CODES" aren't a named export for node <10 +const STATUS_CODES = http.STATUS_CODES; + +/** + * Response class + * + * @param Stream body Readable stream + * @param Object opts Response options + * @return Void + */ +class Response { + constructor() { + let body = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null; + let opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; + + Body.call(this, body, opts); + + const status = opts.status || 200; + const headers = new Headers(opts.headers); + + if (body != null && !headers.has('Content-Type')) { + const contentType = extractContentType(body); + if (contentType) { + headers.append('Content-Type', contentType); + } + } + + this[INTERNALS$1] = { + url: opts.url, + status, + statusText: opts.statusText || STATUS_CODES[status], + headers, + counter: opts.counter + }; + } + + get url() { + return this[INTERNALS$1].url || ''; + } + + get status() { + return this[INTERNALS$1].status; + } + + /** + * Convenience property representing if the request ended normally + */ + get ok() { + return this[INTERNALS$1].status >= 200 && this[INTERNALS$1].status < 300; + } + + get redirected() { + return this[INTERNALS$1].counter > 0; + } + + get statusText() { + return this[INTERNALS$1].statusText; + } + + get headers() { + return this[INTERNALS$1].headers; + } + + /** + * Clone this response + * + * @return Response + */ + clone() { + return new Response(clone(this), { + url: this.url, + status: this.status, + statusText: this.statusText, + headers: this.headers, + ok: this.ok, + redirected: this.redirected + }); + } +} + +Body.mixIn(Response.prototype); + +Object.defineProperties(Response.prototype, { + url: { enumerable: true }, + status: { enumerable: true }, + ok: { enumerable: true }, + redirected: { enumerable: true }, + statusText: { enumerable: true }, + headers: { enumerable: true }, + clone: { enumerable: true } +}); + +Object.defineProperty(Response.prototype, Symbol.toStringTag, { + value: 'Response', + writable: false, + enumerable: false, + configurable: true +}); + +const INTERNALS$2 = Symbol('Request internals'); + +// fix an issue where "format", "parse" aren't a named export for node <10 +const parse_url = Url.parse; +const format_url = Url.format; + +const streamDestructionSupported = 'destroy' in Stream.Readable.prototype; + +/** + * Check if a value is an instance of Request. + * + * @param Mixed input + * @return Boolean + */ +function isRequest(input) { + return typeof input === 'object' && typeof input[INTERNALS$2] === 'object'; +} + +function isAbortSignal(signal) { + const proto = signal && typeof signal === 'object' && Object.getPrototypeOf(signal); + return !!(proto && proto.constructor.name === 'AbortSignal'); +} + +/** + * Request class + * + * @param Mixed input Url or Request instance + * @param Object init Custom options + * @return Void + */ +class Request { + constructor(input) { + let init = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {}; + + let parsedURL; + + // normalize input + if (!isRequest(input)) { + if (input && input.href) { + // in order to support Node.js' Url objects; though WHATWG's URL objects + // will fall into this branch also (since their `toString()` will return + // `href` property anyway) + parsedURL = parse_url(input.href); + } else { + // coerce input to a string before attempting to parse + parsedURL = parse_url(`${input}`); + } + input = {}; + } else { + parsedURL = parse_url(input.url); + } + + let method = init.method || input.method || 'GET'; + method = method.toUpperCase(); + + if ((init.body != null || isRequest(input) && input.body !== null) && (method === 'GET' || method === 'HEAD')) { + throw new TypeError('Request with GET/HEAD method cannot have body'); + } + + let inputBody = init.body != null ? init.body : isRequest(input) && input.body !== null ? clone(input) : null; + + Body.call(this, inputBody, { + timeout: init.timeout || input.timeout || 0, + size: init.size || input.size || 0 + }); + + const headers = new Headers(init.headers || input.headers || {}); + + if (inputBody != null && !headers.has('Content-Type')) { + const contentType = extractContentType(inputBody); + if (contentType) { + headers.append('Content-Type', contentType); + } + } + + let signal = isRequest(input) ? input.signal : null; + if ('signal' in init) signal = init.signal; + + if (signal != null && !isAbortSignal(signal)) { + throw new TypeError('Expected signal to be an instanceof AbortSignal'); + } + + this[INTERNALS$2] = { + method, + redirect: init.redirect || input.redirect || 'follow', + headers, + parsedURL, + signal + }; + + // node-fetch-only options + this.follow = init.follow !== undefined ? init.follow : input.follow !== undefined ? input.follow : 20; + this.compress = init.compress !== undefined ? init.compress : input.compress !== undefined ? input.compress : true; + this.counter = init.counter || input.counter || 0; + this.agent = init.agent || input.agent; + } + + get method() { + return this[INTERNALS$2].method; + } + + get url() { + return format_url(this[INTERNALS$2].parsedURL); + } + + get headers() { + return this[INTERNALS$2].headers; + } + + get redirect() { + return this[INTERNALS$2].redirect; + } + + get signal() { + return this[INTERNALS$2].signal; + } + + /** + * Clone this request + * + * @return Request + */ + clone() { + return new Request(this); + } +} + +Body.mixIn(Request.prototype); + +Object.defineProperty(Request.prototype, Symbol.toStringTag, { + value: 'Request', + writable: false, + enumerable: false, + configurable: true +}); + +Object.defineProperties(Request.prototype, { + method: { enumerable: true }, + url: { enumerable: true }, + headers: { enumerable: true }, + redirect: { enumerable: true }, + clone: { enumerable: true }, + signal: { enumerable: true } +}); + +/** + * Convert a Request to Node.js http request options. + * + * @param Request A Request instance + * @return Object The options object to be passed to http.request + */ +function getNodeRequestOptions(request) { + const parsedURL = request[INTERNALS$2].parsedURL; + const headers = new Headers(request[INTERNALS$2].headers); + + // fetch step 1.3 + if (!headers.has('Accept')) { + headers.set('Accept', '*/*'); + } + + // Basic fetch + if (!parsedURL.protocol || !parsedURL.hostname) { + throw new TypeError('Only absolute URLs are supported'); + } + + if (!/^https?:$/.test(parsedURL.protocol)) { + throw new TypeError('Only HTTP(S) protocols are supported'); + } + + if (request.signal && request.body instanceof Stream.Readable && !streamDestructionSupported) { + throw new Error('Cancellation of streamed requests with AbortSignal is not supported in node < 8'); + } + + // HTTP-network-or-cache fetch steps 2.4-2.7 + let contentLengthValue = null; + if (request.body == null && /^(POST|PUT)$/i.test(request.method)) { + contentLengthValue = '0'; + } + if (request.body != null) { + const totalBytes = getTotalBytes(request); + if (typeof totalBytes === 'number') { + contentLengthValue = String(totalBytes); + } + } + if (contentLengthValue) { + headers.set('Content-Length', contentLengthValue); + } + + // HTTP-network-or-cache fetch step 2.11 + if (!headers.has('User-Agent')) { + headers.set('User-Agent', 'node-fetch/1.0 (+https://github.com/bitinn/node-fetch)'); + } + + // HTTP-network-or-cache fetch step 2.15 + if (request.compress && !headers.has('Accept-Encoding')) { + headers.set('Accept-Encoding', 'gzip,deflate'); + } + + let agent = request.agent; + if (typeof agent === 'function') { + agent = agent(parsedURL); + } + + if (!headers.has('Connection') && !agent) { + headers.set('Connection', 'close'); + } + + // HTTP-network fetch step 4.2 + // chunked encoding is handled by Node.js + + return Object.assign({}, parsedURL, { + method: request.method, + headers: exportNodeCompatibleHeaders(headers), + agent + }); +} + +/** + * abort-error.js + * + * AbortError interface for cancelled requests + */ + +/** + * Create AbortError instance + * + * @param String message Error message for human + * @return AbortError + */ +function AbortError(message) { + Error.call(this, message); + + this.type = 'aborted'; + this.message = message; + + // hide custom error implementation details from end-users + Error.captureStackTrace(this, this.constructor); +} + +AbortError.prototype = Object.create(Error.prototype); +AbortError.prototype.constructor = AbortError; +AbortError.prototype.name = 'AbortError'; + +// fix an issue where "PassThrough", "resolve" aren't a named export for node <10 +const PassThrough$1 = Stream.PassThrough; +const resolve_url = Url.resolve; + +/** + * Fetch function + * + * @param Mixed url Absolute url or Request instance + * @param Object opts Fetch options + * @return Promise + */ +function fetch(url, opts) { + + // allow custom promise + if (!fetch.Promise) { + throw new Error('native promise missing, set fetch.Promise to your favorite alternative'); + } + + Body.Promise = fetch.Promise; + + // wrap http.request into fetch + return new fetch.Promise(function (resolve, reject) { + // build request object + const request = new Request(url, opts); + const options = getNodeRequestOptions(request); + + const send = (options.protocol === 'https:' ? https : http).request; + const signal = request.signal; + + let response = null; + + const abort = function abort() { + let error = new AbortError('The user aborted a request.'); + reject(error); + if (request.body && request.body instanceof Stream.Readable) { + request.body.destroy(error); + } + if (!response || !response.body) return; + response.body.emit('error', error); + }; + + if (signal && signal.aborted) { + abort(); + return; + } + + const abortAndFinalize = function abortAndFinalize() { + abort(); + finalize(); + }; + + // send request + const req = send(options); + let reqTimeout; + + if (signal) { + signal.addEventListener('abort', abortAndFinalize); + } + + function finalize() { + req.abort(); + if (signal) signal.removeEventListener('abort', abortAndFinalize); + clearTimeout(reqTimeout); + } + + if (request.timeout) { + req.once('socket', function (socket) { + reqTimeout = setTimeout(function () { + reject(new FetchError(`network timeout at: ${request.url}`, 'request-timeout')); + finalize(); + }, request.timeout); + }); + } + + req.on('error', function (err) { + reject(new FetchError(`request to ${request.url} failed, reason: ${err.message}`, 'system', err)); + finalize(); + }); + + req.on('response', function (res) { + clearTimeout(reqTimeout); + + const headers = createHeadersLenient(res.headers); + + // HTTP fetch step 5 + if (fetch.isRedirect(res.statusCode)) { + // HTTP fetch step 5.2 + const location = headers.get('Location'); + + // HTTP fetch step 5.3 + const locationURL = location === null ? null : resolve_url(request.url, location); + + // HTTP fetch step 5.5 + switch (request.redirect) { + case 'error': + reject(new FetchError(`uri requested responds with a redirect, redirect mode is set to error: ${request.url}`, 'no-redirect')); + finalize(); + return; + case 'manual': + // node-fetch-specific step: make manual redirect a bit easier to use by setting the Location header value to the resolved URL. + if (locationURL !== null) { + // handle corrupted header + try { + headers.set('Location', locationURL); + } catch (err) { + // istanbul ignore next: nodejs server prevent invalid response headers, we can't test this through normal request + reject(err); + } + } + break; + case 'follow': + // HTTP-redirect fetch step 2 + if (locationURL === null) { + break; + } + + // HTTP-redirect fetch step 5 + if (request.counter >= request.follow) { + reject(new FetchError(`maximum redirect reached at: ${request.url}`, 'max-redirect')); + finalize(); + return; + } + + // HTTP-redirect fetch step 6 (counter increment) + // Create a new Request object. + const requestOpts = { + headers: new Headers(request.headers), + follow: request.follow, + counter: request.counter + 1, + agent: request.agent, + compress: request.compress, + method: request.method, + body: request.body, + signal: request.signal, + timeout: request.timeout, + size: request.size + }; + + // HTTP-redirect fetch step 9 + if (res.statusCode !== 303 && request.body && getTotalBytes(request) === null) { + reject(new FetchError('Cannot follow redirect with body being a readable stream', 'unsupported-redirect')); + finalize(); + return; + } + + // HTTP-redirect fetch step 11 + if (res.statusCode === 303 || (res.statusCode === 301 || res.statusCode === 302) && request.method === 'POST') { + requestOpts.method = 'GET'; + requestOpts.body = undefined; + requestOpts.headers.delete('content-length'); + } + + // HTTP-redirect fetch step 15 + resolve(fetch(new Request(locationURL, requestOpts))); + finalize(); + return; + } + } + + // prepare response + res.once('end', function () { + if (signal) signal.removeEventListener('abort', abortAndFinalize); + }); + let body = res.pipe(new PassThrough$1()); + + const response_options = { + url: request.url, + status: res.statusCode, + statusText: res.statusMessage, + headers: headers, + size: request.size, + timeout: request.timeout, + counter: request.counter + }; + + // HTTP-network fetch step 12.1.1.3 + const codings = headers.get('Content-Encoding'); + + // HTTP-network fetch step 12.1.1.4: handle content codings + + // in following scenarios we ignore compression support + // 1. compression support is disabled + // 2. HEAD request + // 3. no Content-Encoding header + // 4. no content response (204) + // 5. content not modified response (304) + if (!request.compress || request.method === 'HEAD' || codings === null || res.statusCode === 204 || res.statusCode === 304) { + response = new Response(body, response_options); + resolve(response); + return; + } + + // For Node v6+ + // Be less strict when decoding compressed responses, since sometimes + // servers send slightly invalid responses that are still accepted + // by common browsers. + // Always using Z_SYNC_FLUSH is what cURL does. + const zlibOptions = { + flush: zlib.Z_SYNC_FLUSH, + finishFlush: zlib.Z_SYNC_FLUSH + }; + + // for gzip + if (codings == 'gzip' || codings == 'x-gzip') { + body = body.pipe(zlib.createGunzip(zlibOptions)); + response = new Response(body, response_options); + resolve(response); + return; + } + + // for deflate + if (codings == 'deflate' || codings == 'x-deflate') { + // handle the infamous raw deflate response from old servers + // a hack for old IIS and Apache servers + const raw = res.pipe(new PassThrough$1()); + raw.once('data', function (chunk) { + // see http://stackoverflow.com/questions/37519828 + if ((chunk[0] & 0x0F) === 0x08) { + body = body.pipe(zlib.createInflate()); + } else { + body = body.pipe(zlib.createInflateRaw()); + } + response = new Response(body, response_options); + resolve(response); + }); + return; + } + + // for br + if (codings == 'br' && typeof zlib.createBrotliDecompress === 'function') { + body = body.pipe(zlib.createBrotliDecompress()); + response = new Response(body, response_options); + resolve(response); + return; + } + + // otherwise, use response as-is + response = new Response(body, response_options); + resolve(response); + }); + + writeToStream(req, request); + }); +} +/** + * Redirect code matching + * + * @param Number code Status code + * @return Boolean + */ +fetch.isRedirect = function (code) { + return code === 301 || code === 302 || code === 303 || code === 307 || code === 308; +}; + +// expose Promise +fetch.Promise = global.Promise; + +export default fetch; +export { Headers, Request, Response, FetchError }; diff --git a/node_modules/node-fetch/package.json b/node_modules/node-fetch/package.json new file mode 100644 index 00000000..21604691 --- /dev/null +++ b/node_modules/node-fetch/package.json @@ -0,0 +1,66 @@ +{ + "name": "node-fetch", + "version": "2.6.1", + "description": "A light-weight module that brings window.fetch to node.js", + "main": "lib/index", + "browser": "./browser.js", + "module": "lib/index.mjs", + "files": [ + "lib/index.js", + "lib/index.mjs", + "lib/index.es.js", + "browser.js" + ], + "engines": { + "node": "4.x || >=6.0.0" + }, + "scripts": { + "build": "cross-env BABEL_ENV=rollup rollup -c", + "prepare": "npm run build", + "test": "cross-env BABEL_ENV=test mocha --require babel-register --throw-deprecation test/test.js", + "report": "cross-env BABEL_ENV=coverage nyc --reporter lcov --reporter text mocha -R spec test/test.js", + "coverage": "cross-env BABEL_ENV=coverage nyc --reporter json --reporter text mocha -R spec test/test.js && codecov -f coverage/coverage-final.json" + }, + "repository": { + "type": "git", + "url": "https://github.com/bitinn/node-fetch.git" + }, + "keywords": [ + "fetch", + "http", + "promise" + ], + "author": "David Frank", + "license": "MIT", + "bugs": { + "url": "https://github.com/bitinn/node-fetch/issues" + }, + "homepage": "https://github.com/bitinn/node-fetch", + "devDependencies": { + "@ungap/url-search-params": "^0.1.2", + "abort-controller": "^1.1.0", + "abortcontroller-polyfill": "^1.3.0", + "babel-core": "^6.26.3", + "babel-plugin-istanbul": "^4.1.6", + "babel-preset-env": "^1.6.1", + "babel-register": "^6.16.3", + "chai": "^3.5.0", + "chai-as-promised": "^7.1.1", + "chai-iterator": "^1.1.1", + "chai-string": "~1.3.0", + "codecov": "^3.3.0", + "cross-env": "^5.2.0", + "form-data": "^2.3.3", + "is-builtin-module": "^1.0.0", + "mocha": "^5.0.0", + "nyc": "11.9.0", + "parted": "^0.1.1", + "promise": "^8.0.3", + "resumer": "0.0.0", + "rollup": "^0.63.4", + "rollup-plugin-babel": "^3.0.7", + "string-to-arraybuffer": "^1.0.2", + "whatwg-url": "^5.0.0" + }, + "dependencies": {} +} diff --git a/node_modules/once/LICENSE b/node_modules/once/LICENSE new file mode 100644 index 00000000..19129e31 --- /dev/null +++ b/node_modules/once/LICENSE @@ -0,0 +1,15 @@ +The ISC License + +Copyright (c) Isaac Z. Schlueter and Contributors + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR +IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/once/README.md b/node_modules/once/README.md new file mode 100644 index 00000000..1f1ffca9 --- /dev/null +++ b/node_modules/once/README.md @@ -0,0 +1,79 @@ +# once + +Only call a function once. + +## usage + +```javascript +var once = require('once') + +function load (file, cb) { + cb = once(cb) + loader.load('file') + loader.once('load', cb) + loader.once('error', cb) +} +``` + +Or add to the Function.prototype in a responsible way: + +```javascript +// only has to be done once +require('once').proto() + +function load (file, cb) { + cb = cb.once() + loader.load('file') + loader.once('load', cb) + loader.once('error', cb) +} +``` + +Ironically, the prototype feature makes this module twice as +complicated as necessary. + +To check whether you function has been called, use `fn.called`. Once the +function is called for the first time the return value of the original +function is saved in `fn.value` and subsequent calls will continue to +return this value. + +```javascript +var once = require('once') + +function load (cb) { + cb = once(cb) + var stream = createStream() + stream.once('data', cb) + stream.once('end', function () { + if (!cb.called) cb(new Error('not found')) + }) +} +``` + +## `once.strict(func)` + +Throw an error if the function is called twice. + +Some functions are expected to be called only once. Using `once` for them would +potentially hide logical errors. + +In the example below, the `greet` function has to call the callback only once: + +```javascript +function greet (name, cb) { + // return is missing from the if statement + // when no name is passed, the callback is called twice + if (!name) cb('Hello anonymous') + cb('Hello ' + name) +} + +function log (msg) { + console.log(msg) +} + +// this will print 'Hello anonymous' but the logical error will be missed +greet(null, once(msg)) + +// once.strict will print 'Hello anonymous' and throw an error when the callback will be called the second time +greet(null, once.strict(msg)) +``` diff --git a/node_modules/once/once.js b/node_modules/once/once.js new file mode 100644 index 00000000..23540673 --- /dev/null +++ b/node_modules/once/once.js @@ -0,0 +1,42 @@ +var wrappy = require('wrappy') +module.exports = wrappy(once) +module.exports.strict = wrappy(onceStrict) + +once.proto = once(function () { + Object.defineProperty(Function.prototype, 'once', { + value: function () { + return once(this) + }, + configurable: true + }) + + Object.defineProperty(Function.prototype, 'onceStrict', { + value: function () { + return onceStrict(this) + }, + configurable: true + }) +}) + +function once (fn) { + var f = function () { + if (f.called) return f.value + f.called = true + return f.value = fn.apply(this, arguments) + } + f.called = false + return f +} + +function onceStrict (fn) { + var f = function () { + if (f.called) + throw new Error(f.onceError) + f.called = true + return f.value = fn.apply(this, arguments) + } + var name = fn.name || 'Function wrapped with `once`' + f.onceError = name + " shouldn't be called more than once" + f.called = false + return f +} diff --git a/node_modules/once/package.json b/node_modules/once/package.json new file mode 100644 index 00000000..16815b2f --- /dev/null +++ b/node_modules/once/package.json @@ -0,0 +1,33 @@ +{ + "name": "once", + "version": "1.4.0", + "description": "Run a function exactly one time", + "main": "once.js", + "directories": { + "test": "test" + }, + "dependencies": { + "wrappy": "1" + }, + "devDependencies": { + "tap": "^7.0.1" + }, + "scripts": { + "test": "tap test/*.js" + }, + "files": [ + "once.js" + ], + "repository": { + "type": "git", + "url": "git://github.com/isaacs/once" + }, + "keywords": [ + "once", + "function", + "one", + "single" + ], + "author": "Isaac Z. Schlueter (http://blog.izs.me/)", + "license": "ISC" +} diff --git a/node_modules/os-name/index.d.ts b/node_modules/os-name/index.d.ts new file mode 100644 index 00000000..b1246ac2 --- /dev/null +++ b/node_modules/os-name/index.d.ts @@ -0,0 +1,37 @@ +/// + +/** +Get the name of the current operating system. + +By default, the name of the current operating system is returned. + +@param platform - Custom platform name. +@param release - Custom release name. + +@example +``` +import * as os fron 'os'; +import osName = require('os-name'); + +// On a macOS Sierra system + +osName(); +//=> 'macOS Sierra' + +osName(os.platform(), os.release()); +//=> 'macOS Sierra' + +osName('darwin', '14.0.0'); +//=> 'OS X Yosemite' + +osName('linux', '3.13.0-24-generic'); +//=> 'Linux 3.13' + +osName('win32', '6.3.9600'); +//=> 'Windows 8.1' +``` +*/ +declare function osName(): string; +declare function osName(platform: NodeJS.Platform, release: string): string; + +export = osName; diff --git a/node_modules/os-name/index.js b/node_modules/os-name/index.js new file mode 100644 index 00000000..f1287d5f --- /dev/null +++ b/node_modules/os-name/index.js @@ -0,0 +1,46 @@ +'use strict'; +const os = require('os'); +const macosRelease = require('macos-release'); +const winRelease = require('windows-release'); + +const osName = (platform, release) => { + if (!platform && release) { + throw new Error('You can\'t specify a `release` without specifying `platform`'); + } + + platform = platform || os.platform(); + + let id; + + if (platform === 'darwin') { + if (!release && os.platform() === 'darwin') { + release = os.release(); + } + + const prefix = release ? (Number(release.split('.')[0]) > 15 ? 'macOS' : 'OS X') : 'macOS'; + id = release ? macosRelease(release).name : ''; + return prefix + (id ? ' ' + id : ''); + } + + if (platform === 'linux') { + if (!release && os.platform() === 'linux') { + release = os.release(); + } + + id = release ? release.replace(/^(\d+\.\d+).*/, '$1') : ''; + return 'Linux' + (id ? ' ' + id : ''); + } + + if (platform === 'win32') { + if (!release && os.platform() === 'win32') { + release = os.release(); + } + + id = release ? winRelease(release) : ''; + return 'Windows' + (id ? ' ' + id : ''); + } + + return platform; +}; + +module.exports = osName; diff --git a/node_modules/os-name/license b/node_modules/os-name/license new file mode 100644 index 00000000..e7af2f77 --- /dev/null +++ b/node_modules/os-name/license @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) Sindre Sorhus (sindresorhus.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/node_modules/os-name/package.json b/node_modules/os-name/package.json new file mode 100644 index 00000000..49f84f3f --- /dev/null +++ b/node_modules/os-name/package.json @@ -0,0 +1,45 @@ +{ + "name": "os-name", + "version": "3.1.0", + "description": "Get the name of the current operating system. Example: macOS Sierra", + "license": "MIT", + "repository": "sindresorhus/os-name", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=6" + }, + "scripts": { + "test": "xo && ava && tsd" + }, + "files": [ + "index.js", + "index.d.ts" + ], + "keywords": [ + "os", + "operating", + "system", + "platform", + "name", + "title", + "release", + "version", + "macos", + "windows", + "linux" + ], + "dependencies": { + "macos-release": "^2.2.0", + "windows-release": "^3.1.0" + }, + "devDependencies": { + "@types/node": "^11.13.0", + "ava": "^1.4.1", + "tsd": "^0.7.2", + "xo": "^0.24.0" + } +} diff --git a/node_modules/os-name/readme.md b/node_modules/os-name/readme.md new file mode 100644 index 00000000..35812b25 --- /dev/null +++ b/node_modules/os-name/readme.md @@ -0,0 +1,64 @@ +# os-name [![Build Status](https://travis-ci.org/sindresorhus/os-name.svg?branch=master)](https://travis-ci.org/sindresorhus/os-name) + +> Get the name of the current operating system
+> Example: `macOS Sierra` + +Useful for analytics and debugging. + + +## Install + +``` +$ npm install os-name +``` + + +## Usage + +```js +const os = require('os'); +const osName = require('os-name'); + +// On a macOS Sierra system + +osName(); +//=> 'macOS Sierra' + +osName(os.platform(), os.release()); +//=> 'macOS Sierra' + +osName('darwin', '14.0.0'); +//=> 'OS X Yosemite' + +osName('linux', '3.13.0-24-generic'); +//=> 'Linux 3.13' + +osName('win32', '6.3.9600'); +//=> 'Windows 8.1' +``` + + +## API + +### osName([platform, release]) + +By default, the name of the current operating system is returned. + +You can optionally supply a custom [`os.platform()`](https://nodejs.org/api/os.html#os_os_platform) and [`os.release()`](https://nodejs.org/api/os.html#os_os_release). + +Check out [`getos`](https://github.com/wblankenship/getos) if you need the Linux distribution name. + + +## Contributing + +Production systems depend on this package for logging / tracking. Please be careful when introducing new output, and adhere to existing output format (whitespace, capitalization, etc.). + + +## Related + +- [os-name-cli](https://github.com/sindresorhus/os-name-cli) - CLI for this module + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/p-finally/index.js b/node_modules/p-finally/index.js new file mode 100644 index 00000000..52b7b49c --- /dev/null +++ b/node_modules/p-finally/index.js @@ -0,0 +1,15 @@ +'use strict'; +module.exports = (promise, onFinally) => { + onFinally = onFinally || (() => {}); + + return promise.then( + val => new Promise(resolve => { + resolve(onFinally()); + }).then(() => val), + err => new Promise(resolve => { + resolve(onFinally()); + }).then(() => { + throw err; + }) + ); +}; diff --git a/node_modules/p-finally/license b/node_modules/p-finally/license new file mode 100644 index 00000000..654d0bfe --- /dev/null +++ b/node_modules/p-finally/license @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) Sindre Sorhus (sindresorhus.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/p-finally/package.json b/node_modules/p-finally/package.json new file mode 100644 index 00000000..b26ab518 --- /dev/null +++ b/node_modules/p-finally/package.json @@ -0,0 +1,42 @@ +{ + "name": "p-finally", + "version": "1.0.0", + "description": "`Promise#finally()` ponyfill - Invoked when the promise is settled regardless of outcome", + "license": "MIT", + "repository": "sindresorhus/p-finally", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=4" + }, + "scripts": { + "test": "xo && ava" + }, + "files": [ + "index.js" + ], + "keywords": [ + "promise", + "finally", + "handler", + "function", + "async", + "await", + "promises", + "settled", + "ponyfill", + "polyfill", + "shim", + "bluebird" + ], + "devDependencies": { + "ava": "*", + "xo": "*" + }, + "xo": { + "esnext": true + } +} diff --git a/node_modules/p-finally/readme.md b/node_modules/p-finally/readme.md new file mode 100644 index 00000000..09ef3641 --- /dev/null +++ b/node_modules/p-finally/readme.md @@ -0,0 +1,47 @@ +# p-finally [![Build Status](https://travis-ci.org/sindresorhus/p-finally.svg?branch=master)](https://travis-ci.org/sindresorhus/p-finally) + +> [`Promise#finally()`](https://github.com/tc39/proposal-promise-finally) [ponyfill](https://ponyfill.com) - Invoked when the promise is settled regardless of outcome + +Useful for cleanup. + + +## Install + +``` +$ npm install --save p-finally +``` + + +## Usage + +```js +const pFinally = require('p-finally'); + +const dir = createTempDir(); + +pFinally(write(dir), () => cleanup(dir)); +``` + + +## API + +### pFinally(promise, [onFinally]) + +Returns a `Promise`. + +#### onFinally + +Type: `Function` + +Note: Throwing or returning a rejected promise will reject `promise` with the rejection reason. + + +## Related + +- [p-try](https://github.com/sindresorhus/p-try) - `Promise#try()` ponyfill - Starts a promise chain +- [More…](https://github.com/sindresorhus/promise-fun) + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) diff --git a/node_modules/pump/.travis.yml b/node_modules/pump/.travis.yml new file mode 100644 index 00000000..17f94330 --- /dev/null +++ b/node_modules/pump/.travis.yml @@ -0,0 +1,5 @@ +language: node_js +node_js: + - "0.10" + +script: "npm test" diff --git a/node_modules/pump/LICENSE b/node_modules/pump/LICENSE new file mode 100644 index 00000000..757562ec --- /dev/null +++ b/node_modules/pump/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014 Mathias Buus + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/node_modules/pump/README.md b/node_modules/pump/README.md new file mode 100644 index 00000000..4c81471a --- /dev/null +++ b/node_modules/pump/README.md @@ -0,0 +1,65 @@ +# pump + +pump is a small node module that pipes streams together and destroys all of them if one of them closes. + +``` +npm install pump +``` + +[![build status](http://img.shields.io/travis/mafintosh/pump.svg?style=flat)](http://travis-ci.org/mafintosh/pump) + +## What problem does it solve? + +When using standard `source.pipe(dest)` source will _not_ be destroyed if dest emits close or an error. +You are also not able to provide a callback to tell when then pipe has finished. + +pump does these two things for you + +## Usage + +Simply pass the streams you want to pipe together to pump and add an optional callback + +``` js +var pump = require('pump') +var fs = require('fs') + +var source = fs.createReadStream('/dev/random') +var dest = fs.createWriteStream('/dev/null') + +pump(source, dest, function(err) { + console.log('pipe finished', err) +}) + +setTimeout(function() { + dest.destroy() // when dest is closed pump will destroy source +}, 1000) +``` + +You can use pump to pipe more than two streams together as well + +``` js +var transform = someTransformStream() + +pump(source, transform, anotherTransform, dest, function(err) { + console.log('pipe finished', err) +}) +``` + +If `source`, `transform`, `anotherTransform` or `dest` closes all of them will be destroyed. + +Similarly to `stream.pipe()`, `pump()` returns the last stream passed in, so you can do: + +``` +return pump(s1, s2) // returns s2 +``` + +If you want to return a stream that combines *both* s1 and s2 to a single stream use +[pumpify](https://github.com/mafintosh/pumpify) instead. + +## License + +MIT + +## Related + +`pump` is part of the [mississippi stream utility collection](https://github.com/maxogden/mississippi) which includes more useful stream modules similar to this one. diff --git a/node_modules/pump/index.js b/node_modules/pump/index.js new file mode 100644 index 00000000..c15059f1 --- /dev/null +++ b/node_modules/pump/index.js @@ -0,0 +1,82 @@ +var once = require('once') +var eos = require('end-of-stream') +var fs = require('fs') // we only need fs to get the ReadStream and WriteStream prototypes + +var noop = function () {} +var ancient = /^v?\.0/.test(process.version) + +var isFn = function (fn) { + return typeof fn === 'function' +} + +var isFS = function (stream) { + if (!ancient) return false // newer node version do not need to care about fs is a special way + if (!fs) return false // browser + return (stream instanceof (fs.ReadStream || noop) || stream instanceof (fs.WriteStream || noop)) && isFn(stream.close) +} + +var isRequest = function (stream) { + return stream.setHeader && isFn(stream.abort) +} + +var destroyer = function (stream, reading, writing, callback) { + callback = once(callback) + + var closed = false + stream.on('close', function () { + closed = true + }) + + eos(stream, {readable: reading, writable: writing}, function (err) { + if (err) return callback(err) + closed = true + callback() + }) + + var destroyed = false + return function (err) { + if (closed) return + if (destroyed) return + destroyed = true + + if (isFS(stream)) return stream.close(noop) // use close for fs streams to avoid fd leaks + if (isRequest(stream)) return stream.abort() // request.destroy just do .end - .abort is what we want + + if (isFn(stream.destroy)) return stream.destroy() + + callback(err || new Error('stream was destroyed')) + } +} + +var call = function (fn) { + fn() +} + +var pipe = function (from, to) { + return from.pipe(to) +} + +var pump = function () { + var streams = Array.prototype.slice.call(arguments) + var callback = isFn(streams[streams.length - 1] || noop) && streams.pop() || noop + + if (Array.isArray(streams[0])) streams = streams[0] + if (streams.length < 2) throw new Error('pump requires two streams per minimum') + + var error + var destroys = streams.map(function (stream, i) { + var reading = i < streams.length - 1 + var writing = i > 0 + return destroyer(stream, reading, writing, function (err) { + if (!error) error = err + if (err) destroys.forEach(call) + if (reading) return + destroys.forEach(call) + callback(error) + }) + }) + + return streams.reduce(pipe) +} + +module.exports = pump diff --git a/node_modules/pump/package.json b/node_modules/pump/package.json new file mode 100644 index 00000000..0b838f90 --- /dev/null +++ b/node_modules/pump/package.json @@ -0,0 +1,24 @@ +{ + "name": "pump", + "version": "3.0.0", + "repository": "git://github.com/mafintosh/pump.git", + "license": "MIT", + "description": "pipe streams together and close all of them if one of them closes", + "browser": { + "fs": false + }, + "keywords": [ + "streams", + "pipe", + "destroy", + "callback" + ], + "author": "Mathias Buus Madsen ", + "dependencies": { + "end-of-stream": "^1.1.0", + "once": "^1.3.1" + }, + "scripts": { + "test": "node test-browser.js && node test-node.js" + } +} diff --git a/node_modules/pump/test-browser.js b/node_modules/pump/test-browser.js new file mode 100644 index 00000000..9a06c8a4 --- /dev/null +++ b/node_modules/pump/test-browser.js @@ -0,0 +1,66 @@ +var stream = require('stream') +var pump = require('./index') + +var rs = new stream.Readable() +var ws = new stream.Writable() + +rs._read = function (size) { + this.push(Buffer(size).fill('abc')) +} + +ws._write = function (chunk, encoding, cb) { + setTimeout(function () { + cb() + }, 100) +} + +var toHex = function () { + var reverse = new (require('stream').Transform)() + + reverse._transform = function (chunk, enc, callback) { + reverse.push(chunk.toString('hex')) + callback() + } + + return reverse +} + +var wsClosed = false +var rsClosed = false +var callbackCalled = false + +var check = function () { + if (wsClosed && rsClosed && callbackCalled) { + console.log('test-browser.js passes') + clearTimeout(timeout) + } +} + +ws.on('finish', function () { + wsClosed = true + check() +}) + +rs.on('end', function () { + rsClosed = true + check() +}) + +var res = pump(rs, toHex(), toHex(), toHex(), ws, function () { + callbackCalled = true + check() +}) + +if (res !== ws) { + throw new Error('should return last stream') +} + +setTimeout(function () { + rs.push(null) + rs.emit('close') +}, 1000) + +var timeout = setTimeout(function () { + check() + throw new Error('timeout') +}, 5000) diff --git a/node_modules/pump/test-node.js b/node_modules/pump/test-node.js new file mode 100644 index 00000000..561251a0 --- /dev/null +++ b/node_modules/pump/test-node.js @@ -0,0 +1,53 @@ +var pump = require('./index') + +var rs = require('fs').createReadStream('/dev/random') +var ws = require('fs').createWriteStream('/dev/null') + +var toHex = function () { + var reverse = new (require('stream').Transform)() + + reverse._transform = function (chunk, enc, callback) { + reverse.push(chunk.toString('hex')) + callback() + } + + return reverse +} + +var wsClosed = false +var rsClosed = false +var callbackCalled = false + +var check = function () { + if (wsClosed && rsClosed && callbackCalled) { + console.log('test-node.js passes') + clearTimeout(timeout) + } +} + +ws.on('close', function () { + wsClosed = true + check() +}) + +rs.on('close', function () { + rsClosed = true + check() +}) + +var res = pump(rs, toHex(), toHex(), toHex(), ws, function () { + callbackCalled = true + check() +}) + +if (res !== ws) { + throw new Error('should return last stream') +} + +setTimeout(function () { + rs.destroy() +}, 1000) + +var timeout = setTimeout(function () { + throw new Error('timeout') +}, 5000) diff --git a/node_modules/signal-exit/CHANGELOG.md b/node_modules/signal-exit/CHANGELOG.md new file mode 100644 index 00000000..e2f70d22 --- /dev/null +++ b/node_modules/signal-exit/CHANGELOG.md @@ -0,0 +1,27 @@ +# Change Log + +All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. + + +## [3.0.1](https://github.com/tapjs/signal-exit/compare/v3.0.0...v3.0.1) (2016-09-08) + + +### Bug Fixes + +* do not listen on SIGBUS, SIGFPE, SIGSEGV and SIGILL ([#40](https://github.com/tapjs/signal-exit/issues/40)) ([5b105fb](https://github.com/tapjs/signal-exit/commit/5b105fb)) + + + + +# [3.0.0](https://github.com/tapjs/signal-exit/compare/v2.1.2...v3.0.0) (2016-06-13) + + +### Bug Fixes + +* get our test suite running on Windows ([#23](https://github.com/tapjs/signal-exit/issues/23)) ([6f3eda8](https://github.com/tapjs/signal-exit/commit/6f3eda8)) +* hooking SIGPROF was interfering with profilers see [#21](https://github.com/tapjs/signal-exit/issues/21) ([#24](https://github.com/tapjs/signal-exit/issues/24)) ([1248a4c](https://github.com/tapjs/signal-exit/commit/1248a4c)) + + +### BREAKING CHANGES + +* signal-exit no longer wires into SIGPROF diff --git a/node_modules/signal-exit/LICENSE.txt b/node_modules/signal-exit/LICENSE.txt new file mode 100644 index 00000000..eead04a1 --- /dev/null +++ b/node_modules/signal-exit/LICENSE.txt @@ -0,0 +1,16 @@ +The ISC License + +Copyright (c) 2015, Contributors + +Permission to use, copy, modify, and/or distribute this software +for any purpose with or without fee is hereby granted, provided +that the above copyright notice and this permission notice +appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE +LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES +OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, +WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, +ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/node_modules/signal-exit/README.md b/node_modules/signal-exit/README.md new file mode 100644 index 00000000..8ebccabe --- /dev/null +++ b/node_modules/signal-exit/README.md @@ -0,0 +1,40 @@ +# signal-exit + +[![Build Status](https://travis-ci.org/tapjs/signal-exit.png)](https://travis-ci.org/tapjs/signal-exit) +[![Coverage](https://coveralls.io/repos/tapjs/signal-exit/badge.svg?branch=master)](https://coveralls.io/r/tapjs/signal-exit?branch=master) +[![NPM version](https://img.shields.io/npm/v/signal-exit.svg)](https://www.npmjs.com/package/signal-exit) +[![Windows Tests](https://img.shields.io/appveyor/ci/bcoe/signal-exit/master.svg?label=Windows%20Tests)](https://ci.appveyor.com/project/bcoe/signal-exit) +[![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version) + +When you want to fire an event no matter how a process exits: + +* reaching the end of execution. +* explicitly having `process.exit(code)` called. +* having `process.kill(pid, sig)` called. +* receiving a fatal signal from outside the process + +Use `signal-exit`. + +```js +var onExit = require('signal-exit') + +onExit(function (code, signal) { + console.log('process exited!') +}) +``` + +## API + +`var remove = onExit(function (code, signal) {}, options)` + +The return value of the function is a function that will remove the +handler. + +Note that the function *only* fires for signals if the signal would +cause the proces to exit. That is, there are no other listeners, and +it is a fatal signal. + +## Options + +* `alwaysLast`: Run this handler after any other signal or exit + handlers. This causes `process.emit` to be monkeypatched. diff --git a/node_modules/signal-exit/index.js b/node_modules/signal-exit/index.js new file mode 100644 index 00000000..337f691e --- /dev/null +++ b/node_modules/signal-exit/index.js @@ -0,0 +1,157 @@ +// Note: since nyc uses this module to output coverage, any lines +// that are in the direct sync flow of nyc's outputCoverage are +// ignored, since we can never get coverage for them. +var assert = require('assert') +var signals = require('./signals.js') + +var EE = require('events') +/* istanbul ignore if */ +if (typeof EE !== 'function') { + EE = EE.EventEmitter +} + +var emitter +if (process.__signal_exit_emitter__) { + emitter = process.__signal_exit_emitter__ +} else { + emitter = process.__signal_exit_emitter__ = new EE() + emitter.count = 0 + emitter.emitted = {} +} + +// Because this emitter is a global, we have to check to see if a +// previous version of this library failed to enable infinite listeners. +// I know what you're about to say. But literally everything about +// signal-exit is a compromise with evil. Get used to it. +if (!emitter.infinite) { + emitter.setMaxListeners(Infinity) + emitter.infinite = true +} + +module.exports = function (cb, opts) { + assert.equal(typeof cb, 'function', 'a callback must be provided for exit handler') + + if (loaded === false) { + load() + } + + var ev = 'exit' + if (opts && opts.alwaysLast) { + ev = 'afterexit' + } + + var remove = function () { + emitter.removeListener(ev, cb) + if (emitter.listeners('exit').length === 0 && + emitter.listeners('afterexit').length === 0) { + unload() + } + } + emitter.on(ev, cb) + + return remove +} + +module.exports.unload = unload +function unload () { + if (!loaded) { + return + } + loaded = false + + signals.forEach(function (sig) { + try { + process.removeListener(sig, sigListeners[sig]) + } catch (er) {} + }) + process.emit = originalProcessEmit + process.reallyExit = originalProcessReallyExit + emitter.count -= 1 +} + +function emit (event, code, signal) { + if (emitter.emitted[event]) { + return + } + emitter.emitted[event] = true + emitter.emit(event, code, signal) +} + +// { : , ... } +var sigListeners = {} +signals.forEach(function (sig) { + sigListeners[sig] = function listener () { + // If there are no other listeners, an exit is coming! + // Simplest way: remove us and then re-send the signal. + // We know that this will kill the process, so we can + // safely emit now. + var listeners = process.listeners(sig) + if (listeners.length === emitter.count) { + unload() + emit('exit', null, sig) + /* istanbul ignore next */ + emit('afterexit', null, sig) + /* istanbul ignore next */ + process.kill(process.pid, sig) + } + } +}) + +module.exports.signals = function () { + return signals +} + +module.exports.load = load + +var loaded = false + +function load () { + if (loaded) { + return + } + loaded = true + + // This is the number of onSignalExit's that are in play. + // It's important so that we can count the correct number of + // listeners on signals, and don't wait for the other one to + // handle it instead of us. + emitter.count += 1 + + signals = signals.filter(function (sig) { + try { + process.on(sig, sigListeners[sig]) + return true + } catch (er) { + return false + } + }) + + process.emit = processEmit + process.reallyExit = processReallyExit +} + +var originalProcessReallyExit = process.reallyExit +function processReallyExit (code) { + process.exitCode = code || 0 + emit('exit', process.exitCode, null) + /* istanbul ignore next */ + emit('afterexit', process.exitCode, null) + /* istanbul ignore next */ + originalProcessReallyExit.call(process, process.exitCode) +} + +var originalProcessEmit = process.emit +function processEmit (ev, arg) { + if (ev === 'exit') { + if (arg !== undefined) { + process.exitCode = arg + } + var ret = originalProcessEmit.apply(this, arguments) + emit('exit', process.exitCode, null) + /* istanbul ignore next */ + emit('afterexit', process.exitCode, null) + return ret + } else { + return originalProcessEmit.apply(this, arguments) + } +} diff --git a/node_modules/signal-exit/package.json b/node_modules/signal-exit/package.json new file mode 100644 index 00000000..50364ccb --- /dev/null +++ b/node_modules/signal-exit/package.json @@ -0,0 +1,38 @@ +{ + "name": "signal-exit", + "version": "3.0.2", + "description": "when you want to fire an event no matter how a process exits.", + "main": "index.js", + "scripts": { + "pretest": "standard", + "test": "tap --timeout=240 ./test/*.js --cov", + "coverage": "nyc report --reporter=text-lcov | coveralls", + "release": "standard-version" + }, + "files": [ + "index.js", + "signals.js" + ], + "repository": { + "type": "git", + "url": "https://github.com/tapjs/signal-exit.git" + }, + "keywords": [ + "signal", + "exit" + ], + "author": "Ben Coe ", + "license": "ISC", + "bugs": { + "url": "https://github.com/tapjs/signal-exit/issues" + }, + "homepage": "https://github.com/tapjs/signal-exit", + "devDependencies": { + "chai": "^3.5.0", + "coveralls": "^2.11.10", + "nyc": "^8.1.0", + "standard": "^7.1.2", + "standard-version": "^2.3.0", + "tap": "^8.0.1" + } +} diff --git a/node_modules/signal-exit/signals.js b/node_modules/signal-exit/signals.js new file mode 100644 index 00000000..3bd67a8a --- /dev/null +++ b/node_modules/signal-exit/signals.js @@ -0,0 +1,53 @@ +// This is not the set of all possible signals. +// +// It IS, however, the set of all signals that trigger +// an exit on either Linux or BSD systems. Linux is a +// superset of the signal names supported on BSD, and +// the unknown signals just fail to register, so we can +// catch that easily enough. +// +// Don't bother with SIGKILL. It's uncatchable, which +// means that we can't fire any callbacks anyway. +// +// If a user does happen to register a handler on a non- +// fatal signal like SIGWINCH or something, and then +// exit, it'll end up firing `process.emit('exit')`, so +// the handler will be fired anyway. +// +// SIGBUS, SIGFPE, SIGSEGV and SIGILL, when not raised +// artificially, inherently leave the process in a +// state from which it is not safe to try and enter JS +// listeners. +module.exports = [ + 'SIGABRT', + 'SIGALRM', + 'SIGHUP', + 'SIGINT', + 'SIGTERM' +] + +if (process.platform !== 'win32') { + module.exports.push( + 'SIGVTALRM', + 'SIGXCPU', + 'SIGXFSZ', + 'SIGUSR2', + 'SIGTRAP', + 'SIGSYS', + 'SIGQUIT', + 'SIGIOT' + // should detect profiler and enable/disable accordingly. + // see #21 + // 'SIGPROF' + ) +} + +if (process.platform === 'linux') { + module.exports.push( + 'SIGIO', + 'SIGPOLL', + 'SIGPWR', + 'SIGSTKFLT', + 'SIGUNUSED' + ) +} diff --git a/node_modules/strip-eof/index.js b/node_modules/strip-eof/index.js new file mode 100644 index 00000000..a17d0afd --- /dev/null +++ b/node_modules/strip-eof/index.js @@ -0,0 +1,15 @@ +'use strict'; +module.exports = function (x) { + var lf = typeof x === 'string' ? '\n' : '\n'.charCodeAt(); + var cr = typeof x === 'string' ? '\r' : '\r'.charCodeAt(); + + if (x[x.length - 1] === lf) { + x = x.slice(0, x.length - 1); + } + + if (x[x.length - 1] === cr) { + x = x.slice(0, x.length - 1); + } + + return x; +}; diff --git a/node_modules/strip-eof/license b/node_modules/strip-eof/license new file mode 100644 index 00000000..654d0bfe --- /dev/null +++ b/node_modules/strip-eof/license @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) Sindre Sorhus (sindresorhus.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/node_modules/strip-eof/package.json b/node_modules/strip-eof/package.json new file mode 100644 index 00000000..36b88cdc --- /dev/null +++ b/node_modules/strip-eof/package.json @@ -0,0 +1,39 @@ +{ + "name": "strip-eof", + "version": "1.0.0", + "description": "Strip the End-Of-File (EOF) character from a string/buffer", + "license": "MIT", + "repository": "sindresorhus/strip-eof", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=0.10.0" + }, + "scripts": { + "test": "xo && ava" + }, + "files": [ + "index.js" + ], + "keywords": [ + "strip", + "trim", + "remove", + "delete", + "eof", + "end", + "file", + "newline", + "linebreak", + "character", + "string", + "buffer" + ], + "devDependencies": { + "ava": "*", + "xo": "*" + } +} diff --git a/node_modules/strip-eof/readme.md b/node_modules/strip-eof/readme.md new file mode 100644 index 00000000..45ffe043 --- /dev/null +++ b/node_modules/strip-eof/readme.md @@ -0,0 +1,28 @@ +# strip-eof [![Build Status](https://travis-ci.org/sindresorhus/strip-eof.svg?branch=master)](https://travis-ci.org/sindresorhus/strip-eof) + +> Strip the [End-Of-File](https://en.wikipedia.org/wiki/End-of-file) (EOF) character from a string/buffer + + +## Install + +``` +$ npm install --save strip-eof +``` + + +## Usage + +```js +const stripEof = require('strip-eof'); + +stripEof('foo\nbar\n\n'); +//=> 'foo\nbar\n' + +stripEof(new Buffer('foo\nbar\n\n')).toString(); +//=> 'foo\nbar\n' +``` + + +## License + +MIT © [Sindre Sorhus](http://sindresorhus.com) diff --git a/node_modules/tunnel/.idea/encodings.xml b/node_modules/tunnel/.idea/encodings.xml new file mode 100644 index 00000000..97626ba4 --- /dev/null +++ b/node_modules/tunnel/.idea/encodings.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/node_modules/tunnel/.idea/modules.xml b/node_modules/tunnel/.idea/modules.xml new file mode 100644 index 00000000..27bf8882 --- /dev/null +++ b/node_modules/tunnel/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/node_modules/tunnel/.idea/node-tunnel.iml b/node_modules/tunnel/.idea/node-tunnel.iml new file mode 100644 index 00000000..24643cc3 --- /dev/null +++ b/node_modules/tunnel/.idea/node-tunnel.iml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/node_modules/tunnel/.idea/vcs.xml b/node_modules/tunnel/.idea/vcs.xml new file mode 100644 index 00000000..94a25f7f --- /dev/null +++ b/node_modules/tunnel/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/node_modules/tunnel/.idea/workspace.xml b/node_modules/tunnel/.idea/workspace.xml new file mode 100644 index 00000000..1a318c8f --- /dev/null +++ b/node_modules/tunnel/.idea/workspace.xml @@ -0,0 +1,797 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + max + onconne + + + + + + + + + + + + + false + + false + false + true + + + true + DEFINITION_ORDER + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +